aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib/client.h
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2011-01-27 09:35:14 -0600
committerTed Gould <ted@gould.cx>2011-01-27 09:35:14 -0600
commitf0722fc3e8842ec8047d104119117f036da1b99f (patch)
tree87fb39abb9418ff86693207d95e97917c97d8275 /libdbusmenu-glib/client.h
parent49ecfc8c84d543491031aecbe64037e3fd76d366 (diff)
downloadlibdbusmenu-f0722fc3e8842ec8047d104119117f036da1b99f.tar.gz
libdbusmenu-f0722fc3e8842ec8047d104119117f036da1b99f.tar.bz2
libdbusmenu-f0722fc3e8842ec8047d104119117f036da1b99f.zip
Adding documentation for the handler functions.
Diffstat (limited to 'libdbusmenu-glib/client.h')
-rw-r--r--libdbusmenu-glib/client.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/libdbusmenu-glib/client.h b/libdbusmenu-glib/client.h
index f371792..6d78edf 100644
--- a/libdbusmenu-glib/client.h
+++ b/libdbusmenu-glib/client.h
@@ -110,7 +110,28 @@ struct _DbusmenuClient {
DbusmenuClientPrivate * priv;
};
+/**
+ DbusmenuClientTypeHandler:
+ @newitem: The #DbusmenuMenuitem that was created
+ @parent: The parent of @newitem or #NULL if none
+ @client: A pointer to the #DbusmenuClient
+ @user_data: The data you gave us
+
+ The type handler is called when a dbusmenu item is created
+ with a matching type as setup in #dbusmenu_client_add_type_handler
+*/
typedef gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem * newitem, DbusmenuMenuitem * parent, DbusmenuClient * client, gpointer user_data);
+
+/**
+ DbusmenuClientTypeDestroyHandler:
+ @client: A pointer to the #DbusmenuClient
+ @type: The type that this handler was registered with
+ @user_data: The data you gave us
+
+ This handler is called when the type becomes unregistered by the
+ client. This is usally caused by the #DbusmenuClient being destroyed
+ and should free memory or unref objects in @user_data.
+*/
typedef void (*DbusmenuClientTypeDestroyHandler) (DbusmenuClient * client, const gchar * type, gpointer user_data);
GType dbusmenu_client_get_type (void);