Codebase list xapp / debian/2.0.2-1 docs / reference / XAppStatusIconMonitor.html
debian/2.0.2-1

Tree @debian/2.0.2-1 (Download .tar.gz)

XAppStatusIconMonitor.html @debian/2.0.2-1 — raw · history · blame 

  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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XAppStatusIconMonitor: XApp Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="XApp Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="XAppStatusIcon.html" title="XAppStatusIcon">
<link rel="next" href="XAppObjectManagerClient.html" title="XAppObjectManagerClient">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#XAppStatusIconMonitor.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#XAppStatusIconMonitor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#XAppStatusIconMonitor.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XAppStatusIcon.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="XAppObjectManagerClient.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XAppStatusIconMonitor"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XAppStatusIconMonitor.top_of_page"></a>XAppStatusIconMonitor</span></h2>
<p>XAppStatusIconMonitor — Looks for XAppStatusIcons on DBUS and communicates
info to an applet to represent the icons.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="returnvalue">XAppStatusIconMonitor</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppStatusIconMonitor.html#xapp-status-icon-monitor-new" title="xapp_status_icon_monitor_new ()">xapp_status_icon_monitor_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppStatusIconMonitor.html#xapp-status-icon-monitor-list-icons" title="xapp_status_icon_monitor_list_icons ()">xapp_status_icon_monitor_list_icons</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-icon-added" title="The “icon-added” signal">icon-added</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-icon-removed" title="The “icon-removed” signal">icon-removed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="XAppStatusIconMonitor.html#XAPP-TYPE-STATUS-ICON-MONITOR:CAPS" title="XAPP_TYPE_STATUS_ICON_MONITOR">XAPP_TYPE_STATUS_ICON_MONITOR</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-struct" title="XAppStatusIconMonitor">XAppStatusIconMonitor</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> XAppStatusIconMonitor
</pre>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.description"></a><h2>Description</h2>
<p>The XAppStatusIconMonitor is intended to be utilized by some status applet
to display info about an app.</p>
<p>The simplest way to use is to make a new instance of this monitor, and connect
to the <a class="link" href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-icon-added" title="The “icon-added” signal"><span class="type">“icon-added”</span></a> and <a class="link" href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-icon-removed" title="The “icon-removed” signal"><span class="type">“icon-removed”</span></a> signals.
The received object for both of these signals is an <a class="link" href="XAppObjectManagerClient.html#XAppStatusIconInterfaceProxy"><span class="type">XAppStatusIconInterfaceProxy</span></a>.
It represents an application's <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a>, and has properties available for
describing the icon name, tooltip, label and visibility.</p>
<p>The proxy also provides methods to handle clicks, which can be called by the applet,
to request that the app display its menu.</p>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xapp-status-icon-monitor-new"></a><h3>xapp_status_icon_monitor_new ()</h3>
<pre class="programlisting"><a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="returnvalue">XAppStatusIconMonitor</span></a> *
xapp_status_icon_monitor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new monitor.</p>
<div class="refsect3">
<a name="xapp-status-icon-monitor-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a>. Use g_object_unref when finished. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 1.6</p>
</div>
<hr>
<div class="refsect2">
<a name="xapp-status-icon-monitor-list-icons"></a><h3>xapp_status_icon_monitor_list_icons ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
xapp_status_icon_monitor_list_icons (<em class="parameter"><code><a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a> *monitor</code></em>);</pre>
<p>List known icon proxies.</p>
<div class="refsect3">
<a name="xapp-status-icon-monitor-list-icons.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>monitor</p></td>
<td class="parameter_description"><p>a <a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-status-icon-monitor-list-icons.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of icons. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> XAppStatusIconMonitor][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
<p class="since">Since: 1.6</p>
</div>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XAPP-TYPE-STATUS-ICON-MONITOR:CAPS"></a><h3>XAPP_TYPE_STATUS_ICON_MONITOR</h3>
<pre class="programlisting">#define XAPP_TYPE_STATUS_ICON_MONITOR   (xapp_status_icon_monitor_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="XAppStatusIconMonitor-struct"></a><h3>XAppStatusIconMonitor</h3>
<pre class="programlisting">typedef struct _XAppStatusIconMonitor XAppStatusIconMonitor;</pre>
</div>
</div>
<div class="refsect1">
<a name="XAppStatusIconMonitor.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="XAppStatusIconMonitor-icon-added"></a><h3>The <code class="literal">“icon-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a>        *monitor,
               <a class="link" href="XAppObjectManagerClient.html#XAppStatusIconInterfaceProxy"><span class="type">XAppStatusIconInterfaceProxy</span></a> *proxy,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                      user_data)</pre>
<p>This signal is emitted by the monitor when it has discovered a new
<a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> on the bus.</p>
<div class="refsect3">
<a name="XAppStatusIconMonitor-icon-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>monitor</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the interface proxy for the <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> that has been added.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
</div>
<hr>
<div class="refsect2">
<a name="XAppStatusIconMonitor-icon-removed"></a><h3>The <code class="literal">“icon-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a>        *monitor,
               <a class="link" href="XAppObjectManagerClient.html#XAppStatusIconInterfaceProxy"><span class="type">XAppStatusIconInterfaceProxy</span></a> *proxy,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                      user_data)</pre>
<p>This signal is emitted by the monitor when an <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> has disappeared
from the bus.</p>
<div class="refsect3">
<a name="XAppStatusIconMonitor-icon-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>monitor</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> proxy that has been removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>