diff options
Diffstat (limited to 'docs/libdbusmenu-glib/reference/xml/server.xml')
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/server.xml | 309 |
1 files changed, 0 insertions, 309 deletions
diff --git a/docs/libdbusmenu-glib/reference/xml/server.xml b/docs/libdbusmenu-glib/reference/xml/server.xml deleted file mode 100644 index 4f8f68a..0000000 --- a/docs/libdbusmenu-glib/reference/xml/server.xml +++ /dev/null @@ -1,309 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-DbusmenuServer"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuServer.top_of_page">DbusmenuServer</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuServer</refname> -<refpurpose>The server signals changed and - updates on a tree of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objecs.</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-DbusmenuServer.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-DbusmenuServer.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/server.h> - -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS">DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</link> -#define <link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link> -#define <link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link> -#define <link linkend="DBUSMENU-SERVER-PROP-STATUS:CAPS">DBUSMENU_SERVER_PROP_STATUS</link> -#define <link linkend="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS">DBUSMENU_SERVER_PROP_TEXT_DIRECTION</link> -#define <link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link> - <link linkend="DbusmenuServer">DbusmenuServer</link>; -struct <link linkend="DbusmenuServerClass">DbusmenuServerClass</link>; -<link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * <link linkend="dbusmenu-server-new">dbusmenu_server_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>); -<link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> <link linkend="dbusmenu-server-get-status">dbusmenu_server_get_status</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>); -<link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> <link linkend="dbusmenu-server-get-text-direction">dbusmenu_server_get_text_direction</link> - (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *self</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-status">dbusmenu_server_set_status</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> status</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-text-direction">dbusmenu_server_set_text_direction</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> dir</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-DbusmenuServer.description" role="desc"> -<title role="desc.title">Description</title> -<para> -A <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> is the object that represents the local - tree of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects on DBus. It watches the - various signals that those objects emit and correctly - represents them across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> so that - the same tree can be maintained in another process. -</para> -<para> - The server needs to have the root set of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> - objects set via <link linkend="dbusmenu-server-set-root"><type>dbusmenu_server_set_root</type></link> but it will query - all of the objects in that tree automatically. After setting - the root there should be no other maintence required by - users of the server class. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-DbusmenuServer.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-property-updated"><type>"item-property-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-updated"><type>"item-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-layout-updated"><type>"layout-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-layout-updated"><type>"layout-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION "item-activation-requested" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-activation-requested"><type>"item-activation-requested"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_DBUS_OBJECT</title> -<indexterm zone="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_SERVER_PROP_DBUS_OBJECT</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--dbus-object"><type>"dbus-object"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_ROOT_NODE</title> -<indexterm zone="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><primary>DBUSMENU_SERVER_PROP_ROOT_NODE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-STATUS:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_STATUS</title> -<indexterm zone="DBUSMENU-SERVER-PROP-STATUS:CAPS"><primary>DBUSMENU_SERVER_PROP_STATUS</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_STATUS "status" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--status"><type>"status"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_TEXT_DIRECTION</title> -<indexterm zone="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS"><primary>DBUSMENU_SERVER_PROP_TEXT_DIRECTION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION "text-direction" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--text-direction"><type>"text-direction"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-VERSION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_VERSION</title> -<indexterm zone="DBUSMENU-SERVER-PROP-VERSION:CAPS"><primary>DBUSMENU_SERVER_PROP_VERSION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_VERSION "version" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--version"><type>"version"</type></link> -</para></refsect2> -<refsect2 id="DbusmenuServer" role="struct"> -<title>DbusmenuServer</title> -<indexterm zone="DbusmenuServer"><primary>DbusmenuServer</primary></indexterm> -<programlisting>typedef struct _DbusmenuServer DbusmenuServer;</programlisting> -<para> -A server which represents a sharing of a set of - <link linkend="DbusmenuMenuitems"><type>DbusmenuMenuitems</type></link> across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. -</para></refsect2> -<refsect2 id="DbusmenuServerClass" role="struct"> -<title>struct DbusmenuServerClass</title> -<indexterm zone="DbusmenuServerClass"><primary>DbusmenuServerClass</primary></indexterm> -<programlisting>struct DbusmenuServerClass { - GObjectClass parent_class; - - /* Signals */ - void (*id_prop_update)(gint id, gchar * property, gchar * value); - void (*id_update)(gint id); - void (*layout_updated)(gint revision); - void (*item_activation)(gint id, guint timestamp); - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); - void (*reserved6) (void); -}; -</programlisting> -<para> -The class implementing the virtual functions for <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuServerClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.id-prop-update">id_prop_update</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-prop-update"><type>"id-prop-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.id-update">id_update</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-update"><type>"id-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.layout-updated">layout_updated</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-layout-update"><type>"layout-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.item-activation">item_activation</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-item-activation-requested"><type>"item-activation-requested"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-new" role="function"> -<title>dbusmenu_server_new ()</title> -<indexterm zone="dbusmenu-server-new"><primary>dbusmenu_server_new</primary></indexterm> -<programlisting><link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * dbusmenu_server_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting> -<para> -Creates a new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object with a specific object - path on DBus. If <parameter>object</parameter> is set to NULL the default object - name of "/com/canonical/dbusmenu" will be used. -</para><variablelist role="params"> -<varlistentry><term><parameter>object</parameter> :</term> -<listitem><simpara>The object name to show for this menu structure -on DBus. May be NULL.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A brand new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-get-status" role="function"> -<title>dbusmenu_server_get_status ()</title> -<indexterm zone="dbusmenu-server-get-status"><primary>dbusmenu_server_get_status</primary></indexterm> -<programlisting><link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> dbusmenu_server_get_status (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>);</programlisting> -<para> -Gets the current statust hat the server is sending out over - DBus. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to get the status from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The current status the server is sending</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-get-text-direction" role="function"> -<title>dbusmenu_server_get_text_direction ()</title> -<indexterm zone="dbusmenu-server-get-text-direction"><primary>dbusmenu_server_get_text_direction</primary></indexterm> -<programlisting><link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> dbusmenu_server_get_text_direction - (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>);</programlisting> -<para> -Returns the value of the text direction that is being exported - over DBus for this server. It should relate to the direction - of the labels and other text fields that are being exported by - this server. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to get the text direction from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Text direction exported for this server.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-root" role="function"> -<title>dbusmenu_server_set_root ()</title> -<indexterm zone="dbusmenu-server-set-root"><primary>dbusmenu_server_set_root</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_root (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *self</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>);</programlisting> -<para> -This function contains all of the <link linkend="GValue"><type>GValue</type></link> wrapping - required to set the property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link> - on the server <parameter>self</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>self</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to set the root on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>root</parameter> :</term> -<listitem><simpara>The new root <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> tree</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-status" role="function"> -<title>dbusmenu_server_set_status ()</title> -<indexterm zone="dbusmenu-server-set-status"><primary>dbusmenu_server_set_status</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_status (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> status</parameter>);</programlisting> -<para> -Changes the status of the server. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to set the status on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>status</parameter> :</term> -<listitem><simpara>Status value to set on the server</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-text-direction" role="function"> -<title>dbusmenu_server_set_text_direction ()</title> -<indexterm zone="dbusmenu-server-set-text-direction"><primary>dbusmenu_server_set_text_direction</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_text_direction (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> dir</parameter>);</programlisting> -<para> -Sets the text direction that should be exported over DBus for - this server. If the value is set to <link linkend="DBUSMENU-TEXT-DIRECTION-NONE:CAPS"><type>DBUSMENU_TEXT_DIRECTION_NONE</type></link> - the default detection will be used for setting the value and - exported over DBus. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to set the text direction on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dir</parameter> :</term> -<listitem><simpara>Direction of the text</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> |