blob: 5074b523868ee134894bfd6bbf2ffa28819669dd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<?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-gtk-DbusmenuGtkMenu">
<refmeta>
<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkMenu.top_of_page">DbusmenuGtkMenu</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
LIBDBUSMENU-GTK Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DbusmenuGtkMenu</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkMenu.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>#define <link linkend="DBUSMENU-GTKMENU-TYPE:CAPS">DBUSMENU_GTKMENU_TYPE</link>
<link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>;
<link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-new">dbusmenu_gtkmenu_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>,
<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>);
<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link> (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="DBUSMENU-GTKMENU-TYPE:CAPS" role="macro">
<title>DBUSMENU_GTKMENU_TYPE</title>
<indexterm zone="DBUSMENU-GTKMENU-TYPE:CAPS"><primary>DBUSMENU_GTKMENU_TYPE</primary></indexterm>
<programlisting>#define DBUSMENU_GTKMENU_TYPE (dbusmenu_gtkmenu_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DbusmenuGtkMenuClass" role="struct">
<title>DbusmenuGtkMenuClass</title>
<indexterm zone="DbusmenuGtkMenuClass"><primary>DbusmenuGtkMenuClass</primary></indexterm>
<programlisting>typedef struct {
GtkMenuClass parent_class;
/* Reserved */
void (*reserved1) (void);
void (*reserved2) (void);
void (*reserved3) (void);
void (*reserved4) (void);
} DbusmenuGtkMenuClass;
</programlisting>
<variablelist role="struct">
<varlistentry><term><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link> <structfield id="DbusmenuGtkMenuClass.parent-class">parent_class</structfield>;</term>
<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link>
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved1">reserved1</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved2">reserved2</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved3">reserved3</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved4">reserved4</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="dbusmenu-gtkmenu-new" role="function">
<title>dbusmenu_gtkmenu_new ()</title>
<indexterm zone="dbusmenu-gtkmenu-new"><primary>dbusmenu_gtkmenu_new</primary></indexterm>
<programlisting><link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * dbusmenu_gtkmenu_new (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>,
<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>);</programlisting>
<para>
Creates a new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> object and creates a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>
that connects across DBus to a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>dbus_name</parameter> :</term>
<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dbus_object</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> sync'd with a server
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="dbusmenu-gtkmenu-get-client" role="function">
<title>dbusmenu_gtkmenu_get_client ()</title>
<indexterm zone="dbusmenu-gtkmenu-get-client"><primary>dbusmenu_gtkmenu_get_client</primary></indexterm>
<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkmenu_get_client (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>);</programlisting>
<para>
An accessor for the client that this menu is using to
communicate with the server.
</para><variablelist role="params">
<varlistentry><term><parameter>menu</parameter> :</term>
<listitem><simpara>The <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> to get the client from
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A valid <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> or NULL on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
