From 89235a43e3b1af7f57d1fdbc87021ea49e1d5d05 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Wed, 29 Apr 2009 10:11:21 -0500 Subject: Patch from Niel Patel to close the directory after opening it. --- src/applet-main.c | 1 + 1 file changed, 1 insertion(+) diff --git a/src/applet-main.c b/src/applet-main.c index 310cfe9..535a6ae 100644 --- a/src/applet-main.c +++ b/src/applet-main.c @@ -251,6 +251,7 @@ applet_fill_cb (PanelApplet * applet, const gchar * iid, gpointer data) if (load_module(name, menubar)) indicators_loaded++; } + g_dir_close (dir); } if (indicators_loaded == 0) { -- cgit v1.2.3 From c73af692f9bd4cab185206ab90b592469e659d77 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 11:40:56 -0500 Subject: First pass at trying to create some function documentation for Indicator --- libindicate/indicator.c | 99 +++++++++++++++++++++++++++++++++++++++++++++++++ libindicate/indicator.h | 8 ++++ 2 files changed, 107 insertions(+) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index dfcba67..87b11a7 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -76,6 +76,12 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) gobj->finalize = indicate_indicator_finalize; + /** IndicateIndicator::dispaly: + + Emitted when the user has clicked on this indicator. In the + messaging indicator this would be when someone clicks on the + menu item for the indicator. + */ signals[USER_DISPLAY] = g_signal_new(INDICATE_INDICATOR_SIGNAL_DISPLAY, G_TYPE_FROM_CLASS(class), G_SIGNAL_RUN_LAST, @@ -83,6 +89,11 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** IndicateIndicator::hide: + + Emitted every time this indicator is hidden. This + is mostly used by #IndicateServer. + */ signals[HIDE] = g_signal_new(INDICATE_INDICATOR_SIGNAL_HIDE, G_TYPE_FROM_CLASS(class), G_SIGNAL_RUN_LAST, @@ -90,6 +101,11 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** IndicateIndicator::hide: + + Emitted every time this indicator is shown. This + is mostly used by #IndicateServer. + */ signals[SHOW] = g_signal_new(INDICATE_INDICATOR_SIGNAL_SHOW, G_TYPE_FROM_CLASS(class), G_SIGNAL_RUN_LAST, @@ -97,6 +113,11 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** IndicateIndicator::modified: + + Emitted every time an indicator property is changed. + This is mostly used by #IndicateServer. + */ signals[MODIFIED] = g_signal_new(INDICATE_INDICATOR_SIGNAL_MODIFIED, G_TYPE_FROM_CLASS(class), G_SIGNAL_RUN_LAST, @@ -145,6 +166,10 @@ indicate_indicator_finalize (GObject * obj) return; } +/** indicate_indicator_new: + + Builds a new indicator object using #g_object_new. +*/ IndicateIndicator * indicate_indicator_new (void) { @@ -152,6 +177,13 @@ indicate_indicator_new (void) return indicator; } +/** indicate_indicator_show: + @indicator: a #IndicateIndicator to act on + + Shows this indicator on the bus. If the #IndicateServer that it's + connected to is not shown itself this function will show the server + as well using #indicate_server_show. +*/ void indicate_indicator_show (IndicateIndicator * indicator) { @@ -171,6 +203,12 @@ indicate_indicator_show (IndicateIndicator * indicator) return; } +/** indicate_indicator_hide: + @indicator: a #IndicateIndicator to act on + + Hides the indicator from the bus. Does not effect the + indicator's #IndicateServer in any way. +*/ void indicate_indicator_hide (IndicateIndicator * indicator) { @@ -186,6 +224,13 @@ indicate_indicator_hide (IndicateIndicator * indicator) return; } +/** indicate_indicator_is_visible: + @indicator: a #IndicateIndicator to act on + + Checkes the visibility status of @indicator. + + Return value: %TRUE if the indicator is visible else %FALSE. +*/ gboolean indicate_indicator_is_visible (IndicateIndicator * indicator) { @@ -194,6 +239,14 @@ indicate_indicator_is_visible (IndicateIndicator * indicator) return priv->is_visible; } +/** indicate_indicator_get_id: + @indicator: a #IndicateIndicator to act on + + Gets the ID value of the @indicator. + + Return value: The ID of the indicator. Can not be zero. + Zero represents an error. +*/ guint indicate_indicator_get_id (IndicateIndicator * indicator) { @@ -202,6 +255,14 @@ indicate_indicator_get_id (IndicateIndicator * indicator) return priv->id; } +/** indicate_indicator_get_indicator_type: + @indicator: a #IndicateIndicator to act on + + Returns the type of @indicator. This is largely set by the subclass + that the indicator was built with and should not be free'd. + + Return value: A string defining the type or NULL for no type. +*/ const gchar * indicate_indicator_get_indicator_type (IndicateIndicator * indicator) { @@ -215,6 +276,13 @@ indicate_indicator_get_indicator_type (IndicateIndicator * indicator) return NULL; } +/** indicate_indicator_user_display: + @indicator: a #IndicateIndicator to act on + + Emits the #IndicateIndicator::user-display signal simliar to a user + clicking on @indicator over the bus. Signal will not be sent if the + @indicator is not visible. +*/ void indicate_indicator_user_display (IndicateIndicator * indicator) { @@ -227,6 +295,17 @@ indicate_indicator_user_display (IndicateIndicator * indicator) return; } +/** indicate_indicator_set_property: + @indicator: a #IndicateIndicator to act on + @key: name of the property + @data: value of the property + + Sets a simple string property on @indicator. If the property + had previously been set it will replace it with the new value, + otherwise it will create the property. This will include an + emition of #IndicateIndicator::modified if the property value + was changed. +*/ void indicate_indicator_set_property (IndicateIndicator * indicator, const gchar * key, const gchar * data) { @@ -238,6 +317,16 @@ indicate_indicator_set_property (IndicateIndicator * indicator, const gchar * ke return class->set_property(indicator, key, data); } +/** indicate_indicator_set_property_icon: + @indicator: a #IndicateIndicator to act on + @key: name of the property + @data: icon to set property with + + This is a helper function that wraps around #indicate_indicator_set_property + but takes an #GdkPixbuf parameter. It then takes the @data + parameter, turns it into a PNG, base64 encodes it and then + uses that data to call #indicate_indicator_set_property. +*/ void indicate_indicator_set_property_icon (IndicateIndicator * indicator, const gchar * key, const GdkPixbuf * data) { @@ -271,6 +360,16 @@ indicate_indicator_set_property_icon (IndicateIndicator * indicator, const gchar return; } +/** indicate_indicator_set_property_time: + @indicator: a #IndicateIndicator to act on + @key: name of the property + @data: time to set property with + + This is a helper function that wraps around #indicate_indicator_set_property + but takes an #GTimeVal parameter. It then takes the @data + parameter converts it to an ISO 8601 time string and + uses that data to call #indicate_indicator_set_property. +*/ void indicate_indicator_set_property_time (IndicateIndicator * indicator, const gchar * key, GTimeVal * time) { diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 8af5568..4536cf5 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -56,6 +56,14 @@ G_BEGIN_DECLS typedef struct _IndicateIndicator IndicateIndicator; typedef struct _IndicateIndicatorClass IndicateIndicatorClass; +/** + IndicateInidcator: + + The indicator object represents a single item that is shared over the + indicator bus. This could be something like one IM, one e-mail or + a single system update. It should be accessed only through its + accessors. +*/ struct _IndicateIndicator { GObject parent; }; -- cgit v1.2.3 From f62b8365144946f97e7c6450dcc36c09d746ff31 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 11:51:46 -0500 Subject: Dispaly typo --- libindicate/indicator.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index 87b11a7..b691357 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -76,7 +76,7 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) gobj->finalize = indicate_indicator_finalize; - /** IndicateIndicator::dispaly: + /** IndicateIndicator::display: Emitted when the user has clicked on this indicator. In the messaging indicator this would be when someone clicks on the -- cgit v1.2.3 From 73a5c9243d9189a3e3285466f59932a02caabd26 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 12:04:20 -0500 Subject: Ignoring the dbus and glib-marshaller generated header files. --- docs/reference/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 759465e..2589179 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -47,7 +47,7 @@ CFILE_GLOB=$(top_srcdir)/libindicate/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES= +IGNORE_HFILES=dbus-indicate-client.h dbus-indicate-server.h dbus-listener-client.h dbus-listener-server.h listener-marshal.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -- cgit v1.2.3 From a41eab6f1d9d1316ba5080cb6e8d41cf1f059c4b Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 12:08:32 -0500 Subject: Removing symbols that shouldn't be in the docs anyway. --- docs/reference/libindicate-sections.txt | 64 ----- docs/reference/tmpl/libindicate-unused.sgml | 372 ++++++++++++++++++++++++++++ 2 files changed, 372 insertions(+), 64 deletions(-) diff --git a/docs/reference/libindicate-sections.txt b/docs/reference/libindicate-sections.txt index f5f3290..86f6d34 100644 --- a/docs/reference/libindicate-sections.txt +++ b/docs/reference/libindicate-sections.txt @@ -49,31 +49,6 @@ IndicateListenerIndicator IndicateListenerServer IndicateServer IndicateServerClass -dbus_g_proxy_begin_call -dbus_glib_marshal_indicate_server_BOOLEAN__POINTER_POINTER -dbus_glib_marshal_indicate_server_BOOLEAN__STRING_POINTER_POINTER -dbus_glib_marshal_indicate_server_BOOLEAN__UINT_BOXED_POINTER_POINTER -dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER -dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER_POINTER -dbus_glib_marshal_indicate_server_BOOLEAN__UINT_STRING_POINTER_POINTER -g_marshal_value_peek_boolean -g_marshal_value_peek_boxed -g_marshal_value_peek_char -g_marshal_value_peek_double -g_marshal_value_peek_enum -g_marshal_value_peek_flags -g_marshal_value_peek_float -g_marshal_value_peek_int -g_marshal_value_peek_int64 -g_marshal_value_peek_long -g_marshal_value_peek_object -g_marshal_value_peek_param -g_marshal_value_peek_pointer -g_marshal_value_peek_string -g_marshal_value_peek_uchar -g_marshal_value_peek_uint -g_marshal_value_peek_uint64 -g_marshal_value_peek_ulong indicate_indicator_get_id indicate_indicator_get_indicator_type indicate_indicator_get_property @@ -91,22 +66,11 @@ indicate_listener_display indicate_listener_get_property indicate_listener_get_property_cb indicate_listener_get_type -indicate_listener_marshal_VOID__POINTER_POINTER_STRING -indicate_listener_marshal_VOID__POINTER_POINTER_STRING_STRING -indicate_listener_marshal_VOID__UINT_STRING indicate_listener_new indicate_server_add_indicator indicate_server_emit_indicator_added indicate_server_emit_indicator_modified indicate_server_emit_indicator_removed -indicate_server_get_desktop -indicate_server_get_indicator_count -indicate_server_get_indicator_count_by_type -indicate_server_get_indicator_list -indicate_server_get_indicator_list_by_type -indicate_server_get_indicator_properties -indicate_server_get_indicator_property -indicate_server_get_indicator_property_group indicate_server_get_next_id indicate_server_get_type indicate_server_hide @@ -117,33 +81,5 @@ indicate_server_set_dbus_object indicate_server_set_default indicate_server_set_desktop_file indicate_server_show -indicate_server_show_indicator_to_user -org_freedesktop_indicator_get_desktop -org_freedesktop_indicator_get_desktop_async -org_freedesktop_indicator_get_desktop_reply -org_freedesktop_indicator_get_indicator_count -org_freedesktop_indicator_get_indicator_count_async -org_freedesktop_indicator_get_indicator_count_by_type -org_freedesktop_indicator_get_indicator_count_by_type_async -org_freedesktop_indicator_get_indicator_count_by_type_reply -org_freedesktop_indicator_get_indicator_count_reply -org_freedesktop_indicator_get_indicator_list -org_freedesktop_indicator_get_indicator_list_async -org_freedesktop_indicator_get_indicator_list_by_type -org_freedesktop_indicator_get_indicator_list_by_type_async -org_freedesktop_indicator_get_indicator_list_by_type_reply -org_freedesktop_indicator_get_indicator_list_reply -org_freedesktop_indicator_get_indicator_properties -org_freedesktop_indicator_get_indicator_properties_async -org_freedesktop_indicator_get_indicator_properties_reply -org_freedesktop_indicator_get_indicator_property -org_freedesktop_indicator_get_indicator_property_async -org_freedesktop_indicator_get_indicator_property_group -org_freedesktop_indicator_get_indicator_property_group_async -org_freedesktop_indicator_get_indicator_property_group_reply -org_freedesktop_indicator_get_indicator_property_reply -org_freedesktop_indicator_show_indicator_to_user -org_freedesktop_indicator_show_indicator_to_user_async -org_freedesktop_indicator_show_indicator_to_user_reply diff --git a/docs/reference/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml index d4e3767..4727625 100644 --- a/docs/reference/tmpl/libindicate-unused.sgml +++ b/docs/reference/tmpl/libindicate-unused.sgml @@ -1,3 +1,11 @@ + + + + + +@Param1: +@Returns: + @@ -70,6 +78,132 @@ @invocation_hint: @marshal_data: + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + + + + + + +@v: + @@ -193,3 +327,241 @@ @error: @Returns: + + + + + +@proxy: +@OUT_indicator_count: +@Returns: + + + + + + +@proxy: +@callback: +@Returns: + + + + + + +@proxy: +@IN_type: +@OUT_indicator_count: +@Returns: + + + + + + +@proxy: +@IN_type: +@callback: +@Returns: + + + + + + +@proxy: +@OUT_indicator_count: +@error: +@userdata: + + + + + + +@proxy: +@OUT_indicator_count: +@error: +@userdata: + + + + + + +@proxy: +@OUT_indicators: +@Returns: + + + + + + +@proxy: +@callback: +@Returns: + + + + + + +@proxy: +@IN_type: +@OUT_indicators: +@Returns: + + + + + + +@proxy: +@IN_type: +@callback: +@Returns: + + + + + + +@proxy: +@OUT_indicators: +@error: +@userdata: + + + + + + +@proxy: +@OUT_indicators: +@error: +@userdata: + + + + + + +@proxy: +@IN_id: +@OUT_properties: +@Returns: + + + + + + +@proxy: +@IN_id: +@callback: +@Returns: + + + + + + +@proxy: +@OUT_properties: +@error: +@userdata: + + + + + + +@proxy: +@IN_id: +@IN_property: +@OUT_value: +@Returns: + + + + + + +@proxy: +@IN_id: +@IN_property: +@callback: +@Returns: + + + + + + +@proxy: +@IN_id: +@IN_properties: +@OUT_values: +@Returns: + + + + + + +@proxy: +@IN_id: +@IN_properties: +@callback: +@Returns: + + + + + + +@proxy: +@OUT_values: +@error: +@userdata: + + + + + + +@proxy: +@OUT_value: +@error: +@userdata: + + + + + + +@proxy: +@IN_id: +@Returns: + + + + + + +@proxy: +@IN_id: +@callback: +@Returns: + + + + + + +@proxy: +@error: +@userdata: + -- cgit v1.2.3 From 1c91e431be9a8e9bf706485735efccf0a0c54283 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 13:07:29 -0500 Subject: Turns out that gtk-doc can't have the name of the function on the same line as the start of the comment. How stupid. --- libindicate/indicator.c | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index b691357..e40975a 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -76,7 +76,8 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) gobj->finalize = indicate_indicator_finalize; - /** IndicateIndicator::display: + /** + IndicateIndicator::display: Emitted when the user has clicked on this indicator. In the messaging indicator this would be when someone clicks on the @@ -89,7 +90,8 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); - /** IndicateIndicator::hide: + /** + IndicateIndicator::hide: Emitted every time this indicator is hidden. This is mostly used by #IndicateServer. @@ -101,7 +103,8 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); - /** IndicateIndicator::hide: + /** + IndicateIndicator::hide: Emitted every time this indicator is shown. This is mostly used by #IndicateServer. @@ -113,7 +116,8 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); - /** IndicateIndicator::modified: + /** + IndicateIndicator::modified: Emitted every time an indicator property is changed. This is mostly used by #IndicateServer. @@ -166,9 +170,12 @@ indicate_indicator_finalize (GObject * obj) return; } -/** indicate_indicator_new: +/** + indicate_indicator_new: Builds a new indicator object using #g_object_new. + + Return value: A pointer to a new #IndicateIndicator object. */ IndicateIndicator * indicate_indicator_new (void) @@ -177,7 +184,8 @@ indicate_indicator_new (void) return indicator; } -/** indicate_indicator_show: +/** + indicate_indicator_show: @indicator: a #IndicateIndicator to act on Shows this indicator on the bus. If the #IndicateServer that it's @@ -203,7 +211,8 @@ indicate_indicator_show (IndicateIndicator * indicator) return; } -/** indicate_indicator_hide: +/** + indicate_indicator_hide: @indicator: a #IndicateIndicator to act on Hides the indicator from the bus. Does not effect the @@ -224,7 +233,8 @@ indicate_indicator_hide (IndicateIndicator * indicator) return; } -/** indicate_indicator_is_visible: +/** + indicate_indicator_is_visible: @indicator: a #IndicateIndicator to act on Checkes the visibility status of @indicator. @@ -239,7 +249,8 @@ indicate_indicator_is_visible (IndicateIndicator * indicator) return priv->is_visible; } -/** indicate_indicator_get_id: +/** + indicate_indicator_get_id: @indicator: a #IndicateIndicator to act on Gets the ID value of the @indicator. @@ -255,7 +266,8 @@ indicate_indicator_get_id (IndicateIndicator * indicator) return priv->id; } -/** indicate_indicator_get_indicator_type: +/** + indicate_indicator_get_indicator_type: @indicator: a #IndicateIndicator to act on Returns the type of @indicator. This is largely set by the subclass @@ -276,7 +288,8 @@ indicate_indicator_get_indicator_type (IndicateIndicator * indicator) return NULL; } -/** indicate_indicator_user_display: +/** + indicate_indicator_user_display: @indicator: a #IndicateIndicator to act on Emits the #IndicateIndicator::user-display signal simliar to a user @@ -295,7 +308,8 @@ indicate_indicator_user_display (IndicateIndicator * indicator) return; } -/** indicate_indicator_set_property: +/** + indicate_indicator_set_property: @indicator: a #IndicateIndicator to act on @key: name of the property @data: value of the property @@ -317,7 +331,8 @@ indicate_indicator_set_property (IndicateIndicator * indicator, const gchar * ke return class->set_property(indicator, key, data); } -/** indicate_indicator_set_property_icon: +/** + indicate_indicator_set_property_icon: @indicator: a #IndicateIndicator to act on @key: name of the property @data: icon to set property with @@ -360,7 +375,8 @@ indicate_indicator_set_property_icon (IndicateIndicator * indicator, const gchar return; } -/** indicate_indicator_set_property_time: +/** + indicate_indicator_set_property_time: @indicator: a #IndicateIndicator to act on @key: name of the property @data: time to set property with -- cgit v1.2.3 From 43f575ee79e3f0bd6f69a6ce835d5298053073fb Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 14:06:45 -0500 Subject: Getting most of the indicator documentation in the pool. --- libindicate/indicator.c | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index e40975a..c867a9a 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -170,6 +170,14 @@ indicate_indicator_finalize (GObject * obj) return; } +/** + indicate_indicator_get_type: + + Gets a unique #GType for the #IndicateIndicator objects. + + Return value: A unique #GType value. +*/ + /** indicate_indicator_new: @@ -397,6 +405,16 @@ indicate_indicator_set_property_time (IndicateIndicator * indicator, const gchar return; } +/** + indicate_indicator_get_property: + @indicator: a #IndicateIndicator to act on + @key: name of the property + + Returns the value that is set for a property or %NULL if that + property is not set. + + Return value: A constant string or NULL. +*/ const gchar * indicate_indicator_get_property (IndicateIndicator * indicator, const gchar * key) { @@ -408,6 +426,17 @@ indicate_indicator_get_property (IndicateIndicator * indicator, const gchar * ke return class->get_property(indicator, key); } +/** + indicate_indicator_list_properties: + @indicator: a #IndicateIndicator to act on + + This function gets a list of all the properties that exist + on a @indicator. The array may have zero entries but almost + always at least has 'type' in it. + + Return value: An array of strings that is the keys of all + the properties on this indicator. +*/ GPtrArray * indicate_indicator_list_properties (IndicateIndicator * indicator) { -- cgit v1.2.3 From 47c4b8e7c3f328da2ec23ddec762c47b329a44da Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 14:10:33 -0500 Subject: Typo --- libindicate/indicator.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 4536cf5..138a48c 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -57,7 +57,7 @@ typedef struct _IndicateIndicator IndicateIndicator; typedef struct _IndicateIndicatorClass IndicateIndicatorClass; /** - IndicateInidcator: + IndicateIndicator: The indicator object represents a single item that is shared over the indicator bus. This could be something like one IM, one e-mail or -- cgit v1.2.3 From dd49cd3da4456be72f5aae8ba0900c80b637409c Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 14:10:41 -0500 Subject: What is the server --- libindicate/server.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/libindicate/server.h b/libindicate/server.h index cfb4334..0c5a83c 100644 --- a/libindicate/server.h +++ b/libindicate/server.h @@ -57,6 +57,16 @@ G_BEGIN_DECLS #define INDICATE_SERVER_SIGNAL_INTEREST_ADDED "interest-added" #define INDICATE_SERVER_SIGNAL_INTEREST_REMOVED "interest-removed" +/** + IndicateServer: + + This is the object that represents the overall connection + between this application and DBus. It acts as the proxy for + incomming DBus calls and also sends the appropriate signals + on DBus for events happening on other objects locally. It + provides some settings that effection how the application as + a whole is perceived by listeners of the indicator protocol. +*/ typedef struct _IndicateServer IndicateServer; struct _IndicateServer { GObject parent; -- cgit v1.2.3 From 877ac7aac626a3c8ce4bdd601eff9fb92fe64911 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 14:29:40 -0500 Subject: Adding in IndicateIndicatorClass documentation. --- libindicate/indicator.h | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 138a48c..dc057f4 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -68,6 +68,37 @@ struct _IndicateIndicator { GObject parent; }; +/** + IndicateIndicatorClass: + + All of the functions that are used to modify or change data that is + in the indicator. Typically gets subclassed by other types of + indicators, for example #IndicateIndicatorMessages. + + @hide: #IndicateIndicator::hide + + @show: #IndicateIndicator::show + + @user_display: #IndicateIndicator::user-display + + @modified: #IndicateIndicator::modified + + @get_type: Returns a constant string for the type of this indicator. + Typically gets overridden by subclasses and defines the type of + the indicator. + + @set_property: Called when #indicate_indicator_set_property is called + and should set the value. While typically it is overridden by + subclasses they usually handle special properties themselves and + then call the superclass for storage. + + @get_property: Called when #indicate_indicator_get_property is called + and should return the value requested. Many times this is left alone. + + @list_properties: Called when #indicate_indicator_list_properties is called + and returns a list of the properties available. Again this can be + overridden by subclasses to handle special properties. +*/ struct _IndicateIndicatorClass { GObjectClass parent_class; -- cgit v1.2.3 From 9201eb6ce3b2770038f0c71e89aadb3c55af6157 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 14:35:30 -0500 Subject: Making it more like English and less like a pointer table. --- libindicate/indicator.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libindicate/indicator.h b/libindicate/indicator.h index dc057f4..61cc1d2 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -75,13 +75,13 @@ struct _IndicateIndicator { in the indicator. Typically gets subclassed by other types of indicators, for example #IndicateIndicatorMessages. - @hide: #IndicateIndicator::hide + @hide: Slot for #IndicateIndicator::hide. - @show: #IndicateIndicator::show + @show: Slot for #IndicateIndicator::show. - @user_display: #IndicateIndicator::user-display + @user_display: Slot for #IndicateIndicator::user-display. - @modified: #IndicateIndicator::modified + @modified: Slot for #IndicateIndicator::modified. @get_type: Returns a constant string for the type of this indicator. Typically gets overridden by subclasses and defines the type of -- cgit v1.2.3 From d73f65f28afe4fc11cec345e4baadf4d934c656d Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 15:12:37 -0500 Subject: Reformatting to make gtk-doc happy. --- libindicate/indicator.h | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 61cc1d2..77ffb7d 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -70,34 +70,28 @@ struct _IndicateIndicator { /** IndicateIndicatorClass: - - All of the functions that are used to modify or change data that is - in the indicator. Typically gets subclassed by other types of - indicators, for example #IndicateIndicatorMessages. - + @parent_class: Parent class #GObjectClass. @hide: Slot for #IndicateIndicator::hide. - @show: Slot for #IndicateIndicator::show. - @user_display: Slot for #IndicateIndicator::user-display. - @modified: Slot for #IndicateIndicator::modified. - @get_type: Returns a constant string for the type of this indicator. Typically gets overridden by subclasses and defines the type of - the indicator. - - @set_property: Called when #indicate_indicator_set_property is called + the indicator. Is called by indicate_indicator_get_indicator_type(). + @set_property: Called when indicate_indicator_set_property() is called and should set the value. While typically it is overridden by subclasses they usually handle special properties themselves and then call the superclass for storage. - - @get_property: Called when #indicate_indicator_get_property is called + @get_property: Called when indicate_indicator_get_property() is called and should return the value requested. Many times this is left alone. - - @list_properties: Called when #indicate_indicator_list_properties is called + @list_properties: Called when indicate_indicator_list_properties() is called and returns a list of the properties available. Again this can be overridden by subclasses to handle special properties. + + All of the functions that are used to modify or change data that is + in the indicator. Typically gets subclassed by other types of + indicators, for example #IndicateIndicatorMessages. + */ struct _IndicateIndicatorClass { GObjectClass parent_class; -- cgit v1.2.3 From 6a4918e6e72f20209a1fbb595a2d900810be984f Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 15:16:06 -0500 Subject: Removing the big defines that aren't useful and the boilerplate get_type functions. --- docs/reference/libindicate-sections.txt | 39 --------------------------------- 1 file changed, 39 deletions(-) diff --git a/docs/reference/libindicate-sections.txt b/docs/reference/libindicate-sections.txt index 86f6d34..c647758 100644 --- a/docs/reference/libindicate-sections.txt +++ b/docs/reference/libindicate-sections.txt @@ -4,41 +4,6 @@ indicator Everything -INDICATE_INDICATOR -INDICATE_INDICATOR_CLASS -INDICATE_INDICATOR_GET_CLASS -INDICATE_INDICATOR_MESSAGE -INDICATE_INDICATOR_MESSAGE_CLASS -INDICATE_INDICATOR_MESSAGE_GET_CLASS -INDICATE_INDICATOR_SIGNAL_DISPLAY -INDICATE_INDICATOR_SIGNAL_HIDE -INDICATE_INDICATOR_SIGNAL_MODIFIED -INDICATE_INDICATOR_SIGNAL_SHOW -INDICATE_IS_INDICATOR -INDICATE_IS_INDICATOR_CLASS -INDICATE_IS_INDICATOR_MESSAGE -INDICATE_IS_INDICATOR_MESSAGE_CLASS -INDICATE_IS_LISTENER -INDICATE_IS_LISTENER_CLASS -INDICATE_IS_SERVER -INDICATE_IS_SERVER_CLASS -INDICATE_LISTENER -INDICATE_LISTENER_CLASS -INDICATE_LISTENER_GET_CLASS -INDICATE_LISTENER_INDICATOR_ID -INDICATE_LISTENER_SERVER_DBUS_NAME -INDICATE_LISTENER_SIGNAL_INDICATOR_ADDED -INDICATE_LISTENER_SIGNAL_INDICATOR_MODIFIED -INDICATE_LISTENER_SIGNAL_INDICATOR_REMOVED -INDICATE_LISTENER_SIGNAL_SERVER_ADDED -INDICATE_LISTENER_SIGNAL_SERVER_REMOVED -INDICATE_SERVER -INDICATE_SERVER_CLASS -INDICATE_SERVER_GET_CLASS -INDICATE_TYPE_INDICATOR -INDICATE_TYPE_INDICATOR_MESSAGE -INDICATE_TYPE_LISTENER -INDICATE_TYPE_SERVER IndicateIndicator IndicateIndicatorClass IndicateIndicatorMessage @@ -52,11 +17,9 @@ IndicateServerClass indicate_indicator_get_id indicate_indicator_get_indicator_type indicate_indicator_get_property -indicate_indicator_get_type indicate_indicator_hide indicate_indicator_is_visible indicate_indicator_list_properties -indicate_indicator_message_get_type indicate_indicator_message_new indicate_indicator_new indicate_indicator_set_property @@ -65,14 +28,12 @@ indicate_indicator_user_display indicate_listener_display indicate_listener_get_property indicate_listener_get_property_cb -indicate_listener_get_type indicate_listener_new indicate_server_add_indicator indicate_server_emit_indicator_added indicate_server_emit_indicator_modified indicate_server_emit_indicator_removed indicate_server_get_next_id -indicate_server_get_type indicate_server_hide indicate_server_new indicate_server_ref_default -- cgit v1.2.3 From cd973f18b40532e9a1ec16f2c7db5b24afc2c40d Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 15:16:47 -0500 Subject: Adding to the unused side of things. --- docs/reference/tmpl/libindicate-unused.sgml | 260 ++++++++++++++++++++++++++++ 1 file changed, 260 insertions(+) diff --git a/docs/reference/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml index 4727625..1f8a20d 100644 --- a/docs/reference/tmpl/libindicate-unused.sgml +++ b/docs/reference/tmpl/libindicate-unused.sgml @@ -1,3 +1,235 @@ + + + + + +@object: + + + + + + +@klass: + + + + + + +@object: + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@object: + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@object: + + + + + + +@klass: + + + + + + +@object: + + + + + + +@klass: + + + + + + +@object: + + + + + + +@klass: + + + + + + +@object: + + + + + + +@indicator: + + + + + + +@server: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@object: + + + + + + +@klass: + + + + + + +@object: + + + + + + + + + + + + + + + + + + + + + + + + + @@ -204,6 +436,27 @@ @v: + + + + + +@Returns: + + + + + + +@Returns: + + + + + + +@Returns: + @@ -317,6 +570,13 @@ @error: @Returns: + + + + + +@Returns: + -- cgit v1.2.3 From a77a8085c8993dfb3e27952e77c245d6bca86128 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 15:40:06 -0500 Subject: Section information --- libindicate/indicator.h | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/libindicate/indicator.h b/libindicate/indicator.h index 77ffb7d..3e2a803 100644 --- a/libindicate/indicator.h +++ b/libindicate/indicator.h @@ -133,6 +133,37 @@ void indicate_indicator_set_property_time (IndicateIndicator * indicator, const const gchar * indicate_indicator_get_property (IndicateIndicator * indicator, const gchar * key); GPtrArray * indicate_indicator_list_properties (IndicateIndicator * indicator); +/** + SECTION:indicator + @short_description: A representation of state for applications + @stability: Unstable + @include: libindicate/indicator.h + + An indicator is designed to represent a single instance of something + in your application. So this might be an IM or Email using #IndicateIndicatorMessage + or any other thing that is a small unit of information to pass on + to the user. + + Indicators make no promises about how they are preceived by the + user, it's up to the listener to represent them in an intutive and + visually appealling way. But, what we can do is provide information + on the indicator to provide enough information for the listener + to do that. + + Mostly this is done through properties. The only property that is + defined for the base indicator is the 'type' property. And this + is only available to set by creating a subclass of the + #IndicateIndicator object. It is assumed that you can look at the + definitions of the various subtypes to determine which properties + they support. + + It may be that some users don't want to create objects for every + indicator as it could be a lot of overhead if there are large numbers + and there is already a data structure representing them all. In that + case it is recommended that you ignore the #IndicateIndicator object + tree in general and move to subclassing #IndicateServer directly. +*/ + G_END_DECLS #endif /* INDICATE_INDICATOR_H_INCLUDED__ */ -- cgit v1.2.3 From 0b5e0c1c39778f0c489497d4617b1ecbeaa963d9 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 15:50:27 -0500 Subject: Breaking out into sections. --- docs/reference/libindicate-sections.txt | 44 ++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/docs/reference/libindicate-sections.txt b/docs/reference/libindicate-sections.txt index c647758..161a95f 100644 --- a/docs/reference/libindicate-sections.txt +++ b/docs/reference/libindicate-sections.txt @@ -2,33 +2,34 @@
indicator -Everything - +IndicateIndicator IndicateIndicator IndicateIndicatorClass -IndicateIndicatorMessage -IndicateIndicatorMessageClass -IndicateListener -IndicateListenerClass -IndicateListenerIndicator -IndicateListenerServer -IndicateServer -IndicateServerClass indicate_indicator_get_id indicate_indicator_get_indicator_type indicate_indicator_get_property indicate_indicator_hide indicate_indicator_is_visible indicate_indicator_list_properties -indicate_indicator_message_new indicate_indicator_new indicate_indicator_set_property indicate_indicator_show indicate_indicator_user_display -indicate_listener_display -indicate_listener_get_property -indicate_listener_get_property_cb -indicate_listener_new +
+ +
+indicator-message +IndicateIndicatorMessage +IndicateIndicatorMessage +IndicateIndicatorMessageClass +indicate_indicator_message_new +
+ +
+server +IndicateServer +IndicateServer +IndicateServerClass indicate_server_add_indicator indicate_server_emit_indicator_added indicate_server_emit_indicator_modified @@ -42,5 +43,18 @@ indicate_server_set_dbus_object indicate_server_set_default indicate_server_set_desktop_file indicate_server_show +
+
+listener +IndicateListener +IndicateListener +IndicateListenerClass +IndicateListenerIndicator +IndicateListenerServer +indicate_listener_display +indicate_listener_get_property +indicate_listener_get_property_cb +indicate_listener_new
+ -- cgit v1.2.3 From ef5a4ba64eba307f196a9be629ffc62fb2fb5983 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 16:03:42 -0500 Subject: Doing a better job about defining out the documentation gets created and looks. Much cleaner. --- docs/reference/libindicate-docs.sgml | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/docs/reference/libindicate-docs.sgml b/docs/reference/libindicate-docs.sgml index 0f1ccd1..c3038d3 100644 --- a/docs/reference/libindicate-docs.sgml +++ b/docs/reference/libindicate-docs.sgml @@ -1,24 +1,32 @@ - + + libindicate Reference Manual - - for libindicate [VERSION] - The latest version of this documentation can be found on-line at - http://[SERVER]/libindicate/. - - - [Insert title here] - + + Base Classes for Applications + + + + + + Subclasses for specific indicators + + - - libindicate Indicator - - + + Classes for Listeners + + + + + Index of all Symbols + + -- cgit v1.2.3 From 298abb13418fe50b5c2c5e66fcad5c21c4732d41 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 16:04:09 -0500 Subject: Never understand this file --- docs/reference/tmpl/libindicate-unused.sgml | 827 ---------------------------- 1 file changed, 827 deletions(-) diff --git a/docs/reference/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml index 1f8a20d..e69de29 100644 --- a/docs/reference/tmpl/libindicate-unused.sgml +++ b/docs/reference/tmpl/libindicate-unused.sgml @@ -1,827 +0,0 @@ - - - - - -@object: - - - - - - -@klass: - - - - - - -@object: - - - - - - -@obj: - - - - - - -@klass: - - - - - - -@obj: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@object: - - - - - - -@klass: - - - - - - -@obj: - - - - - - -@klass: - - - - - - -@object: - - - - - - -@klass: - - - - - - -@object: - - - - - - -@klass: - - - - - - -@object: - - - - - - -@klass: - - - - - - -@object: - - - - - - -@indicator: - - - - - - -@server: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@object: - - - - - - -@klass: - - - - - - -@object: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Param1: -@Returns: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@v: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@server: -@count: -@error: -@Returns: - - - - - - -@server: -@type: -@count: -@error: -@Returns: - - - - - - -@server: -@indicators: -@error: -@Returns: - - - - - - -@server: -@type: -@indicators: -@error: -@Returns: - - - - - - -@server: -@id: -@properties: -@error: -@Returns: - - - - - - -@server: -@id: -@property: -@value: -@error: -@Returns: - - - - - - -@server: -@id: -@properties: -@value: -@error: -@Returns: - - - - - - -@Returns: - - - - - - -@server: -@id: -@error: -@Returns: - - - - - - -@proxy: -@OUT_indicator_count: -@Returns: - - - - - - -@proxy: -@callback: -@Returns: - - - - - - -@proxy: -@IN_type: -@OUT_indicator_count: -@Returns: - - - - - - -@proxy: -@IN_type: -@callback: -@Returns: - - - - - - -@proxy: -@OUT_indicator_count: -@error: -@userdata: - - - - - - -@proxy: -@OUT_indicator_count: -@error: -@userdata: - - - - - - -@proxy: -@OUT_indicators: -@Returns: - - - - - - -@proxy: -@callback: -@Returns: - - - - - - -@proxy: -@IN_type: -@OUT_indicators: -@Returns: - - - - - - -@proxy: -@IN_type: -@callback: -@Returns: - - - - - - -@proxy: -@OUT_indicators: -@error: -@userdata: - - - - - - -@proxy: -@OUT_indicators: -@error: -@userdata: - - - - - - -@proxy: -@IN_id: -@OUT_properties: -@Returns: - - - - - - -@proxy: -@IN_id: -@callback: -@Returns: - - - - - - -@proxy: -@OUT_properties: -@error: -@userdata: - - - - - - -@proxy: -@IN_id: -@IN_property: -@OUT_value: -@Returns: - - - - - - -@proxy: -@IN_id: -@IN_property: -@callback: -@Returns: - - - - - - -@proxy: -@IN_id: -@IN_properties: -@OUT_values: -@Returns: - - - - - - -@proxy: -@IN_id: -@IN_properties: -@callback: -@Returns: - - - - - - -@proxy: -@OUT_values: -@error: -@userdata: - - - - - - -@proxy: -@OUT_value: -@error: -@userdata: - - - - - - -@proxy: -@IN_id: -@Returns: - - - - - - -@proxy: -@IN_id: -@callback: -@Returns: - - - - - - -@proxy: -@error: -@userdata: - -- cgit v1.2.3 From 933bcaaa5942e9990e07da32bcde392d0e9a7883 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 16:57:51 -0500 Subject: Adding in message documentation and cleaning up some mistakes as I see them. --- libindicate/indicator-message.c | 7 +++++++ libindicate/indicator-message.h | 38 ++++++++++++++++++++++++++++++++------ libindicate/indicator.c | 2 +- 3 files changed, 40 insertions(+), 7 deletions(-) diff --git a/libindicate/indicator-message.c b/libindicate/indicator-message.c index 4e8ef30..9cd735a 100644 --- a/libindicate/indicator-message.c +++ b/libindicate/indicator-message.c @@ -85,6 +85,13 @@ indicate_indicator_message_finalize (GObject *object) G_OBJECT_CLASS (indicate_indicator_message_parent_class)->finalize (object); } +/** + indicate_indicator_message_new: + + Builds a new indicator message object using #g_object_new. + + Return value: A pointer to a new #IndicateIndicatorMessage object. +*/ static const gchar * get_indicator_type (IndicateIndicator * indicator) { diff --git a/libindicate/indicator-message.h b/libindicate/indicator-message.h index 0910477..62a41b7 100644 --- a/libindicate/indicator-message.h +++ b/libindicate/indicator-message.h @@ -47,19 +47,45 @@ G_BEGIN_DECLS typedef struct _IndicateIndicatorMessage IndicateIndicatorMessage; typedef struct _IndicateIndicatorMessageClass IndicateIndicatorMessageClass; -struct _IndicateIndicatorMessageClass -{ -IndicateIndicatorClass parent_class; +/** + IndicateIndicatorMessageClass: + + Subclass of #IndicateIndicator with no new functions or signals. +*/ +struct _IndicateIndicatorMessageClass { + IndicateIndicatorClass parent_class; }; -struct _IndicateIndicatorMessage -{ -IndicateIndicator parent; +/** + IndicateIndicatorMessage: + + A class to represent indicators who's 'type' is "message". These + are basically indicators that represent messages from humans to + humans via computers. Things like instance messages, micro blogging + entries or e-mails. All of these qualify as messages. + + TODO: This should include a list of properties that are supported. +*/ +struct _IndicateIndicatorMessage { + IndicateIndicator parent; }; GType indicate_indicator_message_get_type (void); IndicateIndicatorMessage * indicate_indicator_message_new (void); +/** + SECTION:indicator-message + @short_description: A representation of human generated messages + @stability: Unstable + @include: libindicate/indicator-message.h + + The message indicators represent messages that come from humans + to humans using computers. They come in all different forms with + various different interaction protocols, but they all want the human + at the computer to interact back with the human that sent the + message. +*/ + G_END_DECLS #endif diff --git a/libindicate/indicator.c b/libindicate/indicator.c index c867a9a..15788d4 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -181,7 +181,7 @@ indicate_indicator_finalize (GObject * obj) /** indicate_indicator_new: - Builds a new indicator object using #g_object_new. + Builds a new indicator object using g_object_new(). Return value: A pointer to a new #IndicateIndicator object. */ -- cgit v1.2.3 From a1ba880a312728fa4973c2d498ea574426a291f9 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:17:52 -0500 Subject: Comments for the class, who put all those functions on there... --- libindicate/server.h | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/libindicate/server.h b/libindicate/server.h index 0c5a83c..c327a13 100644 --- a/libindicate/server.h +++ b/libindicate/server.h @@ -72,6 +72,48 @@ struct _IndicateServer { GObject parent; }; +/** + IndicateServerClass: + @parent: Parent Class + @indicator_added: Slot for #IndicatorServer::indicator-added + @indicator_removed: Slot for #IndicatorServer::indicator-removed + @indicator_modified: Slot for #IndicatorServer::indicator-modified + @server_show: Slot for #IndicatorServer::server-show + @server_hide: Slot for #IndicatorServer::server-hide + @server_display: Slot for #IndicatorServer::server-display + @interest_added: Slot for #IndicatorServer::interest-added + @interest_removed: Slot for #IndicatorServer::interest-removed + @get_indicator_count: Returns the number of indicators that are visible + on the bus. Hidden indicators should not be counted. + @get_indciator_count_by_type: Returns the number of indicators that are + of a given type and visible on the bus. + @get_indicator_list: List all of the indicators that are visible. + @get_indicator_list_by_type: List all of the indicators of a given + type that are visible. + @get_indicator_property: Get a property from a particular indicator. + @get_indicator_property_group: Get the values for a set of properties + as an array of entries, returning an array as well. + @get_indicator_properties: Get a list of all the properties that are + on a particular indicator. + @show_indicator_to_user: Respond to someone on the bus asking to show + a particular indicator to the user. + @get_next_id: Get the next unused indicator ID. + @show_interest: React to someone signifying that they are interested + in this server. + @remove_interest: Someone on the bus is no longer interest in this + server, remove it's interest. + @check_interest: Check to see if anyone on the bus is interested in this + server for a particular feature. + @indicate_server_reserved1: Reserved for future use + @indicate_server_reserved2: Reserved for future use + @indicate_server_reserved3: Reserved for future use + @indicate_server_reserved4: Reserved for future use + + All of the functions and signals that make up the server class + including those that are public API to the application and those + that are public API to all of DBus. Subclasses may need to + implement a large portion of these. +*/ typedef struct _IndicateServerClass IndicateServerClass; struct _IndicateServerClass { GObjectClass parent; -- cgit v1.2.3 From f4a1e4626b061bd26d2a0fea8b44ea37d0b56b7a Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:24:53 -0500 Subject: Server section documentation. --- libindicate/server.h | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/libindicate/server.h b/libindicate/server.h index c327a13..f0e1569 100644 --- a/libindicate/server.h +++ b/libindicate/server.h @@ -186,6 +186,35 @@ void indicate_server_emit_indicator_removed (IndicateServer *server, guint id, c void indicate_server_emit_indicator_modified (IndicateServer *server, guint id, const gchar *property); void indicate_server_emit_server_display (IndicateServer *server); +/** + SECTION:server + @short_description: The representation of the application on DBus. + @stability: Unstable + @include: libindicate/server.h + + The server object is the object that provides the functions on + to DBus for other applications to call. It does this by implementing + the DBus indicator spec, but it also allows for subclassing so that + subclasses don't have to worry about the DBus-isms as much as + the functionality that they're trying to express. + + For simple applications there is limited need to set anything + more than the desktop file and the type of the server using + indicate_server_set_desktop_file() and indicate_server_set_type(). + Each of these function sets the respective value and expresses + it in a way that other applications on the bus can read it. + + More advanced applications might find the need to subclass the + #IndicateServer object and make their own. This is likely the + case where applications have complex data stores that they don't + want to turn into a large set of #GObjects that can take up a + significant amount of memory in the program. + + In general, it is recommended that application authors go with + the high memory path first, and then optimize by implementing + their server on a second pass. +*/ + G_END_DECLS #endif /* INDICATE_SERVER_H_INCLUDED__ */ -- cgit v1.2.3 From 15720aae214633691ed4a940dd1b7dcb313ea0ca Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:37:52 -0500 Subject: Basic signals docs. --- libindicate/server.c | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/libindicate/server.c b/libindicate/server.c index d42fe61..e8dad3f 100644 --- a/libindicate/server.c +++ b/libindicate/server.c @@ -163,6 +163,12 @@ indicate_server_class_init (IndicateServerClass * class) gobj->set_property = set_property; gobj->get_property = get_property; + /** + IndicateServer::indicator-added: + + Emitted every time that a new indicator is made visible to + the world. This results in a signal on DBus. + */ signals[INDICATOR_ADDED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_ADDED, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -170,6 +176,12 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__UINT_POINTER, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); + /** + IndicateServer::indicator-removed: + + Emitted every time that a new indicator is made invisible to + the world. This results in a signal on DBus. + */ signals[INDICATOR_REMOVED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_REMOVED, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -177,6 +189,12 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__UINT_POINTER, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); + /** + IndicateServer::indicator-modified: + + Emitted every time that a property on an indicator changes + and it is visible to the world. This results in a signal on DBus. + */ signals[INDICATOR_MODIFIED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_MODIFIED, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -184,6 +202,13 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__UINT_POINTER, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); + /** + IndicateServer::server-show: + + Emitted when a server comes onto DBus by being shown. This + is typically when listeners start reacting to the application's + indicators. This results in a signal on DBus. + */ signals[SERVER_SHOW] = g_signal_new(INDICATE_SERVER_SIGNAL_SERVER_SHOW, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -191,6 +216,12 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_STRING); + /** + IndicateServer::server-hide: + + Emitted when a server removes itself from DBus. This results + in a signal on DBus. + */ signals[SERVER_HIDE] = g_signal_new(INDICATE_SERVER_SIGNAL_SERVER_HIDE, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -198,6 +229,13 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_STRING); + /** + IndicateServer::server-display: + + Emitted when a listener signals that the server itself should be + displayed. This signal is caused by a user clicking on the application + item in the Messaging Menu. This signal is emitted by DBus. + */ signals[SERVER_DISPLAY] = g_signal_new(INDICATE_SERVER_SIGNAL_SERVER_DISPLAY, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -205,6 +243,12 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** + IndicateServer::interest-added: + + Emitted when a listener signals that they are interested in + this server for a particular reason. This signal is emitted by DBus. + */ signals[INTEREST_ADDED] = g_signal_new(INDICATE_SERVER_SIGNAL_INTEREST_ADDED, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, @@ -212,6 +256,12 @@ indicate_server_class_init (IndicateServerClass * class) NULL, NULL, g_cclosure_marshal_VOID__UINT, G_TYPE_NONE, 1, G_TYPE_UINT); + /** + IndicateServer::interest-removed: + + Emitted when a listener signals that they are no longer interested in + this server for a particular reason. This signal is emitted by DBus. + */ signals[INTEREST_REMOVED] = g_signal_new(INDICATE_SERVER_SIGNAL_INTEREST_REMOVED, G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, -- cgit v1.2.3 From dbfd181e1068fdbafd97bf11f5654dc8bc14caa5 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:44:43 -0500 Subject: Woot, signal documentation works now. --- libindicate/server.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/libindicate/server.h b/libindicate/server.h index f0e1569..820e641 100644 --- a/libindicate/server.h +++ b/libindicate/server.h @@ -75,14 +75,14 @@ struct _IndicateServer { /** IndicateServerClass: @parent: Parent Class - @indicator_added: Slot for #IndicatorServer::indicator-added - @indicator_removed: Slot for #IndicatorServer::indicator-removed - @indicator_modified: Slot for #IndicatorServer::indicator-modified - @server_show: Slot for #IndicatorServer::server-show - @server_hide: Slot for #IndicatorServer::server-hide - @server_display: Slot for #IndicatorServer::server-display - @interest_added: Slot for #IndicatorServer::interest-added - @interest_removed: Slot for #IndicatorServer::interest-removed + @indicator_added: Slot for #IndicateServer::indicator-added. + @indicator_removed: Slot for #IndicateServer::indicator-removed. + @indicator_modified: Slot for #IndicateServer::indicator-modified. + @server_show: Slot for #IndicateServer::server-show. + @server_hide: Slot for #IndicateServer::server-hide. + @server_display: Slot for #IndicateServer::server-display. + @interest_added: Slot for #IndicateServer::interest-added. + @interest_removed: Slot for #IndicateServer::interest-removed. @get_indicator_count: Returns the number of indicators that are visible on the bus. Hidden indicators should not be counted. @get_indciator_count_by_type: Returns the number of indicators that are -- cgit v1.2.3 From f64bd73788470bb55a2a1060b7fea815d769d0d4 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:53:10 -0500 Subject: Adding in arguments on the signal docs. --- libindicate/server.c | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/libindicate/server.c b/libindicate/server.c index e8dad3f..6cc6f34 100644 --- a/libindicate/server.c +++ b/libindicate/server.c @@ -165,9 +165,14 @@ indicate_server_class_init (IndicateServerClass * class) /** IndicateServer::indicator-added: + @arg0: The #IndicateServer object + @arg1: The #IndicateIndicator ID number + @arg2: The type of the indicator Emitted every time that a new indicator is made visible to the world. This results in a signal on DBus. + + Can be emitted by subclasses using indicate_server_emit_indicator_added() */ signals[INDICATOR_ADDED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_ADDED, G_TYPE_FROM_CLASS (class), @@ -178,9 +183,14 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); /** IndicateServer::indicator-removed: + @arg0: The #IndicateServer object + @arg1: The #IndicateIndicator ID number + @arg2: The type of the indicator Emitted every time that a new indicator is made invisible to the world. This results in a signal on DBus. + + Can be emitted by subclasses using indicate_server_emit_indicator_removed() */ signals[INDICATOR_REMOVED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_REMOVED, G_TYPE_FROM_CLASS (class), @@ -191,9 +201,14 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); /** IndicateServer::indicator-modified: + @arg0: The #IndicateServer object + @arg1: The #IndicateIndicator ID number + @arg2: The name of the property modified Emitted every time that a property on an indicator changes and it is visible to the world. This results in a signal on DBus. + + Can be emitted by subclasses using indicate_server_emit_indicator_modified() */ signals[INDICATOR_MODIFIED] = g_signal_new(INDICATE_SERVER_SIGNAL_INDICATOR_MODIFIED, G_TYPE_FROM_CLASS (class), @@ -204,6 +219,8 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING); /** IndicateServer::server-show: + @arg0: The #IndicateServer object + @arg1: The type of the server Emitted when a server comes onto DBus by being shown. This is typically when listeners start reacting to the application's @@ -218,6 +235,8 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 1, G_TYPE_STRING); /** IndicateServer::server-hide: + @arg0: The #IndicateServer object + @arg1: The type of the server Emitted when a server removes itself from DBus. This results in a signal on DBus. @@ -231,10 +250,13 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 1, G_TYPE_STRING); /** IndicateServer::server-display: + @arg0: The #IndicateServer object Emitted when a listener signals that the server itself should be displayed. This signal is caused by a user clicking on the application item in the Messaging Menu. This signal is emitted by DBus. + + Can be emitted by subclasses using indicate_server_emit_server_display() */ signals[SERVER_DISPLAY] = g_signal_new(INDICATE_SERVER_SIGNAL_SERVER_DISPLAY, G_TYPE_FROM_CLASS (class), @@ -245,6 +267,8 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 0); /** IndicateServer::interest-added: + @arg0: The #IndicateServer object + @arg1: The interest that was added from #IndicateInterests Emitted when a listener signals that they are interested in this server for a particular reason. This signal is emitted by DBus. @@ -258,6 +282,8 @@ indicate_server_class_init (IndicateServerClass * class) G_TYPE_NONE, 1, G_TYPE_UINT); /** IndicateServer::interest-removed: + @arg0: The #IndicateServer object + @arg1: The interest that was removed from #IndicateInterests Emitted when a listener signals that they are no longer interested in this server for a particular reason. This signal is emitted by DBus. -- cgit v1.2.3 From 1595ee29749284d0606f4a5524aeefbc728498e4 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 20:58:42 -0500 Subject: Adding in arguments for the signals --- libindicate/indicator.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index 15788d4..207d975 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -78,6 +78,7 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) /** IndicateIndicator::display: + @arg0: The #IndicateIndicator object Emitted when the user has clicked on this indicator. In the messaging indicator this would be when someone clicks on the @@ -92,9 +93,12 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) G_TYPE_NONE, 0); /** IndicateIndicator::hide: + @arg0: The #IndicateIndicator object Emitted every time this indicator is hidden. This is mostly used by #IndicateServer. + + Typically this results in an emition of #IndicateServer::indicator-removed. */ signals[HIDE] = g_signal_new(INDICATE_INDICATOR_SIGNAL_HIDE, G_TYPE_FROM_CLASS(class), @@ -104,10 +108,13 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); /** - IndicateIndicator::hide: + IndicateIndicator::show: + @arg0: The #IndicateIndicator object Emitted every time this indicator is shown. This is mostly used by #IndicateServer. + + Typically this results in an emition of #IndicateServer::indicator-added. */ signals[SHOW] = g_signal_new(INDICATE_INDICATOR_SIGNAL_SHOW, G_TYPE_FROM_CLASS(class), @@ -118,9 +125,13 @@ indicate_indicator_class_init (IndicateIndicatorClass * class) G_TYPE_NONE, 0); /** IndicateIndicator::modified: + @arg0: The #IndicateIndicator object + @arg1: The name of the property that changed. Emitted every time an indicator property is changed. This is mostly used by #IndicateServer. + + Typically this results in an emition of #IndicateServer::indicator-modified. */ signals[MODIFIED] = g_signal_new(INDICATE_INDICATOR_SIGNAL_MODIFIED, G_TYPE_FROM_CLASS(class), -- cgit v1.2.3 From 51f63e11e0e39400d5be18a303a18989a7d67ea3 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 21:42:39 -0500 Subject: Documenting most of the public visible functions --- libindicate/server.c | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 133 insertions(+), 1 deletion(-) diff --git a/libindicate/server.c b/libindicate/server.c index 6cc6f34..cec9bd2 100644 --- a/libindicate/server.c +++ b/libindicate/server.c @@ -442,7 +442,17 @@ indicate_server_error_quark (void) return quark; } - +/** + indicate_server_show: + @server: The #IndicateServer to be shown + + This function exports the object onto DBus and shows it + to the world. This will be the start of it receiving external + signals from DBus. It is likely that, if there are listeners + running, there will several #IndicateServer::interest-added + signals coming shortly after this function. This function + emits the #IndicateServer::server-added signal across the bus. +*/ void indicate_server_show (IndicateServer * server) { @@ -479,6 +489,16 @@ indicate_server_show (IndicateServer * server) return; } +/** + indicate_server_hide: + @server: The #IndicateServer to hide. + + This function hides the server from DBus so that it does + not get signals anymore. This causes the signal #IndicateServer::server-hide + to be sent across the bus for all listeners. Also internally + it will signal #IndicateServer::interest-removed for all the + interests that were currently set for this server. +*/ void indicate_server_hide (IndicateServer * server) { @@ -686,6 +706,16 @@ indicator_modified_cb (IndicateIndicator * indicator, gchar * property, Indicate g_signal_emit(server, signals[INDICATOR_MODIFIED], 0, indicate_indicator_get_id(indicator), property, TRUE); } +/** + indicate_server_add_indicator: + @server: The #IndicateServer to add the #IndicateIndictor to. + @indicator: The #IndicateIndicator to add. + + This function adds an indicator @indicator to the list that are + watched by the server @server. This means that signals that are + emitted by the indicator will be picked up and passed via DBus onto + listeners of the application. +*/ void indicate_server_add_indicator (IndicateServer * server, IndicateIndicator * indicator) { @@ -709,6 +739,14 @@ indicate_server_add_indicator (IndicateServer * server, IndicateIndicator * indi return; } +/** + indicate_server_remove_indicator: + @server: The #IndicateServer to remove the #IndicateIndictor from. + @indicator: The #IndicateIndicator to remove. + + Removes an indicator @indicator from being watched by the server @server + so it's signals are no longer watched and set over DBus. +*/ void indicate_server_remove_indicator (IndicateServer * server, IndicateIndicator * indicator) { @@ -739,6 +777,15 @@ indicate_server_set_dbus_object (const gchar * obj) return; } +/** + indicate_server_set_desktop_file: + @server: The #IndicateServer to set the type of + @type: The new desktop file representing the server + + This is a convience function to set the #IndicateServer:desktop + property of the @server object. The property can also be set + via traditional means, but this one is easier to read. +*/ void indicate_server_set_desktop_file (IndicateServer * server, const gchar * path) { @@ -749,6 +796,15 @@ indicate_server_set_desktop_file (IndicateServer * server, const gchar * path) return; } +/** + indicate_server_set_type: + @server: The #IndicateServer to set the type of + @type: The new type of the server + + This is a convience function to set the #IndicateServer:type + property of the @server object. The property can also be set + via traditional means, but this one is easier to read. +*/ void indicate_server_set_type (IndicateServer * server, const gchar * type) { @@ -761,6 +817,17 @@ indicate_server_set_type (IndicateServer * server, const gchar * type) static IndicateServer * default_indicate_server = NULL; +/** + indicate_server_ref_default: + + This function will return a reference to the default #IndicateServer + reference if there is one, or it will create one if one had not + previously been created. It is recommended that all applications + use this function to create a #IndicateServer as it ensure that there + is only one per application. + + Return value: A reference to the default #IndicateServer instance. +*/ IndicateServer * indicate_server_ref_default (void) { @@ -775,6 +842,16 @@ indicate_server_ref_default (void) return default_indicate_server; } +/** + indicate_server_set_default: + @server: The #IndicateServer that should be used + + This function is used to set the default #IndicateServer that will + be used when creating #IndicateIndicators or for anyone else that + calls indicate_server_ref_default(). Typically this is just an + instance of #IndicateServer but applications that create a subclass + of #IndicateServer should set this as well. +*/ void indicate_server_set_default (IndicateServer * server) { @@ -1179,6 +1256,15 @@ _indicate_server_show_indicator_to_user (IndicateServer * server, guint id, GErr return TRUE; } +/** + indicate_server_get_next_id: + @server: The #IndicateServer the ID will be on + + Returns the next available unused ID that an indicator + can have. + + Return value: A valid indicator ID. +*/ guint indicate_server_get_next_id (IndicateServer * server) { @@ -1283,6 +1369,17 @@ _indicate_server_remove_interest (IndicateServer * server, gchar * interest, DBu return FALSE; } +/** + indicate_server_check_interest: + @server: The #IndicateServer being checked + @interest: Which interest type we're checking for + + This function looks at all the interest that various listeners + have specified that they have for this server and returns whether + there is a listener that has the interest specified in @interest. + + Return value: %TRUE if a listener as the interest otherwise %FALSE +*/ gboolean indicate_server_check_interest (IndicateServer * server, IndicateInterests interest) { @@ -1297,6 +1394,16 @@ indicate_server_check_interest (IndicateServer * server, IndicateInterests inter } /* Signal emission functions for sub-classes of the server */ + +/** + indicate_server_emit_indicator_added: + @server: The #IndicateServer being represented + @id: The ID of the indicator being added + @type: The type of the indicator + + This function emits the #IndicateServer::indicator-added signal and is + used by subclasses. +*/ void indicate_server_emit_indicator_added (IndicateServer *server, guint id, const gchar *type) { @@ -1306,6 +1413,15 @@ indicate_server_emit_indicator_added (IndicateServer *server, guint id, const gc g_signal_emit(server, signals[INDICATOR_ADDED], 0, id, type); } +/** + indicate_server_emit_indicator_removed: + @server: The #IndicateServer being represented + @id: The ID of the indicator being removed + @type: The type of the indicator + + This function emits the #IndicateServer::indicator-removed signal and is + used by subclasses. +*/ void indicate_server_emit_indicator_removed (IndicateServer *server, guint id, const gchar *type) { @@ -1315,6 +1431,15 @@ indicate_server_emit_indicator_removed (IndicateServer *server, guint id, const g_signal_emit(server, signals[INDICATOR_REMOVED], 0, id, type); } +/** + indicate_server_emit_indicator_modified: + @server: The #IndicateServer being represented + @id: The ID of the indicator with the modified property + @proprerty: The name of the property being modified + + This function emits the #IndicateServer::indicator-modified signal and is + used by subclasses. +*/ void indicate_server_emit_indicator_modified (IndicateServer *server, guint id, const gchar *property) { @@ -1324,6 +1449,13 @@ indicate_server_emit_indicator_modified (IndicateServer *server, guint id, const g_signal_emit(server, signals[INDICATOR_MODIFIED], 0, id, property); } +/** + indicate_server_emit_server_display: + @server: The #IndicateServer being displayed + + This function emits the #IndicateServer::server-display signal and is + used by subclasses. +*/ void indicate_server_emit_server_display (IndicateServer *server) { -- cgit v1.2.3 From 3810da4bb215f815f9528e9fa7145de9c99efbff Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 21:45:19 -0500 Subject: Fixing some documentation bugs. --- libindicate/indicator-message.h | 1 + libindicate/server.c | 4 ++-- libindicate/server.h | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/libindicate/indicator-message.h b/libindicate/indicator-message.h index 62a41b7..76273c6 100644 --- a/libindicate/indicator-message.h +++ b/libindicate/indicator-message.h @@ -49,6 +49,7 @@ typedef struct _IndicateIndicatorMessageClass IndicateIndicatorMessageClass; /** IndicateIndicatorMessageClass: + @parent_class: Parent Class Subclass of #IndicateIndicator with no new functions or signals. */ diff --git a/libindicate/server.c b/libindicate/server.c index cec9bd2..cd8b33a 100644 --- a/libindicate/server.c +++ b/libindicate/server.c @@ -780,7 +780,7 @@ indicate_server_set_dbus_object (const gchar * obj) /** indicate_server_set_desktop_file: @server: The #IndicateServer to set the type of - @type: The new desktop file representing the server + @path: The new desktop file representing the server This is a convience function to set the #IndicateServer:desktop property of the @server object. The property can also be set @@ -1435,7 +1435,7 @@ indicate_server_emit_indicator_removed (IndicateServer *server, guint id, const indicate_server_emit_indicator_modified: @server: The #IndicateServer being represented @id: The ID of the indicator with the modified property - @proprerty: The name of the property being modified + @property: The name of the property being modified This function emits the #IndicateServer::indicator-modified signal and is used by subclasses. diff --git a/libindicate/server.h b/libindicate/server.h index 820e641..2a300e2 100644 --- a/libindicate/server.h +++ b/libindicate/server.h @@ -85,7 +85,7 @@ struct _IndicateServer { @interest_removed: Slot for #IndicateServer::interest-removed. @get_indicator_count: Returns the number of indicators that are visible on the bus. Hidden indicators should not be counted. - @get_indciator_count_by_type: Returns the number of indicators that are + @get_indicator_count_by_type: Returns the number of indicators that are of a given type and visible on the bus. @get_indicator_list: List all of the indicators that are visible. @get_indicator_list_by_type: List all of the indicators of a given -- cgit v1.2.3 From c027c7f3d30bc35937a5b900355bd593e2a12a04 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 22:29:44 -0500 Subject: Fixing typo --- libindicate/indicator.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libindicate/indicator.c b/libindicate/indicator.c index 207d975..76eb616 100644 --- a/libindicate/indicator.c +++ b/libindicate/indicator.c @@ -398,7 +398,7 @@ indicate_indicator_set_property_icon (IndicateIndicator * indicator, const gchar indicate_indicator_set_property_time: @indicator: a #IndicateIndicator to act on @key: name of the property - @data: time to set property with + @time: time to set property with This is a helper function that wraps around #indicate_indicator_set_property but takes an #GTimeVal parameter. It then takes the @data -- cgit v1.2.3 From 395ae9ad6ba2e6ad679b94a74d1665f59c559daa Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 22:30:04 -0500 Subject: Fixing function listing --- docs/reference/libindicate-sections.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/reference/libindicate-sections.txt b/docs/reference/libindicate-sections.txt index 161a95f..6e2a8cd 100644 --- a/docs/reference/libindicate-sections.txt +++ b/docs/reference/libindicate-sections.txt @@ -13,6 +13,8 @@ indicate_indicator_is_visible indicate_indicator_list_properties indicate_indicator_new indicate_indicator_set_property +indicate_indicator_set_property_icon +indicate_indicator_set_property_time indicate_indicator_show indicate_indicator_user_display @@ -31,17 +33,18 @@ indicate_indicator_message_new IndicateServer IndicateServerClass indicate_server_add_indicator +indicate_server_check_interest indicate_server_emit_indicator_added indicate_server_emit_indicator_modified indicate_server_emit_indicator_removed +indicate_server_emit_server_display indicate_server_get_next_id indicate_server_hide -indicate_server_new indicate_server_ref_default indicate_server_remove_indicator -indicate_server_set_dbus_object indicate_server_set_default indicate_server_set_desktop_file +indicate_server_set_type indicate_server_show -- cgit v1.2.3 From 1b3fd9245f98ac5b13c44f4f9e8ca30ef76ac526 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 30 Apr 2009 22:30:15 -0500 Subject: Never understand this file really. --- docs/reference/tmpl/libindicate-unused.sgml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/reference/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml index e69de29..c3152b1 100644 --- a/docs/reference/tmpl/libindicate-unused.sgml +++ b/docs/reference/tmpl/libindicate-unused.sgml @@ -0,0 +1,14 @@ + + + + + +@Returns: + + + + + + +@obj: + -- cgit v1.2.3