Debian Codegraph @

docs/reference/libxfce4windowingui/html/XfwWindowListMenu.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>XfwWindowListMenu: libxfce4windowing Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="libxfce4windowing Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="XfwWindowActionMenu.html" title="XfwWindowActionMenu">
10 <link rel="next" href="object-tree.html" title="Object Hierarchy">
11 <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#XfwWindowListMenu.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#XfwWindowListMenu.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#XfwWindowListMenu.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
21 <a href="#XfwWindowListMenu.properties" class="shortcut">Properties</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="XfwWindowActionMenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="object-tree.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="XfwWindowListMenu"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="XfwWindowListMenu.top_of_page"></a>XfwWindowListMenu</span></h2>
33 <p>XfwWindowListMenu — a <span class="type">GtkMenu</span> subclass that lists all windows</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="XfwWindowListMenu.stability-level"></a><h2>Stability Level</h2>
39 <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
40 give outside developers early access to new or rapidly changing technology, or
41 to provide an interim solution to a problem where a more general solution is
42 anticipated. No claims are made about either source or binary compatibility from
43 one minor release to the next.
44
45 The Unstable interface level is a warning that these interfaces are subject to
46 change without warning and should not be used in unbundled products.
47
48 Given such caveats, customer impact need not be a factor when considering
49 incompatible changes to an Unstable interface in a major or minor release.
50 Nonetheless, when such changes are introduced, the changes should still be
51 mentioned in the release notes for the affected release.
52 "><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
53 </div>
54 <div class="refsect1">
55 <a name="XfwWindowListMenu.functions"></a><h2>Functions</h2>
56 <div class="informaltable"><table class="informaltable" width="100%" border="0">
57 <colgroup>
58 <col width="150px" class="functions_proto_type">
59 <col class="functions_proto_name">
60 </colgroup>
61 <tbody><tr>
62 <td class="function_type">
63 <span class="returnvalue">GtkWidget</span> *
64 </td>
65 <td class="function_name">
66 <a class="link" href="XfwWindowListMenu.html#xfw-window-list-menu-new" title="xfw_window_list_menu_new ()">xfw_window_list_menu_new</a> <span class="c_punctuation">()</span>
67 </td>
68 </tr></tbody>
69 </table></div>
70 </div>
71 <div class="refsect1">
72 <a name="XfwWindowListMenu.properties"></a><h2>Properties</h2>
73 <div class="informaltable"><table class="informaltable" border="0">
74 <colgroup>
75 <col width="150px" class="properties_type">
76 <col width="300px" class="properties_name">
77 <col width="200px" class="properties_flags">
78 </colgroup>
79 <tbody>
80 <tr>
81 <td class="property_type"><span class="type">int</span></td>
82 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--minimized-icon-saturation" title="The “minimized-icon-saturation” property">minimized-icon-saturation</a></td>
83 <td class="property_flags">Read / Write</td>
84 </tr>
85 <tr>
86 <td class="property_type">
87 <a href="../html/XfwScreen.html#XfwScreen-struct"><span class="type">XfwScreen</span></a> *</td>
88 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--screen" title="The “screen” property">screen</a></td>
89 <td class="property_flags">Read / Write / Construct Only</td>
90 </tr>
91 <tr>
92 <td class="property_type"><span class="type">gboolean</span></td>
93 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-all-workspaces" title="The “show-all-workspaces” property">show-all-workspaces</a></td>
94 <td class="property_flags">Read / Write</td>
95 </tr>
96 <tr>
97 <td class="property_type"><span class="type">gboolean</span></td>
98 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-icons" title="The “show-icons” property">show-icons</a></td>
99 <td class="property_flags">Read / Write</td>
100 </tr>
101 <tr>
102 <td class="property_type"><span class="type">gboolean</span></td>
103 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-sticky-windows-once" title="The “show-sticky-windows-once” property">show-sticky-windows-once</a></td>
104 <td class="property_flags">Read / Write</td>
105 </tr>
106 <tr>
107 <td class="property_type"><span class="type">gboolean</span></td>
108 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-urgent-windows-section" title="The “show-urgent-windows-section” property">show-urgent-windows-section</a></td>
109 <td class="property_flags">Read / Write</td>
110 </tr>
111 <tr>
112 <td class="property_type"><span class="type">gboolean</span></td>
113 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-workspace-actions" title="The “show-workspace-actions” property">show-workspace-actions</a></td>
114 <td class="property_flags">Read / Write</td>
115 </tr>
116 <tr>
117 <td class="property_type"><span class="type">gboolean</span></td>
118 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-workspace-names" title="The “show-workspace-names” property">show-workspace-names</a></td>
119 <td class="property_flags">Read / Write</td>
120 </tr>
121 <tr>
122 <td class="property_type"><span class="type">gboolean</span></td>
123 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--show-workspace-submenus" title="The “show-workspace-submenus” property">show-workspace-submenus</a></td>
124 <td class="property_flags">Read / Write</td>
125 </tr>
126 <tr>
127 <td class="property_type"><span class="type">PangoEllipsizeMode</span></td>
128 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--window-title-ellipsize-mode" title="The “window-title-ellipsize-mode” property">window-title-ellipsize-mode</a></td>
129 <td class="property_flags">Read / Write</td>
130 </tr>
131 <tr>
132 <td class="property_type"><span class="type">int</span></td>
133 <td class="property_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu--window-title-max-width-chars" title="The “window-title-max-width-chars” property">window-title-max-width-chars</a></td>
134 <td class="property_flags">Read / Write</td>
135 </tr>
136 </tbody>
137 </table></div>
138 </div>
139 <div class="refsect1">
140 <a name="XfwWindowListMenu.other"></a><h2>Types and Values</h2>
141 <div class="informaltable"><table class="informaltable" width="100%" border="0">
142 <colgroup>
143 <col width="150px" class="other_proto_type">
144 <col class="other_proto_name">
145 </colgroup>
146 <tbody><tr>
147 <td class="datatype_keyword"> </td>
148 <td class="function_name"><a class="link" href="XfwWindowListMenu.html#XfwWindowListMenu-struct" title="XfwWindowListMenu">XfwWindowListMenu</a></td>
149 </tr></tbody>
150 </table></div>
151 </div>
152 <div class="refsect1">
153 <a name="XfwWindowListMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
154 <pre class="screen"> GObject
155 <span class="lineart">╰──</span> GInitiallyUnowned
156 <span class="lineart">╰──</span> GtkWidget
157 <span class="lineart">╰──</span> GtkContainer
158 <span class="lineart">╰──</span> GtkMenuShell
159 <span class="lineart">╰──</span> GtkMenu
160 <span class="lineart">╰──</span> XfwWindowListMenu
161 </pre>
162 </div>
163 <div class="refsect1">
164 <a name="XfwWindowListMenu.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
165 <p>
166 XfwWindowListMenu implements
167 AtkImplementorIface and GtkBuildable.</p>
168 </div>
169 <div class="refsect1">
170 <a name="XfwWindowListMenu.includes"></a><h2>Includes</h2>
171 <pre class="synopsis">#include &lt;libxfce4windowingui/libxfce4windowingui.h&gt;
172 </pre>
173 </div>
174 <div class="refsect1">
175 <a name="XfwWindowListMenu.description"></a><h2>Description</h2>
176 <p><a class="link" href="XfwWindowListMenu.html" title="XfwWindowListMenu"><span class="type">XfwWindowListMenu</span></a> is a <span class="type">GtkMenu</span> that lists all windows present on the
177 desktop, categorized by workspace. There are also various options that
178 control presentation; see the properties available on the object.</p>
179 </div>
180 <div class="refsect1">
181 <a name="XfwWindowListMenu.functions_details"></a><h2>Functions</h2>
182 <div class="refsect2">
183 <a name="xfw-window-list-menu-new"></a><h3>xfw_window_list_menu_new ()</h3>
184 <pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
185 xfw_window_list_menu_new (<em class="parameter"><code><a href="../html/XfwScreen.html#XfwScreen-struct"><span class="type">XfwScreen</span></a> *screen</code></em>);</pre>
186 <p>Creates a new <a class="link" href="XfwWindowListMenu.html" title="XfwWindowListMenu"><span class="type">XfwWindowListMenu</span></a>, populating it from <em class="parameter"><code>screen</code></em>
187 .</p>
188 <div class="refsect3">
189 <a name="xfw-window-list-menu-new.parameters"></a><h4>Parameters</h4>
190 <div class="informaltable"><table class="informaltable" width="100%" border="0">
191 <colgroup>
192 <col width="150px" class="parameters_name">
193 <col class="parameters_description">
194 <col width="200px" class="parameters_annotations">
195 </colgroup>
196 <tbody><tr>
197 <td class="parameter_name"><p>screen</p></td>
198 <td class="parameter_description"><p>an <a href="../html/XfwScreen.html#XfwScreen-struct"><span class="type">XfwScreen</span></a>.</p></td>
199 <td class="parameter_annotations"> </td>
200 </tr></tbody>
201 </table></div>
202 </div>
203 <div class="refsect3">
204 <a name="xfw-window-list-menu-new.returns"></a><h4>Returns</h4>
205 <p>A <span class="type">GtkMenu</span> subclass as a
206 <span class="type">GtkWidget</span>, with a floating reference. </p>
207 <p><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>][<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p>
208 </div>
209 </div>
210 </div>
211 <div class="refsect1">
212 <a name="XfwWindowListMenu.other_details"></a><h2>Types and Values</h2>
213 <div class="refsect2">
214 <a name="XfwWindowListMenu-struct"></a><h3>XfwWindowListMenu</h3>
215 <pre class="programlisting">typedef struct _XfwWindowListMenu XfwWindowListMenu;</pre>
216 </div>
217 </div>
218 <div class="refsect1">
219 <a name="XfwWindowListMenu.property-details"></a><h2>Property Details</h2>
220 <div class="refsect2">
221 <a name="XfwWindowListMenu--minimized-icon-saturation"></a><h3>The <code class="literal">“minimized-icon-saturation”</code> property</h3>
222 <pre class="programlisting"> “minimized-icon-saturation” <span class="type">int</span></pre>
223 <p>The saturation of icons for minimized windows. The value should be
224 between 0 and 100. Lower values will make the icon look more like a
225 greyscale image.</p>
226 <p>Owner: XfwWindowListMenu</p>
227 <p>Flags: Read / Write</p>
228 <p>Allowed values: [0,100]</p>
229 <p>Default value: 50</p>
230 </div>
231 <hr>
232 <div class="refsect2">
233 <a name="XfwWindowListMenu--screen"></a><h3>The <code class="literal">“screen”</code> property</h3>
234 <pre class="programlisting"> “screen” <a href="../html/XfwScreen.html#XfwScreen-struct"><span class="type">XfwScreen</span></a> *</pre>
235 <p>The <a href="../html/XfwScreen.html#XfwScreen-struct"><span class="type">XfwScreen</span></a> to use when populating the menu.</p>
236 <p>Owner: XfwWindowListMenu</p>
237 <p>Flags: Read / Write / Construct Only</p>
238 </div>
239 <hr>
240 <div class="refsect2">
241 <a name="XfwWindowListMenu--show-all-workspaces"></a><h3>The <code class="literal">“show-all-workspaces”</code> property</h3>
242 <pre class="programlisting"> “show-all-workspaces” <span class="type">gboolean</span></pre>
243 <p>Whether or not to show all workspaces in the list, or just the current
244 workspace.</p>
245 <p>Owner: XfwWindowListMenu</p>
246 <p>Flags: Read / Write</p>
247 <p>Default value: TRUE</p>
248 </div>
249 <hr>
250 <div class="refsect2">
251 <a name="XfwWindowListMenu--show-icons"></a><h3>The <code class="literal">“show-icons”</code> property</h3>
252 <pre class="programlisting"> “show-icons” <span class="type">gboolean</span></pre>
253 <p>Whether or not to show icons in the menu.</p>
254 <p>Owner: XfwWindowListMenu</p>
255 <p>Flags: Read / Write</p>
256 <p>Default value: TRUE</p>
257 </div>
258 <hr>
259 <div class="refsect2">
260 <a name="XfwWindowListMenu--show-sticky-windows-once"></a><h3>The <code class="literal">“show-sticky-windows-once”</code> property</h3>
261 <pre class="programlisting"> “show-sticky-windows-once” <span class="type">gboolean</span></pre>
262 <p>Whether or not sticky/pinned windows should be shown once (on the active
263 workspace), or in each workspace list.</p>
264 <p>Owner: XfwWindowListMenu</p>
265 <p>Flags: Read / Write</p>
266 <p>Default value: FALSE</p>
267 </div>
268 <hr>
269 <div class="refsect2">
270 <a name="XfwWindowListMenu--show-urgent-windows-section"></a><h3>The <code class="literal">“show-urgent-windows-section”</code> property</h3>
271 <pre class="programlisting"> “show-urgent-windows-section” <span class="type">gboolean</span></pre>
272 <p>Whether or not to show an extra section that lists urgent windows on
273 other workspaces.</p>
274 <p>Owner: XfwWindowListMenu</p>
275 <p>Flags: Read / Write</p>
276 <p>Default value: FALSE</p>
277 </div>
278 <hr>
279 <div class="refsect2">
280 <a name="XfwWindowListMenu--show-workspace-actions"></a><h3>The <code class="literal">“show-workspace-actions”</code> property</h3>
281 <pre class="programlisting"> “show-workspace-actions” <span class="type">gboolean</span></pre>
282 <p>Whether or not to show a section in the menu with items to add and
283 remove workspaces.</p>
284 <p>Owner: XfwWindowListMenu</p>
285 <p>Flags: Read / Write</p>
286 <p>Default value: TRUE</p>
287 </div>
288 <hr>
289 <div class="refsect2">
290 <a name="XfwWindowListMenu--show-workspace-names"></a><h3>The <code class="literal">“show-workspace-names”</code> property</h3>
291 <pre class="programlisting"> “show-workspace-names” <span class="type">gboolean</span></pre>
292 <p>Whether or not to show a heading with the workspace name before the list
293 of windows on that workspace.</p>
294 <p>Owner: XfwWindowListMenu</p>
295 <p>Flags: Read / Write</p>
296 <p>Default value: TRUE</p>
297 </div>
298 <hr>
299 <div class="refsect2">
300 <a name="XfwWindowListMenu--show-workspace-submenus"></a><h3>The <code class="literal">“show-workspace-submenus”</code> property</h3>
301 <pre class="programlisting"> “show-workspace-submenus” <span class="type">gboolean</span></pre>
302 <p>Whether or not the lists of windows should be in submenus for each
303 workspace.</p>
304 <p>Owner: XfwWindowListMenu</p>
305 <p>Flags: Read / Write</p>
306 <p>Default value: FALSE</p>
307 </div>
308 <hr>
309 <div class="refsect2">
310 <a name="XfwWindowListMenu--window-title-ellipsize-mode"></a><h3>The <code class="literal">“window-title-ellipsize-mode”</code> property</h3>
311 <pre class="programlisting"> “window-title-ellipsize-mode” <span class="type">PangoEllipsizeMode</span></pre>
312 <p>The <span class="type">PangoEllipsizeMode</span> to use when ellipsizing window titles.</p>
313 <p>Owner: XfwWindowListMenu</p>
314 <p>Flags: Read / Write</p>
315 <p>Default value: PANGO_ELLIPSIZE_MIDDLE</p>
316 </div>
317 <hr>
318 <div class="refsect2">
319 <a name="XfwWindowListMenu--window-title-max-width-chars"></a><h3>The <code class="literal">“window-title-max-width-chars”</code> property</h3>
320 <pre class="programlisting"> “window-title-max-width-chars” <span class="type">int</span></pre>
321 <p>The maximum width (in characters) of window titles to display before
322 ellipsizing.</p>
323 <p>Owner: XfwWindowListMenu</p>
324 <p>Flags: Read / Write</p>
325 <p>Allowed values: &gt;= -1</p>
326 <p>Default value: 24</p>
327 </div>
328 </div>
329 </div>
330 <div class="footer">
331 <hr>Generated by GTK-Doc V1.34.0</div>
332 </body>
333 </html>