Skip to content

Commit f03e6fb

Browse files
clefebvreclefebvre
committed
Update documentation
1 parent 0f5b365 commit f03e6fb

File tree

7 files changed

+1257
-7
lines changed

7 files changed

+1257
-7
lines changed

‎docs/reference/XAppMonitorBlanker.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,25 @@ <h2><span class="refentrytitle"><a name="XAppMonitorBlanker.top_of_page"></a>XAp
7676
</table></div>
7777
</div>
7878
<div class="refsect1">
79+
<a name="XAppMonitorBlanker.other"></a><h2>Types and Values</h2>
80+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
81+
<colgroup>
82+
<col width="150px" class="name">
83+
<col class="description">
84+
</colgroup>
85+
<tbody>
86+
<tr>
87+
<td class="define_keyword">#define</td>
88+
<td class="function_name"><a class="link" href="XAppMonitorBlanker.html#XAPP-TYPE-MONITOR-BLANKER:CAPS" title="XAPP_TYPE_MONITOR_BLANKER">XAPP_TYPE_MONITOR_BLANKER</a></td>
89+
</tr>
90+
<tr>
91+
<td class="datatype_keyword"> </td>
92+
<td class="function_name"><a class="link" href="XAppMonitorBlanker.html#XAppMonitorBlanker-struct" title="XAppMonitorBlanker">XAppMonitorBlanker</a></td>
93+
</tr>
94+
</tbody>
95+
</table></div>
96+
</div>
97+
<div class="refsect1">
7998
<a name="XAppMonitorBlanker.object-hierarchy"></a><h2>Object Hierarchy</h2>
8099
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
81100
<span class="lineart">╰──</span> XAppMonitorBlanker
@@ -185,6 +204,16 @@ <h2><span class="refentrytitle"><a name="XAppMonitorBlanker.top_of_page"></a>XAp
185204
</div>
186205
<div class="refsect1">
187206
<a name="XAppMonitorBlanker.other_details"></a><h2>Types and Values</h2>
207+
<div class="refsect2">
208+
<a name="XAPP-TYPE-MONITOR-BLANKER:CAPS"></a><h3>XAPP_TYPE_MONITOR_BLANKER</h3>
209+
<pre class="programlisting">#define XAPP_TYPE_MONITOR_BLANKER (xapp_monitor_blanker_get_type ())
210+
</pre>
211+
</div>
212+
<hr>
213+
<div class="refsect2">
214+
<a name="XAppMonitorBlanker-struct"></a><h3>XAppMonitorBlanker</h3>
215+
<pre class="programlisting">typedef struct _XAppMonitorBlanker XAppMonitorBlanker;</pre>
216+
</div>
188217
</div>
189218
</div>
190219
<div class="footer">

