From 59c214159f0017b5c623772d4d6f34f940ac1113 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Wed, 9 Jun 2010 15:08:32 -0500 Subject: Autogen and adding new Makefiles --- .../reference/xml/annotation-glossary.xml | 54 + .../reference/xml/api-index-deprecated.xml | 8 + .../reference/xml/api-index-full.xml | 158 +++ .../reference/xml/client-menuitem.xml | 87 ++ docs/libdbusmenu-glib/reference/xml/client.xml | 336 ++++++ .../reference/xml/dbusmenu-client.xml | 657 +++++++++++ .../reference/xml/dbusmenu-server.xml | 462 ++++++++ .../reference/xml/menuitem-proxy.xml | 111 ++ docs/libdbusmenu-glib/reference/xml/menuitem.xml | 1166 ++++++++++++++++++++ docs/libdbusmenu-glib/reference/xml/server.xml | 183 +++ 10 files changed, 3222 insertions(+) create mode 100644 docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/api-index-full.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/client-menuitem.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/client.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/menuitem.xml create mode 100644 docs/libdbusmenu-glib/reference/xml/server.xml (limited to 'docs/libdbusmenu-glib/reference/xml') diff --git a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml new file mode 100644 index 0000000..2dfb261 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml @@ -0,0 +1,54 @@ + + +]> + + + Annotation Glossary +A + + array + + Parameter points to an array of items. + + + +E + + element-type + + Generics and defining elements of containers and arrays. + + + +I + + inout + + Parameter for input and for returning results. Default is transfer full. + + + + in + + Parameter for input. Default is transfer none. + + + +T + + transfer full + + Free data after the code is done. + + + + transfer none + + Don't free data after the code is done. + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml new file mode 100644 index 0000000..8ec0fe4 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml @@ -0,0 +1,8 @@ + + +]> + + diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-full.xml b/docs/libdbusmenu-glib/reference/xml/api-index-full.xml new file mode 100644 index 0000000..84ae6cb --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/api-index-full.xml @@ -0,0 +1,158 @@ + + +]> + +G +DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu, macro in dbusmenu-client +dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER, function in dbusmenu-server +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER, function in dbusmenu-server +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER, function in dbusmenu-server +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER, function in dbusmenu-server +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER, function in dbusmenu-server +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER, function in dbusmenu-server +g_marshal_value_peek_boolean, macro in dbusmenu-server +g_marshal_value_peek_boxed, macro in dbusmenu-server +g_marshal_value_peek_char, macro in dbusmenu-server +g_marshal_value_peek_double, macro in dbusmenu-server +g_marshal_value_peek_enum, macro in dbusmenu-server +g_marshal_value_peek_flags, macro in dbusmenu-server +g_marshal_value_peek_float, macro in dbusmenu-server +g_marshal_value_peek_int, macro in dbusmenu-server +g_marshal_value_peek_int64, macro in dbusmenu-server +g_marshal_value_peek_long, macro in dbusmenu-server +g_marshal_value_peek_object, macro in dbusmenu-server +g_marshal_value_peek_param, macro in dbusmenu-server +g_marshal_value_peek_pointer, macro in dbusmenu-server +g_marshal_value_peek_string, macro in dbusmenu-server +g_marshal_value_peek_uchar, macro in dbusmenu-server +g_marshal_value_peek_uint, macro in dbusmenu-server +g_marshal_value_peek_uint64, macro in dbusmenu-server +g_marshal_value_peek_ulong, macro in dbusmenu-server +dbus_g_proxy_begin_call, function in dbusmenu-client + +M +DbusmenuClientClass, struct in DbusmenuClient +DbusmenuClientMenuitem, struct in DbusmenuClientMenuitem +DbusmenuClientMenuitemClass, struct in DbusmenuClientMenuitem +DbusmenuClientTypeHandler, user_function in DbusmenuClient +DbusmenuMenuitem, struct in DbusmenuMenuitem +DbusmenuMenuitem::child-added, object signal in DbusmenuMenuitem +DbusmenuMenuitem::child-moved, object signal in DbusmenuMenuitem +DbusmenuMenuitem::child-removed, object signal in DbusmenuMenuitem +DbusmenuMenuitem::item-activated, object signal in DbusmenuMenuitem +DbusmenuMenuitem::property-changed, object signal in DbusmenuMenuitem +DbusmenuMenuitem::realized, object signal in DbusmenuMenuitem +DbusmenuMenuitem:id, object property in DbusmenuMenuitem +DbusmenuMenuitemClass, struct in DbusmenuMenuitem +DbusmenuMenuitemProxy, struct in DbusmenuMenuitemProxy +DbusmenuMenuitemProxy:menu-item, object property in DbusmenuMenuitemProxy +DbusmenuMenuitemProxyClass, struct in DbusmenuMenuitemProxy +DbusmenuServerClass, struct in DbusmenuServer +dbusmenu_client_add_type_handler, function in DbusmenuClient +dbusmenu_client_get_root, function in DbusmenuClient +dbusmenu_client_menuitem_new, function in DbusmenuClientMenuitem +DBUSMENU_CLIENT_MENUITEM_TYPE, macro in DbusmenuClientMenuitem +dbusmenu_client_new, function in DbusmenuClient +DBUSMENU_CLIENT_PROP_DBUS_NAME, macro in DbusmenuClient +DBUSMENU_CLIENT_PROP_DBUS_OBJECT, macro in DbusmenuClient +dbusmenu_client_send_about_to_show, function in DbusmenuClient +dbusmenu_client_send_event, function in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_DEFAULT, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_IMAGE, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_SEPARATOR, macro in DbusmenuClient +dbusmenu_menuitem_about_to_show_cb, user_function in DbusmenuMenuitem +dbusmenu_menuitem_buildxml_slot_t, user_function in DbusmenuMenuitem +dbusmenu_menuitem_child_add_position, function in DbusmenuMenuitem +dbusmenu_menuitem_child_append, function in DbusmenuMenuitem +dbusmenu_menuitem_child_delete, function in DbusmenuMenuitem +dbusmenu_menuitem_child_find, function in DbusmenuMenuitem +dbusmenu_menuitem_child_prepend, function in DbusmenuMenuitem +dbusmenu_menuitem_child_reorder, function in DbusmenuMenuitem +dbusmenu_menuitem_find_id, function in DbusmenuMenuitem +dbusmenu_menuitem_foreach, function in DbusmenuMenuitem +dbusmenu_menuitem_get_children, function in DbusmenuMenuitem +dbusmenu_menuitem_get_id, function in DbusmenuMenuitem +dbusmenu_menuitem_get_position, function in DbusmenuMenuitem +dbusmenu_menuitem_get_position_realized, function in DbusmenuMenuitem +dbusmenu_menuitem_get_root, function in DbusmenuMenuitem +dbusmenu_menuitem_handle_event, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_ICON_NAME_BLANK, macro in DbusmenuMenuitem +dbusmenu_menuitem_new, function in DbusmenuMenuitem +dbusmenu_menuitem_new_with_id, function in DbusmenuMenuitem +dbusmenu_menuitem_properties_copy, function in DbusmenuMenuitem +dbusmenu_menuitem_properties_list, function in DbusmenuMenuitem +dbusmenu_menuitem_property_exist, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_bool, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_int, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_value, function in DbusmenuMenuitem +dbusmenu_menuitem_property_remove, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_bool, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_int, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_value, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ENABLED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ICON_DATA, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ICON_NAME, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_LABEL, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TYPE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_VISIBLE, macro in DbusmenuMenuitem +dbusmenu_menuitem_proxy_get_wrapped, function in DbusmenuMenuitemProxy +dbusmenu_menuitem_proxy_new, function in DbusmenuMenuitemProxy +dbusmenu_menuitem_send_about_to_show, function in DbusmenuMenuitem +dbusmenu_menuitem_set_root, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_REALIZED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID, macro in DbusmenuMenuitem +dbusmenu_menuitem_take_children, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_CHECK, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_RADIO, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN, macro in DbusmenuMenuitem +dbusmenu_server_new, function in DbusmenuServer +DBUSMENU_SERVER_PROP_DBUS_OBJECT, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_ROOT_NODE, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_VERSION, macro in DbusmenuServer +dbusmenu_server_set_root, function in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_ID_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuServer + +O +org_ayatana_dbusmenu_about_to_show, function in dbusmenu-client +org_ayatana_dbusmenu_about_to_show_async, function in dbusmenu-client +org_ayatana_dbusmenu_about_to_show_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_event, function in dbusmenu-client +org_ayatana_dbusmenu_event_async, function in dbusmenu-client +org_ayatana_dbusmenu_event_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_get_children, function in dbusmenu-client +org_ayatana_dbusmenu_get_children_async, function in dbusmenu-client +org_ayatana_dbusmenu_get_children_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_get_group_properties, function in dbusmenu-client +org_ayatana_dbusmenu_get_group_properties_async, function in dbusmenu-client +org_ayatana_dbusmenu_get_group_properties_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_get_layout, function in dbusmenu-client +org_ayatana_dbusmenu_get_layout_async, function in dbusmenu-client +org_ayatana_dbusmenu_get_layout_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_get_properties, function in dbusmenu-client +org_ayatana_dbusmenu_get_properties_async, function in dbusmenu-client +org_ayatana_dbusmenu_get_properties_reply, user_function in dbusmenu-client +org_ayatana_dbusmenu_get_property, function in dbusmenu-client +org_ayatana_dbusmenu_get_property_async, function in dbusmenu-client +org_ayatana_dbusmenu_get_property_reply, user_function in dbusmenu-client + + diff --git a/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml new file mode 100644 index 0000000..06208c9 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml @@ -0,0 +1,87 @@ + + +]> + + +DbusmenuClientMenuitem +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuClientMenuitem + + + + +Synopsis + +#define DBUSMENU_CLIENT_MENUITEM_TYPE + DbusmenuClientMenuitem; + DbusmenuClientMenuitemClass; +DbusmenuClientMenuitem * dbusmenu_client_menuitem_new (gint id, + DbusmenuClient *client); + + + +Object Hierarchy + + GObject + +----DbusmenuMenuitem + +----DbusmenuClientMenuitem + + + + +Description + + + + +Details + +DBUSMENU_CLIENT_MENUITEM_TYPE +DBUSMENU_CLIENT_MENUITEM_TYPE +#define DBUSMENU_CLIENT_MENUITEM_TYPE (dbusmenu_client_menuitem_get_type ()) + + + + +DbusmenuClientMenuitem +DbusmenuClientMenuitem +typedef struct _DbusmenuClientMenuitem DbusmenuClientMenuitem; + + + +DbusmenuClientMenuitemClass +DbusmenuClientMenuitemClass +typedef struct { + DbusmenuMenuitemClass parent_class; +} DbusmenuClientMenuitemClass; + + + + +dbusmenu_client_menuitem_new () +dbusmenu_client_menuitem_new +DbusmenuClientMenuitem * dbusmenu_client_menuitem_new (gint id, + DbusmenuClient *client); + + +id : + + +client : + + +Returns : + + + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/client.xml b/docs/libdbusmenu-glib/reference/xml/client.xml new file mode 100644 index 0000000..a8d62bf --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/client.xml @@ -0,0 +1,336 @@ + + +]> + + +DbusmenuClient +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuClient +The catcher of all the server traffic + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/client.h> + +#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +#define DBUSMENU_CLIENT_PROP_DBUS_NAME +#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT +#define DBUSMENU_CLIENT_TYPES_DEFAULT +#define DBUSMENU_CLIENT_TYPES_SEPARATOR +#define DBUSMENU_CLIENT_TYPES_IMAGE + DbusmenuClientClass; +gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem *newitem, + DbusmenuMenuitem *parent, + DbusmenuClient *client); +DbusmenuClient * dbusmenu_client_new (const gchar *name, + const gchar *object); +DbusmenuMenuitem * dbusmenu_client_get_root (DbusmenuClient *client); +gboolean dbusmenu_client_add_type_handler (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc); +void dbusmenu_client_send_event (DbusmenuClient *client, + gint id, + const gchar *name, + const GValue *value, + guint timestamp); +void dbusmenu_client_send_about_to_show (DbusmenuClient *client, + gint id, + void (cbgpointer user_data) (), + gpointer cb_data); + + + + +Description + +The client exists as a mirror to the server. For most folks + all they will do with a client is set it up to connect to + a server and then watch as the menu items on their side + of the bus change. This is all they should need to know about + the client, that it magically makes their menuitems dance. + + + It does this by setting up signal watchers and adjusting + the menuitems appropriately. Most users should watch the + menu items and the signal "layout-changed" for + larger events so that they can be optimized. It is possible + with that signal that even the root node would change. If + that doesn't happen the normal signals on the individual + nodes should be enough for most users. + + + +Details + +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated" + + + + +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed" + + + + +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem" + + + + +DBUSMENU_CLIENT_PROP_DBUS_NAME +DBUSMENU_CLIENT_PROP_DBUS_NAME +#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" + + + + +DBUSMENU_CLIENT_PROP_DBUS_OBJECT +DBUSMENU_CLIENT_PROP_DBUS_OBJECT +#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" + + + + +DBUSMENU_CLIENT_TYPES_DEFAULT +DBUSMENU_CLIENT_TYPES_DEFAULT +#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard" + + + + +DBUSMENU_CLIENT_TYPES_SEPARATOR +DBUSMENU_CLIENT_TYPES_SEPARATOR +#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator" + + + + +DBUSMENU_CLIENT_TYPES_IMAGE +DBUSMENU_CLIENT_TYPES_IMAGE +#define DBUSMENU_CLIENT_TYPES_IMAGE "standard" + + + + +DbusmenuClientClass +DbusmenuClientClass +typedef struct { + GObjectClass parent_class; + + void (*layout_updated)(void); + void (*root_changed) (DbusmenuMenuitem * newroot); + void (*new_menuitem) (DbusmenuMenuitem * newitem); + + /* Reserved for future use */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); +} DbusmenuClientClass; + + +A simple class that takes all of the information from a + DbusmenuServer over DBus and makes the same set of + DbusmenuMenuitem objects appear on the other side. + +GObjectClass parent_class; +GObjectClass + + +layout_updated () +Slot for "layout-updated". + + +root_changed () + + + +new_menuitem () +Slot for "new-menuitem". + + +reserved1 () +Reserved for future use. + + +reserved2 () +Reserved for future use. + + +reserved3 () +Reserved for future use. + + +reserved4 () +Reserved for future use. + + + + +DbusmenuClientTypeHandler () +DbusmenuClientTypeHandler +gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem *newitem, + DbusmenuMenuitem *parent, + DbusmenuClient *client); + + +newitem : + + +parent : + + +client : + + +Returns : + + + +dbusmenu_client_new () +dbusmenu_client_new +DbusmenuClient * dbusmenu_client_new (const gchar *name, + const gchar *object); + +This function creates a new client that connects to a specific + server on DBus. That server is at a specific location sharing + a known object. The interface is assumed by the code to be + the DBus menu interface. The newly created client will start + sending out events as it syncs up with the server. + +name : +The DBus name for the server to connect to + +object : +The object on the server to monitor + +Returns : A brand new DbusmenuClient + + + +dbusmenu_client_get_root () +dbusmenu_client_get_root +DbusmenuMenuitem * dbusmenu_client_get_root (DbusmenuClient *client); + +Grabs the root node for the specified client client. This + function may block. It will block if there is currently a + call to update the layout, it will block on that layout + updated and then return the newly updated layout. Chances + are that this update is in the queue for the mainloop as + it would have been requested some time ago, but in theory + it could block longer. + +client : +The DbusmenuClient to get the root node from + +Returns : A DbusmenuMenuitem representing the root of + menu on the server. If there is no server or there is + an error receiving its layout it'll return NULL. + + + +dbusmenu_client_add_type_handler () +dbusmenu_client_add_type_handler +gboolean dbusmenu_client_add_type_handler (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc); + +This function connects into the type handling of the DbusmenuClient. + Every new menuitem that comes in immediately gets asked for it's + properties. When we get those properties we check the 'type' + property and look to see if it matches a handler that is known + by the client. If so, the newfunc function is executed on that + DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem + signal is sent. + + + In the future the known types will be sent to the server so that it + can make choices about the menu item types availble. + +client : +Client where we're getting types coming in + +type : +A text string that will be matched with the 'type' + property on incoming menu items + +newfunc : +The function that will be executed with those new + items when they come in. + +Returns : If registering the new type was successful. + + + +dbusmenu_client_send_event () +dbusmenu_client_send_event +void dbusmenu_client_send_event (DbusmenuClient *client, + gint id, + const gchar *name, + const GValue *value, + guint timestamp); + + +client : + + +id : + + +name : + + +value : + + +timestamp : + + + + +dbusmenu_client_send_about_to_show () +dbusmenu_client_send_about_to_show +void dbusmenu_client_send_about_to_show (DbusmenuClient *client, + gint id, + void (cbgpointer user_data) (), + gpointer cb_data); + + +client : + + +id : + +gpointer user_data: + +cb_data : + + + + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml new file mode 100644 index 0000000..f7244f7 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml @@ -0,0 +1,657 @@ + + +]> + + +dbusmenu-client +3 + + LIBDBUSMENU-GLIB Library + + + +dbusmenu-client + + + + +Synopsis + +#define DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu +gboolean org_ayatana_dbusmenu_get_layout (DBusGProxy *proxy, + const gint IN_parentId, + guint *OUT_revision, + char **OUT_layout); +void (*org_ayatana_dbusmenu_get_layout_reply) + (DBusGProxy *proxy, + guint OUT_revision, + char *OUT_layout, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_get_layout_async + (DBusGProxy *proxy, + const gint IN_parentId, + org_ayatana_dbusmenu_get_layout_reply callback); +return dbus_g_proxy_begin_call (proxy Param1); +gboolean org_ayatana_dbusmenu_get_group_properties + (DBusGProxy *proxy, + const GArray *IN_ids, + const char **IN_propertyNames, + GPtrArray **OUT_properties); +void (*org_ayatana_dbusmenu_get_group_properties_reply) + (DBusGProxy *proxy, + GPtrArray *OUT_properties, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_get_group_properties_async + (DBusGProxy *proxy, + const GArray *IN_ids, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_group_properties_reply callback); +gboolean org_ayatana_dbusmenu_get_children (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + GPtrArray **OUT_properties); +void (*org_ayatana_dbusmenu_get_children_reply) + (DBusGProxy *proxy, + GPtrArray *OUT_properties, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_get_children_async + (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_children_reply callback); +gboolean org_ayatana_dbusmenu_get_property (DBusGProxy *proxy, + const gint IN_id, + const char *IN_name, + GValue *OUT_value); +void (*org_ayatana_dbusmenu_get_property_reply) + (DBusGProxy *proxy, + GValue OUT_value, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_get_property_async + (DBusGProxy *proxy, + const gint IN_id, + const char *IN_name, + org_ayatana_dbusmenu_get_property_reply callback); +gboolean org_ayatana_dbusmenu_get_properties (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + GHashTable **OUT_properties); +void (*org_ayatana_dbusmenu_get_properties_reply) + (DBusGProxy *proxy, + GHashTable *OUT_properties, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_get_properties_async + (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_properties_reply callback); +gboolean org_ayatana_dbusmenu_event (DBusGProxy *proxy, + const gint IN_id, + const char *IN_eventId, + const GValue *IN_data, + const guint IN_timestamp); +void (*org_ayatana_dbusmenu_event_reply) (DBusGProxy *proxy, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_event_async (DBusGProxy *proxy, + const gint IN_id, + const char *IN_eventId, + const GValue *IN_data, + const guint IN_timestamp, + org_ayatana_dbusmenu_event_reply callback); +gboolean org_ayatana_dbusmenu_about_to_show (DBusGProxy *proxy, + const gint IN_id, + gboolean *OUT_needUpdate); +void (*org_ayatana_dbusmenu_about_to_show_reply) + (DBusGProxy *proxy, + gboolean OUT_needUpdate, + GError *error, + gpointer userdata); +DBusGProxyCall * org_ayatana_dbusmenu_about_to_show_async + (DBusGProxy *proxy, + const gint IN_id, + org_ayatana_dbusmenu_about_to_show_reply callback); + + + + +Description + + + + +Details + +DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu +DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu +#define DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu + + + + +org_ayatana_dbusmenu_get_layout () +org_ayatana_dbusmenu_get_layout +gboolean org_ayatana_dbusmenu_get_layout (DBusGProxy *proxy, + const gint IN_parentId, + guint *OUT_revision, + char **OUT_layout); + + +proxy : + + +IN_parentId : + + +OUT_revision : + + +OUT_layout : + + +Returns : + + + +org_ayatana_dbusmenu_get_layout_reply () +org_ayatana_dbusmenu_get_layout_reply +void (*org_ayatana_dbusmenu_get_layout_reply) + (DBusGProxy *proxy, + guint OUT_revision, + char *OUT_layout, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_revision : + + +OUT_layout : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_get_layout_async () +org_ayatana_dbusmenu_get_layout_async +DBusGProxyCall * org_ayatana_dbusmenu_get_layout_async + (DBusGProxy *proxy, + const gint IN_parentId, + org_ayatana_dbusmenu_get_layout_reply callback); + + +proxy : + + +IN_parentId : + + +callback : + + +Returns : + + + +dbus_g_proxy_begin_call () +dbus_g_proxy_begin_call +return dbus_g_proxy_begin_call (proxy Param1); + + +Param1 : + + +Returns : + + + +org_ayatana_dbusmenu_get_group_properties () +org_ayatana_dbusmenu_get_group_properties +gboolean org_ayatana_dbusmenu_get_group_properties + (DBusGProxy *proxy, + const GArray *IN_ids, + const char **IN_propertyNames, + GPtrArray **OUT_properties); + + +proxy : + + +IN_ids : + + +IN_propertyNames : + + +OUT_properties : + + +Returns : + + + +org_ayatana_dbusmenu_get_group_properties_reply () +org_ayatana_dbusmenu_get_group_properties_reply +void (*org_ayatana_dbusmenu_get_group_properties_reply) + (DBusGProxy *proxy, + GPtrArray *OUT_properties, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_properties : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_get_group_properties_async () +org_ayatana_dbusmenu_get_group_properties_async +DBusGProxyCall * org_ayatana_dbusmenu_get_group_properties_async + (DBusGProxy *proxy, + const GArray *IN_ids, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_group_properties_reply callback); + + +proxy : + + +IN_ids : + + +IN_propertyNames : + + +callback : + + +Returns : + + + +org_ayatana_dbusmenu_get_children () +org_ayatana_dbusmenu_get_children +gboolean org_ayatana_dbusmenu_get_children (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + GPtrArray **OUT_properties); + + +proxy : + + +IN_id : + + +IN_propertyNames : + + +OUT_properties : + + +Returns : + + + +org_ayatana_dbusmenu_get_children_reply () +org_ayatana_dbusmenu_get_children_reply +void (*org_ayatana_dbusmenu_get_children_reply) + (DBusGProxy *proxy, + GPtrArray *OUT_properties, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_properties : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_get_children_async () +org_ayatana_dbusmenu_get_children_async +DBusGProxyCall * org_ayatana_dbusmenu_get_children_async + (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_children_reply callback); + + +proxy : + + +IN_id : + + +IN_propertyNames : + + +callback : + + +Returns : + + + +org_ayatana_dbusmenu_get_property () +org_ayatana_dbusmenu_get_property +gboolean org_ayatana_dbusmenu_get_property (DBusGProxy *proxy, + const gint IN_id, + const char *IN_name, + GValue *OUT_value); + + +proxy : + + +IN_id : + + +IN_name : + + +OUT_value : + + +Returns : + + + +org_ayatana_dbusmenu_get_property_reply () +org_ayatana_dbusmenu_get_property_reply +void (*org_ayatana_dbusmenu_get_property_reply) + (DBusGProxy *proxy, + GValue OUT_value, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_value : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_get_property_async () +org_ayatana_dbusmenu_get_property_async +DBusGProxyCall * org_ayatana_dbusmenu_get_property_async + (DBusGProxy *proxy, + const gint IN_id, + const char *IN_name, + org_ayatana_dbusmenu_get_property_reply callback); + + +proxy : + + +IN_id : + + +IN_name : + + +callback : + + +Returns : + + + +org_ayatana_dbusmenu_get_properties () +org_ayatana_dbusmenu_get_properties +gboolean org_ayatana_dbusmenu_get_properties (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + GHashTable **OUT_properties); + + +proxy : + + +IN_id : + + +IN_propertyNames : + + +OUT_properties : + + +Returns : + + + +org_ayatana_dbusmenu_get_properties_reply () +org_ayatana_dbusmenu_get_properties_reply +void (*org_ayatana_dbusmenu_get_properties_reply) + (DBusGProxy *proxy, + GHashTable *OUT_properties, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_properties : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_get_properties_async () +org_ayatana_dbusmenu_get_properties_async +DBusGProxyCall * org_ayatana_dbusmenu_get_properties_async + (DBusGProxy *proxy, + const gint IN_id, + const char **IN_propertyNames, + org_ayatana_dbusmenu_get_properties_reply callback); + + +proxy : + + +IN_id : + + +IN_propertyNames : + + +callback : + + +Returns : + + + +org_ayatana_dbusmenu_event () +org_ayatana_dbusmenu_event +gboolean org_ayatana_dbusmenu_event (DBusGProxy *proxy, + const gint IN_id, + const char *IN_eventId, + const GValue *IN_data, + const guint IN_timestamp); + + +proxy : + + +IN_id : + + +IN_eventId : + + +IN_data : + + +IN_timestamp : + + +Returns : + + + +org_ayatana_dbusmenu_event_reply () +org_ayatana_dbusmenu_event_reply +void (*org_ayatana_dbusmenu_event_reply) (DBusGProxy *proxy, + GError *error, + gpointer userdata); + + +proxy : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_event_async () +org_ayatana_dbusmenu_event_async +DBusGProxyCall * org_ayatana_dbusmenu_event_async (DBusGProxy *proxy, + const gint IN_id, + const char *IN_eventId, + const GValue *IN_data, + const guint IN_timestamp, + org_ayatana_dbusmenu_event_reply callback); + + +proxy : + + +IN_id : + + +IN_eventId : + + +IN_data : + + +IN_timestamp : + + +callback : + + +Returns : + + + +org_ayatana_dbusmenu_about_to_show () +org_ayatana_dbusmenu_about_to_show +gboolean org_ayatana_dbusmenu_about_to_show (DBusGProxy *proxy, + const gint IN_id, + gboolean *OUT_needUpdate); + + +proxy : + + +IN_id : + + +OUT_needUpdate : + + +Returns : + + + +org_ayatana_dbusmenu_about_to_show_reply () +org_ayatana_dbusmenu_about_to_show_reply +void (*org_ayatana_dbusmenu_about_to_show_reply) + (DBusGProxy *proxy, + gboolean OUT_needUpdate, + GError *error, + gpointer userdata); + + +proxy : + + +OUT_needUpdate : + + +error : + + +userdata : + + + + +org_ayatana_dbusmenu_about_to_show_async () +org_ayatana_dbusmenu_about_to_show_async +DBusGProxyCall * org_ayatana_dbusmenu_about_to_show_async + (DBusGProxy *proxy, + const gint IN_id, + org_ayatana_dbusmenu_about_to_show_reply callback); + + +proxy : + + +IN_id : + + +callback : + + +Returns : + + + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml new file mode 100644 index 0000000..836e1d6 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml @@ -0,0 +1,462 @@ + + +]> + + +dbusmenu-server +3 + + LIBDBUSMENU-GLIB Library + + + +dbusmenu-server + + + + +Synopsis + +#define g_marshal_value_peek_boolean (v) +#define g_marshal_value_peek_char (v) +#define g_marshal_value_peek_uchar (v) +#define g_marshal_value_peek_int (v) +#define g_marshal_value_peek_uint (v) +#define g_marshal_value_peek_long (v) +#define g_marshal_value_peek_ulong (v) +#define g_marshal_value_peek_int64 (v) +#define g_marshal_value_peek_uint64 (v) +#define g_marshal_value_peek_enum (v) +#define g_marshal_value_peek_flags (v) +#define g_marshal_value_peek_float (v) +#define g_marshal_value_peek_double (v) +#define g_marshal_value_peek_string (v) +#define g_marshal_value_peek_param (v) +#define g_marshal_value_peek_boxed (v) +#define g_marshal_value_peek_pointer (v) +#define g_marshal_value_peek_object (v) +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + + + +Description + + + + +Details + +g_marshal_value_peek_boolean() +g_marshal_value_peek_boolean +#define g_marshal_value_peek_boolean(v) + + +v : + + + + +g_marshal_value_peek_char() +g_marshal_value_peek_char +#define g_marshal_value_peek_char(v) + + +v : + + + + +g_marshal_value_peek_uchar() +g_marshal_value_peek_uchar +#define g_marshal_value_peek_uchar(v) + + +v : + + + + +g_marshal_value_peek_int() +g_marshal_value_peek_int +#define g_marshal_value_peek_int(v) + + +v : + + + + +g_marshal_value_peek_uint() +g_marshal_value_peek_uint +#define g_marshal_value_peek_uint(v) + + +v : + + + + +g_marshal_value_peek_long() +g_marshal_value_peek_long +#define g_marshal_value_peek_long(v) + + +v : + + + + +g_marshal_value_peek_ulong() +g_marshal_value_peek_ulong +#define g_marshal_value_peek_ulong(v) + + +v : + + + + +g_marshal_value_peek_int64() +g_marshal_value_peek_int64 +#define g_marshal_value_peek_int64(v) + + +v : + + + + +g_marshal_value_peek_uint64() +g_marshal_value_peek_uint64 +#define g_marshal_value_peek_uint64(v) + + +v : + + + + +g_marshal_value_peek_enum() +g_marshal_value_peek_enum +#define g_marshal_value_peek_enum(v) + + +v : + + + + +g_marshal_value_peek_flags() +g_marshal_value_peek_flags +#define g_marshal_value_peek_flags(v) + + +v : + + + + +g_marshal_value_peek_float() +g_marshal_value_peek_float +#define g_marshal_value_peek_float(v) + + +v : + + + + +g_marshal_value_peek_double() +g_marshal_value_peek_double +#define g_marshal_value_peek_double(v) + + +v : + + + + +g_marshal_value_peek_string() +g_marshal_value_peek_string +#define g_marshal_value_peek_string(v) + + +v : + + + + +g_marshal_value_peek_param() +g_marshal_value_peek_param +#define g_marshal_value_peek_param(v) + + +v : + + + + +g_marshal_value_peek_boxed() +g_marshal_value_peek_boxed +#define g_marshal_value_peek_boxed(v) + + +v : + + + + +g_marshal_value_peek_pointer() +g_marshal_value_peek_pointer +#define g_marshal_value_peek_pointer(v) + + +v : + + + + +g_marshal_value_peek_object() +g_marshal_value_peek_object +#define g_marshal_value_peek_object(v) + + +v : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + +dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER () +dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER +void dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER + (GClosure *closure, + GValue *return_value, + guint n_param_values, + const GValue *param_values, + gpointer invocation_hint, + gpointer marshal_data); + + +closure : + + +return_value : + + +n_param_values : + + +param_values : + + +invocation_hint : + + +marshal_data : + + + + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml new file mode 100644 index 0000000..7d8b431 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml @@ -0,0 +1,111 @@ + + +]> + + +DbusmenuMenuitemProxy +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuMenuitemProxy + + + + +Synopsis + + DbusmenuMenuitemProxy; + DbusmenuMenuitemProxyClass; +DbusmenuMenuitemProxy * dbusmenu_menuitem_proxy_new (DbusmenuMenuitem *mi); +DbusmenuMenuitem * dbusmenu_menuitem_proxy_get_wrapped (DbusmenuMenuitemProxy *pmi); + + + +Object Hierarchy + + GObject + +----DbusmenuMenuitem + +----DbusmenuMenuitemProxy + + + +Properties + + "menu-item" DbusmenuMenuitem* : Read / Write / Construct Only + + + + +Description + + + + +Details + +DbusmenuMenuitemProxy +DbusmenuMenuitemProxy +typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy; + + + +DbusmenuMenuitemProxyClass +DbusmenuMenuitemProxyClass +typedef struct { + DbusmenuMenuitemClass parent_class; +} DbusmenuMenuitemProxyClass; + + +Functions and signal slots for DbusmenuMenuitemProxy. + +DbusmenuMenuitemClass parent_class; +The Class of DbusmeneMenuitem + + + + +dbusmenu_menuitem_proxy_new () +dbusmenu_menuitem_proxy_new +DbusmenuMenuitemProxy * dbusmenu_menuitem_proxy_new (DbusmenuMenuitem *mi); + +Builds a new DbusmenuMenuitemProxy object that proxies + all of the values for mi. + +mi : +The DbusmenuMenuitem to proxy + +Returns : A new DbusmenuMenuitemProxy object. + + + +dbusmenu_menuitem_proxy_get_wrapped () +dbusmenu_menuitem_proxy_get_wrapped +DbusmenuMenuitem * dbusmenu_menuitem_proxy_get_wrapped (DbusmenuMenuitemProxy *pmi); + +Accesses the private variable of which DbusmenuMenuitem + we are doing the proxying for. + +pmi : +DbusmenuMenuitemProxy to look into + +Returns : A DbusmenuMenuitem object or a NULL if we + don't have one or there is an error. + + + + + +Property Details +The <literal>"menu-item"</literal> property +DbusmenuMenuitemProxy:menu-item + "menu-item" DbusmenuMenuitem* : Read / Write / Construct Only +An instance of the DbusmenuMenuitem class that this menuitem will mimic. + + + diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem.xml b/docs/libdbusmenu-glib/reference/xml/menuitem.xml new file mode 100644 index 0000000..75f77d6 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/menuitem.xml @@ -0,0 +1,1166 @@ + + +]> + + +DbusmenuMenuitem +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuMenuitem +A lowlevel represenation of a menuitem + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/menuitem.h> + +#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +#define DBUSMENU_MENUITEM_PROP_TYPE +#define DBUSMENU_MENUITEM_PROP_VISIBLE +#define DBUSMENU_MENUITEM_PROP_ENABLED +#define DBUSMENU_MENUITEM_PROP_LABEL +#define DBUSMENU_MENUITEM_PROP_ICON_NAME +#define DBUSMENU_MENUITEM_PROP_ICON_DATA +#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +#define DBUSMENU_MENUITEM_TOGGLE_CHECK +#define DBUSMENU_MENUITEM_TOGGLE_RADIO +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +#define DBUSMENU_MENUITEM_ICON_NAME_BLANK + DbusmenuMenuitem; +void (*dbusmenu_menuitem_about_to_show_cb) + (DbusmenuMenuitem *mi, + gpointer user_data); +void (*dbusmenu_menuitem_buildxml_slot_t) + (DbusmenuMenuitem *mi, + GPtrArray *stringarray); + DbusmenuMenuitemClass; +DbusmenuMenuitem * dbusmenu_menuitem_new (void); +DbusmenuMenuitem * dbusmenu_menuitem_new_with_id (gint id); +gint dbusmenu_menuitem_get_id (DbusmenuMenuitem *mi); +GList * dbusmenu_menuitem_get_children (DbusmenuMenuitem *mi); +GList * dbusmenu_menuitem_take_children (DbusmenuMenuitem *mi); +guint dbusmenu_menuitem_get_position (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); +guint dbusmenu_menuitem_get_position_realized + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); +gboolean dbusmenu_menuitem_child_append (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_prepend (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_delete (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_add_position + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); +gboolean dbusmenu_menuitem_child_reorder (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); +DbusmenuMenuitem * dbusmenu_menuitem_child_find (DbusmenuMenuitem *mi, + gint id); +DbusmenuMenuitem * dbusmenu_menuitem_find_id (DbusmenuMenuitem *mi, + gint id); +gboolean dbusmenu_menuitem_property_set (DbusmenuMenuitem *mi, + const gchar *property, + const gchar *value); +gboolean dbusmenu_menuitem_property_set_value + (DbusmenuMenuitem *mi, + const gchar *property, + const GValue *value); +gboolean dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi, + const gchar *property, + const gboolean value); +gboolean dbusmenu_menuitem_property_set_int (DbusmenuMenuitem *mi, + const gchar *property, + const gint value); +const gchar * dbusmenu_menuitem_property_get (DbusmenuMenuitem *mi, + const gchar *property); +const GValue * dbusmenu_menuitem_property_get_value + (DbusmenuMenuitem *mi, + const gchar *property); +gboolean dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi, + const gchar *property); +gint dbusmenu_menuitem_property_get_int (DbusmenuMenuitem *mi, + const gchar *property); +gboolean dbusmenu_menuitem_property_exist (DbusmenuMenuitem *mi, + const gchar *property); +GList * dbusmenu_menuitem_properties_list (DbusmenuMenuitem *mi); +GHashTable * dbusmenu_menuitem_properties_copy (DbusmenuMenuitem *mi); +void dbusmenu_menuitem_property_remove (DbusmenuMenuitem *mi, + const gchar *property); +void dbusmenu_menuitem_set_root (DbusmenuMenuitem *mi, + gboolean root); +gboolean dbusmenu_menuitem_get_root (DbusmenuMenuitem *mi); +void dbusmenu_menuitem_foreach (DbusmenuMenuitem *mi, + void (funcDbusmenuMenuitem * mi, gpointer data) (), + gpointer data); +void dbusmenu_menuitem_handle_event (DbusmenuMenuitem *mi, + const gchar *name, + const GValue *value, + guint timestamp); +void dbusmenu_menuitem_send_about_to_show + (DbusmenuMenuitem *mi, + dbusmenu_menuitem_about_to_show_cb cb, + gpointer cb_data); + + + +Object Hierarchy + + GObject + +----DbusmenuMenuitem + +----DbusmenuClientMenuitem + +----DbusmenuMenuitemProxy + + + +Properties + + "id" gint : Read / Write / Construct Only + + + +Signals + + "child-added" : Run Last + "child-moved" : Run Last + "child-removed" : Run Last + "item-activated" : Run Last + "property-changed" : Run Last + "realized" : Run Last + + + + +Description + +A DbusmenuMenuitem is the lowest level of represenation of a +single item in a menu. It gets created on the server side +and copied over to the client side where it gets rendered. As +the server starts to change it, and grow it, and do all kinds +of fun stuff that information is transfered over DBus and the +client updates it's understanding of the object model. + + +Most people using either the client or the server should be +able to deal mostly with DbusmenuMenuitem objects. These +are simple, but then they can be attached to more complex +objects and handled appropriately. + + + +Details + +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED "property-changed" + + + + +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED "item-activated" + + + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED "child-added" + + + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED "child-removed" + + + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED "child-moved" + + + + +DBUSMENU_MENUITEM_SIGNAL_REALIZED +DBUSMENU_MENUITEM_SIGNAL_REALIZED +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED "realized" + + + + +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM)) + + + + +DBUSMENU_MENUITEM_PROP_TYPE +DBUSMENU_MENUITEM_PROP_TYPE +#define DBUSMENU_MENUITEM_PROP_TYPE "type" + + + + +DBUSMENU_MENUITEM_PROP_VISIBLE +DBUSMENU_MENUITEM_PROP_VISIBLE +#define DBUSMENU_MENUITEM_PROP_VISIBLE "visible" + + + + +DBUSMENU_MENUITEM_PROP_ENABLED +DBUSMENU_MENUITEM_PROP_ENABLED +#define DBUSMENU_MENUITEM_PROP_ENABLED "enabled" + + + + +DBUSMENU_MENUITEM_PROP_LABEL +DBUSMENU_MENUITEM_PROP_LABEL +#define DBUSMENU_MENUITEM_PROP_LABEL "label" + + + + +DBUSMENU_MENUITEM_PROP_ICON_NAME +DBUSMENU_MENUITEM_PROP_ICON_NAME +#define DBUSMENU_MENUITEM_PROP_ICON_NAME "icon-name" + + + + +DBUSMENU_MENUITEM_PROP_ICON_DATA +DBUSMENU_MENUITEM_PROP_ICON_DATA +#define DBUSMENU_MENUITEM_PROP_ICON_DATA "icon-data" + + + + +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE "toggle-type" + + + + +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE "toggle-state" + + + + +DBUSMENU_MENUITEM_TOGGLE_CHECK +DBUSMENU_MENUITEM_TOGGLE_CHECK +#define DBUSMENU_MENUITEM_TOGGLE_CHECK "checkmark" + + + + +DBUSMENU_MENUITEM_TOGGLE_RADIO +DBUSMENU_MENUITEM_TOGGLE_RADIO +#define DBUSMENU_MENUITEM_TOGGLE_RADIO "radio" + + + + +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED 0 + + + + +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED 1 + + + + +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN -1 + + + + +DBUSMENU_MENUITEM_ICON_NAME_BLANK +DBUSMENU_MENUITEM_ICON_NAME_BLANK +#define DBUSMENU_MENUITEM_ICON_NAME_BLANK "blank-icon" + + + + +DbusmenuMenuitem +DbusmenuMenuitem +typedef struct _DbusmenuMenuitem DbusmenuMenuitem; + +This is the GObject based object that represents a menu +item. It gets created the same on both the client and +the server side and libdbusmenu-glib does the work of making +this object model appear on both sides of DBus. Simple +really, though through updates and people coming on and off +the bus it can lead to lots of fun complex scenarios. + + +dbusmenu_menuitem_about_to_show_cb () +dbusmenu_menuitem_about_to_show_cb +void (*dbusmenu_menuitem_about_to_show_cb) + (DbusmenuMenuitem *mi, + gpointer user_data); + +Callback prototype for a callback that is called when the +menu should be shown. + +mi : +Menu item that should be shown + +user_data : + Extra user data sent with the function. closure + + +dbusmenu_menuitem_buildxml_slot_t () +dbusmenu_menuitem_buildxml_slot_t +void (*dbusmenu_menuitem_buildxml_slot_t) + (DbusmenuMenuitem *mi, + GPtrArray *stringarray); + +This is the function that is called to represent this menu item +as an XML fragment. Should call it's own children. + +mi : + Menu item that should be built from. in. +stringarray : + An array of strings that can be combined into an XML file.. inout. transfer none. array. element-type utf8. + + +DbusmenuMenuitemClass +DbusmenuMenuitemClass +typedef struct { + GObjectClass parent_class; + + /* Signals */ + void (*property_changed) (gchar * property, GValue * value); + void (*item_activated) (guint timestamp); + void (*child_added) (DbusmenuMenuitem * child, guint position); + void (*child_removed) (DbusmenuMenuitem * child); + void (*child_moved) (DbusmenuMenuitem * child, guint newpos, guint oldpos); + void (*realized) (void); + + /* Virtual functions */ + dbusmenu_menuitem_buildxml_slot_t buildxml; + void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, const GValue * value, guint timestamp); + void (*send_about_to_show) (DbusmenuMenuitem * mi, dbusmenu_menuitem_about_to_show_cb cb, gpointer cb_data); + + void (*reserved1) (void); + /* void (*reserved2) (void); */ + /* void (*reserved3) (void); */ + /* void (*reserved4) (void); -- realized, realloc when bumping lib version */ +} DbusmenuMenuitemClass; + + +GObjectClass parent_class; + + + +property_changed () +Slot for "property-changed". + + +item_activated () +Slot for "item-activated". + + +child_added () +Slot for "child-added". + + +child_removed () +Slot for "child-removed". + + +child_moved () +Slot for "child-moved". + + +realized () +Slot for "realized". + + +dbusmenu_menuitem_buildxml_slot_t buildxml; +Virtual function that appends the strings required to represent this menu item in the menu XML file. + + +handle_event () +This function is to override how events are handled by subclasses. Look at dbusmenu_menuitem_handle_event for lots of good information. + + +send_about_to_show () +Virtual function that notifies server that the client is about to show a menu. + + +reserved1 () +Reserved for future use. + + + + +dbusmenu_menuitem_new () +dbusmenu_menuitem_new +DbusmenuMenuitem * dbusmenu_menuitem_new (void); + +Create a new DbusmenuMenuitem with all default values. + +Returns : A newly allocated DbusmenuMenuitem. + + + +dbusmenu_menuitem_new_with_id () +dbusmenu_menuitem_new_with_id +DbusmenuMenuitem * dbusmenu_menuitem_new_with_id (gint id); + +This creates a blank DbusmenuMenuitem with a specific ID. + +id : +ID to use for this menuitem + +Returns : A newly allocated DbusmenuMenuitem. + + + +dbusmenu_menuitem_get_id () +dbusmenu_menuitem_get_id +gint dbusmenu_menuitem_get_id (DbusmenuMenuitem *mi); + +Gets the unique ID for mi. + +mi : +The DbusmenuMenuitem to query. + +Returns : The ID of the mi. + + + +dbusmenu_menuitem_get_children () +dbusmenu_menuitem_get_children +GList * dbusmenu_menuitem_get_children (DbusmenuMenuitem *mi); + +Returns simply the list of children that this menu item + has. The list is valid until another child related function + is called, where it might be changed. + +mi : +The DbusmenuMenuitem to query. + +Returns : A GList of pointers to DbusmenuMenuitem objects. + + + +dbusmenu_menuitem_take_children () +dbusmenu_menuitem_take_children +GList * dbusmenu_menuitem_take_children (DbusmenuMenuitem *mi); + +While the name sounds devious that's exactly what this function + does. It takes the list of children from the mi and clears the + internal list. The calling function is now in charge of the ref's + on the children it has taken. A lot of responsibility involved + in taking children. + +mi : +The DbusmenMenuitem to take the children from. + +Returns : A GList of pointers to DbusmenuMenuitem objects. + + + +dbusmenu_menuitem_get_position () +dbusmenu_menuitem_get_position +guint dbusmenu_menuitem_get_position (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); + +This function returns the position of the menu item mi + in the children of parent. It will return zero if the + menu item can't be found. + +mi : +The DbusmenuMenuitem to find the position of + +parent : +The DbusmenuMenuitem who's children contain mi + +Returns : The position of mi in the children of parent. + + + +dbusmenu_menuitem_get_position_realized () +dbusmenu_menuitem_get_position_realized +guint dbusmenu_menuitem_get_position_realized + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); + +This function is very similar to dbusmenu_menuitem_get_position + except that it only counts in the children that have been realized. + +mi : +The DbusmenuMenuitem to find the position of + +parent : +The DbusmenuMenuitem who's children contain mi + +Returns : The position of mi in the realized children of parent. + + + +dbusmenu_menuitem_child_append () +dbusmenu_menuitem_child_append +gboolean dbusmenu_menuitem_child_append (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function adds child to the list of children on mi at + the end of that list. + +mi : +The DbusmenuMenuitem which will become a new parent + +child : +The DbusmenMenuitem that will be a child + +Returns : Whether the child has been added successfully. + + + +dbusmenu_menuitem_child_prepend () +dbusmenu_menuitem_child_prepend +gboolean dbusmenu_menuitem_child_prepend (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function adds child to the list of children on mi at + the beginning of that list. + +mi : +The DbusmenuMenuitem which will become a new parent + +child : +The DbusmenMenuitem that will be a child + +Returns : Whether the child has been added successfully. + + + +dbusmenu_menuitem_child_delete () +dbusmenu_menuitem_child_delete +gboolean dbusmenu_menuitem_child_delete (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function removes child from the children list of mi. It does + not call g_object_unref on child. + +mi : +The DbusmenuMenuitem which has child as a child + +child : +The child DbusmenuMenuitem that you want to no longer + be a child of mi. + +Returns : If we were able to delete child. + + + +dbusmenu_menuitem_child_add_position () +dbusmenu_menuitem_child_add_position +gboolean dbusmenu_menuitem_child_add_position + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); + +Puts child in the list of children for mi at the location + specified in position. If there is not enough entires available + then child will be placed at the end of the list. + +mi : +The DbusmenuMenuitem that we're adding the child child to. + +child : +The DbusmenuMenuitem to make a child of mi. + +position : +Where in mi object's list of chidren child should be placed. + +Returns : Whether child was added successfully. + + + +dbusmenu_menuitem_child_reorder () +dbusmenu_menuitem_child_reorder +gboolean dbusmenu_menuitem_child_reorder (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); + +This function moves a child on the list of children. It is + for a child that is already in the list, but simply needs a + new location. + +mi : + + +child : +The DbusmenuMenuitem that is a child needing to be moved + +position : +The position in the list to place it in + +Returns : Whether the move was successful. + + + +dbusmenu_menuitem_child_find () +dbusmenu_menuitem_child_find +DbusmenuMenuitem * dbusmenu_menuitem_child_find (DbusmenuMenuitem *mi, + gint id); + +Search the children of mi to find one with the ID of id. + If it doesn't exist then we return NULL. + +mi : +The DbusmenuMenuitem who's children to look on + +id : +The ID of the child that we're looking for. + +Returns : The menu item with the ID id or NULL if it + can't be found. + + + +dbusmenu_menuitem_find_id () +dbusmenu_menuitem_find_id +DbusmenuMenuitem * dbusmenu_menuitem_find_id (DbusmenuMenuitem *mi, + gint id); + +This function searchs the whole tree of children that + are attached to mi. This could be quite a few nodes, all + the way down the tree. It is a depth first search. + +mi : +DbusmenuMenuitem at the top of the tree to search + +id : +ID of the DbusmenuMenuitem to search for + +Returns : The DbusmenuMenuitem with the ID of id + or NULL if there isn't such a menu item in the tree + represented by mi. + + + +dbusmenu_menuitem_property_set () +dbusmenu_menuitem_property_set +gboolean dbusmenu_menuitem_property_set (DbusmenuMenuitem *mi, + const gchar *property, + const gchar *value); + +Takes the pair of property and value and places them as a + property on mi. If a property already exists by that name, + then the value is set to the new value. If not, the property + is added. If the value is changed or the property was previously + unset then the signal "prop-changed" will be + emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. + +property : +Name of the property to set. + +value : +The value of the property. + +Returns : A boolean representing if the property value was set. + + + +dbusmenu_menuitem_property_set_value () +dbusmenu_menuitem_property_set_value +gboolean dbusmenu_menuitem_property_set_value + (DbusmenuMenuitem *mi, + const gchar *property, + const GValue *value); + + +mi : + + +property : + + +value : + + +Returns : + + + +dbusmenu_menuitem_property_set_bool () +dbusmenu_menuitem_property_set_bool +gboolean dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi, + const gchar *property, + const gboolean value); + +Takes a boolean value and sets it on property as a + property on mi. If a property already exists by that name, + then the value is set to the new value. If not, the property + is added. If the value is changed or the property was previously + unset then the signal "prop-changed" will be + emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. + +property : +Name of the property to set. + +value : +The value of the property. + +Returns : A boolean representing if the property value was set. + + + +dbusmenu_menuitem_property_set_int () +dbusmenu_menuitem_property_set_int +gboolean dbusmenu_menuitem_property_set_int (DbusmenuMenuitem *mi, + const gchar *property, + const gint value); + +Takes a boolean value and sets it on property as a + property on mi. If a property already exists by that name, + then the value is set to the new value. If not, the property + is added. If the value is changed or the property was previously + unset then the signal "prop-changed" will be + emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. + +property : +Name of the property to set. + +value : +The value of the property. + +Returns : A boolean representing if the property value was set. + + + +dbusmenu_menuitem_property_get () +dbusmenu_menuitem_property_get +const gchar * dbusmenu_menuitem_property_get (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if + it exits. NULL will be returned if the property doesn't + exist. + +mi : +The DbusmenuMenuitem to look for the property on. + +property : +The property to grab. + +Returns : A string with the value of the property + that shouldn't be free'd. Or NULL if the property + is not set or is not a string. + + + +dbusmenu_menuitem_property_get_value () +dbusmenu_menuitem_property_get_value +const GValue * dbusmenu_menuitem_property_get_value + (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if + it exits. NULL will be returned if the property doesn't + exist. + +mi : +The DbusmenuMenuitem to look for the property on. + +property : +The property to grab. + +Returns : A GValue for the property. + + + +dbusmenu_menuitem_property_get_bool () +dbusmenu_menuitem_property_get_bool +gboolean dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if + it exits. Returns FALSE if the property doesn't exist. + +mi : +The DbusmenuMenuitem to look for the property on. + +property : +The property to grab. + +Returns : The value of the property or FALSE. + + + +dbusmenu_menuitem_property_get_int () +dbusmenu_menuitem_property_get_int +gint dbusmenu_menuitem_property_get_int (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if + it exits. Returns zero if the property doesn't exist. + +mi : +The DbusmenuMenuitem to look for the property on. + +property : +The property to grab. + +Returns : The value of the property or zero. + + + +dbusmenu_menuitem_property_exist () +dbusmenu_menuitem_property_exist +gboolean dbusmenu_menuitem_property_exist (DbusmenuMenuitem *mi, + const gchar *property); + + +mi : + + +property : + + +Returns : + + + +dbusmenu_menuitem_properties_list () +dbusmenu_menuitem_properties_list +GList * dbusmenu_menuitem_properties_list (DbusmenuMenuitem *mi); + +This functiong gets a list of the names of all the properties + that are set on this menu item. This data on the list is owned + by the menuitem but the list is not and should be freed using + g_list_free() when the calling function is done with it. + +mi : +DbusmenuMenuitem to list the properties on + +Returns : A list of strings or NULL if there are none. + + + +dbusmenu_menuitem_properties_copy () +dbusmenu_menuitem_properties_copy +GHashTable * dbusmenu_menuitem_properties_copy (DbusmenuMenuitem *mi); + +This function takes the properties of a DbusmenuMenuitem + and puts them into a GHashTable that is referenced by the + key of a string and has the value of a string. The hash + table may not have any entries if there aren't any or there + is an error in processing. It is the caller's responsibility + to destroy the created GHashTable. + +mi : +DbusmenuMenuitem that we're interested in the properties of + +Returns : A brand new GHashTable that contains all of the + properties that are on this DbusmenuMenuitem mi. + + + +dbusmenu_menuitem_property_remove () +dbusmenu_menuitem_property_remove +void dbusmenu_menuitem_property_remove (DbusmenuMenuitem *mi, + const gchar *property); + +Removes a property from the menuitem. + +mi : +The DbusmenuMenuitem to remove the property on. + +property : +The property to look for. + + + +dbusmenu_menuitem_set_root () +dbusmenu_menuitem_set_root +void dbusmenu_menuitem_set_root (DbusmenuMenuitem *mi, + gboolean root); + +This function sets the internal value of whether this is a + root node or not. + +mi : +DbusmenuMenuitem to set whether it's root + +root : +Whether mi is a root node or not + + + +dbusmenu_menuitem_get_root () +dbusmenu_menuitem_get_root +gboolean dbusmenu_menuitem_get_root (DbusmenuMenuitem *mi); + +This function returns the internal value of whether this is a + root node or not. + +mi : +DbusmenuMenuitem to see whether it's root + +Returns : TRUE if this is a root node + + + +dbusmenu_menuitem_foreach () +dbusmenu_menuitem_foreach +void dbusmenu_menuitem_foreach (DbusmenuMenuitem *mi, + void (funcDbusmenuMenuitem * mi, gpointer data) (), + gpointer data); + +This calls the function func on this menu item and all + of the children of this item. And their children. And + their children. And... you get the point. It will get + called on the whole tree. + +mi : +The DbusmenItem to start from + +data : + User data to pass to the function. closure + + +dbusmenu_menuitem_handle_event () +dbusmenu_menuitem_handle_event +void dbusmenu_menuitem_handle_event (DbusmenuMenuitem *mi, + const gchar *name, + const GValue *value, + guint timestamp); + +This function is called to create an event. It is likely + to be overrided by subclasses. The default menu item + will respond to the activate signal and do: + + + Emits the "item-activate" signal on this + menu item. Called by server objects when they get the + appropriate DBus signals from the client. + + + If you subclass this function you should really think + about calling the parent function unless you have a good + reason not to. + +mi : +The DbusmenuMenuitem to send the signal on. + +name : +The name of the signal + +value : +A value that could be set for the event + +timestamp : +The timestamp of when the event happened + + + +dbusmenu_menuitem_send_about_to_show () +dbusmenu_menuitem_send_about_to_show +void dbusmenu_menuitem_send_about_to_show + (DbusmenuMenuitem *mi, + dbusmenu_menuitem_about_to_show_cb cb, + gpointer cb_data); + +This function is used to send the even that the submenu + of this item is about to be shown. Callers to this event + should delay showing the menu until their callback is + called if possible. + +mi : +The DbusmenuMenuitem to send the signal on. + +cb : +Callback to call when the call has returned. + +cb_data : + Data to pass to the callback.. closure + + + + +Property Details +The <literal>"id"</literal> property +DbusmenuMenuitem:id + "id" gint : Read / Write / Construct Only +This is a unique indentifier for the menu item.Allowed values: [G_MAXULONG,30000] +Default value: -1 + + + +Signal Details +The <literal>"child-added"</literal> signal +DbusmenuMenuitem::child-added +void user_function (DbusmenuMenuitem *arg0, + GObject *arg1, + guint arg2, + gpointer user_data) : Run Last + +Signaled when the child menuitem has been added to + the parent. + +arg0 : +The DbusmenuMenuitem which is the parent. + +arg1 : +The DbusmenuMenuitem which is the child. + +arg2 : +The position that the child is being added in. + +user_data : +user data set when the signal handler was connected. +The <literal>"child-moved"</literal> signal +DbusmenuMenuitem::child-moved +void user_function (DbusmenuMenuitem *arg0, + GObject *arg1, + guint arg2, + guint arg3, + gpointer user_data) : Run Last + +Signaled when the child menuitem has had it's location + in the list change. + +arg0 : +The DbusmenuMenuitem which is the parent. + +arg1 : +The DbusmenuMenuitem which is the child. + +arg2 : +The position that the child is being moved to. + +arg3 : +The position that the child is was in. + +user_data : +user data set when the signal handler was connected. +The <literal>"child-removed"</literal> signal +DbusmenuMenuitem::child-removed +void user_function (DbusmenuMenuitem *arg0, + GObject *arg1, + gpointer user_data) : Run Last + +Signaled when the child menuitem has been requested to + be removed from the parent. This signal is called when + it has been removed from the list but not yet had + g_object_unref called on it. + +arg0 : +The DbusmenuMenuitem which was the parent. + +arg1 : +The DbusmenuMenuitem which was the child. + +user_data : +user data set when the signal handler was connected. +The <literal>"item-activated"</literal> signal +DbusmenuMenuitem::item-activated +void user_function (DbusmenuMenuitem *arg0, + guint arg1, + gpointer user_data) : Run Last + +Emitted on the objects on the server side when + they are signaled on the client side. + +arg0 : +The DbusmenuMenuitem object. + +arg1 : +The timestamp of when it was activated + +user_data : +user data set when the signal handler was connected. +The <literal>"property-changed"</literal> signal +DbusmenuMenuitem::property-changed +void user_function (DbusmenuMenuitem *arg0, + gchar *arg1, + gpointer arg2, + gpointer user_data) : Run Last + +Emitted everytime a property on a menuitem is either + updated or added. + +arg0 : +The DbusmenuMenuitem object. + +arg1 : +The name of the property that changed + +arg2 : +The new value of the property + +user_data : +user data set when the signal handler was connected. +The <literal>"realized"</literal> signal +DbusmenuMenuitem::realized +void user_function (DbusmenuMenuitem *arg0, + gpointer user_data) : Run Last + +Emitted when the initial request for properties + is complete on the item. If there is a type + handler configured for the "type" parameter + that will be executed before this is signaled. + +arg0 : +The DbusmenuMenuitem object. + +user_data : +user data set when the signal handler was connected. + + + + diff --git a/docs/libdbusmenu-glib/reference/xml/server.xml b/docs/libdbusmenu-glib/reference/xml/server.xml new file mode 100644 index 0000000..1390c03 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/server.xml @@ -0,0 +1,183 @@ + + +]> + + +DbusmenuServer +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuServer + + + + +Synopsis + +#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +#define DBUSMENU_SERVER_PROP_DBUS_OBJECT +#define DBUSMENU_SERVER_PROP_ROOT_NODE +#define DBUSMENU_SERVER_PROP_VERSION + DbusmenuServerClass; +DbusmenuServer * dbusmenu_server_new (const gchar *object); +void dbusmenu_server_set_root (DbusmenuServer *server, + DbusmenuMenuitem *root); + + + + +Description + + + + +Details + +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" + + + + +DBUSMENU_SERVER_SIGNAL_ID_UPDATE +DBUSMENU_SERVER_SIGNAL_ID_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" + + + + +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" + + + + +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED + + + + +DBUSMENU_SERVER_PROP_DBUS_OBJECT +DBUSMENU_SERVER_PROP_DBUS_OBJECT +#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" + + + + +DBUSMENU_SERVER_PROP_ROOT_NODE +DBUSMENU_SERVER_PROP_ROOT_NODE +#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" + + + + +DBUSMENU_SERVER_PROP_VERSION +DBUSMENU_SERVER_PROP_VERSION +#define DBUSMENU_SERVER_PROP_VERSION "version" + + + + +DbusmenuServerClass +DbusmenuServerClass +typedef struct { + GObjectClass parent_class; + + /* Signals */ + void (*id_prop_update)(gint id, gchar * property, gchar * value); + void (*id_update)(gint id); + void (*layout_updated)(gint revision); + + /* Reserved */ + void (*dbusmenu_server_reserved1)(void); + void (*dbusmenu_server_reserved2)(void); + void (*dbusmenu_server_reserved3)(void); + void (*dbusmenu_server_reserved4)(void); +} DbusmenuServerClass; + + +The class implementing the virtual functions for DbusmenuServer. + +GObjectClass parent_class; +GObjectClass + + +id_prop_update () +Slot for "id-prop-update". + + +id_update () +Slot for "id-update". + + +layout_updated () +Slot for "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. + + + + +dbusmenu_server_new () +dbusmenu_server_new +DbusmenuServer * dbusmenu_server_new (const gchar *object); + +Creates a new DbusmenuServer object with a specific object + path on DBus. If object is set to NULL the default object + name of "/org/ayatana/dbusmenu" will be used. + +object : +The object name to show for this menu structure + on DBus. May be NULL. + +Returns : A brand new DbusmenuServer + + + +dbusmenu_server_set_root () +dbusmenu_server_set_root +void dbusmenu_server_set_root (DbusmenuServer *server, + DbusmenuMenuitem *root); + +This function contains all of the GValue wrapping + required to set the property "root-node" + on the server self. + +server : + + +root : +The new root DbusmenuMenuitem tree + + + + + + -- cgit v1.2.3 From c4f60378cd36a80b5206ecbe41013544978890b5 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 10 Jun 2010 12:36:23 -0500 Subject: Trying to delete some files that aren't in the tarball --- .../reference/xml/dbusmenu-client.xml | 657 --------------------- .../reference/xml/dbusmenu-server.xml | 462 --------------- 2 files changed, 1119 deletions(-) delete mode 100644 docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml delete mode 100644 docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml (limited to 'docs/libdbusmenu-glib/reference/xml') diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml deleted file mode 100644 index f7244f7..0000000 --- a/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml +++ /dev/null @@ -1,657 +0,0 @@ - - -]> - - -dbusmenu-client -3 - - LIBDBUSMENU-GLIB Library - - - -dbusmenu-client - - - - -Synopsis - -#define DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu -gboolean org_ayatana_dbusmenu_get_layout (DBusGProxy *proxy, - const gint IN_parentId, - guint *OUT_revision, - char **OUT_layout); -void (*org_ayatana_dbusmenu_get_layout_reply) - (DBusGProxy *proxy, - guint OUT_revision, - char *OUT_layout, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_get_layout_async - (DBusGProxy *proxy, - const gint IN_parentId, - org_ayatana_dbusmenu_get_layout_reply callback); -return dbus_g_proxy_begin_call (proxy Param1); -gboolean org_ayatana_dbusmenu_get_group_properties - (DBusGProxy *proxy, - const GArray *IN_ids, - const char **IN_propertyNames, - GPtrArray **OUT_properties); -void (*org_ayatana_dbusmenu_get_group_properties_reply) - (DBusGProxy *proxy, - GPtrArray *OUT_properties, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_get_group_properties_async - (DBusGProxy *proxy, - const GArray *IN_ids, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_group_properties_reply callback); -gboolean org_ayatana_dbusmenu_get_children (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - GPtrArray **OUT_properties); -void (*org_ayatana_dbusmenu_get_children_reply) - (DBusGProxy *proxy, - GPtrArray *OUT_properties, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_get_children_async - (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_children_reply callback); -gboolean org_ayatana_dbusmenu_get_property (DBusGProxy *proxy, - const gint IN_id, - const char *IN_name, - GValue *OUT_value); -void (*org_ayatana_dbusmenu_get_property_reply) - (DBusGProxy *proxy, - GValue OUT_value, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_get_property_async - (DBusGProxy *proxy, - const gint IN_id, - const char *IN_name, - org_ayatana_dbusmenu_get_property_reply callback); -gboolean org_ayatana_dbusmenu_get_properties (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - GHashTable **OUT_properties); -void (*org_ayatana_dbusmenu_get_properties_reply) - (DBusGProxy *proxy, - GHashTable *OUT_properties, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_get_properties_async - (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_properties_reply callback); -gboolean org_ayatana_dbusmenu_event (DBusGProxy *proxy, - const gint IN_id, - const char *IN_eventId, - const GValue *IN_data, - const guint IN_timestamp); -void (*org_ayatana_dbusmenu_event_reply) (DBusGProxy *proxy, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_event_async (DBusGProxy *proxy, - const gint IN_id, - const char *IN_eventId, - const GValue *IN_data, - const guint IN_timestamp, - org_ayatana_dbusmenu_event_reply callback); -gboolean org_ayatana_dbusmenu_about_to_show (DBusGProxy *proxy, - const gint IN_id, - gboolean *OUT_needUpdate); -void (*org_ayatana_dbusmenu_about_to_show_reply) - (DBusGProxy *proxy, - gboolean OUT_needUpdate, - GError *error, - gpointer userdata); -DBusGProxyCall * org_ayatana_dbusmenu_about_to_show_async - (DBusGProxy *proxy, - const gint IN_id, - org_ayatana_dbusmenu_about_to_show_reply callback); - - - - -Description - - - - -Details - -DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu -DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu -#define DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu - - - - -org_ayatana_dbusmenu_get_layout () -org_ayatana_dbusmenu_get_layout -gboolean org_ayatana_dbusmenu_get_layout (DBusGProxy *proxy, - const gint IN_parentId, - guint *OUT_revision, - char **OUT_layout); - - -proxy : - - -IN_parentId : - - -OUT_revision : - - -OUT_layout : - - -Returns : - - - -org_ayatana_dbusmenu_get_layout_reply () -org_ayatana_dbusmenu_get_layout_reply -void (*org_ayatana_dbusmenu_get_layout_reply) - (DBusGProxy *proxy, - guint OUT_revision, - char *OUT_layout, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_revision : - - -OUT_layout : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_get_layout_async () -org_ayatana_dbusmenu_get_layout_async -DBusGProxyCall * org_ayatana_dbusmenu_get_layout_async - (DBusGProxy *proxy, - const gint IN_parentId, - org_ayatana_dbusmenu_get_layout_reply callback); - - -proxy : - - -IN_parentId : - - -callback : - - -Returns : - - - -dbus_g_proxy_begin_call () -dbus_g_proxy_begin_call -return dbus_g_proxy_begin_call (proxy Param1); - - -Param1 : - - -Returns : - - - -org_ayatana_dbusmenu_get_group_properties () -org_ayatana_dbusmenu_get_group_properties -gboolean org_ayatana_dbusmenu_get_group_properties - (DBusGProxy *proxy, - const GArray *IN_ids, - const char **IN_propertyNames, - GPtrArray **OUT_properties); - - -proxy : - - -IN_ids : - - -IN_propertyNames : - - -OUT_properties : - - -Returns : - - - -org_ayatana_dbusmenu_get_group_properties_reply () -org_ayatana_dbusmenu_get_group_properties_reply -void (*org_ayatana_dbusmenu_get_group_properties_reply) - (DBusGProxy *proxy, - GPtrArray *OUT_properties, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_properties : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_get_group_properties_async () -org_ayatana_dbusmenu_get_group_properties_async -DBusGProxyCall * org_ayatana_dbusmenu_get_group_properties_async - (DBusGProxy *proxy, - const GArray *IN_ids, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_group_properties_reply callback); - - -proxy : - - -IN_ids : - - -IN_propertyNames : - - -callback : - - -Returns : - - - -org_ayatana_dbusmenu_get_children () -org_ayatana_dbusmenu_get_children -gboolean org_ayatana_dbusmenu_get_children (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - GPtrArray **OUT_properties); - - -proxy : - - -IN_id : - - -IN_propertyNames : - - -OUT_properties : - - -Returns : - - - -org_ayatana_dbusmenu_get_children_reply () -org_ayatana_dbusmenu_get_children_reply -void (*org_ayatana_dbusmenu_get_children_reply) - (DBusGProxy *proxy, - GPtrArray *OUT_properties, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_properties : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_get_children_async () -org_ayatana_dbusmenu_get_children_async -DBusGProxyCall * org_ayatana_dbusmenu_get_children_async - (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_children_reply callback); - - -proxy : - - -IN_id : - - -IN_propertyNames : - - -callback : - - -Returns : - - - -org_ayatana_dbusmenu_get_property () -org_ayatana_dbusmenu_get_property -gboolean org_ayatana_dbusmenu_get_property (DBusGProxy *proxy, - const gint IN_id, - const char *IN_name, - GValue *OUT_value); - - -proxy : - - -IN_id : - - -IN_name : - - -OUT_value : - - -Returns : - - - -org_ayatana_dbusmenu_get_property_reply () -org_ayatana_dbusmenu_get_property_reply -void (*org_ayatana_dbusmenu_get_property_reply) - (DBusGProxy *proxy, - GValue OUT_value, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_value : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_get_property_async () -org_ayatana_dbusmenu_get_property_async -DBusGProxyCall * org_ayatana_dbusmenu_get_property_async - (DBusGProxy *proxy, - const gint IN_id, - const char *IN_name, - org_ayatana_dbusmenu_get_property_reply callback); - - -proxy : - - -IN_id : - - -IN_name : - - -callback : - - -Returns : - - - -org_ayatana_dbusmenu_get_properties () -org_ayatana_dbusmenu_get_properties -gboolean org_ayatana_dbusmenu_get_properties (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - GHashTable **OUT_properties); - - -proxy : - - -IN_id : - - -IN_propertyNames : - - -OUT_properties : - - -Returns : - - - -org_ayatana_dbusmenu_get_properties_reply () -org_ayatana_dbusmenu_get_properties_reply -void (*org_ayatana_dbusmenu_get_properties_reply) - (DBusGProxy *proxy, - GHashTable *OUT_properties, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_properties : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_get_properties_async () -org_ayatana_dbusmenu_get_properties_async -DBusGProxyCall * org_ayatana_dbusmenu_get_properties_async - (DBusGProxy *proxy, - const gint IN_id, - const char **IN_propertyNames, - org_ayatana_dbusmenu_get_properties_reply callback); - - -proxy : - - -IN_id : - - -IN_propertyNames : - - -callback : - - -Returns : - - - -org_ayatana_dbusmenu_event () -org_ayatana_dbusmenu_event -gboolean org_ayatana_dbusmenu_event (DBusGProxy *proxy, - const gint IN_id, - const char *IN_eventId, - const GValue *IN_data, - const guint IN_timestamp); - - -proxy : - - -IN_id : - - -IN_eventId : - - -IN_data : - - -IN_timestamp : - - -Returns : - - - -org_ayatana_dbusmenu_event_reply () -org_ayatana_dbusmenu_event_reply -void (*org_ayatana_dbusmenu_event_reply) (DBusGProxy *proxy, - GError *error, - gpointer userdata); - - -proxy : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_event_async () -org_ayatana_dbusmenu_event_async -DBusGProxyCall * org_ayatana_dbusmenu_event_async (DBusGProxy *proxy, - const gint IN_id, - const char *IN_eventId, - const GValue *IN_data, - const guint IN_timestamp, - org_ayatana_dbusmenu_event_reply callback); - - -proxy : - - -IN_id : - - -IN_eventId : - - -IN_data : - - -IN_timestamp : - - -callback : - - -Returns : - - - -org_ayatana_dbusmenu_about_to_show () -org_ayatana_dbusmenu_about_to_show -gboolean org_ayatana_dbusmenu_about_to_show (DBusGProxy *proxy, - const gint IN_id, - gboolean *OUT_needUpdate); - - -proxy : - - -IN_id : - - -OUT_needUpdate : - - -Returns : - - - -org_ayatana_dbusmenu_about_to_show_reply () -org_ayatana_dbusmenu_about_to_show_reply -void (*org_ayatana_dbusmenu_about_to_show_reply) - (DBusGProxy *proxy, - gboolean OUT_needUpdate, - GError *error, - gpointer userdata); - - -proxy : - - -OUT_needUpdate : - - -error : - - -userdata : - - - - -org_ayatana_dbusmenu_about_to_show_async () -org_ayatana_dbusmenu_about_to_show_async -DBusGProxyCall * org_ayatana_dbusmenu_about_to_show_async - (DBusGProxy *proxy, - const gint IN_id, - org_ayatana_dbusmenu_about_to_show_reply callback); - - -proxy : - - -IN_id : - - -callback : - - -Returns : - - - - - - diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml deleted file mode 100644 index 836e1d6..0000000 --- a/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml +++ /dev/null @@ -1,462 +0,0 @@ - - -]> - - -dbusmenu-server -3 - - LIBDBUSMENU-GLIB Library - - - -dbusmenu-server - - - - -Synopsis - -#define g_marshal_value_peek_boolean (v) -#define g_marshal_value_peek_char (v) -#define g_marshal_value_peek_uchar (v) -#define g_marshal_value_peek_int (v) -#define g_marshal_value_peek_uint (v) -#define g_marshal_value_peek_long (v) -#define g_marshal_value_peek_ulong (v) -#define g_marshal_value_peek_int64 (v) -#define g_marshal_value_peek_uint64 (v) -#define g_marshal_value_peek_enum (v) -#define g_marshal_value_peek_flags (v) -#define g_marshal_value_peek_float (v) -#define g_marshal_value_peek_double (v) -#define g_marshal_value_peek_string (v) -#define g_marshal_value_peek_param (v) -#define g_marshal_value_peek_boxed (v) -#define g_marshal_value_peek_pointer (v) -#define g_marshal_value_peek_object (v) -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - - - -Description - - - - -Details - -g_marshal_value_peek_boolean() -g_marshal_value_peek_boolean -#define g_marshal_value_peek_boolean(v) - - -v : - - - - -g_marshal_value_peek_char() -g_marshal_value_peek_char -#define g_marshal_value_peek_char(v) - - -v : - - - - -g_marshal_value_peek_uchar() -g_marshal_value_peek_uchar -#define g_marshal_value_peek_uchar(v) - - -v : - - - - -g_marshal_value_peek_int() -g_marshal_value_peek_int -#define g_marshal_value_peek_int(v) - - -v : - - - - -g_marshal_value_peek_uint() -g_marshal_value_peek_uint -#define g_marshal_value_peek_uint(v) - - -v : - - - - -g_marshal_value_peek_long() -g_marshal_value_peek_long -#define g_marshal_value_peek_long(v) - - -v : - - - - -g_marshal_value_peek_ulong() -g_marshal_value_peek_ulong -#define g_marshal_value_peek_ulong(v) - - -v : - - - - -g_marshal_value_peek_int64() -g_marshal_value_peek_int64 -#define g_marshal_value_peek_int64(v) - - -v : - - - - -g_marshal_value_peek_uint64() -g_marshal_value_peek_uint64 -#define g_marshal_value_peek_uint64(v) - - -v : - - - - -g_marshal_value_peek_enum() -g_marshal_value_peek_enum -#define g_marshal_value_peek_enum(v) - - -v : - - - - -g_marshal_value_peek_flags() -g_marshal_value_peek_flags -#define g_marshal_value_peek_flags(v) - - -v : - - - - -g_marshal_value_peek_float() -g_marshal_value_peek_float -#define g_marshal_value_peek_float(v) - - -v : - - - - -g_marshal_value_peek_double() -g_marshal_value_peek_double -#define g_marshal_value_peek_double(v) - - -v : - - - - -g_marshal_value_peek_string() -g_marshal_value_peek_string -#define g_marshal_value_peek_string(v) - - -v : - - - - -g_marshal_value_peek_param() -g_marshal_value_peek_param -#define g_marshal_value_peek_param(v) - - -v : - - - - -g_marshal_value_peek_boxed() -g_marshal_value_peek_boxed -#define g_marshal_value_peek_boxed(v) - - -v : - - - - -g_marshal_value_peek_pointer() -g_marshal_value_peek_pointer -#define g_marshal_value_peek_pointer(v) - - -v : - - - - -g_marshal_value_peek_object() -g_marshal_value_peek_object -#define g_marshal_value_peek_object(v) - - -v : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - -dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER () -dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER -void dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER - (GClosure *closure, - GValue *return_value, - guint n_param_values, - const GValue *param_values, - gpointer invocation_hint, - gpointer marshal_data); - - -closure : - - -return_value : - - -n_param_values : - - -param_values : - - -invocation_hint : - - -marshal_data : - - - - - - - -- cgit v1.2.3