← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/eggtrayicon.xml

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/eggtrayicon.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-EggTrayIcon">
 
5
<refmeta>
 
6
<refentrytitle>EggTrayIcon</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>EggTrayIcon</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
<link linkend="EggTrayIcon">EggTrayIcon</link>* <link linkend="egg-tray-icon-new-for-screen">egg_tray_icon_new_for_screen</link>   (<link linkend="GdkScreen">GdkScreen</link> *screen,
 
22
                                             const <link linkend="gchar">gchar</link> *name);
 
23
<link linkend="EggTrayIcon">EggTrayIcon</link>* <link linkend="egg-tray-icon-new">egg_tray_icon_new</link>              (const <link linkend="gchar">gchar</link> *name);
 
24
<link linkend="guint">guint</link>       <link linkend="egg-tray-icon-send-message">egg_tray_icon_send_message</link>      (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
25
                                             <link linkend="gint">gint</link> timeout,
 
26
                                             const <link linkend="char">char</link> *message,
 
27
                                             <link linkend="gint">gint</link> len);
 
28
<link linkend="void">void</link>        <link linkend="egg-tray-icon-cancel-message">egg_tray_icon_cancel_message</link>    (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
29
                                             <link linkend="guint">guint</link> id);
 
30
<link linkend="gboolean">gboolean</link>    <link linkend="egg-tray-icon-have-manager">egg_tray_icon_have_manager</link>      (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon);
 
31
<link linkend="EggNotificationBubble">EggNotificationBubble</link>* <link linkend="egg-tray-icon-notify">egg_tray_icon_notify</link> (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
32
                                             <link linkend="guint">guint</link> timeout,
 
33
                                             const <link linkend="char">char</link> *primary,
 
34
                                             <link linkend="GtkWidget">GtkWidget</link> *msgicon,
 
35
                                             const <link linkend="char">char</link> *secondary);
 
36
<link linkend="GtkOrientation">GtkOrientation</link> <link linkend="egg-tray-icon-get-orientation">egg_tray_icon_get_orientation</link>
 
37
                                            (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon);
 
38
 
 
39
</synopsis>
 
40
</refsynopsisdiv>
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
<refsect1>
 
51
<title>Description</title>
 
52
<para>
 
53
 
 
54
</para>
 
55
</refsect1>
 
56
 
 
57
<refsect1>
 
58
<title>Details</title>
 
59
<refsect2>
 
60
<title><anchor id="egg-tray-icon-new-for-screen"/>egg_tray_icon_new_for_screen ()</title>
 
