aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-gtk
diff options
context:
space:
mode:
authorTed Gould <ted@canonical.com>2009-05-20 12:41:18 +0200
committerTed Gould <ted@canonical.com>2009-05-20 12:41:18 +0200
commitc5a17e6a710ffadb20cdd65a9f42a2a1299424a4 (patch)
tree497d8a6cf2630c6ae95056c61d96e2cbe094dfc3 /libdbusmenu-gtk
parent039c05e5e8961e1eac265a7a073526a2257d6665 (diff)
downloadlibdbusmenu-c5a17e6a710ffadb20cdd65a9f42a2a1299424a4.tar.gz
libdbusmenu-c5a17e6a710ffadb20cdd65a9f42a2a1299424a4.tar.bz2
libdbusmenu-c5a17e6a710ffadb20cdd65a9f42a2a1299424a4.zip
Adding in some section documentation describing the menu item
Diffstat (limited to 'libdbusmenu-gtk')
-rw-r--r--libdbusmenu-gtk/menu.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/libdbusmenu-gtk/menu.h b/libdbusmenu-gtk/menu.h
index 34def17..dd5bdd1 100644
--- a/libdbusmenu-gtk/menu.h
+++ b/libdbusmenu-gtk/menu.h
@@ -44,6 +44,31 @@ struct _DbusmenuGtkMenu {
GType dbusmenu_gtkmenu_get_type (void);
DbusmenuGtkMenu * dbusmenu_gtkmenu_new (gchar * dbus_name, gchar * dbus_object);
+/**
+ SECTION:gtkmenu
+ @short_description: A GTK Menu Object that syncronizes over DBus
+ @stability: Unstable
+ @include: libdbusmenu-gtk/menu.h
+
+ In general, this is just a #GtkMenu, why else would you care? Oh,
+ because this menu is created by someone else on a server that exists
+ on the other side of DBus. You need a #DbusmenuServer to be able
+ push the data into this menu.
+
+ The first thing you need to know is how to find that #DbusmenuServer
+ on DBus. This involves both the DBus name and the DBus object that
+ the menu interface can be found on. Those two value should be set
+ when creating the object using dbusmenu_gtkmenu_new(). They are then
+ stored on two properties #DbusmenuGtkMenu:dbus-name and #DbusmenuGtkMenu:dbus-object.
+
+ After creation the #DbusmenuGtkMenu it will continue to keep in
+ synchronization with the #DbusmenuServer object across Dbus. If the
+ number of entries change, the menus change, if they change thier
+ properties change, they update in the items. All of this should
+ be handled transparently to the user of this object.
+
+ TODO: Document properties.
+*/
G_END_DECLS
#endif