From b259f290c45dba356179f1089f5740ee04feb24c Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Tue, 12 May 2009 10:31:59 -0500 Subject: Object docs --- libdbusmenu-glib/server.h | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) (limited to 'libdbusmenu-glib/server.h') diff --git a/libdbusmenu-glib/server.h b/libdbusmenu-glib/server.h index de5f9eb..2c6c817 100644 --- a/libdbusmenu-glib/server.h +++ b/libdbusmenu-glib/server.h @@ -51,9 +51,20 @@ G_BEGIN_DECLS #define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" #define DBUSMENU_SERVER_PROP_LAYOUT "layout" -typedef struct _DbusmenuServer DbusmenuServer; +/** + DbusmenuServerClass: + @parent_class: #GObjectClass + @id_prop_update: Slot for #DbusmenuServer::id-prop-update. + @id_update: Slot for #DbusmenuServer::id-update. + @layout_update: Slot for #DbusmenuServer::layout-update. + @dbusmenu_server_reserved1: Reserved for future use. + @dbusmenu_server_reserved2: Reserved for future use. + @dbusmenu_server_reserved3: Reserved for future use. + @dbusmenu_server_reserved4: Reserved for future use. + + The class implementing the virtual functions for #DbusmenuServer. +*/ typedef struct _DbusmenuServerClass DbusmenuServerClass; - struct _DbusmenuServerClass { GObjectClass parent_class; @@ -69,6 +80,14 @@ struct _DbusmenuServerClass { void (*dbusmenu_server_reserved4)(void); }; +/** + DbusmenuServer: + @parent: #GObject + + A server which represents a sharing of a set of + #DbusmenuMenuitems across DBus to a #DbusmenuClient. +*/ +typedef struct _DbusmenuServer DbusmenuServer; struct _DbusmenuServer { GObject parent; }; @@ -77,6 +96,25 @@ GType dbusmenu_server_get_type (void); DbusmenuServer * dbusmenu_server_new (const gchar * object); void dbusmenu_server_set_root (DbusmenuServer * server, DbusmenuMenuitem * root); +/** + SECIONT:server + @short_description: The server signals changed and + updates on a tree of #DbusmenuMenuitem objecs. + @stability: Unstable + @include: libdbusmenu-glib/server.h + + A #DbusmenuServer is the object that represents the local + tree of #DbusmenuMenuitem objects on DBus. It watches the + various signals that those objects emit and correctly + represents them across DBus to a #DbusmenuClient so that + the same tree can be maintained in another process. + + The server needs to have the root set of #DbusmenuMenuitem + objects set via #dbusmenu_server_set_root but it will query + all of the objects in that tree automatically. After setting + the root there should be no other maintence required by + users of the server class. +*/ G_END_DECLS #endif -- cgit v1.2.3