‎docs/reference/XAppStatusIcon.html‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,14 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
6868
</tr>
6969
<tr>
7070
<td class="function_type">
71+
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
72+
</td>
73+
<td class="function_name">
74+
<a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-icon-size" title="xapp_status_icon_get_icon_size ()">xapp_status_icon_get_icon_size</a> <span class="c_punctuation">()</span>
75+
</td>
76+
</tr>
77+
<tr>
78+
<td class="function_type">
7179
<span class="returnvalue">void</span>
7280
</td>
7381
<td class="function_name">
@@ -151,6 +159,11 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
151159
</colgroup>
152160
<tbody>
153161
<tr>
162+
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
163+
<td class="property_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon--icon-size" title="The “icon-size” property">icon-size</a></td>
164+
<td class="property_flags">Read / Write</td>
165+
</tr>
166+
<tr>
154167
<td class="property_type">
155168
<a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *</td>
156169
<td class="property_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon--primary-menu" title="The “primary-menu” property">primary-menu</a></td>
@@ -191,6 +204,11 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
191204
</tr>
192205
<tr>
193206
<td class="signal_type"><span class="returnvalue">void</span></td>
207+
<td class="signal_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-scroll-event" title="The “scroll-event” signal">scroll-event</a></td>
208+
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
209+
</tr>
210+
<tr>
211+
<td class="signal_type"><span class="returnvalue">void</span></td>
194212
<td class="signal_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-state-changed" title="The “state-changed” signal">state-changed</a></td>
195213
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
196214
</tr>
@@ -214,6 +232,10 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
214232
<td class="function_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState">XAppStatusIconState</a></td>
215233
</tr>
216234
<tr>
235+
<td class="datatype_keyword">enum</td>
236+
<td class="function_name"><a class="link" href="XAppStatusIcon.html#XAppScrollDirection" title="enum XAppScrollDirection">XAppScrollDirection</a></td>
237+
</tr>
238+
<tr>
217239
<td class="datatype_keyword"> </td>
218240
<td class="function_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-struct" title="XAppStatusIcon">XAppStatusIcon</a></td>
219241
</tr>
@@ -223,6 +245,7 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
223245
<div class="refsect1">
224246
<a name="XAppStatusIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
225247
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
248+
<span class="lineart">├──</span> XAppScrollDirection
226249
<span class="lineart">╰──</span> XAppStatusIconState
227250
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
228251
<span class="lineart">╰──</span> XAppStatusIcon
@@ -314,6 +337,34 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
314337
</div>
315338
<hr>
316339
<div class="refsect2">
340+
<a name="xapp-status-icon-get-icon-size"></a><h3>xapp_status_icon_get_icon_size ()</h3>
341+
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
342+
xapp_status_icon_get_icon_size (<em class="parameter"><code><a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon</code></em>);</pre>
343+
<div class="refsect3">
344+
<a name="xapp-status-icon-get-icon-size.parameters"></a><h4>Parameters</h4>
345+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
346+
<colgroup>
347+
<col width="150px" class="parameters_name">
348+
<col class="parameters_description">
349+
<col width="200px" class="parameters_annotations">
350+
</colgroup>
351+
<tbody><tr>
352+
<td class="parameter_name"><p>icon</p></td>
353+
<td class="parameter_description"><p>a <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a></p></td>
354+
<td class="parameter_annotations"> </td>
355+
</tr></tbody>
356+
</table></div>
357+
</div>
358+
<div class="refsect3">
359+
<a name="xapp-status-icon-get-icon-size.returns"></a><h4>Returns</h4>
360+
<p> The desired icon size - usually set by the host based on panel size.
361+
This is not what it's guaranteed to get, and this is really only useful when
362+
receiving absolute icon paths from the client app.</p>
363+
</div>
364+
<p class="since">Since: 1.8</p>
365+
</div>
366+
<hr>
367+
<div class="refsect2">
317368
<a name="xapp-status-icon-set-tooltip-text"></a><h3>xapp_status_icon_set_tooltip_text ()</h3>
318369
<pre class="programlisting"><span class="returnvalue">void</span>
319370
xapp_status_icon_set_tooltip_text (<em class="parameter"><code><a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon</code></em>,
@@ -617,13 +668,71 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
617668
</div>
618669
<hr>
619670
<div class="refsect2">
671+
<a name="XAppScrollDirection"></a><h3>enum XAppScrollDirection</h3>
672+
<p>Represents the direction of icon scroll events.</p>
673+
<div class="refsect3">
674+
<a name="XAppScrollDirection.members"></a><h4>Members</h4>
675+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
676+
<colgroup>
677+
<col width="300px" class="enum_members_name">
678+
<col class="enum_members_description">
679+
<col width="200px" class="enum_members_annotations">
680+
</colgroup>
681+
<tbody>
682+
<tr>
683+
<td class="enum_member_name"><p><a name="XAPP-SCROLL-UP:CAPS"></a>XAPP_SCROLL_UP</p></td>
684+
<td class="enum_member_description">
685+
<p>Scroll theoretical content up.</p>
686+
</td>
687+
<td class="enum_member_annotations"> </td>
688+
</tr>
689+
<tr>
690+
<td class="enum_member_name"><p><a name="XAPP-SCROLL-DOWN:CAPS"></a>XAPP_SCROLL_DOWN</p></td>
691+
<td class="enum_member_description">
692+
<p>Scroll theoretical content down.</p>
693+
</td>
694+
<td class="enum_member_annotations"> </td>
695+
</tr>
696+
<tr>
697+
<td class="enum_member_name"><p><a name="XAPP-SCROLL-LEFT:CAPS"></a>XAPP_SCROLL_LEFT</p></td>
698+
<td class="enum_member_description">
699+
<p>Scroll theoretical content left.</p>
700+
</td>
701+
<td class="enum_member_annotations"> </td>
702+
</tr>
703+
<tr>
704+
<td class="enum_member_name"><p><a name="XAPP-SCROLL-RIGHT:CAPS"></a>XAPP_SCROLL_RIGHT</p></td>
705+
<td class="enum_member_description">
706+
<p>Scroll theoretical content right.</p>
707+
</td>
708+
<td class="enum_member_annotations"> </td>
709+
</tr>
710+
</tbody>
711+
</table></div>
712+
</div>
713+
</div>
714+
<hr>
715+
<div class="refsect2">
620716
<a name="XAppStatusIcon-struct"></a><h3>XAppStatusIcon</h3>
621717
<pre class="programlisting">typedef struct _XAppStatusIcon XAppStatusIcon;</pre>
622718
</div>
623719
</div>
624720
<div class="refsect1">
625721
<a name="XAppStatusIcon.property-details"></a><h2>Property Details</h2>
626722
<div class="refsect2">
723+
<a name="XAppStatusIcon--icon-size"></a><h3>The <code class="literal">“icon-size”</code> property</h3>
724+
<pre class="programlisting"> “icon-size” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
725+
<p>The icon size that is preferred by icon monitor/host - this is usually a product
726+
of some calculation based on the panel size. It can be used by the client to size
727+
an icon to be saved as a file and its path sent to the host.</p>
728+
<p>If this value is 0 it has not been set, and its value can be unreliable if the host
729+
has multiple <a href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-struct"><span class="type">XAppStatusIconMonitors</span></a> active.</p>
730+
<p>Flags: Read / Write</p>
731+
<p>Allowed values: [0,96]</p>
732+
<p>Default value: 0</p>
733+
</div>
734+
<hr>
735+
<div class="refsect2">
627736
<a name="XAppStatusIcon--primary-menu"></a><h3>The <code class="literal">“primary-menu”</code> property</h3>
628737
<pre class="programlisting"> “primary-menu” <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *</pre>
629738
<p>A <a href="../gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a> to use when requested by the remote monitor via a left (or primary) click.</p>
@@ -829,6 +938,57 @@ <h2><span class="refentrytitle"><a name="XAppStatusIcon.top_of_page"></a>XAppSta
829938
</div>
830939
<hr>
831940
<div class="refsect2">
941+
<a name="XAppStatusIcon-scroll-event"></a><h3>The <code class="literal">“scroll-event”</code> signal</h3>
942+
<pre class="programlisting"><span class="returnvalue">void</span>
943+
user_function (<a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon,
944+
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> amount,
945+
<a class="link" href="XAppStatusIcon.html#XAppScrollDirection" title="enum XAppScrollDirection"><span class="type">XAppScrollDirection</span></a> direction,
946+
<a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> time,
947+
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
948+
<p>Gets emitted when the user uses the mouse scroll wheel over the status icon.
949+
For the most part, amounts will always be 1, unless an applet supports smooth
950+
scrolling. Generally the direction value is most important.</p>
951+
<div class="refsect3">
952+
<a name="XAppStatusIcon-scroll-event.parameters"></a><h4>Parameters</h4>
953+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
954+
<colgroup>
955+
<col width="150px" class="parameters_name">
956+
<col class="parameters_description">
957+
<col width="200px" class="parameters_annotations">
958+
</colgroup>
959+
<tbody>
960+
<tr>
961+
<td class="parameter_name"><p>icon</p></td>
962+
<td class="parameter_description"><p>The <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a></p></td>
963+
<td class="parameter_annotations"> </td>
964+
</tr>
965+
<tr>
966+
<td class="parameter_name"><p>amount</p></td>
967+
<td class="parameter_description"><p>The amount of movement for the scroll event</p></td>
968+
<td class="parameter_annotations"> </td>
969+
</tr>
970+
<tr>
971+
<td class="parameter_name"><p>direction</p></td>
972+
<td class="parameter_description"><p>the <a class="link" href="XAppStatusIcon.html#XAppScrollDirection" title="enum XAppScrollDirection"><span class="type">XAppScrollDirection</span></a> of the scroll event</p></td>
973+
<td class="parameter_annotations"> </td>
974+
</tr>
975+
<tr>
976+
<td class="parameter_name"><p>time</p></td>
977+
<td class="parameter_description"><p>The time supplied by the event, or 0</p></td>
978+
<td class="parameter_annotations"> </td>
979+
</tr>
980+
<tr>
981+
<td class="parameter_name"><p>user_data</p></td>
982+
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
983+
<td class="parameter_annotations"> </td>
984+
</tr>
985+
</tbody>
986+
</table></div>
987+
</div>
988+
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
989+
</div>
990+
<hr>
991+
<div class="refsect2">
832992
<a name="XAppStatusIcon-state-changed"></a><h3>The <code class="literal">“state-changed”</code> signal</h3>
833993
<pre class="programlisting"><span class="returnvalue">void</span>
834994
user_function (<a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon,

0 commit comments

Comments
 (0)