Codebase list xapp / e98737a
New upstream version 1.6.2 Norbert Preining 4 years ago
62 changed file(s) with 11291 addition(s) and 85 deletion(s). Raw diff Collapse all Expand all
+4
-0
README.md less more
1414 This project is still relatively new though and we can't yet commit to a stable ABI.
1515
1616 You are welcome to use libxapp or xapps-common in your application, but if you do, please make sure to tell us, so that we can communicate with you going forward about any potential changes.
17
18 # API Reference
19
20 http://developer.linuxmint.com/xapps/reference/index.html
1721
1822 ## XAppMonitorBlanker
1923
+89
-0
debian/changelog less more
0 xapp (1.6.2) tricia; urgency=medium
1
2 [ Eli Schwartz ]
3 * mate applet: fix configuring
4 * mate applet: fix regression in install location
5 * debian: fixup changed file locations
6
7 [ Michael Webster ]
8 * mate-xapp-status-applet.py: handle a null icon name correctly.
9 * test-scripts: have xapp-status-applet sort icons in the same manner the real applets do (symbolic to the right, then by alpha process name).
10 * xapp-status-icon.c: Keep an account of button presses so an orphan release doesn't activate or pop up a menu.
11 * xapp-status-icon: Track and notify changes in types of support for the icon - notify when a status icon is picked up by a native applet, a traditional system tray, or is not being picked up by anything.
12 * xapp-status-icon.c: Replace g_enum_to_string with a custom function, this isn't available with lmde's glib.
13
14 -- Clement Lefebvre <root@linuxmint.com> Fri, 22 Nov 2019 10:36:41 +0000
15
16 xapp (1.6.1) tricia; urgency=medium
17
18 [ Michael Webster ]
19 * xapp-status-icon: Add a function to check for the existence of any active status applets.
20
21 -- Clement Lefebvre <root@linuxmint.com> Wed, 13 Nov 2019 17:33:22 +0100
22
23 xapp (1.6.0) tricia; urgency=medium
24
25 [ Clement Lefebvre ]
26 * Implement XAppStatusIcon (#67)
27
28 [ James Ross ]
29 * libxapp: cleanup compile warnings (#69)
30
31 [ Michael Webster ]
32 * status icons: Add a monitor class for applets - XAppStatusIconMonitor, (#70)
33 * test-scripts: add a status-icon-via-libappindicator script.
34 * xapp-status-icon.c: Remove leftover debug line
35 * xapp-status-icon: When a menu is provided to XAppStatusIcon, handle positioning and showing it internally instead of requiring the application to do it.
36 * xapp-status-icon.c: Use G_ class macros to cleanup header file, fix xapp_status_icon_get_menu() (copy/paste error).
37 * Add some useful build C-flags, fix test script exec bit.
38
39 [ Clement Lefebvre ]
40 * Add API reference in docs/reference/
41 * Set theme jekyll-theme-architect
42 * README: Add link to API reference
43
44 [ Michael Webster ]
45 * xapp-status-icon.c: Emit 'activate' during fallback status icon activation.
46 * docs: Generate html automatically
47
48 [ Stephen Collins ]
49 * xapp-icon-chooser-dialog.c: Remove unused variable
50 * icon chooser dialog: add default_icon property
51 * icon chooser dialog: add *_add_custom_category () function
52
53 [ Michael Webster ]
54 * Add a Mate status applet (#72)
55 * xapp-status-icon.c: Refactor event handling.
56
57 [ Stephen Collins ]
58 * xapp-icon-chooser-dialog.c: prevent segfault on non-existent icon name (#76)
59
60 [ Clement Lefebvre ]
61 * IconChooserButton: Add the ability to set the default category (#77)
62
63 [ Stephen Collins ]
64 * xapp-icon-chooser-button.c: add missing dispose method (#78)
65
66 [ Michael Webster ]
67 * mate-xapp-status-applet.py: Make improvements to event handling and widget appearance during clicks.
68 * Add a custom install script for installing the generated header file.
69 * Add i18n for the mate applet.
70 * mate applet: Add an about window, use more appropriate install locations, move build replacement strings to a separate imported file.
71 * xapp-status-icon.c: During async ops, when checking for cancellation, use the error code, as the cancellable may have reset in the interim, but the code will be correct.
72
73 [ Michael Webster ]
74 * status icons: Support multiple icons from the same process.
75
76 [ Clement Lefebvre ]
77 * Revert "docs: Generate html automatically"
78 * Add a makedoc script to update docs/reference
79 * Update reference docs
80
81 [ Stephen Collins ]
82 * xapp-icon-chooser-dialog.c: color the symbolic icons properly and fix hidpi (#79)
83
84 [ Clement Lefebvre ]
85 * l10n: Update POT
86
87 -- Clement Lefebvre <root@linuxmint.com> Tue, 12 Nov 2019 11:12:12 +0100
88
089 xapp (1.4.9) tina; urgency=medium
190
291 [ Michael Webster ]
+3
-0
debian/xapps-common.install less more
11 usr/bin/
22 usr/share/icons
33 usr/share/locale
4 usr/libexec/xapps
5 usr/share/mate-panel/applets
6 usr/share/dbus-1/services
+1
-0
docs/_config.yml less more
0 theme: jekyll-theme-architect⏎
+721
-0
docs/reference/XAppGtkWindow.html less more
0 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>XAppGtkWindow: XApp Reference Manual</title>
5 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
6 <link rel="home" href="index.html" title="XApp Reference Manual">
7 <link rel="up" href="ch01.html" title="API reference">
8 <link rel="prev" href="ch01.html" title="API reference">
9 <link rel="next" href="XAppIconChooserButton.html" title="XAppIconChooserButton">
10 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
15 <td width="100%" align="left" class="shortcuts">
16 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
17 <a href="#XAppGtkWindow.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
18 <a href="#XAppGtkWindow.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
19 <a href="#XAppGtkWindow.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="XAppIconChooserButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="XAppGtkWindow"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="XAppGtkWindow.top_of_page"></a>XAppGtkWindow</span></h2>
31 <p>XAppGtkWindow — A subclass of <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><code class="literal">GtkWindow</code></a> that allows additional
32 communication with the window manager.</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="XAppGtkWindow.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_return">
41 <col class="functions_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="XAppGtkWindow.html#xapp-gtk-window-new" title="xapp_gtk_window_new ()">xapp_gtk_window_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <span class="returnvalue">void</span>
55 </td>
56 <td class="function_name">
57 <a class="link" href="XAppGtkWindow.html#xapp-gtk-window-set-icon-name" title="xapp_gtk_window_set_icon_name ()">xapp_gtk_window_set_icon_name</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">void</span>
63 </td>
64 <td class="function_name">
65 <a class="link" href="XAppGtkWindow.html#xapp-gtk-window-set-icon-from-file" title="xapp_gtk_window_set_icon_from_file ()">xapp_gtk_window_set_icon_from_file</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <span class="returnvalue">void</span>
71 </td>
72 <td class="function_name">
73 <a class="link" href="XAppGtkWindow.html#xapp-gtk-window-set-progress" title="xapp_gtk_window_set_progress ()">xapp_gtk_window_set_progress</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">void</span>
79 </td>
80 <td class="function_name">
81 <a class="link" href="XAppGtkWindow.html#xapp-gtk-window-set-progress-pulse" title="xapp_gtk_window_set_progress_pulse ()">xapp_gtk_window_set_progress_pulse</a> <span class="c_punctuation">()</span>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">
86 <span class="returnvalue">void</span>
87 </td>
88 <td class="function_name">
89 <a class="link" href="XAppGtkWindow.html#xapp-set-window-icon-name" title="xapp_set_window_icon_name ()">xapp_set_window_icon_name</a> <span class="c_punctuation">()</span>
90 </td>
91 </tr>
92 <tr>
93 <td class="function_type">
94 <span class="returnvalue">void</span>
95 </td>
96 <td class="function_name">
97 <a class="link" href="XAppGtkWindow.html#xapp-set-window-icon-from-file" title="xapp_set_window_icon_from_file ()">xapp_set_window_icon_from_file</a> <span class="c_punctuation">()</span>
98 </td>
99 </tr>
100 <tr>
101 <td class="function_type">
102 <span class="returnvalue">void</span>
103 </td>
104 <td class="function_name">
105 <a class="link" href="XAppGtkWindow.html#xapp-set-window-progress" title="xapp_set_window_progress ()">xapp_set_window_progress</a> <span class="c_punctuation">()</span>
106 </td>
107 </tr>
108 <tr>
109 <td class="function_type">
110 <span class="returnvalue">void</span>
111 </td>
112 <td class="function_name">
113 <a class="link" href="XAppGtkWindow.html#xapp-set-window-progress-pulse" title="xapp_set_window_progress_pulse ()">xapp_set_window_progress_pulse</a> <span class="c_punctuation">()</span>
114 </td>
115 </tr>
116 <tr>
117 <td class="function_type">
118 <span class="returnvalue">void</span>
119 </td>
120 <td class="function_name">
121 <a class="link" href="XAppGtkWindow.html#xapp-set-xid-icon-name" title="xapp_set_xid_icon_name ()">xapp_set_xid_icon_name</a> <span class="c_punctuation">()</span>
122 </td>
123 </tr>
124 <tr>
125 <td class="function_type">
126 <span class="returnvalue">void</span>
127 </td>
128 <td class="function_name">
129 <a class="link" href="XAppGtkWindow.html#xapp-set-xid-icon-from-file" title="xapp_set_xid_icon_from_file ()">xapp_set_xid_icon_from_file</a> <span class="c_punctuation">()</span>
130 </td>
131 </tr>
132 <tr>
133 <td class="function_type">
134 <span class="returnvalue">void</span>
135 </td>
136 <td class="function_name">
137 <a class="link" href="XAppGtkWindow.html#xapp-set-xid-progress" title="xapp_set_xid_progress ()">xapp_set_xid_progress</a> <span class="c_punctuation">()</span>
138 </td>
139 </tr>
140 <tr>
141 <td class="function_type">
142 <span class="returnvalue">void</span>
143 </td>
144 <td class="function_name">
145 <a class="link" href="XAppGtkWindow.html#xapp-set-xid-progress-pulse" title="xapp_set_xid_progress_pulse ()">xapp_set_xid_progress_pulse</a> <span class="c_punctuation">()</span>
146 </td>
147 </tr>
148 </tbody>
149 </table></div>
150 </div>
151 <div class="refsect1">
152 <a name="XAppGtkWindow.other"></a><h2>Types and Values</h2>
153 <div class="informaltable"><table class="informaltable" width="100%" border="0">
154 <colgroup>
155 <col width="150px" class="name">
156 <col class="description">
157 </colgroup>
158 <tbody>
159 <tr>
160 <td class="define_keyword">#define</td>
161 <td class="function_name"><a class="link" href="XAppGtkWindow.html#XAPP-TYPE-GTK-WINDOW:CAPS" title="XAPP_TYPE_GTK_WINDOW">XAPP_TYPE_GTK_WINDOW</a></td>
162 </tr>
163 <tr>
164 <td class="datatype_keyword">struct</td>
165 <td class="function_name"><a class="link" href="XAppGtkWindow.html#XAppGtkWindowClass" title="struct XAppGtkWindowClass">XAppGtkWindowClass</a></td>
166 </tr>
167 <tr>
168 <td class="datatype_keyword"> </td>
169 <td class="function_name"><a class="link" href="XAppGtkWindow.html#XAppGtkWindow-struct" title="XAppGtkWindow">XAppGtkWindow</a></td>
170 </tr>
171 </tbody>
172 </table></div>
173 </div>
174 <div class="refsect1">
175 <a name="XAppGtkWindow.object-hierarchy"></a><h2>Object Hierarchy</h2>
176 <pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
177 <span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
178 <span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
179 <span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
180 <span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
181 <span class="lineart">╰──</span> <a href="../gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
182 <span class="lineart">╰──</span> XAppGtkWindow
183 <span class="lineart">╰──</span> <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog">XAppIconChooserDialog</a>
184 </pre>
185 </div>
186 <div class="refsect1">
187 <a name="XAppGtkWindow.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
188 <p>
189 XAppGtkWindow implements
190 AtkImplementorIface and <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
191 </div>
192 <div class="refsect1">
193 <a name="XAppGtkWindow.description"></a><h2>Description</h2>
194 <p>This widget is a simple subclass of GtkWindow that provides the following
195 additional capabilities:</p>
196 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
197 <li class="listitem"><p>Ability to set an icon name or icon file path for the window manager to
198 make use of, rather than relying on a desktop file or fixed-size window-
199 backed icon that Gtk normally generates. The window manager must support
200 the NET_WM_XAPP_ICON_NAME hint.</p></li>
201 <li class="listitem"><p>Ability to send progress info to the window manager, in the form of an integer,
202 0-100, which can then be used to display this progress in some manner in a task
203 manager or window list. The window manager must support the NET_WM_XAPP_PROGRESS
204 hint.</p></li>
205 <li class="listitem"><p>Ability to signal a 'pulsing' progress state, of potentially indeterminate value,
206 in the form of a boolean, which can be passed on to a window list. The window
207 manager must support the NET_WM_XAPP_PROGRESS_PULSE hint</p></li>
208 </ul></div>
209 <p>Wrappers:</p>
210 <p>Also provided are corresponding wrapper functions for normal GtkWindows.
211 They are not class methods - they are called with the target widget as their first
212 argument.</p>
213 <p>For example:</p>
214 <p>win = Gtk.Window()
215 XApp.set_window_icon_name(win, "foobar")</p>
216 <p>These functions mirror those of the <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> class, but allow the properties
217 to work with normal GtkWindows and descendants of GtkWindow.</p>
218 </div>
219 <div class="refsect1">
220 <a name="XAppGtkWindow.functions_details"></a><h2>Functions</h2>
221 <div class="refsect2">
222 <a name="xapp-gtk-window-new"></a><h3>xapp_gtk_window_new ()</h3>
223 <pre class="programlisting"><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
224 xapp_gtk_window_new (<em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindowType"><span class="type">GtkWindowType</span></a> type</code></em>);</pre>
225 <p>Creates a new <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> of type <em class="parameter"><code>type</code></em>
226 . See <a href="../gtk3/GtkWindow.html#gtk-window-new"><code class="function">gtk_window_new()</code></a>
227 for more details.</p>
228 <div class="refsect3">
229 <a name="xapp-gtk-window-new.parameters"></a><h4>Parameters</h4>
230 <div class="informaltable"><table class="informaltable" width="100%" border="0">
231 <colgroup>
232 <col width="150px" class="parameters_name">
233 <col class="parameters_description">
234 <col width="200px" class="parameters_annotations">
235 </colgroup>
236 <tbody><tr>
237 <td class="parameter_name"><p>type</p></td>
238 <td class="parameter_description"><p>The <a href="../gtk3/GtkWindow.html#GtkWindowType"><span class="type">GtkWindowType</span></a> to use</p></td>
239 <td class="parameter_annotations"> </td>
240 </tr></tbody>
241 </table></div>
242 </div>
243 <div class="refsect3">
244 <a name="xapp-gtk-window-new.returns"></a><h4>Returns</h4>
245 <p> A new <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> (transfer: full)</p>
246 </div>
247 </div>
248 <hr>
249 <div class="refsect2">
250 <a name="xapp-gtk-window-set-icon-name"></a><h3>xapp_gtk_window_set_icon_name ()</h3>
251 <pre class="programlisting"><span class="returnvalue">void</span>
252 xapp_gtk_window_set_icon_name (<em class="parameter"><code><a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> *window</code></em>,
253 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre>
254 <p>Sets the icon name hint for a window manager (like muffin) to make
255 available when applications want to change their icons during runtime
256 without having to resort to the internal low-res pixbufs that GdkWindow
257 sets on the client side. This also chains up and calls GtkWindow.set_icon_name
258 for convenience and compatibility. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
259 <div class="refsect3">
260 <a name="xapp-gtk-window-set-icon-name.parameters"></a><h4>Parameters</h4>
261 <div class="informaltable"><table class="informaltable" width="100%" border="0">
262 <colgroup>
263 <col width="150px" class="parameters_name">
264 <col class="parameters_description">
265 <col width="200px" class="parameters_annotations">
266 </colgroup>
267 <tbody>
268 <tr>
269 <td class="parameter_name"><p>window</p></td>
270 <td class="parameter_description"><p>The <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> to set the icon name for</p></td>
271 <td class="parameter_annotations"> </td>
272 </tr>
273 <tr>
274 <td class="parameter_name"><p>icon_name</p></td>
275 <td class="parameter_description"><p>The icon name or path to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
276 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
277 </tr>
278 </tbody>
279 </table></div>
280 </div>
281 </div>
282 <hr>
283 <div class="refsect2">
284 <a name="xapp-gtk-window-set-icon-from-file"></a><h3>xapp_gtk_window_set_icon_from_file ()</h3>
285 <pre class="programlisting"><span class="returnvalue">void</span>
286 xapp_gtk_window_set_icon_from_file (<em class="parameter"><code><a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> *window</code></em>,
287 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
288 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
289 <p>Sets the icon name hint for a window manager (like muffin) to make
290 available when applications want to change their icons during runtime
291 without having to resort to the internal low-res pixbufs that GdkWindow
292 sets on the client side. This also chains up and calls GtkWindow.set_icon_from_file
293 for convenience and compatibility. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
294 <div class="refsect3">
295 <a name="xapp-gtk-window-set-icon-from-file.parameters"></a><h4>Parameters</h4>
296 <div class="informaltable"><table class="informaltable" width="100%" border="0">
297 <colgroup>
298 <col width="150px" class="parameters_name">
299 <col class="parameters_description">
300 <col width="200px" class="parameters_annotations">
301 </colgroup>
302 <tbody>
303 <tr>
304 <td class="parameter_name"><p>window</p></td>
305 <td class="parameter_description"><p>The <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> to set the icon name for</p></td>
306 <td class="parameter_annotations"> </td>
307 </tr>
308 <tr>
309 <td class="parameter_name"><p>file_name</p></td>
310 <td class="parameter_description"><p>The icon path to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
311 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
312 </tr>
313 <tr>
314 <td class="parameter_name"><p>error</p></td>
315 <td class="parameter_description"><p>An error to set if something goes wrong. </p></td>
316 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
317 </tr>
318 </tbody>
319 </table></div>
320 </div>
321 </div>
322 <hr>
323 <div class="refsect2">
324 <a name="xapp-gtk-window-set-progress"></a><h3>xapp_gtk_window_set_progress ()</h3>
325 <pre class="programlisting"><span class="returnvalue">void</span>
326 xapp_gtk_window_set_progress (<em class="parameter"><code><a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> *window</code></em>,
327 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> progress</code></em>);</pre>
328 <p>Sets the progress hint for a window manager (like muffin) to make
329 available when applications want to display the application's progress
330 in some operation. The value sent to the WM will be clamped to
331 between 0 and 100.</p>
332 <p>Note: If a window will stick around after progress is complete, you will
333 probaby need to set progress to 0 to remove any progress effects on taskbars
334 and window lists.</p>
335 <p>Setting progress will also cancel the 'pulsing' flag on the window as
336 well, if it has been set.</p>
337 <div class="refsect3">
338 <a name="xapp-gtk-window-set-progress.parameters"></a><h4>Parameters</h4>
339 <div class="informaltable"><table class="informaltable" width="100%" border="0">
340 <colgroup>
341 <col width="150px" class="parameters_name">
342 <col class="parameters_description">
343 <col width="200px" class="parameters_annotations">
344 </colgroup>
345 <tbody>
346 <tr>
347 <td class="parameter_name"><p>window</p></td>
348 <td class="parameter_description"><p>The <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> to set the progress for</p></td>
349 <td class="parameter_annotations"> </td>
350 </tr>
351 <tr>
352 <td class="parameter_name"><p>progress</p></td>
353 <td class="parameter_description"><p>The value to set for progress.</p></td>
354 <td class="parameter_annotations"> </td>
355 </tr>
356 </tbody>
357 </table></div>
358 </div>
359 </div>
360 <hr>
361 <div class="refsect2">
362 <a name="xapp-gtk-window-set-progress-pulse"></a><h3>xapp_gtk_window_set_progress_pulse ()</h3>
363 <pre class="programlisting"><span class="returnvalue">void</span>
364 xapp_gtk_window_set_progress_pulse (<em class="parameter"><code><a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> *window</code></em>,
365 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pulse</code></em>);</pre>
366 <p>Sets the progress pulse hint hint for a window manager (like muffin)
367 to make available when applications want to display indeterminate or
368 ongoing progress in a task manager.</p>
369 <p>Note: If a window will stick around after progress is complete, you will
370 probaby need to set progress to 0 to remove any progress effects on taskbars
371 and window lists. This will also remove the pulse state, if it is set.</p>
372 <p>Setting an explicit progress value will unset this flag.</p>
373 <div class="refsect3">
374 <a name="xapp-gtk-window-set-progress-pulse.parameters"></a><h4>Parameters</h4>
375 <div class="informaltable"><table class="informaltable" width="100%" border="0">
376 <colgroup>
377 <col width="150px" class="parameters_name">
378 <col class="parameters_description">
379 <col width="200px" class="parameters_annotations">
380 </colgroup>
381 <tbody>
382 <tr>
383 <td class="parameter_name"><p>window</p></td>
384 <td class="parameter_description"><p>The <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow"><span class="type">XAppGtkWindow</span></a> to set the progress for</p></td>
385 <td class="parameter_annotations"> </td>
386 </tr>
387 <tr>
388 <td class="parameter_name"><p>pulse</p></td>
389 <td class="parameter_description"><p>Whether to have pulsing set or not.</p></td>
390 <td class="parameter_annotations"> </td>
391 </tr>
392 </tbody>
393 </table></div>
394 </div>
395 </div>
396 <hr>
397 <div class="refsect2">
398 <a name="xapp-set-window-icon-name"></a><h3>xapp_set_window_icon_name ()</h3>
399 <pre class="programlisting"><span class="returnvalue">void</span>
400 xapp_set_window_icon_name (<em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
401 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre>
402 <p>Sets the icon name hint for a window manager (like muffin) to make
403 available when applications want to change their icons during runtime
404 without having to resort to the internal low-res pixbufs that GdkWindow
405 sets on the client side. This is a function, not a method, for taking
406 advantage of this feature with descendants of GtkWindows, such as
407 GtkDialogs. Sets gtk_window_set_icon_name as well, to avoid needing
408 to have two calls each time. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
409 <div class="refsect3">
410 <a name="xapp-set-window-icon-name.parameters"></a><h4>Parameters</h4>
411 <div class="informaltable"><table class="informaltable" width="100%" border="0">
412 <colgroup>
413 <col width="150px" class="parameters_name">
414 <col class="parameters_description">
415 <col width="200px" class="parameters_annotations">
416 </colgroup>
417 <tbody>
418 <tr>
419 <td class="parameter_name"><p>window</p></td>
420 <td class="parameter_description"><p>The <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> to set the icon name for</p></td>
421 <td class="parameter_annotations"> </td>
422 </tr>
423 <tr>
424 <td class="parameter_name"><p>icon_name</p></td>
425 <td class="parameter_description"><p>The icon name to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
426 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
427 </tr>
428 </tbody>
429 </table></div>
430 </div>
431 </div>
432 <hr>
433 <div class="refsect2">
434 <a name="xapp-set-window-icon-from-file"></a><h3>xapp_set_window_icon_from_file ()</h3>
435 <pre class="programlisting"><span class="returnvalue">void</span>
436 xapp_set_window_icon_from_file (<em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
437 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
438 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
439 <p>Sets the icon name hint for a window manager (like muffin) to make
440 available when applications want to change their icons during runtime
441 without having to resort to the internal low-res pixbufs that GdkWindow
442 sets on the client side. This also chains up and calls GtkWindow.set_icon_from_file
443 for convenience and compatibility. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
444 <div class="refsect3">
445 <a name="xapp-set-window-icon-from-file.parameters"></a><h4>Parameters</h4>
446 <div class="informaltable"><table class="informaltable" width="100%" border="0">
447 <colgroup>
448 <col width="150px" class="parameters_name">
449 <col class="parameters_description">
450 <col width="200px" class="parameters_annotations">
451 </colgroup>
452 <tbody>
453 <tr>
454 <td class="parameter_name"><p>window</p></td>
455 <td class="parameter_description"><p>The <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> to set the icon name for</p></td>
456 <td class="parameter_annotations"> </td>
457 </tr>
458 <tr>
459 <td class="parameter_name"><p>file_name</p></td>
460 <td class="parameter_description"><p>The icon path to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
461 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
462 </tr>
463 <tr>
464 <td class="parameter_name"><p>error</p></td>
465 <td class="parameter_description"><p>An error to set if something goes wrong. </p></td>
466 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
467 </tr>
468 </tbody>
469 </table></div>
470 </div>
471 </div>
472 <hr>
473 <div class="refsect2">
474 <a name="xapp-set-window-progress"></a><h3>xapp_set_window_progress ()</h3>
475 <pre class="programlisting"><span class="returnvalue">void</span>
476 xapp_set_window_progress (<em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
477 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> progress</code></em>);</pre>
478 <p>Sets the progress hint for a window manager (like muffin) to make
479 available when applications want to display the application's progress
480 in some operation. The value sent to the WM will be clamped to
481 between 0 and 100.</p>
482 <p>Note: If a window will stick around after progress is complete, you will
483 probaby need to set progress to 0 to remove any progress effects on taskbars
484 and window lists.</p>
485 <p>Setting progress will also cancel the 'pulsing' flag on the window as
486 well, if it has been set.</p>
487 <div class="refsect3">
488 <a name="xapp-set-window-progress.parameters"></a><h4>Parameters</h4>
489 <div class="informaltable"><table class="informaltable" width="100%" border="0">
490 <colgroup>
491 <col width="150px" class="parameters_name">
492 <col class="parameters_description">
493 <col width="200px" class="parameters_annotations">
494 </colgroup>
495 <tbody>
496 <tr>
497 <td class="parameter_name"><p>window</p></td>
498 <td class="parameter_description"><p>The <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> to set the progress for</p></td>
499 <td class="parameter_annotations"> </td>
500 </tr>
501 <tr>
502 <td class="parameter_name"><p>progress</p></td>
503 <td class="parameter_description"><p>The value to set for progress.</p></td>
504 <td class="parameter_annotations"> </td>
505 </tr>
506 </tbody>
507 </table></div>
508 </div>
509 </div>
510 <hr>
511 <div class="refsect2">
512 <a name="xapp-set-window-progress-pulse"></a><h3>xapp_set_window_progress_pulse ()</h3>
513 <pre class="programlisting"><span class="returnvalue">void</span>
514 xapp_set_window_progress_pulse (<em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
515 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pulse</code></em>);</pre>
516 <p>Sets the progress pulse hint hint for a window manager (like muffin)
517 to make available when applications want to display indeterminate or
518 ongoing progress in a task manager.</p>
519 <p>Note: If a window will stick around after progress is complete, you will
520 probaby need to set progress to 0 to remove any progress effects on taskbars
521 and window lists. This will also remove the pulse state, if it is set.</p>
522 <p>Setting an explicit progress value will unset this flag.</p>
523 <div class="refsect3">
524 <a name="xapp-set-window-progress-pulse.parameters"></a><h4>Parameters</h4>
525 <div class="informaltable"><table class="informaltable" width="100%" border="0">
526 <colgroup>
527 <col width="150px" class="parameters_name">
528 <col class="parameters_description">
529 <col width="200px" class="parameters_annotations">
530 </colgroup>
531 <tbody>
532 <tr>
533 <td class="parameter_name"><p>window</p></td>
534 <td class="parameter_description"><p>The <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> to set the progress for</p></td>
535 <td class="parameter_annotations"> </td>
536 </tr>
537 <tr>
538 <td class="parameter_name"><p>pulse</p></td>
539 <td class="parameter_description"><p>Whether to have pulsing set or not.</p></td>
540 <td class="parameter_annotations"> </td>
541 </tr>
542 </tbody>
543 </table></div>
544 </div>
545 </div>
546 <hr>
547 <div class="refsect2">
548 <a name="xapp-set-xid-icon-name"></a><h3>xapp_set_xid_icon_name ()</h3>
549 <pre class="programlisting"><span class="returnvalue">void</span>
550 xapp_set_xid_icon_name (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> xid</code></em>,
551 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre>
552 <p>Sets the icon name hint for a window manager (like muffin) to make
553 available when applications want to change their icons during runtime
554 without having to resort to the internal low-res pixbufs that GdkWindow
555 sets on the client side. This is a function, not a method, for applying
556 the icon name property for a given (possibly foreign) window, by passing
557 the window's XID. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
558 <div class="refsect3">
559 <a name="xapp-set-xid-icon-name.parameters"></a><h4>Parameters</h4>
560 <div class="informaltable"><table class="informaltable" width="100%" border="0">
561 <colgroup>
562 <col width="150px" class="parameters_name">
563 <col class="parameters_description">
564 <col width="200px" class="parameters_annotations">
565 </colgroup>
566 <tbody>
567 <tr>
568 <td class="parameter_name"><p>xid</p></td>
569 <td class="parameter_description"><p>The Window to set the icon name for</p></td>
570 <td class="parameter_annotations"> </td>
571 </tr>
572 <tr>
573 <td class="parameter_name"><p>icon_name</p></td>
574 <td class="parameter_description"><p>The icon name to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
575 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
576 </tr>
577 </tbody>
578 </table></div>
579 </div>
580 </div>
581 <hr>
582 <div class="refsect2">
583 <a name="xapp-set-xid-icon-from-file"></a><h3>xapp_set_xid_icon_from_file ()</h3>
584 <pre class="programlisting"><span class="returnvalue">void</span>
585 xapp_set_xid_icon_from_file (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> xid</code></em>,
586 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>);</pre>
587 <p>Sets the icon name hint for a window manager (like muffin) to make
588 available when applications want to change their icons during runtime
589 without having to resort to the internal low-res pixbufs that GdkWindow
590 sets on the client side. This is a function, not a method, for applying
591 the icon name property for a given (possibly foreign) window, by passing
592 the window's XID. Set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset.</p>
593 <div class="refsect3">
594 <a name="xapp-set-xid-icon-from-file.parameters"></a><h4>Parameters</h4>
595 <div class="informaltable"><table class="informaltable" width="100%" border="0">
596 <colgroup>
597 <col width="150px" class="parameters_name">
598 <col class="parameters_description">
599 <col width="200px" class="parameters_annotations">
600 </colgroup>
601 <tbody>
602 <tr>
603 <td class="parameter_name"><p>xid</p></td>
604 <td class="parameter_description"><p>The Window to set the icon name for</p></td>
605 <td class="parameter_annotations"> </td>
606 </tr>
607 <tr>
608 <td class="parameter_name"><p>file_name</p></td>
609 <td class="parameter_description"><p>The icon path to set, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset. </p></td>
610 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
611 </tr>
612 </tbody>
613 </table></div>
614 </div>
615 </div>
616 <hr>
617 <div class="refsect2">
618 <a name="xapp-set-xid-progress"></a><h3>xapp_set_xid_progress ()</h3>
619 <pre class="programlisting"><span class="returnvalue">void</span>
620 xapp_set_xid_progress (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> xid</code></em>,
621 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> progress</code></em>);</pre>
622 <p>Sets the progress hint for a window manager (like muffin) to make
623 available when applications want to display the application's progress
624 in some operation. The value sent to the WM will be clamped to
625 between 0 and 100.</p>
626 <p>Setting progress will also cancel the 'pulsing' flag on the window as
627 well, if it has been set.</p>
628 <p>Note: If a window will stick around after progress is complete, you will
629 probaby need to set progress to 0 to remove any progress effects on taskbars
630 and window lists.</p>
631 <p>This is a function, not a method, for applying the progress property for
632 a given (possibly foreign) window, by passing the window's XID.</p>
633 <div class="refsect3">
634 <a name="xapp-set-xid-progress.parameters"></a><h4>Parameters</h4>
635 <div class="informaltable"><table class="informaltable" width="100%" border="0">
636 <colgroup>
637 <col width="150px" class="parameters_name">
638 <col class="parameters_description">
639 <col width="200px" class="parameters_annotations">
640 </colgroup>
641 <tbody>
642 <tr>
643 <td class="parameter_name"><p>xid</p></td>
644 <td class="parameter_description"><p>The Window to set the progress for</p></td>
645 <td class="parameter_annotations"> </td>
646 </tr>
647 <tr>
648 <td class="parameter_name"><p>progress</p></td>
649 <td class="parameter_description"><p>The value to set for progress.</p></td>
650 <td class="parameter_annotations"> </td>
651 </tr>
652 </tbody>
653 </table></div>
654 </div>
655 </div>
656 <hr>
657 <div class="refsect2">
658 <a name="xapp-set-xid-progress-pulse"></a><h3>xapp_set_xid_progress_pulse ()</h3>
659 <pre class="programlisting"><span class="returnvalue">void</span>
660 xapp_set_xid_progress_pulse (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> xid</code></em>,
661 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pulse</code></em>);</pre>
662 <p>Sets the progress pulse hint hint for a window manager (like muffin)
663 to make available when applications want to display indeterminate or
664 ongoing progress in a task manager.</p>
665 <p>Note: If a window will stick around after progress is complete, you will
666 probaby need to set progress to 0 to remove any progress effects on taskbars
667 and window lists.</p>
668 <p>Setting an explicit progress value will unset this flag.</p>
669 <div class="refsect3">
670 <a name="xapp-set-xid-progress-pulse.parameters"></a><h4>Parameters</h4>
671 <div class="informaltable"><table class="informaltable" width="100%" border="0">
672 <colgroup>
673 <col width="150px" class="parameters_name">
674 <col class="parameters_description">
675 <col width="200px" class="parameters_annotations">
676 </colgroup>
677 <tbody>
678 <tr>
679 <td class="parameter_name"><p>xid</p></td>
680 <td class="parameter_description"><p>The Window to set the progress for</p></td>
681 <td class="parameter_annotations"> </td>
682 </tr>
683 <tr>
684 <td class="parameter_name"><p>pulse</p></td>
685 <td class="parameter_description"><p>Whether to have pulsing set or not.</p></td>
686 <td class="parameter_annotations"> </td>
687 </tr>
688 </tbody>
689 </table></div>
690 </div>
691 </div>
692 </div>
693 <div class="refsect1">
694 <a name="XAppGtkWindow.other_details"></a><h2>Types and Values</h2>
695 <div class="refsect2">
696 <a name="XAPP-TYPE-GTK-WINDOW:CAPS"></a><h3>XAPP_TYPE_GTK_WINDOW</h3>
697 <pre class="programlisting">#define XAPP_TYPE_GTK_WINDOW (xapp_gtk_window_get_type ())
698 </pre>
699 </div>
700 <hr>
701 <div class="refsect2">
702 <a name="XAppGtkWindowClass"></a><h3>struct XAppGtkWindowClass</h3>
703 <pre class="programlisting">struct XAppGtkWindowClass {
704 GtkWindowClass parent_class;
705
706 gpointer padding[12];
707 };
708 </pre>
709 </div>
710 <hr>
711 <div class="refsect2">
712 <a name="XAppGtkWindow-struct"></a><h3>XAppGtkWindow</h3>
713 <pre class="programlisting">typedef struct _XAppGtkWindow XAppGtkWindow;</pre>
714 </div>
715 </div>
716 </div>
717 <div class="footer">
718 <hr>Generated by GTK-Doc V1.27</div>
719 </body>
720 </html>⏎
+409
-0
docs/reference/XAppIconChooserButton.html less more
0 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>XAppIconChooserButton: XApp Reference Manual</title>
5 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
6 <link rel="home" href="index.html" title="XApp Reference Manual">
7 <link rel="up" href="ch01.html" title="API reference">
8 <link rel="prev" href="XAppGtkWindow.html" title="XAppGtkWindow">
9 <link rel="next" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog">
10 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
15 <td width="100%" align="left" class="shortcuts">
16 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
17 <a href="#XAppIconChooserButton.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
18 <a href="#XAppIconChooserButton.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
19 <a href="#XAppIconChooserButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#XAppIconChooserButton.properties" class="shortcut">Properties</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="XAppGtkWindow.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="XAppIconChooserDialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="XAppIconChooserButton"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="XAppIconChooserButton.top_of_page"></a>XAppIconChooserButton</span></h2>
32 <p>XAppIconChooserButton — A button for selecting an icon</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="XAppIconChooserButton.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_return">
41 <col class="functions_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="returnvalue">XAppIconChooserButton</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-new" title="xapp_icon_chooser_button_new ()">xapp_icon_chooser_button_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="returnvalue">XAppIconChooserButton</span></a> *
55 </td>
56 <td class="function_name">
57 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-new-with-size" title="xapp_icon_chooser_button_new_with_size ()">xapp_icon_chooser_button_new_with_size</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">void</span>
63 </td>
64 <td class="function_name">
65 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-set-icon-size" title="xapp_icon_chooser_button_set_icon_size ()">xapp_icon_chooser_button_set_icon_size</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <span class="returnvalue">void</span>
71 </td>
72 <td class="function_name">
73 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-set-icon" title="xapp_icon_chooser_button_set_icon ()">xapp_icon_chooser_button_set_icon</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">void</span>
79 </td>
80 <td class="function_name">
81 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-set-default-category" title="xapp_icon_chooser_button_set_default_category ()">xapp_icon_chooser_button_set_default_category</a> <span class="c_punctuation">()</span>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
86 </td>
87 <td class="function_name">
88 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-get-icon" title="xapp_icon_chooser_button_get_icon ()">xapp_icon_chooser_button_get_icon</a> <span class="c_punctuation">()</span>
89 </td>
90 </tr>
91 <tr>
92 <td class="function_type">
93 <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="returnvalue">XAppIconChooserDialog</span></a> *
94 </td>
95 <td class="function_name">
96 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-get-dialog" title="xapp_icon_chooser_button_get_dialog ()">xapp_icon_chooser_button_get_dialog</a> <span class="c_punctuation">()</span>
97 </td>
98 </tr>
99 </tbody>
100 </table></div>
101 </div>
102 <div class="refsect1">
103 <a name="XAppIconChooserButton.properties"></a><h2>Properties</h2>
104 <div class="informaltable"><table class="informaltable" border="0">
105 <colgroup>
106 <col width="150px" class="properties_type">
107 <col width="300px" class="properties_name">
108 <col width="200px" class="properties_flags">
109 </colgroup>
110 <tbody>
111 <tr>
112 <td class="property_type">
113 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
114 <td class="property_name"><a class="link" href="XAppIconChooserButton.html#XAppIconChooserButton--category" title="The “category” property">category</a></td>
115 <td class="property_flags">Read / Write</td>
116 </tr>
117 <tr>
118 <td class="property_type">
119 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
120 <td class="property_name"><a class="link" href="XAppIconChooserButton.html#XAppIconChooserButton--icon" title="The “icon” property">icon</a></td>
121 <td class="property_flags">Read / Write</td>
122 </tr>
123 <tr>
124 <td class="property_type"><a href="../gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a></td>
125 <td class="property_name"><a class="link" href="XAppIconChooserButton.html#XAppIconChooserButton--icon-size" title="The “icon-size” property">icon-size</a></td>
126 <td class="property_flags">Read / Write</td>
127 </tr>
128 </tbody>
129 </table></div>
130 </div>
131 <div class="refsect1">
132 <a name="XAppIconChooserButton.other"></a><h2>Types and Values</h2>
133 <div class="informaltable"><table class="informaltable" width="100%" border="0">
134 <colgroup>
135 <col width="150px" class="name">
136 <col class="description">
137 </colgroup>
138 <tbody>
139 <tr>
140 <td class="define_keyword">#define</td>
141 <td class="function_name"><a class="link" href="XAppIconChooserButton.html#XAPP-TYPE-ICON-CHOOSER-BUTTON:CAPS" title="XAPP_TYPE_ICON_CHOOSER_BUTTON">XAPP_TYPE_ICON_CHOOSER_BUTTON</a></td>
142 </tr>
143 <tr>
144 <td class="datatype_keyword"> </td>
145 <td class="function_name"><a class="link" href="XAppIconChooserButton.html#XAppIconChooserButton-struct" title="XAppIconChooserButton">XAppIconChooserButton</a></td>
146 </tr>
147 </tbody>
148 </table></div>
149 </div>
150 <div class="refsect1">
151 <a name="XAppIconChooserButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
152 <pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
153 <span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
154 <span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
155 <span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
156 <span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
157 <span class="lineart">╰──</span> <a href="../gtk3/GtkButton.html#GtkButton-struct">GtkButton</a>
158 <span class="lineart">╰──</span> XAppIconChooserButton
159 </pre>
160 </div>
161 <div class="refsect1">
162 <a name="XAppIconChooserButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
163 <p>
164 XAppIconChooserButton implements
165 AtkImplementorIface, <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>, <a href="../gtk3/GtkActionable.html#GtkActionable-struct">GtkActionable</a> and <a href="../gtk3/GtkActivatable.html#GtkActivatable-struct">GtkActivatable</a>.</p>
166 </div>
167 <div class="refsect1">
168 <a name="XAppIconChooserButton.description"></a><h2>Description</h2>
169 <p>The XAppIconChooserButton creates a button so that
170 the user can select an icon. When the button is clicked
171 it will open an XAppIconChooserDialog. The currently
172 selected icon will be displayed as the button image.</p>
173 </div>
174 <div class="refsect1">
175 <a name="XAppIconChooserButton.functions_details"></a><h2>Functions</h2>
176 <div class="refsect2">
177 <a name="xapp-icon-chooser-button-new"></a><h3>xapp_icon_chooser_button_new ()</h3>
178 <pre class="programlisting"><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="returnvalue">XAppIconChooserButton</span></a> *
179 xapp_icon_chooser_button_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
180 <p>Creates a new <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> and sets its icon to <em class="parameter"><code>icon</code></em>
181 .</p>
182 <div class="refsect3">
183 <a name="xapp-icon-chooser-button-new.returns"></a><h4>Returns</h4>
184 <p> a newly created <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p>
185 </div>
186 </div>
187 <hr>
188 <div class="refsect2">
189 <a name="xapp-icon-chooser-button-new-with-size"></a><h3>xapp_icon_chooser_button_new_with_size ()</h3>
190 <pre class="programlisting"><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="returnvalue">XAppIconChooserButton</span></a> *
191 xapp_icon_chooser_button_new_with_size
192 (<em class="parameter"><code><a href="../gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>);</pre>
193 <p>Creates a new <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a>, and sets the sizes of the button image and the icons in
194 the dialog. Note that xapp_icon_chooser_button_new_with_size (NULL, NULL) is the same as calling
195 <a class="link" href="XAppIconChooserButton.html#xapp-icon-chooser-button-new" title="xapp_icon_chooser_button_new ()"><code class="function">xapp_icon_chooser_button_new()</code></a>.</p>
196 <div class="refsect3">
197 <a name="xapp-icon-chooser-button-new-with-size.parameters"></a><h4>Parameters</h4>
198 <div class="informaltable"><table class="informaltable" width="100%" border="0">
199 <colgroup>
200 <col width="150px" class="parameters_name">
201 <col class="parameters_description">
202 <col width="200px" class="parameters_annotations">
203 </colgroup>
204 <tbody><tr>
205 <td class="parameter_name"><p>icon_size</p></td>
206 <td class="parameter_description"><p>the size of icon to use in the button, or NULL to use the default value.</p></td>
207 <td class="parameter_annotations"> </td>
208 </tr></tbody>
209 </table></div>
210 </div>
211 <div class="refsect3">
212 <a name="xapp-icon-chooser-button-new-with-size.returns"></a><h4>Returns</h4>
213 <p> a newly created <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p>
214 </div>
215 </div>
216 <hr>
217 <div class="refsect2">
218 <a name="xapp-icon-chooser-button-set-icon-size"></a><h3>xapp_icon_chooser_button_set_icon_size ()</h3>
219 <pre class="programlisting"><span class="returnvalue">void</span>
220 xapp_icon_chooser_button_set_icon_size
221 (<em class="parameter"><code><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> *button</code></em>,
222 <em class="parameter"><code><a href="../gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>);</pre>
223 <p>Sets the icon size used in the button.</p>
224 <div class="refsect3">
225 <a name="xapp-icon-chooser-button-set-icon-size.parameters"></a><h4>Parameters</h4>
226 <div class="informaltable"><table class="informaltable" width="100%" border="0">
227 <colgroup>
228 <col width="150px" class="parameters_name">
229 <col class="parameters_description">
230 <col width="200px" class="parameters_annotations">
231 </colgroup>
232 <tbody>
233 <tr>
234 <td class="parameter_name"><p>button</p></td>
235 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p></td>
236 <td class="parameter_annotations"> </td>
237 </tr>
238 <tr>
239 <td class="parameter_name"><p>icon_size</p></td>
240 <td class="parameter_description"><p>the size of icon to use in the button, or -1 to use the default value.</p></td>
241 <td class="parameter_annotations"> </td>
242 </tr>
243 </tbody>
244 </table></div>
245 </div>
246 </div>
247 <hr>
248 <div class="refsect2">
249 <a name="xapp-icon-chooser-button-set-icon"></a><h3>xapp_icon_chooser_button_set_icon ()</h3>
250 <pre class="programlisting"><span class="returnvalue">void</span>
251 xapp_icon_chooser_button_set_icon (<em class="parameter"><code><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> *button</code></em>,
252 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon</code></em>);</pre>
253 <p>Sets the icon on the <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a>.</p>
254 <div class="refsect3">
255 <a name="xapp-icon-chooser-button-set-icon.parameters"></a><h4>Parameters</h4>
256 <div class="informaltable"><table class="informaltable" width="100%" border="0">
257 <colgroup>
258 <col width="150px" class="parameters_name">
259 <col class="parameters_description">
260 <col width="200px" class="parameters_annotations">
261 </colgroup>
262 <tbody>
263 <tr>
264 <td class="parameter_name"><p>button</p></td>
265 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p></td>
266 <td class="parameter_annotations"> </td>
267 </tr>
268 <tr>
269 <td class="parameter_name"><p>icon</p></td>
270 <td class="parameter_description"><p>a string representing the icon to be set. This may be an icon name or a file path. </p></td>
271 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
272 </tr>
273 </tbody>
274 </table></div>
275 </div>
276 </div>
277 <hr>
278 <div class="refsect2">
279 <a name="xapp-icon-chooser-button-set-default-category"></a><h3>xapp_icon_chooser_button_set_default_category ()</h3>
280 <pre class="programlisting"><span class="returnvalue">void</span>
281 xapp_icon_chooser_button_set_default_category
282 (<em class="parameter"><code><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> *button</code></em>,
283 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);</pre>
284 <p>Sets the icon on the <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a>.</p>
285 <div class="refsect3">
286 <a name="xapp-icon-chooser-button-set-default-category.parameters"></a><h4>Parameters</h4>
287 <div class="informaltable"><table class="informaltable" width="100%" border="0">
288 <colgroup>
289 <col width="150px" class="parameters_name">
290 <col class="parameters_description">
291 <col width="200px" class="parameters_annotations">
292 </colgroup>
293 <tbody>
294 <tr>
295 <td class="parameter_name"><p>button</p></td>
296 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p></td>
297 <td class="parameter_annotations"> </td>
298 </tr>
299 <tr>
300 <td class="parameter_name"><p>category</p></td>
301 <td class="parameter_description"><p>a string representing the category selected by default. </p></td>
302 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
303 </tr>
304 </tbody>
305 </table></div>
306 </div>
307 </div>
308 <hr>
309 <div class="refsect2">
310 <a name="xapp-icon-chooser-button-get-icon"></a><h3>xapp_icon_chooser_button_get_icon ()</h3>
311 <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
312 xapp_icon_chooser_button_get_icon (<em class="parameter"><code><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> *button</code></em>);</pre>
313 <p>Gets the icon from the <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a>.</p>
314 <div class="refsect3">
315 <a name="xapp-icon-chooser-button-get-icon.parameters"></a><h4>Parameters</h4>
316 <div class="informaltable"><table class="informaltable" width="100%" border="0">
317 <colgroup>
318 <col width="150px" class="parameters_name">
319 <col class="parameters_description">
320 <col width="200px" class="parameters_annotations">
321 </colgroup>
322 <tbody><tr>
323 <td class="parameter_name"><p>button</p></td>
324 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p></td>
325 <td class="parameter_annotations"> </td>
326 </tr></tbody>
327 </table></div>
328 </div>
329 <div class="refsect3">
330 <a name="xapp-icon-chooser-button-get-icon.returns"></a><h4>Returns</h4>
331 <p> a string representing the icon. This may be an icon name or a file path.</p>
332 </div>
333 </div>
334 <hr>
335 <div class="refsect2">
336 <a name="xapp-icon-chooser-button-get-dialog"></a><h3>xapp_icon_chooser_button_get_dialog ()</h3>
337 <pre class="programlisting"><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="returnvalue">XAppIconChooserDialog</span></a> *
338 xapp_icon_chooser_button_get_dialog (<em class="parameter"><code><a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a> *button</code></em>);</pre>
339 <p>Gets a reference to the icon chooser dialog for the <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a>.
340 This is useful for setting properties on the dialog.</p>
341 <div class="refsect3">
342 <a name="xapp-icon-chooser-button-get-dialog.parameters"></a><h4>Parameters</h4>
343 <div class="informaltable"><table class="informaltable" width="100%" border="0">
344 <colgroup>
345 <col width="150px" class="parameters_name">
346 <col class="parameters_description">
347 <col width="200px" class="parameters_annotations">
348 </colgroup>
349 <tbody><tr>
350 <td class="parameter_name"><p>button</p></td>
351 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserButton.html" title="XAppIconChooserButton"><span class="type">XAppIconChooserButton</span></a></p></td>
352 <td class="parameter_annotations"> </td>
353 </tr></tbody>
354 </table></div>
355 </div>
356 <div class="refsect3">
357 <a name="xapp-icon-chooser-button-get-dialog.returns"></a><h4>Returns</h4>
358 <p>the <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a>. </p>
359 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
360 </div>
361 </div>
362 </div>
363 <div class="refsect1">
364 <a name="XAppIconChooserButton.other_details"></a><h2>Types and Values</h2>
365 <div class="refsect2">
366 <a name="XAPP-TYPE-ICON-CHOOSER-BUTTON:CAPS"></a><h3>XAPP_TYPE_ICON_CHOOSER_BUTTON</h3>
367 <pre class="programlisting">#define XAPP_TYPE_ICON_CHOOSER_BUTTON (xapp_icon_chooser_button_get_type ())
368 </pre>
369 </div>
370 <hr>
371 <div class="refsect2">
372 <a name="XAppIconChooserButton-struct"></a><h3>XAppIconChooserButton</h3>
373 <pre class="programlisting">typedef struct _XAppIconChooserButton XAppIconChooserButton;</pre>
374 </div>
375 </div>
376 <div class="refsect1">
377 <a name="XAppIconChooserButton.property-details"></a><h2>Property Details</h2>
378 <div class="refsect2">
379 <a name="XAppIconChooserButton--category"></a><h3>The <code class="literal">“category”</code> property</h3>
380 <pre class="programlisting"> “category” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
381 <p>The category selected by default.</p>
382 <p>Flags: Read / Write</p>
383 <p>Default value: ""</p>
384 </div>
385 <hr>
386 <div class="refsect2">
387 <a name="XAppIconChooserButton--icon"></a><h3>The <code class="literal">“icon”</code> property</h3>
388 <pre class="programlisting"> “icon” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
389 <p>The preferred size to use when looking up icons. This only works with icon names.
390 Additionally, there is no guarantee that a selected icon name will exist in a
391 particular size.</p>
392 <p>Flags: Read / Write</p>
393 <p>Default value: ""</p>
394 </div>
395 <hr>
396 <div class="refsect2">
397 <a name="XAppIconChooserButton--icon-size"></a><h3>The <code class="literal">“icon-size”</code> property</h3>
398 <pre class="programlisting"> “icon-size” <a href="../gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a></pre>
399 <p>The size to use when displaying the icon.</p>
400 <p>Flags: Read / Write</p>
401 <p>Default value: GTK_ICON_SIZE_DND</p>
402 </div>
403 </div>
404 </div>
405 <div class="footer">
406 <hr>Generated by GTK-Doc V1.27</div>
407 </body>
408 </html>⏎
+603
-0
docs/reference/XAppIconChooserDialog.html less more
0 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>XAppIconChooserDialog: XApp Reference Manual</title>
5 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
6 <link rel="home" href="index.html" title="XApp Reference Manual">
7 <link rel="up" href="ch01.html" title="API reference">
8 <link rel="prev" href="XAppIconChooserButton.html" title="XAppIconChooserButton">
9 <link rel="next" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController">
10 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
15 <td width="100%" align="left" class="shortcuts">
16 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
17 <a href="#XAppIconChooserDialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
18 <a href="#XAppIconChooserDialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
19 <a href="#XAppIconChooserDialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#XAppIconChooserDialog.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
21 <a href="#XAppIconChooserDialog.signals" class="shortcut">Signals</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="XAppIconChooserButton.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="XAppKbdLayoutController.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="XAppIconChooserDialog"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="XAppIconChooserDialog.top_of_page"></a>XAppIconChooserDialog</span></h2>
33 <p>XAppIconChooserDialog — A dialog for selecting an icon</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="XAppIconChooserDialog.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_return">
42 <col class="functions_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">
47 <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="returnvalue">XAppIconChooserDialog</span></a> *
48 </td>
49 <td class="function_name">
50 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-new" title="xapp_icon_chooser_dialog_new ()">xapp_icon_chooser_dialog_new</a> <span class="c_punctuation">()</span>
51 </td>
52 </tr>
53 <tr>
54 <td class="function_type">
55 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
56 </td>
57 <td class="function_name">
58 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run" title="xapp_icon_chooser_dialog_run ()">xapp_icon_chooser_dialog_run</a> <span class="c_punctuation">()</span>
59 </td>
60 </tr>
61 <tr>
62 <td class="function_type">
63 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
64 </td>
65 <td class="function_name">
66 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-icon" title="xapp_icon_chooser_dialog_run_with_icon ()">xapp_icon_chooser_dialog_run_with_icon</a> <span class="c_punctuation">()</span>
67 </td>
68 </tr>
69 <tr>
70 <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="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-category" title="xapp_icon_chooser_dialog_run_with_category ()">xapp_icon_chooser_dialog_run_with_category</a> <span class="c_punctuation">()</span>
75 </td>
76 </tr>
77 <tr>
78 <td class="function_type">
79 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
80 </td>
81 <td class="function_name">
82 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-get-icon-string" title="xapp_icon_chooser_dialog_get_icon_string ()">xapp_icon_chooser_dialog_get_icon_string</a> <span class="c_punctuation">()</span>
83 </td>
84 </tr>
85 <tr>
86 <td class="function_type">
87 <span class="returnvalue">void</span>
88 </td>
89 <td class="function_name">
90 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-add-button" title="xapp_icon_chooser_dialog_add_button ()">xapp_icon_chooser_dialog_add_button</a> <span class="c_punctuation">()</span>
91 </td>
92 </tr>
93 <tr>
94 <td class="function_type">
95 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
96 </td>
97 <td class="function_name">
98 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-get-default-icon" title="xapp_icon_chooser_dialog_get_default_icon ()">xapp_icon_chooser_dialog_get_default_icon</a> <span class="c_punctuation">()</span>
99 </td>
100 </tr>
101 <tr>
102 <td class="function_type">
103 <span class="returnvalue">void</span>
104 </td>
105 <td class="function_name">
106 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-set-default-icon" title="xapp_icon_chooser_dialog_set_default_icon ()">xapp_icon_chooser_dialog_set_default_icon</a> <span class="c_punctuation">()</span>
107 </td>
108 </tr>
109 <tr>
110 <td class="function_type">
111 <span class="returnvalue">void</span>
112 </td>
113 <td class="function_name">
114 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-add-custom-category" title="xapp_icon_chooser_dialog_add_custom_category ()">xapp_icon_chooser_dialog_add_custom_category</a> <span class="c_punctuation">()</span>
115 </td>
116 </tr>
117 </tbody>
118 </table></div>
119 </div>
120 <div class="refsect1">
121 <a name="XAppIconChooserDialog.properties"></a><h2>Properties</h2>
122 <div class="informaltable"><table class="informaltable" border="0">
123 <colgroup>
124 <col width="150px" class="properties_type">
125 <col width="300px" class="properties_name">
126 <col width="200px" class="properties_flags">
127 </colgroup>
128 <tbody>
129 <tr>
130 <td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
131 <td class="property_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog--allow-paths" title="The “allow-paths” property">allow-paths</a></td>
132 <td class="property_flags">Read / Write</td>
133 </tr>
134 <tr>
135 <td class="property_type">
136 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
137 <td class="property_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog--default-icon" title="The “default-icon” property">default-icon</a></td>
138 <td class="property_flags">Read / Write</td>
139 </tr>
140 <tr>
141 <td class="property_type"><a class="link" href="XAppIconChooserDialog.html#XAppIconSize" title="enum XAppIconSize"><span class="type">XAppIconSize</span></a></td>
142 <td class="property_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog--icon-size" title="The “icon-size” property">icon-size</a></td>
143 <td class="property_flags">Read / Write</td>
144 </tr>
145 </tbody>
146 </table></div>
147 </div>
148 <div class="refsect1">
149 <a name="XAppIconChooserDialog.signals"></a><h2>Signals</h2>
150 <div class="informaltable"><table class="informaltable" border="0">
151 <colgroup>
152 <col width="150px" class="signals_return">
153 <col width="300px" class="signals_name">
154 <col width="200px" class="signals_flags">
155 </colgroup>
156 <tbody>
157 <tr>
158 <td class="signal_type"><span class="returnvalue">void</span></td>
159 <td class="signal_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog-close" title="The “close” signal">close</a></td>
160 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
161 </tr>
162 <tr>
163 <td class="signal_type"><span class="returnvalue">void</span></td>
164 <td class="signal_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog-select" title="The “select” signal">select</a></td>
165 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
166 </tr>
167 </tbody>
168 </table></div>
169 </div>
170 <div class="refsect1">
171 <a name="XAppIconChooserDialog.other"></a><h2>Types and Values</h2>
172 <div class="informaltable"><table class="informaltable" width="100%" border="0">
173 <colgroup>
174 <col width="150px" class="name">
175 <col class="description">
176 </colgroup>
177 <tbody>
178 <tr>
179 <td class="define_keyword">#define</td>
180 <td class="function_name"><a class="link" href="XAppIconChooserDialog.html#XAPP-TYPE-ICON-CHOOSER-DIALOG:CAPS" title="XAPP_TYPE_ICON_CHOOSER_DIALOG">XAPP_TYPE_ICON_CHOOSER_DIALOG</a></td>
181 </tr>
182 <tr>
183 <td class="datatype_keyword">enum</td>
184 <td class="function_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconSize" title="enum XAppIconSize">XAppIconSize</a></td>
185 </tr>
186 <tr>
187 <td class="datatype_keyword"> </td>
188 <td class="function_name"><a class="link" href="XAppIconChooserDialog.html#XAppIconChooserDialog-struct" title="XAppIconChooserDialog">XAppIconChooserDialog</a></td>
189 </tr>
190 </tbody>
191 </table></div>
192 </div>
193 <div class="refsect1">
194 <a name="XAppIconChooserDialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
195 <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
196 <span class="lineart">╰──</span> XAppIconSize
197 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
198 <span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
199 <span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
200 <span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
201 <span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
202 <span class="lineart">╰──</span> <a href="../gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
203 <span class="lineart">╰──</span> <a class="link" href="XAppGtkWindow.html" title="XAppGtkWindow">XAppGtkWindow</a>
204 <span class="lineart">╰──</span> XAppIconChooserDialog
205 </pre>
206 </div>
207 <div class="refsect1">
208 <a name="XAppIconChooserDialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
209 <p>
210 XAppIconChooserDialog implements
211 AtkImplementorIface and <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
212 </div>
213 <div class="refsect1">
214 <a name="XAppIconChooserDialog.description"></a><h2>Description</h2>
215 <p>The XAppIconChooserDialog creates a dialog so that
216 the user can select an icon. It provides the ability
217 to browse by category, search by icon name, or select
218 from a specific file.</p>
219 </div>
220 <div class="refsect1">
221 <a name="XAppIconChooserDialog.functions_details"></a><h2>Functions</h2>
222 <div class="refsect2">
223 <a name="xapp-icon-chooser-dialog-new"></a><h3>xapp_icon_chooser_dialog_new ()</h3>
224 <pre class="programlisting"><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="returnvalue">XAppIconChooserDialog</span></a> *
225 xapp_icon_chooser_dialog_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
226 <p>Creates a new <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a>.</p>
227 <div class="refsect3">
228 <a name="xapp-icon-chooser-dialog-new.returns"></a><h4>Returns</h4>
229 <p> a newly created <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p>
230 </div>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="xapp-icon-chooser-dialog-run"></a><h3>xapp_icon_chooser_dialog_run ()</h3>
235 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
236 xapp_icon_chooser_dialog_run (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>);</pre>
237 <p>Shows the dialog and enters a separate main loop until an icon is chosen or the action is canceled.</p>
238 <p>xapp_icon_chooser_dialog_run (), <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-icon" title="xapp_icon_chooser_dialog_run_with_icon ()"><code class="function">xapp_icon_chooser_dialog_run_with_icon()</code></a>, and
239 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-category" title="xapp_icon_chooser_dialog_run_with_category ()"><code class="function">xapp_icon_chooser_dialog_run_with_category()</code></a> may all be called multiple times. This is useful for
240 applications which use this dialog multiple times, as it may improve performance for subsequent
241 calls.</p>
242 <div class="refsect3">
243 <a name="xapp-icon-chooser-dialog-run.parameters"></a><h4>Parameters</h4>
244 <div class="informaltable"><table class="informaltable" width="100%" border="0">
245 <colgroup>
246 <col width="150px" class="parameters_name">
247 <col class="parameters_description">
248 <col width="200px" class="parameters_annotations">
249 </colgroup>
250 <tbody><tr>
251 <td class="parameter_name"><p>dialog</p></td>
252 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
253 <td class="parameter_annotations"> </td>
254 </tr></tbody>
255 </table></div>
256 </div>
257 <div class="refsect3">
258 <a name="xapp-icon-chooser-dialog-run.returns"></a><h4>Returns</h4>
259 <p> GTK_RESPONSE_OK if the user selected an icon, or GTK_RESPONSE_CANCEL otherwise</p>
260 </div>
261 </div>
262 <hr>
263 <div class="refsect2">
264 <a name="xapp-icon-chooser-dialog-run-with-icon"></a><h3>xapp_icon_chooser_dialog_run_with_icon ()</h3>
265 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
266 xapp_icon_chooser_dialog_run_with_icon
267 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>,
268 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon</code></em>);</pre>
269 <p>Like xapp_icon_chooser_dialog_run but selects the icon specified by <em class="parameter"><code>icon</code></em>
270 . This can be either an
271 icon name or a path. Passing an icon string or path that doesn't exist is accepted, but it may show
272 multiple results, or none at all. This behavior is useful if, for example, you wish to have the
273 user select an image file from a particular directory.</p>
274 <p>If the property allow_paths is FALSE, setting a path will yield no results when the dialog is opened.</p>
275 <p>xapp_icon_chooser_dialog_run (), <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-icon" title="xapp_icon_chooser_dialog_run_with_icon ()"><code class="function">xapp_icon_chooser_dialog_run_with_icon()</code></a>, and
276 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-category" title="xapp_icon_chooser_dialog_run_with_category ()"><code class="function">xapp_icon_chooser_dialog_run_with_category()</code></a> may all be called multiple times. This is useful for
277 applications which use this dialog multiple times, as it may improve performance for subsequent
278 calls.</p>
279 <div class="refsect3">
280 <a name="xapp-icon-chooser-dialog-run-with-icon.parameters"></a><h4>Parameters</h4>
281 <div class="informaltable"><table class="informaltable" width="100%" border="0">
282 <colgroup>
283 <col width="150px" class="parameters_name">
284 <col class="parameters_description">
285 <col width="200px" class="parameters_annotations">
286 </colgroup>
287 <tbody>
288 <tr>
289 <td class="parameter_name"><p>dialog</p></td>
290 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
291 <td class="parameter_annotations"> </td>
292 </tr>
293 <tr>
294 <td class="parameter_name"><p>icon</p></td>
295 <td class="parameter_description"><p>a string representing the icon that should be selected</p></td>
296 <td class="parameter_annotations"> </td>
297 </tr>
298 </tbody>
299 </table></div>
300 </div>
301 <div class="refsect3">
302 <a name="xapp-icon-chooser-dialog-run-with-icon.returns"></a><h4>Returns</h4>
303 <p> GTK_RESPONSE_OK if the user selected an icon, or GTK_RESPONSE_CANCEL otherwise</p>
304 </div>
305 </div>
306 <hr>
307 <div class="refsect2">
308 <a name="xapp-icon-chooser-dialog-run-with-category"></a><h3>xapp_icon_chooser_dialog_run_with_category ()</h3>
309 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
310 xapp_icon_chooser_dialog_run_with_category
311 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>,
312 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category</code></em>);</pre>
313 <p>Like xapp_icon_chooser_dialog_run but selects a particular category specified by <em class="parameter"><code>category</code></em>
314 .
315 This is used when there is a particular category of icon that is more appropriate than the
316 others. If the category does not exist, the first category in the list will be selected. To
317 get a list of possible categories, use <a href="../gtk3/GtkIconTheme.html#gtk-icon-theme-list-contexts"><code class="function">gtk_icon_theme_list_contexts()</code></a>.</p>
318 <p>xapp_icon_chooser_dialog_run (), <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-icon" title="xapp_icon_chooser_dialog_run_with_icon ()"><code class="function">xapp_icon_chooser_dialog_run_with_icon()</code></a>, and
319 <a class="link" href="XAppIconChooserDialog.html#xapp-icon-chooser-dialog-run-with-category" title="xapp_icon_chooser_dialog_run_with_category ()"><code class="function">xapp_icon_chooser_dialog_run_with_category()</code></a> may all be called multiple times. This is useful for
320 applications which use this dialog multiple times, as it may improve performance for subsequent
321 calls.</p>
322 <div class="refsect3">
323 <a name="xapp-icon-chooser-dialog-run-with-category.parameters"></a><h4>Parameters</h4>
324 <div class="informaltable"><table class="informaltable" width="100%" border="0">
325 <colgroup>
326 <col width="150px" class="parameters_name">
327 <col class="parameters_description">
328 <col width="200px" class="parameters_annotations">
329 </colgroup>
330 <tbody><tr>
331 <td class="parameter_name"><p>dialog</p></td>
332 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
333 <td class="parameter_annotations"> </td>
334 </tr></tbody>
335 </table></div>
336 </div>
337 <div class="refsect3">
338 <a name="xapp-icon-chooser-dialog-run-with-category.returns"></a><h4>Returns</h4>
339 <p> GTK_RESPONSE_OK if the user selected an icon, or GTK_RESPONSE_CANCEL otherwise</p>
340 </div>
341 </div>
342 <hr>
343 <div class="refsect2">
344 <a name="xapp-icon-chooser-dialog-get-icon-string"></a><h3>xapp_icon_chooser_dialog_get_icon_string ()</h3>
345 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
346 xapp_icon_chooser_dialog_get_icon_string
347 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>);</pre>
348 <p>Gets the currently selected icon from the dialog. If allow-paths is TRUE, this function may return
349 either an icon name or a path depending on what the user selects. Otherwise it will only return an
350 icon name.</p>
351 <div class="refsect3">
352 <a name="xapp-icon-chooser-dialog-get-icon-string.parameters"></a><h4>Parameters</h4>
353 <div class="informaltable"><table class="informaltable" width="100%" border="0">
354 <colgroup>
355 <col width="150px" class="parameters_name">
356 <col class="parameters_description">
357 <col width="200px" class="parameters_annotations">
358 </colgroup>
359 <tbody><tr>
360 <td class="parameter_name"><p>dialog</p></td>
361 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
362 <td class="parameter_annotations"> </td>
363 </tr></tbody>
364 </table></div>
365 </div>
366 <div class="refsect3">
367 <a name="xapp-icon-chooser-dialog-get-icon-string.returns"></a><h4>Returns</h4>
368 <p>the string representation of the currently selected icon or NULL
369 if no icon is selected. </p>
370 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
371 </div>
372 </div>
373 <hr>
374 <div class="refsect2">
375 <a name="xapp-icon-chooser-dialog-add-button"></a><h3>xapp_icon_chooser_dialog_add_button ()</h3>
376 <pre class="programlisting"><span class="returnvalue">void</span>
377 xapp_icon_chooser_dialog_add_button (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>,
378 <em class="parameter"><code><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *button</code></em>,
379 <em class="parameter"><code><a href="../gtk3/gtk3-Standard-Enumerations.html#GtkPackType"><span class="type">GtkPackType</span></a> packing</code></em>,
380 <em class="parameter"><code><a href="../gtk3/GtkDialog.html#GtkResponseType"><span class="type">GtkResponseType</span></a> response_id</code></em>);</pre>
381 <p>Allows a button to be added to the <a href="../gtk3/GtkActionBar.html#GtkActionBar-struct"><span class="type">GtkActionBar</span></a> of the dialog with a custom
382 response id.</p>
383 <div class="refsect3">
384 <a name="xapp-icon-chooser-dialog-add-button.parameters"></a><h4>Parameters</h4>
385 <div class="informaltable"><table class="informaltable" width="100%" border="0">
386 <colgroup>
387 <col width="150px" class="parameters_name">
388 <col class="parameters_description">
389 <col width="200px" class="parameters_annotations">
390 </colgroup>
391 <tbody>
392 <tr>
393 <td class="parameter_name"><p>dialog</p></td>
394 <td class="parameter_description"><p>an <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
395 <td class="parameter_annotations"> </td>
396 </tr>
397 <tr>
398 <td class="parameter_name"><p>button</p></td>
399 <td class="parameter_description"><p>a <a href="../gtk3/GtkButton.html#GtkButton-struct"><span class="type">GtkButton</span></a> to add</p></td>
400 <td class="parameter_annotations"> </td>
401 </tr>
402 <tr>
403 <td class="parameter_name"><p>packing</p></td>
404 <td class="parameter_description"><p>the <a href="../gtk3/gtk3-Standard-Enumerations.html#GtkPackType"><span class="type">GtkPackType</span></a> to specify start or end packing to the action bar</p></td>
405 <td class="parameter_annotations"> </td>
406 </tr>
407 <tr>
408 <td class="parameter_name"><p>response_id</p></td>
409 <td class="parameter_description"><p>the dialog response id to return when this button is clicked.</p></td>
410 <td class="parameter_annotations"> </td>
411 </tr>
412 </tbody>
413 </table></div>
414 </div>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="xapp-icon-chooser-dialog-get-default-icon"></a><h3>xapp_icon_chooser_dialog_get_default_icon ()</h3>
419 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
420 xapp_icon_chooser_dialog_get_default_icon
421 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>);</pre>
422 <p>Returns the default icon (if set).</p>
423 <div class="refsect3">
424 <a name="xapp-icon-chooser-dialog-get-default-icon.returns"></a><h4>Returns</h4>
425 <p>the default icon, or NULL if none is set. </p>
426 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
427 </div>
428 </div>
429 <hr>
430 <div class="refsect2">
431 <a name="xapp-icon-chooser-dialog-set-default-icon"></a><h3>xapp_icon_chooser_dialog_set_default_icon ()</h3>
432 <pre class="programlisting"><span class="returnvalue">void</span>
433 xapp_icon_chooser_dialog_set_default_icon
434 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>,
435 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon</code></em>);</pre>
436 <p>Sets the default icon. If <em class="parameter"><code>icon</code></em>
437 is not NULL, a button will be shown that
438 will reset the dialog to it's default value.</p>
439 <div class="refsect3">
440 <a name="xapp-icon-chooser-dialog-set-default-icon.parameters"></a><h4>Parameters</h4>
441 <div class="informaltable"><table class="informaltable" width="100%" border="0">
442 <colgroup>
443 <col width="150px" class="parameters_name">
444 <col class="parameters_description">
445 <col width="200px" class="parameters_annotations">
446 </colgroup>
447 <tbody><tr>
448 <td class="parameter_name"><p>icon</p></td>
449 <td class="parameter_description"><p>the default icon, or NULL to unset</p></td>
450 <td class="parameter_annotations"> </td>
451 </tr></tbody>
452 </table></div>
453 </div>
454 </div>
455 <hr>
456 <div class="refsect2">
457 <a name="xapp-icon-chooser-dialog-add-custom-category"></a><h3>xapp_icon_chooser_dialog_add_custom_category ()</h3>
458 <pre class="programlisting"><span class="returnvalue">void</span>
459 xapp_icon_chooser_dialog_add_custom_category
460 (<em class="parameter"><code><a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *dialog</code></em>,
461 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
462 <em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *icons</code></em>);</pre>
463 <p>Adds a custom category to the dialog.</p>
464 <div class="refsect3">
465 <a name="xapp-icon-chooser-dialog-add-custom-category.parameters"></a><h4>Parameters</h4>
466 <div class="informaltable"><table class="informaltable" width="100%" border="0">
467 <colgroup>
468 <col width="150px" class="parameters_name">
469 <col class="parameters_description">
470 <col width="200px" class="parameters_annotations">
471 </colgroup>
472 <tbody>
473 <tr>
474 <td class="parameter_name"><p>dialog</p></td>
475 <td class="parameter_description"><p>a <a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a></p></td>
476 <td class="parameter_annotations"> </td>
477 </tr>
478 <tr>
479 <td class="parameter_name"><p>name</p></td>
480 <td class="parameter_description"><p>the name of the category as it will be displayed in the category list</p></td>
481 <td class="parameter_annotations"> </td>
482 </tr>
483 <tr>
484 <td class="parameter_name"><p>icons</p></td>
485 <td class="parameter_description"><p>a list of icon names to add to the new category. </p></td>
486 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
487 </tr>
488 </tbody>
489 </table></div>
490 </div>
491 </div>
492 </div>
493 <div class="refsect1">
494 <a name="XAppIconChooserDialog.other_details"></a><h2>Types and Values</h2>
495 <div class="refsect2">
496 <a name="XAPP-TYPE-ICON-CHOOSER-DIALOG:CAPS"></a><h3>XAPP_TYPE_ICON_CHOOSER_DIALOG</h3>
497 <pre class="programlisting">#define XAPP_TYPE_ICON_CHOOSER_DIALOG (xapp_icon_chooser_dialog_get_type ())
498 </pre>
499 </div>
500 <hr>
501 <div class="refsect2">
502 <a name="XAppIconSize"></a><h3>enum XAppIconSize</h3>
503 <div class="refsect3">
504 <a name="XAppIconSize.members"></a><h4>Members</h4>
505 <div class="informaltable"><table class="informaltable" width="100%" border="0">
506 <colgroup>
507 <col width="300px" class="enum_members_name">
508 <col class="enum_members_description">
509 <col width="200px" class="enum_members_annotations">
510 </colgroup>
511 <tbody>
512 <tr>
513 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-16:CAPS"></a>XAPP_ICON_SIZE_16</p></td>
514 <td> </td>
515 <td> </td>
516 </tr>
517 <tr>
518 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-22:CAPS"></a>XAPP_ICON_SIZE_22</p></td>
519 <td> </td>
520 <td> </td>
521 </tr>
522 <tr>
523 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-24:CAPS"></a>XAPP_ICON_SIZE_24</p></td>
524 <td> </td>
525 <td> </td>
526 </tr>
527 <tr>
528 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-32:CAPS"></a>XAPP_ICON_SIZE_32</p></td>
529 <td> </td>
530 <td> </td>
531 </tr>
532 <tr>
533 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-48:CAPS"></a>XAPP_ICON_SIZE_48</p></td>
534 <td> </td>
535 <td> </td>
536 </tr>
537 <tr>
538 <td class="enum_member_name"><p><a name="XAPP-ICON-SIZE-96:CAPS"></a>XAPP_ICON_SIZE_96</p></td>
539 <td> </td>
540 <td> </td>
541 </tr>
542 </tbody>
543 </table></div>
544 </div>
545 </div>
546 <hr>
547 <div class="refsect2">
548 <a name="XAppIconChooserDialog-struct"></a><h3>XAppIconChooserDialog</h3>
549 <pre class="programlisting">typedef struct _XAppIconChooserDialog XAppIconChooserDialog;</pre>
550 </div>
551 </div>
552 <div class="refsect1">
553 <a name="XAppIconChooserDialog.property-details"></a><h2>Property Details</h2>
554 <div class="refsect2">
555 <a name="XAppIconChooserDialog--allow-paths"></a><h3>The <code class="literal">“allow-paths”</code> property</h3>
556 <pre class="programlisting"> “allow-paths” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
557 <p>Whether to allow paths to be searched and selected or only icon names.</p>
558 <p>Flags: Read / Write</p>
559 <p>Default value: TRUE</p>
560 </div>
561 <hr>
562 <div class="refsect2">
563 <a name="XAppIconChooserDialog--default-icon"></a><h3>The <code class="literal">“default-icon”</code> property</h3>
564 <pre class="programlisting"> “default-icon” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
565 <p>The icon to use by default.</p>
566 <p>Flags: Read / Write</p>
567 <p>Default value: NULL</p>
568 </div>
569 <hr>
570 <div class="refsect2">
571 <a name="XAppIconChooserDialog--icon-size"></a><h3>The <code class="literal">“icon-size”</code> property</h3>
572 <pre class="programlisting"> “icon-size” <a class="link" href="XAppIconChooserDialog.html#XAppIconSize" title="enum XAppIconSize"><span class="type">XAppIconSize</span></a></pre>
573 <p>The preferred size to use when looking up icons. This only works with icon names.
574 Additionally, there is no guarantee that a selected icon name will exist in a
575 particular size.</p>
576 <p>Flags: Read / Write</p>
577 <p>Default value: XAPP_ICON_SIZE_32</p>
578 </div>
579 </div>
580 <div class="refsect1">
581 <a name="XAppIconChooserDialog.signal-details"></a><h2>Signal Details</h2>
582 <div class="refsect2">
583 <a name="XAppIconChooserDialog-close"></a><h3>The <code class="literal">“close”</code> signal</h3>
584 <pre class="programlisting"><span class="returnvalue">void</span>
585 user_function (<a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *xappiconchooserdialog,
586 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
587 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
588 </div>
589 <hr>
590 <div class="refsect2">
591 <a name="XAppIconChooserDialog-select"></a><h3>The <code class="literal">“select”</code> signal</h3>
592 <pre class="programlisting"><span class="returnvalue">void</span>
593 user_function (<a class="link" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog"><span class="type">XAppIconChooserDialog</span></a> *xappiconchooserdialog,
594 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
595 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
596 </div>
597 </div>
598 </div>
599 <div class="footer">
600 <hr>Generated by GTK-Doc V1.27</div>
601 </body>
602 </html>⏎
+747
-0
docs/reference/XAppKbdLayoutController.html less more
0 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>XAppKbdLayoutController: XApp Reference Manual</title>
5 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
6 <link rel="home" href="index.html" title="XApp Reference Manual">
7 <link rel="up" href="ch01.html" title="API reference">
8 <link rel="prev" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog">
9 <link rel="next" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker">
10 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
15 <td width="100%" align="left" class="shortcuts">
16 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
17 <a href="#XAppKbdLayoutController.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
18 <a href="#XAppKbdLayoutController.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#XAppKbdLayoutController.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
20 <a href="#XAppKbdLayoutController.signals" class="shortcut">Signals</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="XAppIconChooserDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="XAppMonitorBlanker.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="XAppKbdLayoutController"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="XAppKbdLayoutController.top_of_page"></a>XAppKbdLayoutController</span></h2>
32 <p>XAppKbdLayoutController — Keyboard layout selection UI element provider.</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="XAppKbdLayoutController.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_return">
41 <col class="functions_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="returnvalue">XAppKbdLayoutController</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-new" title="xapp_kbd_layout_controller_new ()">xapp_kbd_layout_controller_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
55 </td>
56 <td class="function_name">
57 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-enabled" title="xapp_kbd_layout_controller_get_enabled ()">xapp_kbd_layout_controller_get_enabled</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
63 </td>
64 <td class="function_name">
65 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-group" title="xapp_kbd_layout_controller_get_current_group ()">xapp_kbd_layout_controller_get_current_group</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <span class="returnvalue">void</span>
71 </td>
72 <td class="function_name">
73 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-set-current-group" title="xapp_kbd_layout_controller_set_current_group ()">xapp_kbd_layout_controller_set_current_group</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">void</span>
79 </td>
80 <td class="function_name">
81 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-next-group" title="xapp_kbd_layout_controller_next_group ()">xapp_kbd_layout_controller_next_group</a> <span class="c_punctuation">()</span>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">
86 <span class="returnvalue">void</span>
87 </td>
88 <td class="function_name">
89 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-previous-group" title="xapp_kbd_layout_controller_previous_group ()">xapp_kbd_layout_controller_previous_group</a> <span class="c_punctuation">()</span>
90 </td>
91 </tr>
92 <tr>
93 <td class="function_type">
94 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
95 </td>
96 <td class="function_name">
97 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-name" title="xapp_kbd_layout_controller_get_current_name ()">xapp_kbd_layout_controller_get_current_name</a> <span class="c_punctuation">()</span>
98 </td>
99 </tr>
100 <tr>
101 <td class="function_type">
102 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
103 </td>
104 <td class="function_name">
105 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-all-names" title="xapp_kbd_layout_controller_get_all_names ()">xapp_kbd_layout_controller_get_all_names</a> <span class="c_punctuation">()</span>
106 </td>
107 </tr>
108 <tr>
109 <td class="function_type">
110 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
111 </td>
112 <td class="function_name">
113 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-icon-name" title="xapp_kbd_layout_controller_get_current_icon_name ()">xapp_kbd_layout_controller_get_current_icon_name</a> <span class="c_punctuation">()</span>
114 </td>
115 </tr>
116 <tr>
117 <td class="function_type">
118 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
119 </td>
120 <td class="function_name">
121 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-icon-name-for-group" title="xapp_kbd_layout_controller_get_icon_name_for_group ()">xapp_kbd_layout_controller_get_icon_name_for_group</a> <span class="c_punctuation">()</span>
122 </td>
123 </tr>
124 <tr>
125 <td class="function_type">
126 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
127 </td>
128 <td class="function_name">
129 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-flag-id" title="xapp_kbd_layout_controller_get_current_flag_id ()">xapp_kbd_layout_controller_get_current_flag_id</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#gint"><span class="returnvalue">gint</span></a>
135 </td>
136 <td class="function_name">
137 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-flag-id-for-group" title="xapp_kbd_layout_controller_get_flag_id_for_group ()">xapp_kbd_layout_controller_get_flag_id_for_group</a> <span class="c_punctuation">()</span>
138 </td>
139 </tr>
140 <tr>
141 <td class="function_type">
142 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
143 </td>
144 <td class="function_name">
145 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-short-group-label" title="xapp_kbd_layout_controller_get_current_short_group_label ()">xapp_kbd_layout_controller_get_current_short_group_label</a> <span class="c_punctuation">()</span>
146 </td>
147 </tr>
148 <tr>
149 <td class="function_type">
150 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
151 </td>
152 <td class="function_name">
153 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-short-group-label-for-group" title="xapp_kbd_layout_controller_get_short_group_label_for_group ()">xapp_kbd_layout_controller_get_short_group_label_for_group</a> <span class="c_punctuation">()</span>
154 </td>
155 </tr>
156 <tr>
157 <td class="function_type">
158 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
159 </td>
160 <td class="function_name">
161 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-variant-label" title="xapp_kbd_layout_controller_get_current_variant_label ()">xapp_kbd_layout_controller_get_current_variant_label</a> <span class="c_punctuation">()</span>
162 </td>
163 </tr>
164 <tr>
165 <td class="function_type">
166 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
167 </td>
168 <td class="function_name">
169 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-variant-label-for-group" title="xapp_kbd_layout_controller_get_variant_label_for_group ()">xapp_kbd_layout_controller_get_variant_label_for_group</a> <span class="c_punctuation">()</span>
170 </td>
171 </tr>
172 <tr>
173 <td class="function_type">
174 <span class="returnvalue">void</span>
175 </td>
176 <td class="function_name">
177 <a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-render-cairo-subscript" title="xapp_kbd_layout_controller_render_cairo_subscript ()">xapp_kbd_layout_controller_render_cairo_subscript</a> <span class="c_punctuation">()</span>
178 </td>
179 </tr>
180 </tbody>
181 </table></div>
182 </div>
183 <div class="refsect1">
184 <a name="XAppKbdLayoutController.properties"></a><h2>Properties</h2>
185 <div class="informaltable"><table class="informaltable" border="0">
186 <colgroup>
187 <col width="150px" class="properties_type">
188 <col width="300px" class="properties_name">
189 <col width="200px" class="properties_flags">
190 </colgroup>
191 <tbody><tr>
192 <td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
193 <td class="property_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController--enabled" title="The “enabled” property">enabled</a></td>
194 <td class="property_flags">Read</td>
195 </tr></tbody>
196 </table></div>
197 </div>
198 <div class="refsect1">
199 <a name="XAppKbdLayoutController.signals"></a><h2>Signals</h2>
200 <div class="informaltable"><table class="informaltable" border="0">
201 <colgroup>
202 <col width="150px" class="signals_return">
203 <col width="300px" class="signals_name">
204 <col width="200px" class="signals_flags">
205 </colgroup>
206 <tbody>
207 <tr>
208 <td class="signal_type"><span class="returnvalue">void</span></td>
209 <td class="signal_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController-config-changed" title="The “config-changed” signal">config-changed</a></td>
210 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
211 </tr>
212 <tr>
213 <td class="signal_type"><span class="returnvalue">void</span></td>
214 <td class="signal_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController-layout-changed" title="The “layout-changed” signal">layout-changed</a></td>
215 <td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
216 </tr>
217 </tbody>
218 </table></div>
219 </div>
220 <div class="refsect1">
221 <a name="XAppKbdLayoutController.object-hierarchy"></a><h2>Object Hierarchy</h2>
222 <pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
223 <span class="lineart">╰──</span> XAppKbdLayoutController
224 </pre>
225 </div>
226 <div class="refsect1">
227 <a name="XAppKbdLayoutController.description"></a><h2>Description</h2>
228 <p>A GObject wrapper for Gkbd that provides additional UI element
229 support for keyboard layout flags and abbreviations, as well as
230 Wfacilities to distinguish regional and hardware-based variants
231 which might otherwise appear identical in a layout list.</p>
232 </div>
233 <div class="refsect1">
234 <a name="XAppKbdLayoutController.functions_details"></a><h2>Functions</h2>
235 <div class="refsect2">
236 <a name="xapp-kbd-layout-controller-new"></a><h3>xapp_kbd_layout_controller_new ()</h3>
237 <pre class="programlisting"><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="returnvalue">XAppKbdLayoutController</span></a> *
238 xapp_kbd_layout_controller_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
239 <p>Creates a new XAppKbdLayoutController instance.</p>
240 <div class="refsect3">
241 <a name="xapp-kbd-layout-controller-new.returns"></a><h4>Returns</h4>
242 <p>a new <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> instance. </p>
243 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
244 </div>
245 </div>
246 <hr>
247 <div class="refsect2">
248 <a name="xapp-kbd-layout-controller-get-enabled"></a><h3>xapp_kbd_layout_controller_get_enabled ()</h3>
249 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
250 xapp_kbd_layout_controller_get_enabled
251 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
252 <p>Returns whether or not the layout controller is enabled</p>
253 <div class="refsect3">
254 <a name="xapp-kbd-layout-controller-get-enabled.parameters"></a><h4>Parameters</h4>
255 <div class="informaltable"><table class="informaltable" width="100%" border="0">
256 <colgroup>
257 <col width="150px" class="parameters_name">
258 <col class="parameters_description">
259 <col width="200px" class="parameters_annotations">
260 </colgroup>
261 <tbody><tr>
262 <td class="parameter_name"><p>controller</p></td>
263 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
264 <td class="parameter_annotations"> </td>
265 </tr></tbody>
266 </table></div>
267 </div>
268 </div>
269 <hr>
270 <div class="refsect2">
271 <a name="xapp-kbd-layout-controller-get-current-group"></a><h3>xapp_kbd_layout_controller_get_current_group ()</h3>
272 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
273 xapp_kbd_layout_controller_get_current_group
274 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
275 <p>Selects the previous group in the group list.</p>
276 <div class="refsect3">
277 <a name="xapp-kbd-layout-controller-get-current-group.parameters"></a><h4>Parameters</h4>
278 <div class="informaltable"><table class="informaltable" width="100%" border="0">
279 <colgroup>
280 <col width="150px" class="parameters_name">
281 <col class="parameters_description">
282 <col width="200px" class="parameters_annotations">
283 </colgroup>
284 <tbody><tr>
285 <td class="parameter_name"><p>controller</p></td>
286 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
287 <td class="parameter_annotations"> </td>
288 </tr></tbody>
289 </table></div>
290 </div>
291 </div>
292 <hr>
293 <div class="refsect2">
294 <a name="xapp-kbd-layout-controller-set-current-group"></a><h3>xapp_kbd_layout_controller_set_current_group ()</h3>
295 <pre class="programlisting"><span class="returnvalue">void</span>
296 xapp_kbd_layout_controller_set_current_group
297 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
298 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
299 <p>Selects the given group number as active.</p>
300 <div class="refsect3">
301 <a name="xapp-kbd-layout-controller-set-current-group.parameters"></a><h4>Parameters</h4>
302 <div class="informaltable"><table class="informaltable" width="100%" border="0">
303 <colgroup>
304 <col width="150px" class="parameters_name">
305 <col class="parameters_description">
306 <col width="200px" class="parameters_annotations">
307 </colgroup>
308 <tbody>
309 <tr>
310 <td class="parameter_name"><p>controller</p></td>
311 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
312 <td class="parameter_annotations"> </td>
313 </tr>
314 <tr>
315 <td class="parameter_name"><p>group</p></td>
316 <td class="parameter_description"><p>the group number to make active</p></td>
317 <td class="parameter_annotations"> </td>
318 </tr>
319 </tbody>
320 </table></div>
321 </div>
322 </div>
323 <hr>
324 <div class="refsect2">
325 <a name="xapp-kbd-layout-controller-next-group"></a><h3>xapp_kbd_layout_controller_next_group ()</h3>
326 <pre class="programlisting"><span class="returnvalue">void</span>
327 xapp_kbd_layout_controller_next_group (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
328 <p>Selects the next group in the group list.</p>
329 <div class="refsect3">
330 <a name="xapp-kbd-layout-controller-next-group.parameters"></a><h4>Parameters</h4>
331 <div class="informaltable"><table class="informaltable" width="100%" border="0">
332 <colgroup>
333 <col width="150px" class="parameters_name">
334 <col class="parameters_description">
335 <col width="200px" class="parameters_annotations">
336 </colgroup>
337 <tbody><tr>
338 <td class="parameter_name"><p>controller</p></td>
339 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
340 <td class="parameter_annotations"> </td>
341 </tr></tbody>
342 </table></div>
343 </div>
344 </div>
345 <hr>
346 <div class="refsect2">
347 <a name="xapp-kbd-layout-controller-previous-group"></a><h3>xapp_kbd_layout_controller_previous_group ()</h3>
348 <pre class="programlisting"><span class="returnvalue">void</span>
349 xapp_kbd_layout_controller_previous_group
350 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
351 <p>Selects the previous group in the group list.</p>
352 <div class="refsect3">
353 <a name="xapp-kbd-layout-controller-previous-group.parameters"></a><h4>Parameters</h4>
354 <div class="informaltable"><table class="informaltable" width="100%" border="0">
355 <colgroup>
356 <col width="150px" class="parameters_name">
357 <col class="parameters_description">
358 <col width="200px" class="parameters_annotations">
359 </colgroup>
360 <tbody><tr>
361 <td class="parameter_name"><p>controller</p></td>
362 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
363 <td class="parameter_annotations"> </td>
364 </tr></tbody>
365 </table></div>
366 </div>
367 </div>
368 <hr>
369 <div class="refsect2">
370 <a name="xapp-kbd-layout-controller-get-current-name"></a><h3>xapp_kbd_layout_controller_get_current_name ()</h3>
371 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
372 xapp_kbd_layout_controller_get_current_name
373 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
374 <p>Returns the full name of the current keyboard layout.</p>
375 <div class="refsect3">
376 <a name="xapp-kbd-layout-controller-get-current-name.parameters"></a><h4>Parameters</h4>
377 <div class="informaltable"><table class="informaltable" width="100%" border="0">
378 <colgroup>
379 <col width="150px" class="parameters_name">
380 <col class="parameters_description">
381 <col width="200px" class="parameters_annotations">
382 </colgroup>
383 <tbody><tr>
384 <td class="parameter_name"><p>controller</p></td>
385 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
386 <td class="parameter_annotations"> </td>
387 </tr></tbody>
388 </table></div>
389 </div>
390 <div class="refsect3">
391 <a name="xapp-kbd-layout-controller-get-current-name.returns"></a><h4>Returns</h4>
392 <p>the newly created string or NULL
393 if something went wrong. </p>
394 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
395 </div>
396 </div>
397 <hr>
398 <div class="refsect2">
399 <a name="xapp-kbd-layout-controller-get-all-names"></a><h3>xapp_kbd_layout_controller_get_all_names ()</h3>
400 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
401 xapp_kbd_layout_controller_get_all_names
402 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
403 <p>Returns an array of all full layout names</p>
404 <div class="refsect3">
405 <a name="xapp-kbd-layout-controller-get-all-names.parameters"></a><h4>Parameters</h4>
406 <div class="informaltable"><table class="informaltable" width="100%" border="0">
407 <colgroup>
408 <col width="150px" class="parameters_name">
409 <col class="parameters_description">
410 <col width="200px" class="parameters_annotations">
411 </colgroup>
412 <tbody><tr>
413 <td class="parameter_name"><p>controller</p></td>
414 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
415 <td class="parameter_annotations"> </td>
416 </tr></tbody>
417 </table></div>
418 </div>
419 <div class="refsect3">
420 <a name="xapp-kbd-layout-controller-get-all-names.returns"></a><h4>Returns</h4>
421 <p>array of names. </p>
422 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p>
423 </div>
424 </div>
425 <hr>
426 <div class="refsect2">
427 <a name="xapp-kbd-layout-controller-get-current-icon-name"></a><h3>xapp_kbd_layout_controller_get_current_icon_name ()</h3>
428 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
429 xapp_kbd_layout_controller_get_current_icon_name
430 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
431 <p>Returns the icon file name (no path or extension) to use for the current layout</p>
432 <div class="refsect3">
433 <a name="xapp-kbd-layout-controller-get-current-icon-name.parameters"></a><h4>Parameters</h4>
434 <div class="informaltable"><table class="informaltable" width="100%" border="0">
435 <colgroup>
436 <col width="150px" class="parameters_name">
437 <col class="parameters_description">
438 <col width="200px" class="parameters_annotations">
439 </colgroup>
440 <tbody><tr>
441 <td class="parameter_name"><p>controller</p></td>
442 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
443 <td class="parameter_annotations"> </td>
444 </tr></tbody>
445 </table></div>
446 </div>
447 <div class="refsect3">
448 <a name="xapp-kbd-layout-controller-get-current-icon-name.returns"></a><h4>Returns</h4>
449 <p>a new string with the icon name. </p>
450 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
451 </div>
452 </div>
453 <hr>
454 <div class="refsect2">
455 <a name="xapp-kbd-layout-controller-get-icon-name-for-group"></a><h3>xapp_kbd_layout_controller_get_icon_name_for_group ()</h3>
456 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
457 xapp_kbd_layout_controller_get_icon_name_for_group
458 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
459 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
460 <p>Returns the icon file name (no path or extension) to use for the specified layout.</p>
461 <div class="refsect3">
462 <a name="xapp-kbd-layout-controller-get-icon-name-for-group.parameters"></a><h4>Parameters</h4>
463 <div class="informaltable"><table class="informaltable" width="100%" border="0">
464 <colgroup>
465 <col width="150px" class="parameters_name">
466 <col class="parameters_description">
467 <col width="200px" class="parameters_annotations">
468 </colgroup>
469 <tbody>
470 <tr>
471 <td class="parameter_name"><p>controller</p></td>
472 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
473 <td class="parameter_annotations"> </td>
474 </tr>
475 <tr>
476 <td class="parameter_name"><p>group</p></td>
477 <td class="parameter_description"><p>a group number</p></td>
478 <td class="parameter_annotations"> </td>
479 </tr>
480 </tbody>
481 </table></div>
482 </div>
483 <div class="refsect3">
484 <a name="xapp-kbd-layout-controller-get-icon-name-for-group.returns"></a><h4>Returns</h4>
485 <p>a new string with the icon name. </p>
486 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
487 </div>
488 </div>
489 <hr>
490 <div class="refsect2">
491 <a name="xapp-kbd-layout-controller-get-current-flag-id"></a><h3>xapp_kbd_layout_controller_get_current_flag_id ()</h3>
492 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
493 xapp_kbd_layout_controller_get_current_flag_id
494 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
495 <p>Returns the duplicate id for the current layout</p>
496 <div class="refsect3">
497 <a name="xapp-kbd-layout-controller-get-current-flag-id.parameters"></a><h4>Parameters</h4>
498 <div class="informaltable"><table class="informaltable" width="100%" border="0">
499 <colgroup>
500 <col width="150px" class="parameters_name">
501 <col class="parameters_description">
502 <col width="200px" class="parameters_annotations">
503 </colgroup>
504 <tbody><tr>
505 <td class="parameter_name"><p>controller</p></td>
506 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
507 <td class="parameter_annotations"> </td>
508 </tr></tbody>
509 </table></div>
510 </div>
511 <div class="refsect3">
512 <a name="xapp-kbd-layout-controller-get-current-flag-id.returns"></a><h4>Returns</h4>
513 <p> the id</p>
514 </div>
515 </div>
516 <hr>
517 <div class="refsect2">
518 <a name="xapp-kbd-layout-controller-get-flag-id-for-group"></a><h3>xapp_kbd_layout_controller_get_flag_id_for_group ()</h3>
519 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
520 xapp_kbd_layout_controller_get_flag_id_for_group
521 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
522 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
523 </div>
524 <hr>
525 <div class="refsect2">
526 <a name="xapp-kbd-layout-controller-get-current-short-group-label"></a><h3>xapp_kbd_layout_controller_get_current_short_group_label ()</h3>
527 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
528 xapp_kbd_layout_controller_get_current_short_group_label
529 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
530 <p>Returns the short group label (and subscript, if any) of the current layout</p>
531 <div class="refsect3">
532 <a name="xapp-kbd-layout-controller-get-current-short-group-label.parameters"></a><h4>Parameters</h4>
533 <div class="informaltable"><table class="informaltable" width="100%" border="0">
534 <colgroup>
535 <col width="150px" class="parameters_name">
536 <col class="parameters_description">
537 <col width="200px" class="parameters_annotations">
538 </colgroup>
539 <tbody><tr>
540 <td class="parameter_name"><p>controller</p></td>
541 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
542 <td class="parameter_annotations"> </td>
543 </tr></tbody>
544 </table></div>
545 </div>
546 <div class="refsect3">
547 <a name="xapp-kbd-layout-controller-get-current-short-group-label.returns"></a><h4>Returns</h4>
548 <p>a new string or NULL. </p>
549 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
550 </div>
551 </div>
552 <hr>
553 <div class="refsect2">
554 <a name="xapp-kbd-layout-controller-get-short-group-label-for-group"></a><h3>xapp_kbd_layout_controller_get_short_group_label_for_group ()</h3>
555 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
556 xapp_kbd_layout_controller_get_short_group_label_for_group
557 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
558 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
559 <p>Returns the short group label and subscript of the specified layout.</p>
560 <div class="refsect3">
561 <a name="xapp-kbd-layout-controller-get-short-group-label-for-group.parameters"></a><h4>Parameters</h4>
562 <div class="informaltable"><table class="informaltable" width="100%" border="0">
563 <colgroup>
564 <col width="150px" class="parameters_name">
565 <col class="parameters_description">
566 <col width="200px" class="parameters_annotations">
567 </colgroup>
568 <tbody>
569 <tr>
570 <td class="parameter_name"><p>controller</p></td>
571 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
572 <td class="parameter_annotations"> </td>
573 </tr>
574 <tr>
575 <td class="parameter_name"><p>group</p></td>
576 <td class="parameter_description"><p>a group number</p></td>
577 <td class="parameter_annotations"> </td>
578 </tr>
579 </tbody>
580 </table></div>
581 </div>
582 <div class="refsect3">
583 <a name="xapp-kbd-layout-controller-get-short-group-label-for-group.returns"></a><h4>Returns</h4>
584 <p>a new string or NULL. </p>
585 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
586 </div>
587 </div>
588 <hr>
589 <div class="refsect2">
590 <a name="xapp-kbd-layout-controller-get-current-variant-label"></a><h3>xapp_kbd_layout_controller_get_current_variant_label ()</h3>
591 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
592 xapp_kbd_layout_controller_get_current_variant_label
593 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
594 <p>Returns the variant label (and subscript, if any) of the current layout</p>
595 <div class="refsect3">
596 <a name="xapp-kbd-layout-controller-get-current-variant-label.parameters"></a><h4>Parameters</h4>
597 <div class="informaltable"><table class="informaltable" width="100%" border="0">
598 <colgroup>
599 <col width="150px" class="parameters_name">
600 <col class="parameters_description">
601 <col width="200px" class="parameters_annotations">
602 </colgroup>
603 <tbody><tr>
604 <td class="parameter_name"><p>controller</p></td>
605 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
606 <td class="parameter_annotations"> </td>
607 </tr></tbody>
608 </table></div>
609 </div>
610 <div class="refsect3">
611 <a name="xapp-kbd-layout-controller-get-current-variant-label.returns"></a><h4>Returns</h4>
612 <p>a new string or NULL. </p>
613 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
614 </div>
615 </div>
616 <hr>
617 <div class="refsect2">
618 <a name="xapp-kbd-layout-controller-get-variant-label-for-group"></a><h3>xapp_kbd_layout_controller_get_variant_label_for_group ()</h3>
619 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
620 xapp_kbd_layout_controller_get_variant_label_for_group
621 (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
622 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
623 <p>Returns the variant label and subscript of the specified layout.</p>
624 <div class="refsect3">
625 <a name="xapp-kbd-layout-controller-get-variant-label-for-group.parameters"></a><h4>Parameters</h4>
626 <div class="informaltable"><table class="informaltable" width="100%" border="0">
627 <colgroup>
628 <col width="150px" class="parameters_name">
629 <col class="parameters_description">
630 <col width="200px" class="parameters_annotations">
631 </colgroup>
632 <tbody>
633 <tr>
634 <td class="parameter_name"><p>controller</p></td>
635 <td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
636 <td class="parameter_annotations"> </td>
637 </tr>
638 <tr>
639 <td class="parameter_name"><p>group</p></td>
640 <td class="parameter_description"><p>a group number</p></td>
641 <td class="parameter_annotations"> </td>
642 </tr>
643 </tbody>
644 </table></div>
645 </div>
646 <div class="refsect3">
647 <a name="xapp-kbd-layout-controller-get-variant-label-for-group.returns"></a><h4>Returns</h4>
648 <p>a new string or NULL. </p>
649 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
650 </div>
651 </div>
652 <hr>
653 <div class="refsect2">
654 <a name="xapp-kbd-layout-controller-render-cairo-subscript"></a><h3>xapp_kbd_layout_controller_render_cairo_subscript ()</h3>
655 <pre class="programlisting"><span class="returnvalue">void</span>
656 xapp_kbd_layout_controller_render_cairo_subscript
657 (<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
658 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
659 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y</code></em>,
660 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
661 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
662 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> subscript</code></em>);</pre>
663 <p>Renders a subscript number in the given work area. This should
664 be called from within a "draw" or "paint" widget/actor function,
665 where a valid cairo_t is provided to draw with.</p>
666 <div class="refsect3">
667 <a name="xapp-kbd-layout-controller-render-cairo-subscript.parameters"></a><h4>Parameters</h4>
668 <div class="informaltable"><table class="informaltable" width="100%" border="0">
669 <colgroup>
670 <col width="150px" class="parameters_name">
671 <col class="parameters_description">
672 <col width="200px" class="parameters_annotations">
673 </colgroup>
674 <tbody>
675 <tr>
676 <td class="parameter_name"><p>cr</p></td>
677 <td class="parameter_description"><p>a <span class="type">cairo_t</span></p></td>
678 <td class="parameter_annotations"> </td>
679 </tr>
680 <tr>
681 <td class="parameter_name"><p>x</p></td>
682 <td class="parameter_description"><p>the x position of the drawing area</p></td>
683 <td class="parameter_annotations"> </td>
684 </tr>
685 <tr>
686 <td class="parameter_name"><p>y</p></td>
687 <td class="parameter_description"><p>the y position of the drawing area</p></td>
688 <td class="parameter_annotations"> </td>
689 </tr>
690 <tr>
691 <td class="parameter_name"><p>width</p></td>
692 <td class="parameter_description"><p>the width of the drawing area</p></td>
693 <td class="parameter_annotations"> </td>
694 </tr>
695 <tr>
696 <td class="parameter_name"><p>height</p></td>
697 <td class="parameter_description"><p>the height of the drawing area</p></td>
698 <td class="parameter_annotations"> </td>
699 </tr>
700 <tr>
701 <td class="parameter_name"><p>subscript</p></td>
702 <td class="parameter_description"><p>the number to render</p></td>
703 <td class="parameter_annotations"> </td>
704 </tr>
705 </tbody>
706 </table></div>
707 </div>
708 </div>
709 </div>
710 <div class="refsect1">
711 <a name="XAppKbdLayoutController.other_details"></a><h2>Types and Values</h2>
712 </div>
713 <div class="refsect1">
714 <a name="XAppKbdLayoutController.property-details"></a><h2>Property Details</h2>
715 <div class="refsect2">
716 <a name="XAppKbdLayoutController--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
717 <pre class="programlisting"> “enabled” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
718 <p>Whether we're enabled (more than one keyboard layout is installed).</p>
719 <p>Flags: Read</p>
720 <p>Default value: FALSE</p>
721 </div>
722 </div>
723 <div class="refsect1">
724 <a name="XAppKbdLayoutController.signal-details"></a><h2>Signal Details</h2>
725 <div class="refsect2">
726 <a name="XAppKbdLayoutController-config-changed"></a><h3>The <code class="literal">“config-changed”</code> signal</h3>
727 <pre class="programlisting"><span class="returnvalue">void</span>
728 user_function (<a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *xappkbdlayoutcontroller,
729 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
730 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
731 </div>
732 <hr>
733 <div class="refsect2">
734 <a name="XAppKbdLayoutController-layout-changed"></a><h3>The <code class="literal">“layout-changed”</code> signal</h3>
735 <pre class="programlisting"><span class="returnvalue">void</span>
736 user_function (<a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *xappkbdlayoutcontroller,
737 <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1,
738 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
739 <p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
740 </div>
741 </div>
742 </div>
743 <div class="footer">
744 <hr>Generated by GTK-Doc V1.27</div>
745 </body>
746 </html>⏎
+193
-0
docs/reference/XAppMonitorBlanker.html less more
0 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>XAppMonitorBlanker: XApp Reference Manual</title>
5 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
6 <link rel="home" href="index.html" title="XApp Reference Manual">
7 <link rel="up" href="ch01.html" title="API reference">
8 <link rel="prev" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController">
9 <link rel="next" href="XAppPreferencesWindow.html" title="XAppPreferencesWindow">
10 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
15 <td width="100%" align="left" class="shortcuts">
16 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
17 <a href="#XAppMonitorBlanker.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
18 <a href="#XAppMonitorBlanker.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="XAppKbdLayoutController.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="XAppPreferencesWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="XAppMonitorBlanker"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="XAppMonitorBlanker.top_of_page"></a>XAppMonitorBlanker</span></h2>
30 <p>XAppMonitorBlanker — Blank and unblank unused monitors</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="XAppMonitorBlanker.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="returnvalue">XAppMonitorBlanker</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-new" title="xapp_monitor_blanker_new ()">xapp_monitor_blanker_new</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">void</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()">xapp_monitor_blanker_blank_other_monitors</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">void</span>
61 </td>
62 <td class="function_name">
63 <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-unblank-monitors" title="xapp_monitor_blanker_unblank_monitors ()">xapp_monitor_blanker_unblank_monitors</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
69 </td>
70 <td class="function_name">
71 <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-are-monitors-blanked" title="xapp_monitor_blanker_are_monitors_blanked ()">xapp_monitor_blanker_are_monitors_blanked</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 </tbody>
75 </table></div>
76 </div>
77 <div class="refsect1">
78 <a name="XAppMonitorBlanker.object-hierarchy"></a><h2>Object Hierarchy</h2>
79 <pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
80 <span class="lineart">╰──</span> XAppMonitorBlanker
81 </pre>
82 </div>
83 <div class="refsect1">
84 <a name="XAppMonitorBlanker.description"></a><h2>Description</h2>
85 <p>The XAppMonitorBlanker widget that creates one or more
86 POPUP type GtkWindows that are used to blank unused
87 monitors in multiple monitor setups.</p>
88 </div>
89 <div class="refsect1">
90 <a name="XAppMonitorBlanker.functions_details"></a><h2>Functions</h2>
91 <div class="refsect2">
92 <a name="xapp-monitor-blanker-new"></a><h3>xapp_monitor_blanker_new ()</h3>
93 <pre class="programlisting"><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="returnvalue">XAppMonitorBlanker</span></a> *
94 xapp_monitor_blanker_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
95 <p>Creates a new <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a>.</p>
96 <div class="refsect3">
97 <a name="xapp-monitor-blanker-new.returns"></a><h4>Returns</h4>
98 <p> a newly created <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p>
99 </div>
100 </div>
101 <hr>
102 <div class="refsect2">
103 <a name="xapp-monitor-blanker-blank-other-monitors"></a><h3>xapp_monitor_blanker_blank_other_monitors ()</h3>
104 <pre class="programlisting"><span class="returnvalue">void</span>
105 xapp_monitor_blanker_blank_other_monitors
106 (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>,
107 <em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
108 <p>Blanks monitors besides the one where the <em class="parameter"><code>window</code></em>
109 is.</p>
110 <div class="refsect3">
111 <a name="xapp-monitor-blanker-blank-other-monitors.parameters"></a><h4>Parameters</h4>
112 <div class="informaltable"><table class="informaltable" width="100%" border="0">
113 <colgroup>
114 <col width="150px" class="parameters_name">
115 <col class="parameters_description">
116 <col width="200px" class="parameters_annotations">
117 </colgroup>
118 <tbody>
119 <tr>
120 <td class="parameter_name"><p>self</p></td>
121 <td class="parameter_description"><p>a <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p></td>
122 <td class="parameter_annotations"> </td>
123 </tr>
124 <tr>
125 <td class="parameter_name"><p>window</p></td>
126 <td class="parameter_description"><p>a <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a></p></td>
127 <td class="parameter_annotations"> </td>
128 </tr>
129 </tbody>
130 </table></div>
131 </div>
132 </div>
133 <hr>
134 <div class="refsect2">
135 <a name="xapp-monitor-blanker-unblank-monitors"></a><h3>xapp_monitor_blanker_unblank_monitors ()</h3>
136 <pre class="programlisting"><span class="returnvalue">void</span>
137 xapp_monitor_blanker_unblank_monitors (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>);</pre>
138 <p>Unblanks monitors that were blanked by
139 <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()"><code class="function">xapp_monitor_blanker_blank_other_monitors()</code></a>;</p>
140 <div class="refsect3">
141 <a name="xapp-monitor-blanker-unblank-monitors.parameters"></a><h4>Parameters</h4>
142 <div class="informaltable"><table class="informaltable" width="100%" border="0">
143 <colgroup>
144 <col width="150px" class="parameters_name">
145 <col class="parameters_description">
146 <col width="200px" class="parameters_annotations">
147 </colgroup>
148 <tbody><tr>
149 <td class="parameter_name"><p>self</p></td>
150 <td class="parameter_description"><p>a <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p></td>
151 <td class="parameter_annotations"> </td>
152 </tr></tbody>
153 </table></div>
154 </div>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="xapp-monitor-blanker-are-monitors-blanked"></a><h3>xapp_monitor_blanker_are_monitors_blanked ()</h3>
159 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
160 xapp_monitor_blanker_are_monitors_blanked
161 (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>);</pre>
162 <p>Returns whether monitors are currently blanked.
163 See <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()"><code class="function">xapp_monitor_blanker_blank_other_monitors()</code></a>.</p>
164 <div class="refsect3">
165 <a name="xapp-monitor-blanker-are-monitors-blanked.parameters"></a><h4>Parameters</h4>
166 <div class="informaltable"><table class="informaltable" width="100%"