~ubuntu-branches/ubuntu/precise/rhythmbox/precise-201203091205

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-tray-icon.xml

Tags: upstream-0.9.5
ImportĀ upstreamĀ versionĀ 0.9.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="rhythmbox-rb-tray-icon">
5
5
<refmeta>
6
 
<refentrytitle>rb-tray-icon</refentrytitle>
 
6
<refentrytitle id="top_of_page">rb-tray-icon</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>rb-tray-icon</refname><refpurpose></refpurpose>
 
12
<refname>rb-tray-icon</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
13
15
</refnamediv>
14
16
 
15
 
<refsynopsisdiv><title>Synopsis</title>
 
17
<refsynopsisdiv id="synopsis">
 
18
<title id="synopsis.title">Synopsis</title>
16
19
 
17
20
<synopsis>
18
21
 
20
23
 
21
24
typedef     <link linkend="RBTrayIconPrivate">RBTrayIconPrivate</link>;
22
25
<link linkend="RBTrayIcon">RBTrayIcon</link>* <link linkend="rb-tray-icon-new">rb_tray_icon_new</link>                (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
23
 
                                             <link linkend="RBRemoteProxy">RBRemoteProxy</link> *remote);
 
26
                                             <link linkend="RBShell">RBShell</link> *shell);
24
27
<link linkend="void">void</link>        <link linkend="rb-tray-icon-get-geom">rb_tray_icon_get_geom</link>           (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
25
28
                                             <link linkend="int">int</link> *x,
26
29
                                             <link linkend="int">int</link> *y,
46
49
 
47
50
 
48
51
 
49
 
<refsect1>
50
 
<title>Description</title>
 
52
<refsect1 id="desc">
 
53
<title id="desc.title">Description</title>
51
54
<para>
52
55
 
53
56
</para>
54
57
</refsect1>
55
58
 
56
 
<refsect1>
57
 
<title>Details</title>
 
59
<refsect1 id="details">
 
60
<title id="details.title">Details</title>
58
61
<refsect2>
59
 
<title><anchor id="RBTrayIconPrivate"/>RBTrayIconPrivate</title>
 
62
<title><anchor id="RBTrayIconPrivate" role="typedef"/>RBTrayIconPrivate</title>
60
63
<indexterm><primary>RBTrayIconPrivate</primary></indexterm><programlisting>typedef struct RBTrayIconPrivate RBTrayIconPrivate;
61
64
</programlisting>
62
65
<para>
63
66
 
64
67
</para></refsect2>
65
68
<refsect2>
66
 
<title><anchor id="rb-tray-icon-new"/>rb_tray_icon_new ()</title>
 
69
<title><anchor id="rb-tray-icon-new" role="function"/>rb_tray_icon_new ()</title>
67
70
<indexterm><primary>rb_tray_icon_new</primary></indexterm><programlisting><link linkend="RBTrayIcon">RBTrayIcon</link>* rb_tray_icon_new                (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
68
 
                                             <link linkend="RBRemoteProxy">RBRemoteProxy</link> *remote);</programlisting>
 
71
                                             <link linkend="RBShell">RBShell</link> *shell);</programlisting>
69
72
<para>
70
73
 
71
74
</para><variablelist role="params">
72
75
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
73
76
<listitem><simpara>
74
77
</simpara></listitem></varlistentry>
75
 
<varlistentry><term><parameter>remote</parameter>&nbsp;:</term>
 
78
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
76
79
<listitem><simpara>
77
80
</simpara></listitem></varlistentry>
78
81
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
81
84
</simpara></listitem></varlistentry>
82
85
</variablelist></refsect2>
83
86
<refsect2>
84
 
<title><anchor id="rb-tray-icon-get-geom"/>rb_tray_icon_get_geom ()</title>
 
87
<title><anchor id="rb-tray-icon-get-geom" role="function"/>rb_tray_icon_get_geom ()</title>
85
88
<indexterm><primary>rb_tray_icon_get_geom</primary></indexterm><programlisting><link linkend="void">void</link>        rb_tray_icon_get_geom           (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
86
89
                                             <link linkend="int">int</link> *x,
87
90
                                             <link linkend="int">int</link> *y,
109
112
</simpara></listitem></varlistentry>
110
113
</variablelist></refsect2>
111
114
<refsect2>
112
 
<title><anchor id="rb-tray-icon-notify"/>rb_tray_icon_notify ()</title>
 
115
<title><anchor id="rb-tray-icon-notify" role="function"/>rb_tray_icon_notify ()</title>
113
116
<indexterm><primary>rb_tray_icon_notify</primary></indexterm><programlisting><link linkend="void">void</link>        rb_tray_icon_notify             (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
114
117
                                             <link linkend="guint">guint</link> timeout,
115
118
                                             const <link linkend="char">char</link> *primary,
137
140
</simpara></listitem></varlistentry>
138
141
</variablelist></refsect2>
139
142
<refsect2>
140
 
<title><anchor id="rb-tray-icon-cancel-notify"/>rb_tray_icon_cancel_notify ()</title>
 
143
<title><anchor id="rb-tray-icon-cancel-notify" role="function"/>rb_tray_icon_cancel_notify ()</title>
141
144
<indexterm><primary>rb_tray_icon_cancel_notify</primary></indexterm><programlisting><link linkend="void">void</link>        rb_tray_icon_cancel_notify      (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon);</programlisting>
142
145
<para>
143
146
 
149
152
</simpara></listitem></varlistentry>
150
153
</variablelist></refsect2>
151
154
<refsect2>
152
 
<title><anchor id="rb-tray-icon-set-tooltip"/>rb_tray_icon_set_tooltip ()</title>
 
155
<title><anchor id="rb-tray-icon-set-tooltip" role="function"/>rb_tray_icon_set_tooltip ()</title>
153
156
<indexterm><primary>rb_tray_icon_set_tooltip</primary></indexterm><programlisting><link linkend="void">void</link>        rb_tray_icon_set_tooltip        (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
154
157
                                             const <link linkend="char">char</link> *tooltip);</programlisting>
155
158
<para>