diff options
author | Ted Gould <ted@gould.cx> | 2011-02-24 15:04:39 -0600 |
---|---|---|
committer | Ted Gould <ted@gould.cx> | 2011-02-24 15:04:39 -0600 |
commit | f8fed10917f0f2ebba16d2d6628fad2d2d46c04e (patch) | |
tree | 38af9ba8014eff7907c5ae06bcad13f441787abf /docs/libdbusmenu-glib/reference/tmpl | |
parent | 44927e6da03d633f0958ce5e04e62e752a43d201 (diff) | |
parent | f5ef3600b66047f13796972ee40acf7b50b81790 (diff) | |
download | libdbusmenu-f8fed10917f0f2ebba16d2d6628fad2d2d46c04e.tar.gz libdbusmenu-f8fed10917f0f2ebba16d2d6628fad2d2d46c04e.tar.bz2 libdbusmenu-f8fed10917f0f2ebba16d2d6628fad2d2d46c04e.zip |
Import upstream version 0.3.99
Diffstat (limited to 'docs/libdbusmenu-glib/reference/tmpl')
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/client.sgml | 222 | ||||
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/libdbusmenu-glib-unused.sgml | 0 | ||||
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml | 59 | ||||
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml | 635 | ||||
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/server.sgml | 171 | ||||
-rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/types.sgml | 109 |
6 files changed, 1196 insertions, 0 deletions
diff --git a/docs/libdbusmenu-glib/reference/tmpl/client.sgml b/docs/libdbusmenu-glib/reference/tmpl/client.sgml new file mode 100644 index 0000000..ac87e1e --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/client.sgml @@ -0,0 +1,222 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuClient + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_PROP_DBUS_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_PROP_DBUS_OBJECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_PROP_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_PROP_TEXT_DIRECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_TYPES_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_TYPES_SEPARATOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_CLIENT_TYPES_IMAGE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT DbusmenuClient ##### --> +<para> + +</para> + + +<!-- ##### STRUCT DbusmenuClientClass ##### --> +<para> + +</para> + +@parent_class: +@layout_updated: +@root_changed: +@new_menuitem: +@item_activate: +@event_result: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + +<!-- ##### USER_FUNCTION DbusmenuClientTypeHandler ##### --> +<para> + +</para> + +@newitem: +@parent: +@client: +@user_data: +@Returns: + + +<!-- ##### USER_FUNCTION DbusmenuClientTypeDestroyHandler ##### --> +<para> + +</para> + +@client: +@type: +@user_data: + + +<!-- ##### FUNCTION dbusmenu_client_new ##### --> +<para> + +</para> + +@name: +@object: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_client_get_root ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_client_get_status ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_client_get_text_direction ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_client_add_type_handler ##### --> +<para> + +</para> + +@client: +@type: +@newfunc: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_client_add_type_handler_full ##### --> +<para> + +</para> + +@client: +@type: +@newfunc: +@user_data: +@destroy_func: +@Returns: + + diff --git a/docs/libdbusmenu-glib/reference/tmpl/libdbusmenu-glib-unused.sgml b/docs/libdbusmenu-glib/reference/tmpl/libdbusmenu-glib-unused.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/libdbusmenu-glib-unused.sgml diff --git a/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml b/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml new file mode 100644 index 0000000..503c293 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml @@ -0,0 +1,59 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuMenuitemProxy + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT DbusmenuMenuitemProxy ##### --> +<para> + +</para> + + +<!-- ##### STRUCT DbusmenuMenuitemProxyClass ##### --> +<para> + +</para> + +@parent_class: +@reserved1: +@reserved2: +@reserved3: +@reserved4: + +<!-- ##### FUNCTION dbusmenu_menuitem_proxy_new ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_proxy_get_wrapped ##### --> +<para> + +</para> + +@pmi: +@Returns: + + diff --git a/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml b/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml new file mode 100644 index 0000000..c45f2c9 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml @@ -0,0 +1,635 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuMenuitem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_EVENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_REALIZED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_VISIBLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_LABEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_ICON_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_ICON_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_TOGGLE_STATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_PROP_SHORTCUT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_TOGGLE_CHECK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_TOGGLE_RADIO ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_ICON_NAME_BLANK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SHORTCUT_ALT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SHORTCUT_CONTROL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SHORTCUT_SHIFT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_MENUITEM_SHORTCUT_SUPER ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT DbusmenuMenuitem ##### --> +<para> + +</para> + +@parent: +@priv: + +<!-- ##### USER_FUNCTION dbusmenu_menuitem_about_to_show_cb ##### --> +<para> + +</para> + +@mi: +@user_data: + + +<!-- ##### USER_FUNCTION dbusmenu_menuitem_buildvariant_slot_t ##### --> +<para> + +</para> + +@mi: +@properties: +@Returns: + + +<!-- ##### STRUCT DbusmenuMenuitemClass ##### --> +<para> + +</para> + +@parent_class: +@property_changed: +@item_activated: +@child_added: +@child_removed: +@child_moved: +@realized: +@buildvariant: +@handle_event: +@show_to_user: +@about_to_show: +@event: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: + +<!-- ##### FUNCTION dbusmenu_menuitem_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_new_with_id ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_id ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_children ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_take_children ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_position ##### --> +<para> + +</para> + +@mi: +@parent: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_position_realized ##### --> +<para> + +</para> + +@mi: +@parent: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_append ##### --> +<para> + +</para> + +@mi: +@child: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_prepend ##### --> +<para> + +</para> + +@mi: +@child: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_delete ##### --> +<para> + +</para> + +@mi: +@child: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_add_position ##### --> +<para> + +</para> + +@mi: +@child: +@position: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_reorder ##### --> +<para> + +</para> + +@mi: +@child: +@position: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_child_find ##### --> +<para> + +</para> + +@mi: +@id: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_find_id ##### --> +<para> + +</para> + +@mi: +@id: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set ##### --> +<para> + +</para> + +@mi: +@property: +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_bool ##### --> +<para> + +</para> + +@mi: +@property: +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_int ##### --> +<para> + +</para> + +@mi: +@property: +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_variant ##### --> +<para> + +</para> + +@mi: +@property: +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get ##### --> +<para> + +</para> + +@mi: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get_bool ##### --> +<para> + +</para> + +@mi: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get_int ##### --> +<para> + +</para> + +@mi: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get_variant ##### --> +<para> + +</para> + +@mi: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_exist ##### --> +<para> + +</para> + +@mi: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_properties_list ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_properties_copy ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_remove ##### --> +<para> + +</para> + +@mi: +@property: + + +<!-- ##### FUNCTION dbusmenu_menuitem_set_root ##### --> +<para> + +</para> + +@mi: +@root: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_root ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_foreach ##### --> +<para> + +</para> + +@mi: +@func: +@data: + + +<!-- ##### FUNCTION dbusmenu_menuitem_handle_event ##### --> +<para> + +</para> + +@mi: +@name: +@variant: +@timestamp: + + +<!-- ##### FUNCTION dbusmenu_menuitem_send_about_to_show ##### --> +<para> + +</para> + +@mi: +@cb: +@cb_data: + + +<!-- ##### FUNCTION dbusmenu_menuitem_show_to_user ##### --> +<para> + +</para> + +@mi: +@timestamp: + + +<!-- ##### FUNCTION dbusmenu_menuitem_get_parent ##### --> +<para> + +</para> + +@mi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_set_parent ##### --> +<para> + +</para> + +@mi: +@parent: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_unparent ##### --> +<para> + +</para> + +@mi: +@Returns: + + diff --git a/docs/libdbusmenu-glib/reference/tmpl/server.sgml b/docs/libdbusmenu-glib/reference/tmpl/server.sgml new file mode 100644 index 0000000..ca9c51e --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/server.sgml @@ -0,0 +1,171 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuServer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_SIGNAL_ID_UPDATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_PROP_DBUS_OBJECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_PROP_ROOT_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_PROP_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_PROP_TEXT_DIRECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_SERVER_PROP_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT DbusmenuServer ##### --> +<para> + +</para> + + +<!-- ##### STRUCT DbusmenuServerClass ##### --> +<para> + +</para> + +@parent_class: +@id_prop_update: +@id_update: +@layout_updated: +@item_activation: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + +<!-- ##### FUNCTION dbusmenu_server_new ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_server_get_status ##### --> +<para> + +</para> + +@server: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_server_get_text_direction ##### --> +<para> + +</para> + +@server: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_server_set_root ##### --> +<para> + +</para> + +@self: +@root: + + +<!-- ##### FUNCTION dbusmenu_server_set_status ##### --> +<para> + +</para> + +@server: +@status: + + +<!-- ##### FUNCTION dbusmenu_server_set_text_direction ##### --> +<para> + +</para> + +@server: +@dir: + + diff --git a/docs/libdbusmenu-glib/reference/tmpl/types.sgml b/docs/libdbusmenu-glib/reference/tmpl/types.sgml new file mode 100644 index 0000000..8a5e419 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/types.sgml @@ -0,0 +1,109 @@ +<!-- ##### SECTION Title ##### --> +Types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_TYPE_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_TYPE_TEXT_DIRECTION ##### --> +<para> + +</para> + + + +<!-- ##### ENUM DbusmenuStatus ##### --> +<para> + +</para> + +@DBUSMENU_STATUS_NORMAL: +@DBUSMENU_STATUS_NOTICE: + +<!-- ##### ENUM DbusmenuTextDirection ##### --> +<para> + +</para> + +@DBUSMENU_TEXT_DIRECTION_NONE: +@DBUSMENU_TEXT_DIRECTION_LTR: +@DBUSMENU_TEXT_DIRECTION_RTL: + +<!-- ##### FUNCTION dbusmenu_status_get_nick ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_status_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_status_get_value_from_nick ##### --> +<para> + +</para> + +@nick: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_text_direction_get_nick ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_text_direction_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_text_direction_get_value_from_nick ##### --> +<para> + +</para> + +@nick: +@Returns: + + |