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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="rhythmbox-rb-tray-icon">
<refmeta>
<refentrytitle role="top_of_page" id="rhythmbox-rb-tray-icon.top_of_page">rb-tray-icon</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-tray-icon</refname>
<refpurpose>Notification area icon</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="rhythmbox-rb-tray-icon.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="RBTrayIconPrivate">RBTrayIconPrivate</link>;
<link linkend="RBTrayIcon">RBTrayIcon</link>* <link linkend="rb-tray-icon-new">rb_tray_icon_new</link> (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="RBShell">RBShell</link> *shell);
<link linkend="void">void</link> <link linkend="rb-tray-icon-get-geom">rb_tray_icon_get_geom</link> (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y,
<link linkend="int">int</link> *width,
<link linkend="int">int</link> *height);
<link linkend="void">void</link> <link linkend="rb-tray-icon-notify">rb_tray_icon_notify</link> (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
<link linkend="guint">guint</link> timeout,
const <link linkend="char">char</link> *primary_markup,
<link linkend="GtkWidget">GtkWidget</link> *msgicon,
const <link linkend="char">char</link> *secondary_markup,
<link linkend="gboolean">gboolean</link> requested);
<link linkend="void">void</link> <link linkend="rb-tray-icon-cancel-notify">rb_tray_icon_cancel_notify</link> (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon);
<link linkend="void">void</link> <link linkend="rb-tray-icon-set-tooltip-primary-text">rb_tray_icon_set_tooltip_primary_text</link>
(<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
const <link linkend="char">char</link> *primary_text);
<link linkend="void">void</link> <link linkend="rb-tray-icon-set-tooltip-icon">rb_tray_icon_set_tooltip_icon</link> (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
<link linkend="GtkWidget">GtkWidget</link> *msgicon);
<link linkend="void">void</link> <link linkend="rb-tray-icon-set-tooltip-secondary-markup">rb_tray_icon_set_tooltip_secondary_markup</link>
(<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
const <link linkend="char">char</link> *secondary_markup);
</synopsis>
</refsynopsisdiv>
<refsect1 id="rhythmbox-rb-tray-icon.description" role="desc">
<title role="desc.title">Description</title>
<para>
The tray icon handles a few different forms of input:
<itemizedlist>
<listitem>left clicking hides and shows the main window</listitem>
<listitem>right clicking brings up a popup menu</listitem>
<listitem>dropping files on the icon adds them to the library</listitem>
<listitem>scroll events change the playback volume</listitem>
</itemizedlist>
</para>
<para>
The tooltip for the tray icon consists of an image, the primary text
(displayed in bold large type), and the secondary text (which can
contain markup).
</para>
<para>
The tooltip is shown after the mouse pointer has been within the tray
icon area for half a second. This delay is only reset once the pointer
has been outside the tray icon area for more than one second.
</para>
<para>
The tray icon can also display notification bubbles (using libnotify).
These contain the same set of elements as the tooltip. The tooltip is
suppressed while a notification bubble is being displayed. A GConf setting
allows the user to disable notification bubbles.</para>
<para>
</para>
</refsect1>
<refsect1 id="rhythmbox-rb-tray-icon.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBTrayIconPrivate" role="typedef">
<title>RBTrayIconPrivate</title>
<indexterm zone="RBTrayIconPrivate"><primary>RBTrayIconPrivate</primary></indexterm><programlisting>typedef struct RBTrayIconPrivate RBTrayIconPrivate;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-tray-icon-new" role="function">
<title>rb_tray_icon_new ()</title>
<indexterm zone="rb-tray-icon-new"><primary>rb_tray_icon_new</primary></indexterm><programlisting><link linkend="RBTrayIcon">RBTrayIcon</link>* rb_tray_icon_new (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="RBShell">RBShell</link> *shell);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mgr</parameter> :</term>
<listitem><simpara> the <link linkend="GtkUIManager"><type>GtkUIManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shell</parameter> :</term>
<listitem><simpara> the <link linkend="RBShell"><type>RBShell</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-get-geom" role="function">
<title>rb_tray_icon_get_geom ()</title>
<indexterm zone="rb-tray-icon-get-geom"><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,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y,
<link linkend="int">int</link> *width,
<link linkend="int">int</link> *height);</programlisting>
<para>
Retrieves the current position and size of the tray icon.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> returns the x position of the tray icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> returns the y position of the tray icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> returns the width of the tray icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> returns the height of the tray icon
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-notify" role="function">
<title>rb_tray_icon_notify ()</title>
<indexterm zone="rb-tray-icon-notify"><primary>rb_tray_icon_notify</primary></indexterm><programlisting><link linkend="void">void</link> rb_tray_icon_notify (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
<link linkend="guint">guint</link> timeout,
const <link linkend="char">char</link> *primary_markup,
<link linkend="GtkWidget">GtkWidget</link> *msgicon,
const <link linkend="char">char</link> *secondary_markup,
<link linkend="gboolean">gboolean</link> requested);</programlisting>
<para>
Displays a notification bubble attached to the tray icon. If the user has
disabled notifications, the notification is only displayed if <parameter>requested</parameter>
is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timeout</parameter> :</term>
<listitem><simpara> how long the notification should be displayed (in milliseconds)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>primary_markup</parameter> :</term>
<listitem><simpara> primary markup to display in the notification
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msgicon</parameter> :</term>
<listitem><simpara> <link linkend="GtkWidget"><type>GtkWidget</type></link> to display as the image in the notification
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>secondary_markup</parameter> :</term>
<listitem><simpara> secondary markup to display in the notification
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested</parameter> :</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the notification was directly requested by the user
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-cancel-notify" role="function">
<title>rb_tray_icon_cancel_notify ()</title>
<indexterm zone="rb-tray-icon-cancel-notify"><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>
<para>
Cancels any existing notification bubble.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-set-tooltip-primary-text" role="function">
<title>rb_tray_icon_set_tooltip_primary_text ()</title>
<indexterm zone="rb-tray-icon-set-tooltip-primary-text"><primary>rb_tray_icon_set_tooltip_primary_text</primary></indexterm><programlisting><link linkend="void">void</link> rb_tray_icon_set_tooltip_primary_text
(<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
const <link linkend="char">char</link> *primary_text);</programlisting>
<para>
Updates the tooltip's primary text and updates the tooltip's
visibility. The primary text cannot contain markup. It is
always displayed in bold large type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>primary_text</parameter> :</term>
<listitem><simpara> New primary text for the tooltip
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-set-tooltip-icon" role="function">
<title>rb_tray_icon_set_tooltip_icon ()</title>
<indexterm zone="rb-tray-icon-set-tooltip-icon"><primary>rb_tray_icon_set_tooltip_icon</primary></indexterm><programlisting><link linkend="void">void</link> rb_tray_icon_set_tooltip_icon (<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
<link linkend="GtkWidget">GtkWidget</link> *msgicon);</programlisting>
<para>
Updates the icon in the tooltip.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msgicon</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> to display as the icon in the tooltip
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-tray-icon-set-tooltip-secondary-markup" role="function">
<title>rb_tray_icon_set_tooltip_secondary_markup ()</title>
<indexterm zone="rb-tray-icon-set-tooltip-secondary-markup"><primary>rb_tray_icon_set_tooltip_secondary_markup</primary></indexterm><programlisting><link linkend="void">void</link> rb_tray_icon_set_tooltip_secondary_markup
(<link linkend="RBTrayIcon">RBTrayIcon</link> *icon,
const <link linkend="char">char</link> *secondary_markup);</programlisting>
<para>
Updates the secondary text in the tooltip. The secondary text can contain
simple markup.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>icon</parameter> :</term>
<listitem><simpara> the <link linkend="RBTrayIcon"><type>RBTrayIcon</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>secondary_markup</parameter> :</term>
<listitem><simpara> markup text to display as the secondary text in the toolip
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
