Codebase list xapp / 1396b61
Update docs Clement Lefebvre 4 years ago
5 changed file(s) with 176 addition(s) and 3 deletion(s). Raw diff Collapse all Expand all
+150
-1
docs/reference/XAppStatusIcon.html less more
121121 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-secondary-menu" title="xapp_status_icon_get_secondary_menu ()">xapp_status_icon_get_secondary_menu</a> <span class="c_punctuation">()</span>
122122 </td>
123123 </tr>
124 <tr>
125 <td class="function_type">
126 <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="returnvalue">XAppStatusIconState</span></a>
127 </td>
128 <td class="function_name">
129 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-state" title="xapp_status_icon_get_state ()">xapp_status_icon_get_state</a> <span class="c_punctuation">()</span>
130 </td>
131 </tr>
132 <tr>
133 <td class="function_type">
134 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
135 </td>
136 <td class="function_name">
137 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-any-monitors" title="xapp_status_icon_any_monitors ()">xapp_status_icon_any_monitors</a> <span class="c_punctuation">()</span>
138 </td>
139 </tr>
124140 </tbody>
125141 </table></div>
126142 </div>
172188 <td class="signal_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-button-release-event" title="The “button-release-event” signal">button-release-event</a></td>
173189 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
174190 </tr>
191 <tr>
192 <td class="signal_type"><span class="returnvalue">void</span></td>
193 <td class="signal_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-state-changed" title="The “state-changed” signal">state-changed</a></td>
194 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
195 </tr>
175196 </tbody>
176197 </table></div>
177198 </div>
188209 <td class="function_name"><a class="link" href="XAppStatusIcon.html#XAPP-TYPE-STATUS-ICON:CAPS" title="XAPP_TYPE_STATUS_ICON">XAPP_TYPE_STATUS_ICON</a></td>
189210 </tr>
190211 <tr>
212 <td class="datatype_keyword">enum</td>
213 <td class="function_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState">XAppStatusIconState</a></td>
214 </tr>
215 <tr>
191216 <td class="datatype_keyword"> </td>
192217 <td class="function_name"><a class="link" href="XAppStatusIcon.html#XAppStatusIcon-struct" title="XAppStatusIcon">XAppStatusIcon</a></td>
193218 </tr>
196221 </div>
197222 <div class="refsect1">
198223 <a name="XAppStatusIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
199 <pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
224 <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
225 <span class="lineart">╰──</span> XAppStatusIconState
226 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
200227 <span class="lineart">╰──</span> XAppStatusIcon
201228 </pre>
202229 </div>
497524 </div>
498525 <p class="since">Since: 1.6</p>
499526 </div>
527 <hr>
528 <div class="refsect2">
529 <a name="xapp-status-icon-get-state"></a><h3>xapp_status_icon_get_state ()</h3>
530 <pre class="programlisting"><a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="returnvalue">XAppStatusIconState</span></a>
531 xapp_status_icon_get_state (<em class="parameter"><code><a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon</code></em>);</pre>
532 <p>Gets the current <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="type">XAppStatusIconState</span></a> of icon. The state is determined by whether
533 the icon is being displayed by an <span class="type">XAppStatusMonitor</span> client, a fallback tray icon,
534 or not being displayed at all.</p>
535 <p>See <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="type">XAppStatusIconState</span></a> for more details.</p>
536 <div class="refsect3">
537 <a name="xapp-status-icon-get-state.parameters"></a><h4>Parameters</h4>
538 <div class="informaltable"><table class="informaltable" width="100%" border="0">
539 <colgroup>
540 <col width="150px" class="parameters_name">
541 <col class="parameters_description">
542 <col width="200px" class="parameters_annotations">
543 </colgroup>
544 <tbody><tr>
545 <td class="parameter_name"><p>icon</p></td>
546 <td class="parameter_description"><p>an <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a></p></td>
547 <td class="parameter_annotations"> </td>
548 </tr></tbody>
549 </table></div>
550 </div>
551 <div class="refsect3">
552 <a name="xapp-status-icon-get-state.returns"></a><h4>Returns</h4>
553 <p> the icon's state.</p>
554 </div>
555 <p class="since">Since: 1.6</p>
556 </div>
557 <hr>
558 <div class="refsect2">
559 <a name="xapp-status-icon-any-monitors"></a><h3>xapp_status_icon_any_monitors ()</h3>
560 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
561 xapp_status_icon_any_monitors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
562 <p>Looks for the existence of any active <a href="XAppStatusIconMonitor.html#XAppStatusIconMonitor-struct"><span class="type">XAppStatusIconMonitors</span></a> on the bus.</p>
563 <div class="refsect3">
564 <a name="xapp-status-icon-any-monitors.returns"></a><h4>Returns</h4>
565 <p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if at least one monitor was found.</p>
566 </div>
567 <p class="since">Since: 1.6</p>
568 </div>
500569 </div>
501570 <div class="refsect1">
502571 <a name="XAppStatusIcon.other_details"></a><h2>Types and Values</h2>
504573 <a name="XAPP-TYPE-STATUS-ICON:CAPS"></a><h3>XAPP_TYPE_STATUS_ICON</h3>
505574 <pre class="programlisting">#define XAPP_TYPE_STATUS_ICON (xapp_status_icon_get_type ())
506575 </pre>
576 </div>
577 <hr>
578 <div class="refsect2">
579 <a name="XAppStatusIconState"></a><h3>enum XAppStatusIconState</h3>
580 <div class="refsect3">
581 <a name="XAppStatusIconState.members"></a><h4>Members</h4>
582 <div class="informaltable"><table class="informaltable" width="100%" border="0">
583 <colgroup>
584 <col width="300px" class="enum_members_name">
585 <col class="enum_members_description">
586 <col width="200px" class="enum_members_annotations">
587 </colgroup>
588 <tbody>
589 <tr>
590 <td class="enum_member_name"><p><a name="XAPP-STATUS-ICON-STATE-NATIVE:CAPS"></a>XAPP_STATUS_ICON_STATE_NATIVE</p></td>
591 <td class="enum_member_description">
592 <p>The <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> is currently being handled
593 by an <a class="link" href="XAppStatusIconMonitor.html" title="XAppStatusIconMonitor"><span class="type">XAppStatusIconMonitor</span></a> (usually in an applet).</p>
594 </td>
595 <td class="enum_member_annotations"> </td>
596 </tr>
597 <tr>
598 <td class="enum_member_name"><p><a name="XAPP-STATUS-ICON-STATE-FALLBACK:CAPS"></a>XAPP_STATUS_ICON_STATE_FALLBACK</p></td>
599 <td class="enum_member_description">
600 <p>The <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> is currently being handled
601 by a legacy system tray implementation (using GtkStatusIcon).</p>
602 </td>
603 <td class="enum_member_annotations"> </td>
604 </tr>
605 <tr>
606 <td class="enum_member_name"><p><a name="XAPP-STATUS-ICON-STATE-NO-SUPPORT:CAPS"></a>XAPP_STATUS_ICON_STATE_NO_SUPPORT</p></td>
607 <td class="enum_member_description">
608 <p>The <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> is not currently being handled by any
609 kind of status icon implementation.</p>
610 </td>
611 <td class="enum_member_annotations"> </td>
612 </tr>
613 </tbody>
614 </table></div>
615 </div>
507616 </div>
508617 <hr>
509618 <div class="refsect2">
717826 </div>
718827 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
719828 </div>
829 <hr>
830 <div class="refsect2">
831 <a name="XAppStatusIcon-state-changed"></a><h3>The <code class="literal">“state-changed”</code> signal</h3>
832 <pre class="programlisting"><span class="returnvalue">void</span>
833 user_function (<a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a> *icon,
834 <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="type">XAppStatusIconState</span></a> new_state,
835 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
836 <p>Gets emitted when the state of the icon changes. If you wish
837 to react to changes in how the status icon is being handled
838 (perhaps to alter the menu or other click behavior), you should
839 connect to this - see <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="type">XAppStatusIconState</span></a> for more details.</p>
840 <div class="refsect3">
841 <a name="XAppStatusIcon-state-changed.parameters"></a><h4>Parameters</h4>
842 <div class="informaltable"><table class="informaltable" width="100%" border="0">
843 <colgroup>
844 <col width="150px" class="parameters_name">
845 <col class="parameters_description">
846 <col width="200px" class="parameters_annotations">
847 </colgroup>
848 <tbody>
849 <tr>
850 <td class="parameter_name"><p>icon</p></td>
851 <td class="parameter_description"><p>The <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon"><span class="type">XAppStatusIcon</span></a></p></td>
852 <td class="parameter_annotations"> </td>
853 </tr>
854 <tr>
855 <td class="parameter_name"><p>new_state</p></td>
856 <td class="parameter_description"><p>The new <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState"><span class="type">XAppStatusIconState</span></a> of the icon</p></td>
857 <td class="parameter_annotations"> </td>
858 </tr>
859 <tr>
860 <td class="parameter_name"><p>user_data</p></td>
861 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
862 <td class="parameter_annotations"> </td>
863 </tr>
864 </tbody>
865 </table></div>
866 </div>
867 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
868 </div>
720869 </div>
721870 </div>
722871 <div class="footer">
+16
-0
docs/reference/api-index-full.html less more
364364 </dt>
365365 <dd></dd>
366366 <dt>
367 <a class="link" href="XAppStatusIcon.html#XAppStatusIcon-state-changed" title="The “state-changed” signal">XAppStatusIcon::state-changed</a>, object signal in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
368 </dt>
369 <dd></dd>
370 <dt>
367371 <a class="link" href="XAppStatusIcon.html#XAppStatusIcon--primary-menu" title="The “primary-menu” property">XAppStatusIcon:primary-menu</a>, object property in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
368372 </dt>
369373 <dd></dd>
412416 </dt>
413417 <dd></dd>
414418 <dt>
419 <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState">XAppStatusIconState</a>, enum in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
420 </dt>
421 <dd></dd>
422 <dt>
423 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-any-monitors" title="xapp_status_icon_any_monitors ()">xapp_status_icon_any_monitors</a>, function in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
424 </dt>
425 <dd></dd>
426 <dt>
415427 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-primary-menu" title="xapp_status_icon_get_primary_menu ()">xapp_status_icon_get_primary_menu</a>, function in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
416428 </dt>
417429 <dd></dd>
418430 <dt>
419431 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-secondary-menu" title="xapp_status_icon_get_secondary_menu ()">xapp_status_icon_get_secondary_menu</a>, function in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
432 </dt>
433 <dd></dd>
434 <dt>
435 <a class="link" href="XAppStatusIcon.html#xapp-status-icon-get-state" title="xapp_status_icon_get_state ()">xapp_status_icon_get_state</a>, function in <a class="link" href="XAppStatusIcon.html" title="XAppStatusIcon">XAppStatusIcon</a>
420436 </dt>
421437 <dd></dd>
422438 <dt>
+1
-1
docs/reference/index.html less more
1414 <div>
1515 <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">XApp Reference Manual</p></th></tr></table></div>
1616 <div><p class="releaseinfo">
17 xapp 1.5.0
17 xapp 1.6.2
1818 </p></div>
1919 </div>
2020 <hr>
+7
-0
docs/reference/libxapp.devhelp2 less more
110110 <keyword type="function" name="xapp_status_icon_get_primary_menu ()" link="XAppStatusIcon.html#xapp-status-icon-get-primary-menu" since="1.6"/>
111111 <keyword type="function" name="xapp_status_icon_set_secondary_menu ()" link="XAppStatusIcon.html#xapp-status-icon-set-secondary-menu" since="1.6"/>
112112 <keyword type="function" name="xapp_status_icon_get_secondary_menu ()" link="XAppStatusIcon.html#xapp-status-icon-get-secondary-menu" since="1.6"/>
113 <keyword type="function" name="xapp_status_icon_get_state ()" link="XAppStatusIcon.html#xapp-status-icon-get-state" since="1.6"/>
114 <keyword type="function" name="xapp_status_icon_any_monitors ()" link="XAppStatusIcon.html#xapp-status-icon-any-monitors" since="1.6"/>
113115 <keyword type="macro" name="XAPP_TYPE_STATUS_ICON" link="XAppStatusIcon.html#XAPP-TYPE-STATUS-ICON:CAPS"/>
116 <keyword type="enum" name="enum XAppStatusIconState" link="XAppStatusIcon.html#XAppStatusIconState"/>
114117 <keyword type="struct" name="XAppStatusIcon" link="XAppStatusIcon.html#XAppStatusIcon-struct"/>
115118 <keyword type="property" name="The “primary-menu” property" link="XAppStatusIcon.html#XAppStatusIcon--primary-menu"/>
116119 <keyword type="property" name="The “secondary-menu” property" link="XAppStatusIcon.html#XAppStatusIcon--secondary-menu"/>
117120 <keyword type="signal" name="The “activate” signal" link="XAppStatusIcon.html#XAppStatusIcon-activate"/>
118121 <keyword type="signal" name="The “button-press-event” signal" link="XAppStatusIcon.html#XAppStatusIcon-button-press-event"/>
119122 <keyword type="signal" name="The “button-release-event” signal" link="XAppStatusIcon.html#XAppStatusIcon-button-release-event"/>
123 <keyword type="signal" name="The “state-changed” signal" link="XAppStatusIcon.html#XAppStatusIcon-state-changed"/>
120124 <keyword type="function" name="xapp_status_icon_monitor_new ()" link="XAppStatusIconMonitor.html#xapp-status-icon-monitor-new" since="1.6"/>
121125 <keyword type="function" name="xapp_status_icon_monitor_list_icons ()" link="XAppStatusIconMonitor.html#xapp-status-icon-monitor-list-icons" since="1.6"/>
122126 <keyword type="macro" name="XAPP_TYPE_STATUS_ICON_MONITOR" link="XAppStatusIconMonitor.html#XAPP-TYPE-STATUS-ICON-MONITOR:CAPS"/>
167171 <keyword type="constant" name="XAPP_ICON_SIZE_32" link="XAppIconChooserDialog.html#XAPP-ICON-SIZE-32:CAPS"/>
168172 <keyword type="constant" name="XAPP_ICON_SIZE_48" link="XAppIconChooserDialog.html#XAPP-ICON-SIZE-48:CAPS"/>
169173 <keyword type="constant" name="XAPP_ICON_SIZE_96" link="XAppIconChooserDialog.html#XAPP-ICON-SIZE-96:CAPS"/>
174 <keyword type="constant" name="XAPP_STATUS_ICON_STATE_NATIVE" link="XAppStatusIcon.html#XAPP-STATUS-ICON-STATE-NATIVE:CAPS"/>
175 <keyword type="constant" name="XAPP_STATUS_ICON_STATE_FALLBACK" link="XAppStatusIcon.html#XAPP-STATUS-ICON-STATE-FALLBACK:CAPS"/>
176 <keyword type="constant" name="XAPP_STATUS_ICON_STATE_NO_SUPPORT" link="XAppStatusIcon.html#XAPP-STATUS-ICON-STATE-NO-SUPPORT:CAPS"/>
170177 </functions>
171178 </book>
+2
-1
docs/reference/object-tree.html less more
4545 <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
4646 <span class="lineart">╰──</span> <a class="link" href="XAppStatusIconInterfaceSkeleton.html#XAppStatusIconInterface">XAppStatusIconInterface</a>
4747 <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
48 <span class="lineart">╰──</span> <a class="link" href="XAppIconChooserDialog.html#XAppIconSize" title="enum XAppIconSize">XAppIconSize</a>
48 <span class="lineart">├──</span> <a class="link" href="XAppIconChooserDialog.html#XAppIconSize" title="enum XAppIconSize">XAppIconSize</a>
49 <span class="lineart">╰──</span> <a class="link" href="XAppStatusIcon.html#XAppStatusIconState" title="enum XAppStatusIconState">XAppStatusIconState</a>
4950 </pre>
5051 </div>
5152 <div class="footer">