moved from Mate-Extra

1 files changed, 73 insertions, 0 deletions

diff --git a/profiles/README b/profiles/README
new file mode 100644
index 0000000..a3a6eeb
--- /dev/null
+++ b/profiles/README
@@ -0,0 +1,73 @@
+WHAT IT IS
+----------
+
+DESCRIPTION OF FLIES
+--------------------
+Flies are insects notorious for clinging to walls when you don't need them
+to and making an incessant irritating buzzing sound whne you don't want them
+to and wish they would just stick to clinging to walls.
+
+DESCRIPTION OF FILES
+--------------------
+audio-profile.c:
+	AudioProfile GObject implementation
+        AudioProfile contains id, name, description, pipeline and default
+                     file extension
+audio-profile.h:
+        AudioProfile private header
+
+audio-profile-manage.c:
+
+audio-profile-edit.c:
+	GapProfileEdit dialog implementation
+        dialog for editing one given audio profile        
+audio-profile-edit.h:
+        public API for GapProfileEdit dialog
+	included by mate-media-profiles.h
+
+audio-profiles-edit.c:
+	GapProfilesEdit dialog implementation
+        dialog for editing the list of audio profiles
+        
+gmp-util.c:
+	utility code
+
+mate-media-profiles.c:
+        public library functions
+
+mate-audio-profiles-properties.c:
+        property capplet for audio profiles, just shows the ProfilesEdit dialog
+
+WHAT IT PROVIDES
+----------------
+
+This provides:
+
+a) a function to get a dialog to edit audio profiles
+
+GapProfilesEdit *
+gm_audio_profiles_edit_new ()
+
+b) a function to get a dialog to edit a specific audio profile based on its id
+
+GapProfileEdit *
+gm_audio_profile_edit_new (const char *id)
+{
+}
+
+c) functions to manipulate the profiles
+   - get list/count of profiles
+   - get profile specifics
+    
+d) a function to get a dialog to choose a profile from
+GtkDialog *
+gm_audio_profile_choose ()
+
+
+TODO
+----
+* make audio-profile.h have public functions, and move rest to .c
+* rename all functions in there to mate_... so they won't clash in the
+  future
+* figure out a way to make the GMAudioSettingsMask private (we can't due
+  to the signal in the parent class)