61
<indexterm><primary>egg_tray_icon_new_for_screen</primary></indexterm><programlisting><link linkend="EggTrayIcon">EggTrayIcon</link>* egg_tray_icon_new_for_screen   (<link linkend="GdkScreen">GdkScreen</link> *screen,
 
62
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
 
63
<para>
 
64
 
 
65
</para><variablelist role="params">
 
66
<varlistentry><term><parameter>screen</parameter>&nbsp;:</term>
 
67
<listitem><simpara>
 
68
</simpara></listitem></varlistentry>
 
69
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
70
<listitem><simpara>
 
71
</simpara></listitem></varlistentry>
 
72
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
73
 
 
74
 
 
75
</simpara></listitem></varlistentry>
 
76
</variablelist></refsect2>
 
77
<refsect2>
 
78
<title><anchor id="egg-tray-icon-new"/>egg_tray_icon_new ()</title>
 
79
<indexterm><primary>egg_tray_icon_new</primary></indexterm><programlisting><link linkend="EggTrayIcon">EggTrayIcon</link>* egg_tray_icon_new              (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
80
<para>
 
81
 
 
82
</para><variablelist role="params">
 
83
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
84
<listitem><simpara>
 
85
</simpara></listitem></varlistentry>
 
86
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
87
 
 
88
 
 
89
</simpara></listitem></varlistentry>
 
90
</variablelist></refsect2>
 
91
<refsect2>
 
92
<title><anchor id="egg-tray-icon-send-message"/>egg_tray_icon_send_message ()</title>
 
93
<indexterm><primary>egg_tray_icon_send_message</primary></indexterm><programlisting><link linkend="guint">guint</link>       egg_tray_icon_send_message      (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
94
                                             <link linkend="gint">gint</link> timeout,
 
95
                                             const <link linkend="char">char</link> *message,
 
96
                                             <link linkend="gint">gint</link> len);</programlisting>
 
97
<para>
 
98
 
 
99
</para><variablelist role="params">
 
100
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
101
<listitem><simpara>
 
102
</simpara></listitem></varlistentry>
 
103
<varlistentry><term><parameter>timeout</parameter>&nbsp;:</term>
 
104
<listitem><simpara>
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
107
<listitem><simpara>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
110
<listitem><simpara>
 
111
</simpara></listitem></varlistentry>
 
112
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
113
 
 
114
 
 
115
</simpara></listitem></varlistentry>
 
116
</variablelist></refsect2>
 
117
<refsect2>
 
118
<title><anchor id="egg-tray-icon-cancel-message"/>egg_tray_icon_cancel_message ()</title>
 
119
<indexterm><primary>egg_tray_icon_cancel_message</primary></indexterm><programlisting><link linkend="void">void</link>        egg_tray_icon_cancel_message    (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
120
                                             <link linkend="guint">guint</link> id);</programlisting>
 
121
<para>
 
122
 
 
123
</para><variablelist role="params">
 
124
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
125
<listitem><simpara>
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 
128
<listitem><simpara>
 
129
 
 
130
 
 
131
</simpara></listitem></varlistentry>
 
132
</variablelist></refsect2>
 
133
<refsect2>
 
134
<title><anchor id="egg-tray-icon-have-manager"/>egg_tray_icon_have_manager ()</title>
 
135
<indexterm><primary>egg_tray_icon_have_manager</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    egg_tray_icon_have_manager      (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon);</programlisting>
 
136
<para>
 
137
 
 
138
</para><variablelist role="params">
 
139
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
140
<listitem><simpara>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
143
 
 
144
 
 
145
</simpara></listitem></varlistentry>
 
146
</variablelist></refsect2>
 
147
<refsect2>
 
148
<title><anchor id="egg-tray-icon-notify"/>egg_tray_icon_notify ()</title>
 
149
<indexterm><primary>egg_tray_icon_notify</primary></indexterm><programlisting><link linkend="EggNotificationBubble">EggNotificationBubble</link>* egg_tray_icon_notify (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon,
 
150
                                             <link linkend="guint">guint</link> timeout,
 
151
                                             const <link linkend="char">char</link> *primary,
 
152
                                             <link linkend="GtkWidget">GtkWidget</link> *msgicon,
 
153
                                             const <link linkend="char">char</link> *secondary);</programlisting>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
158
<listitem><simpara>
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><parameter>timeout</parameter>&nbsp;:</term>
 
161
<listitem><simpara>
 
162
</simpara></listitem></varlistentry>
 
163
<varlistentry><term><parameter>primary</parameter>&nbsp;:</term>
 
164
<listitem><simpara>
 
165
</simpara></listitem></varlistentry>
 
166
<varlistentry><term><parameter>msgicon</parameter>&nbsp;:</term>
 
167
<listitem><simpara>
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><parameter>secondary</parameter>&nbsp;:</term>
 
170
<listitem><simpara>
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
173
 
 
174
 
 
175
</simpara></listitem></varlistentry>
 
176
</variablelist></refsect2>
 
177
<refsect2>
 
178
<title><anchor id="egg-tray-icon-get-orientation"/>egg_tray_icon_get_orientation ()</title>
 
179
<indexterm><primary>egg_tray_icon_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> egg_tray_icon_get_orientation
 
180
                                            (<link linkend="EggTrayIcon">EggTrayIcon</link> *icon);</programlisting>
 
181
<para>
 
182
 
 
183
</para><variablelist role="params">
 
184
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
185
<listitem><simpara>
 
186
</simpara></listitem></varlistentry>
 
187
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
188
 
 
189
 
 
190
</simpara></listitem></varlistentry>
 
191
</variablelist></refsect2>
 
192
 
 
193
</refsect1>
 
194
 
 
195
 
 
196
 
 
197
 
 
198
</refentry>