/usr/share/gtk-doc/html/libwnck-3.0/WnckTasklist.html is in libwnck-3-dev 3.24.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WnckTasklist: Libwnck Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libwnck Reference Manual">
<link rel="up" href="widgets.html" title="Part IV. Libwnck Widgets">
<link rel="prev" href="WnckSelector.html" title="WnckSelector">
<link rel="next" href="utils.html" title="Part V. Libwnck Utilities">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#WnckTasklist.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#WnckTasklist.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#WnckTasklist.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_style_properties"> <span class="dim">|</span>
<a href="#WnckTasklist.style-properties" class="shortcut">Style Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="WnckSelector.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="WnckTasklist"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WnckTasklist.top_of_page"></a>WnckTasklist</span></h2>
<p>WnckTasklist — a tasklist widget, showing the list of windows as a list
of buttons.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="WnckTasklist.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="WnckTasklist.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-new" title="wnck_tasklist_new ()">wnck_tasklist_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-grouping" title="wnck_tasklist_set_grouping ()">wnck_tasklist_set_grouping</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-grouping-limit" title="wnck_tasklist_set_grouping_limit ()">wnck_tasklist_set_grouping_limit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-include-all-workspaces" title="wnck_tasklist_set_include_all_workspaces ()">wnck_tasklist_set_include_all_workspaces</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-switch-workspace-on-unminimize" title="wnck_tasklist_set_switch_workspace_on_unminimize ()">wnck_tasklist_set_switch_workspace_on_unminimize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-button-relief" title="wnck_tasklist_set_button_relief ()">wnck_tasklist_set_button_relief</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="WnckTasklist.html#WnckLoadIconFunction" title="WnckLoadIconFunction ()">*WnckLoadIconFunction</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-icon-loader" title="wnck_tasklist_set_icon_loader ()">wnck_tasklist_set_icon_loader</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">int</span> *
</td>
<td class="function_name">
<a class="link" href="WnckTasklist.html#wnck-tasklist-get-size-hint-list" title="wnck_tasklist_get_size_hint_list ()">wnck_tasklist_get_size_hint_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckTasklist.style-properties"></a><h2>Style Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="style_properties_type">
<col width="300px" class="style_properties_name">
<col width="200px" class="style_properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="WnckTasklist.html#WnckTasklist--s-fade-loop-time" title="The “fade-loop-time” style property">fade-loop-time</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="WnckTasklist.html#WnckTasklist--s-fade-max-loops" title="The “fade-max-loops” style property">fade-max-loops</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="WnckTasklist.html#WnckTasklist--s-fade-opacity" title="The “fade-opacity” style property">fade-opacity</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="WnckTasklist.html#WnckTasklist--s-fade-overlay-rect" title="The “fade-overlay-rect” style property">fade-overlay-rect</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckTasklist.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="WnckTasklist.html#WnckTasklist-struct" title="struct WnckTasklist">WnckTasklist</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WnckTasklist.html#WnckTasklistGroupingType" title="enum WnckTasklistGroupingType">WnckTasklistGroupingType</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckTasklist.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> WnckTasklist
</pre>
</div>
<div class="refsect1">
<a name="WnckTasklist.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
WnckTasklist implements
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="WnckTasklist.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libwnck/libwnck.h>
</pre>
</div>
<div class="refsect1">
<a name="WnckTasklist.description"></a><h2>Description</h2>
<p>The <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> represents client windows on a screen as a list of buttons
labelled with the window titles and icons. Pressing a button can activate or
minimize the represented window, and other typical actions are available
through a popup menu. Windows needing attention can also be distinguished
by a fade effect on the buttons representing them, to help attract the
user's attention.</p>
<p>The behavior of the <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> can be customized in various ways, like
grouping multiple windows of the same application in one button (see
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-grouping" title="wnck_tasklist_set_grouping ()"><code class="function">wnck_tasklist_set_grouping()</code></a> and <a class="link" href="WnckTasklist.html#wnck-tasklist-set-grouping-limit" title="wnck_tasklist_set_grouping_limit ()"><code class="function">wnck_tasklist_set_grouping_limit()</code></a>), or
showing windows from all workspaces (see
<a class="link" href="WnckTasklist.html#wnck-tasklist-set-include-all-workspaces" title="wnck_tasklist_set_include_all_workspaces ()"><code class="function">wnck_tasklist_set_include_all_workspaces()</code></a>). The fade effect for windows
needing attention can be controlled by various style properties like
<span class="type">“fade-max-loops”</span> and <span class="type">“fade-opacity”</span>.</p>
<p>The tasklist also acts as iconification destination. If there are multiple
<a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> or other applications setting the iconification destination
for windows, the iconification destinations might not be consistent among
windows and it is not possible to determine which <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> (or which
other application) owns this propriety.</p>
</div>
<div class="refsect1">
<a name="WnckTasklist.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="wnck-tasklist-new"></a><h3>wnck_tasklist_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
wnck_tasklist_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>. The <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> will list <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> of the
<a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> it is on.</p>
<div class="refsect3">
<a name="wnck-tasklist-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-grouping"></a><h3>wnck_tasklist_set_grouping ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_grouping (<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a class="link" href="WnckTasklist.html#WnckTasklistGroupingType" title="enum WnckTasklistGroupingType"><span class="type">WnckTasklistGroupingType</span></a> grouping</code></em>);</pre>
<p>Sets the grouping policy for <em class="parameter"><code>tasklist</code></em>
to <em class="parameter"><code>grouping</code></em>
.</p>
<div class="refsect3">
<a name="wnck-tasklist-set-grouping.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>grouping</p></td>
<td class="parameter_description"><p>a grouping policy.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-grouping-limit"></a><h3>wnck_tasklist_set_grouping_limit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_grouping_limit (<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit</code></em>);</pre>
<p>Sets the maximum size of buttons in <em class="parameter"><code>tasklist</code></em>
before <em class="parameter"><code>tasklist</code></em>
tries to
group <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> in the same <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a> in only one button. This
limit is valid only when the grouping policy of <em class="parameter"><code>tasklist</code></em>
is
<a class="link" href="WnckTasklist.html#WNCK-TASKLIST-AUTO-GROUP:CAPS"><code class="literal">WNCK_TASKLIST_AUTO_GROUP</code></a>.</p>
<div class="refsect3">
<a name="wnck-tasklist-set-grouping-limit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>limit</p></td>
<td class="parameter_description"><p>a size in pixels.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-include-all-workspaces"></a><h3>wnck_tasklist_set_include_all_workspaces ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_include_all_workspaces
(<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_all_workspaces</code></em>);</pre>
<p>Sets <em class="parameter"><code>tasklist</code></em>
to display <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> from all <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> or not,
according to <em class="parameter"><code>include_all_workspaces</code></em>
.</p>
<p>Note that if the active <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> has a viewport and if
<em class="parameter"><code>include_all_workspaces</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then only the <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> visible in the
viewport are displayed in <em class="parameter"><code>tasklist</code></em>
. The rationale for this is that the
viewport is generally used to implement workspace-like behavior. A
side-effect of this is that, when using multiple <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> with
viewport, it is not possible to show all <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> from a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>
(even those that are not visible in the viewport) in <em class="parameter"><code>tasklist</code></em>
without
showing all <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> from all <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p>
<div class="refsect3">
<a name="wnck-tasklist-set-include-all-workspaces.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_all_workspaces</p></td>
<td class="parameter_description"><p>whether to display <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> from all
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> in <em class="parameter"><code>tasklist</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-switch-workspace-on-unminimize"></a><h3>wnck_tasklist_set_switch_workspace_on_unminimize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_switch_workspace_on_unminimize
(<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> switch_workspace_on_unminimize</code></em>);</pre>
<p>Sets <em class="parameter"><code>tasklist</code></em>
to activate or not the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> a <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> is on
when unminimizing it, according to <em class="parameter"><code>switch_workspace_on_unminimize</code></em>
.</p>
<p>FIXME: does it still work?</p>
<div class="refsect3">
<a name="wnck-tasklist-set-switch-workspace-on-unminimize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>switch_workspace_on_unminimize</p></td>
<td class="parameter_description"><p>whether to activate the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> a
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> is on when unminimizing it.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-button-relief"></a><h3>wnck_tasklist_set_button_relief ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_button_relief (<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Standard-Enumerations.html#GtkReliefStyle"><span class="type">GtkReliefStyle</span></a> relief</code></em>);</pre>
<p>Sets the relief type of the buttons in <em class="parameter"><code>tasklist</code></em>
to <em class="parameter"><code>relief</code></em>
. The main use of
this function is proper integration of <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> in panels with
non-system backgrounds.</p>
<div class="refsect3">
<a name="wnck-tasklist-set-button-relief.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>relief</p></td>
<td class="parameter_description"><p>a relief type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="WnckLoadIconFunction"></a><h3>WnckLoadIconFunction ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
<span class="c_punctuation">(</span>*WnckLoadIconFunction<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *icon_name</code></em>,
<em class="parameter"><code><span class="type">int</span> size</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> flags</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
<p>Specifies the type of function passed to <a class="link" href="WnckTasklist.html#wnck-tasklist-set-icon-loader" title="wnck_tasklist_set_icon_loader ()"><code class="function">wnck_tasklist_set_icon_loader()</code></a>.</p>
<div class="refsect3">
<a name="WnckLoadIconFunction.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>icon_name</p></td>
<td class="parameter_description"><p>an icon name as in the Icon field in a .desktop file for the
icon to load.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the desired icon size.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>not defined to do anything yet.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data passed to the function, set when the <a class="link" href="WnckTasklist.html#WnckLoadIconFunction" title="WnckLoadIconFunction ()"><span class="type">WnckLoadIconFunction</span></a> has
been set for the <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="WnckLoadIconFunction.returns"></a><h4>Returns</h4>
<p> it should return a <code class="classname">GdkPixbuf</code> of <em class="parameter"><code>icon_name</code></em>
at size <em class="parameter"><code>size</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no icon for <em class="parameter"><code>icon_name</code></em>
at size <em class="parameter"><code>size</code></em>
could be
loaded.</p>
</div>
<p class="since">Since: 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-set-icon-loader"></a><h3>wnck_tasklist_set_icon_loader ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_tasklist_set_icon_loader (<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><a class="link" href="WnckTasklist.html#WnckLoadIconFunction" title="WnckLoadIconFunction ()"><span class="type">WnckLoadIconFunction</span></a> load_icon_func</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> free_data_func</code></em>);</pre>
<p>Sets a function to be used for loading icons.</p>
<div class="refsect3">
<a name="wnck-tasklist-set-icon-loader.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_icon_func</p></td>
<td class="parameter_description"><p>icon loader function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data for icon loader function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>free_data_func</p></td>
<td class="parameter_description"><p>function to free the data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-tasklist-get-size-hint-list"></a><h3>wnck_tasklist_get_size_hint_list ()</h3>
<pre class="programlisting">const <span class="returnvalue">int</span> *
wnck_tasklist_get_size_hint_list (<em class="parameter"><code><a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> *tasklist</code></em>,
<em class="parameter"><code><span class="type">int</span> *n_elements</code></em>);</pre>
<p>Since a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> does not have a fixed size (<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> can be grouped
when needed, for example), the standard size request mechanism in GTK+ is
not enough to announce what sizes can be used by <em class="parameter"><code>tasklist</code></em>
. The size hints
mechanism is a solution for this. See <code class="function">panel_applet_set_size_hints()</code> for more
information.</p>
<div class="refsect3">
<a name="wnck-tasklist-get-size-hint-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tasklist</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_elements</p></td>
<td class="parameter_description"><p>return location for the number of elements in the array
returned by this function. This number should always be pair.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-tasklist-get-size-hint-list.returns"></a><h4>Returns</h4>
<p> a list of size hints that can be used to allocate an
appropriate size for <em class="parameter"><code>tasklist</code></em>
.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="WnckTasklist.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="WnckTasklist-struct"></a><h3>struct WnckTasklist</h3>
<pre class="programlisting">struct WnckTasklist;</pre>
<p>The <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> struct contains only private fields and should not be
directly accessed.</p>
</div>
<hr>
<div class="refsect2">
<a name="WnckTasklistGroupingType"></a><h3>enum WnckTasklistGroupingType</h3>
<p>Type defining the policy of the <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a> for grouping multiple
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> of the same <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a>.</p>
<div class="refsect3">
<a name="WnckTasklistGroupingType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="WNCK-TASKLIST-NEVER-GROUP:CAPS"></a>WNCK_TASKLIST_NEVER_GROUP</p></td>
<td class="enum_member_description">
<p>never group multiple <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> of the same
<a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-TASKLIST-AUTO-GROUP:CAPS"></a>WNCK_TASKLIST_AUTO_GROUP</p></td>
<td class="enum_member_description">
<p>group multiple <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> of the same
<a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a> for some <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a>, when there is not enough place
to have a good-looking list of all <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-TASKLIST-ALWAYS-GROUP:CAPS"></a>WNCK_TASKLIST_ALWAYS_GROUP</p></td>
<td class="enum_member_description">
<p>always group multiple <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> of the same
<a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a>, for all <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="WnckTasklist.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="WnckTasklist--s-fade-loop-time"></a><h3>The <code class="literal">“fade-loop-time”</code> style property</h3>
<pre class="programlisting"> “fade-loop-time” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>When a window needs attention, a fade effect is drawn on the button
representing the window. This property controls the time one loop of this
fade effect takes, in seconds.</p>
<p>Flags: Read</p>
<p>Allowed values: [0.2,10]</p>
<p>Default value: 3</p>
<p class="since">Since: 2.16</p>
</div>
<hr>
<div class="refsect2">
<a name="WnckTasklist--s-fade-max-loops"></a><h3>The <code class="literal">“fade-max-loops”</code> style property</h3>
<pre class="programlisting"> “fade-max-loops” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>When a window needs attention, a fade effect is drawn on the button
representing the window. This property controls the number of loops for
this fade effect. 0 means the button will only fade to the final color.</p>
<p>Flags: Read</p>
<p>Allowed values: [0,50]</p>
<p>Default value: 5</p>
<p class="since">Since: 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="WnckTasklist--s-fade-opacity"></a><h3>The <code class="literal">“fade-opacity”</code> style property</h3>
<pre class="programlisting"> “fade-opacity” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>When a window needs attention, a fade effect is drawn on the button
representing the window. This property controls the final opacity that
will be reached by the fade effect.</p>
<p>Flags: Read</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.8</p>
<p class="since">Since: 2.16</p>
</div>
<hr>
<div class="refsect2">
<a name="WnckTasklist--s-fade-overlay-rect"></a><h3>The <code class="literal">“fade-overlay-rect”</code> style property</h3>
<pre class="programlisting"> “fade-overlay-rect” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>When a window needs attention, a fade effect is drawn on the button
representing the window. Set this property to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to enable a
compatibility mode for pixbuf engine themes that cannot react to color
changes. If enabled, a rectangle with the correct color will be drawn on
top of the button.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
<p class="since">Since: 2.16</p>
</div>
</div>
<div class="refsect1">
<a name="WnckTasklist.see-also"></a><h2>See Also</h2>
<p><a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>, <a class="link" href="WnckSelector.html" title="WnckSelector"><span class="type">WnckSelector</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|