~ubuntu-branches/ubuntu/saucy/libwnck/saucy

« back to all changes in this revision

Viewing changes to doc/html/WnckTasklist.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-11-17 14:22:08 UTC
  • mfrom: (1.1.58 upstream)
  • Revision ID: james.westby@ubuntu.com-20101117142208-7sv76zbyshdaeshh
Tags: 1:2.30.6-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
162
162
<tbody>
163
163
<tr>
164
164
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
165
 
<td>deprecated argument, can be <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
166
 
</td>
 
165
<td>deprecated argument, can be <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
167
166
</tr>
168
167
<tr>
169
168
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
170
 
<td> a newly created <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
171
 
</td>
 
169
<td>a newly created <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
172
170
</tr>
173
171
</tbody>
174
172
</table></div>
190
188
<tbody>
191
189
<tr>
192
190
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
193
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
194
 
</td>
 
191
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
195
192
</tr>
196
193
<tr>
197
194
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
198
 
<td>a <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>.
199
 
</td>
 
195
<td>a <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>.</td>
200
196
</tr>
201
197
</tbody>
202
198
</table></div>
253
249
<tbody>
254
250
<tr>
255
251
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
256
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
257
 
</td>
 
252
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
258
253
</tr>
259
254
<tr>
260
255
<td><p><span class="term"><em class="parameter"><code>grouping</code></em> :</span></p></td>
261
 
<td>a grouping policy.
262
 
</td>
 
256
<td>a grouping policy.</td>
263
257
</tr>
264
258
</tbody>
265
259
</table></div>
280
274
<tbody>
281
275
<tr>
282
276
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
283
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
284
 
</td>
 
277
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
285
278
</tr>
286
279
<tr>
287
280
<td><p><span class="term"><em class="parameter"><code>limit</code></em> :</span></p></td>
288
 
<td>a size in pixels.
289
 
</td>
 
281
<td>a size in pixels.</td>
290
282
</tr>
291
283
</tbody>
292
284
</table></div>
316
308
<tbody>
317
309
<tr>
318
310
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
319
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
320
 
</td>
 
311
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
321
312
</tr>
322
313
<tr>
323
314
<td><p><span class="term"><em class="parameter"><code>include_all_workspaces</code></em> :</span></p></td>
324
315
<td>whether to display <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> from all
325
 
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> in <em class="parameter"><code>tasklist</code></em>.
326
 
</td>
 
316
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> in <em class="parameter"><code>tasklist</code></em>.</td>
327
317
</tr>
328
318
</tbody>
329
319
</table></div>
346
336
<tbody>
347
337
<tr>
348
338
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
349
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
350
 
</td>
 
339
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
351
340
</tr>
352
341
<tr>
353
342
<td><p><span class="term"><em class="parameter"><code>switch_workspace_on_unminimize</code></em> :</span></p></td>
354
343
<td>whether to activate the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> a
355
 
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> is on when unminimizing it.
356
 
</td>
 
344
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> is on when unminimizing it.</td>
357
345
</tr>
358
346
</tbody>
359
347
</table></div>
373
361
<tbody>
374
362
<tr>
375
363
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
376
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
377
 
</td>
 
364
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
378
365
</tr>
379
366
<tr>
380
367
<td><p><span class="term"><em class="parameter"><code>relief</code></em> :</span></p></td>
381
 
<td>a relief type.
382
 
</td>
 
368
<td>a relief type.</td>
383
369
</tr>
384
370
</tbody>
385
371
</table></div>
401
387
<tbody>
402
388
<tr>
403
389
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
404
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
405
 
</td>
 
390
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
406
391
</tr>
407
392
<tr>
408
393
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
409
 
<td> -1.
410
 
 
411
 
</td>
 
394
<td>-1.</td>
412
395
</tr>
413
396
</tbody>
414
397
</table></div>
430
413
<tbody>
431
414
<tr>
432
415
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
433
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
434
 
</td>
 
416
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
435
417
</tr>
436
418
<tr>
437
419
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
438
 
<td>a minimum width in pixels.
439
 
</td>
 
420
<td>a minimum width in pixels.</td>
440
421
</tr>
441
422
</tbody>
442
423
</table></div>
457
438
<tbody>
458
439
<tr>
459
440
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
460
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
461
 
</td>
 
441
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
462
442
</tr>
463
443
<tr>
464
444
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465
 
<td> -1.
466
 
 
467
 
</td>
 
445
<td>-1.</td>
468
446
</tr>
469
447
</tbody>
470
448
</table></div>
486
464
<tbody>
487
465
<tr>
488
466
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
489
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
490
 
</td>
 
467
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
491
468
</tr>
492
469
<tr>
493
470
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
494
 
<td>a minimum height in pixels.
495
 
</td>
 
471
<td>a minimum height in pixels.</td>
496
472
</tr>
497
473
</tbody>
498
474
</table></div>
513
489
<tr>
514
490
<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td>
515
491
<td>an icon name as in the Icon field in a .desktop file for the
516
 
icon to load.
517
 
</td>
 
492
icon to load.</td>
518
493
</tr>
519
494
<tr>
520
495
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
521
 
<td>the desired icon size.
522
 
</td>
 
496
<td>the desired icon size.</td>
523
497
</tr>
524
498
<tr>
525
499
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
526
 
<td>not defined to do anything yet.
527
 
</td>
 
500
<td>not defined to do anything yet.</td>
528
501
</tr>
529
502
<tr>
530
503
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
531
504
<td>data passed to the function, set when the <a class="link" href="WnckTasklist.html#WnckLoadIconFunction" title="WnckLoadIconFunction ()"><span class="type">WnckLoadIconFunction</span></a> has
532
 
been set for the <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
533
 
</td>
 
505
been set for the <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
534
506
</tr>
535
507
<tr>
536
508
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
537
 
<td> it should return a <code class="classname">GdkPixbuf</code> of <em class="parameter"><code>icon_name</code></em>
 
509
<td>it should return a <code class="classname">GdkPixbuf</code> of <em class="parameter"><code>icon_name</code></em>
538
510
at size <em class="parameter"><code>size</code></em>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.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
539
 
loaded.
540
 
 
541
 
</td>
 
511
loaded.</td>
542
512
</tr>
543
513
</tbody>
544
514
</table></div>
564
534
</tr>
565
535
<tr>
566
536
<td><p><span class="term"><em class="parameter"><code>load_icon_func</code></em> :</span></p></td>
567
 
<td>icon loader function
568
 
</td>
 
537
<td>icon loader function</td>
569
538
</tr>
570
539
<tr>
571
540
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
572
 
<td>data for icon loader function
573
 
</td>
 
541
<td>data for icon loader function</td>
574
542
</tr>
575
543
<tr>
576
544
<td><p><span class="term"><em class="parameter"><code>free_data_func</code></em> :</span></p></td>
577
 
<td>function to free the data
578
 
</td>
 
545
<td>function to free the data</td>
579
546
</tr>
580
547
</tbody>
581
548
</table></div>
590
557
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
591
558
when needed, for example), the standard size request mechanism in GTK+ is
592
559
not enough to announce what sizes can be used by <em class="parameter"><code>tasklist</code></em>. The size hints
593
 
mechanism is a solution for this. See <a href="/gnome/usr/share/gtk-doc/html/panel-applet/panel-applet-panel-applet.html#panel-applet-set-size-hints"><code class="function">panel_applet_set_size_hints()</code></a> for more
 
560
mechanism is a solution for this. See <code class="function">panel_applet_set_size_hints()</code> for more
594
561
information.
595
562
</p>
596
563
<div class="variablelist"><table border="0">
598
565
<tbody>
599
566
<tr>
600
567
<td><p><span class="term"><em class="parameter"><code>tasklist</code></em> :</span></p></td>
601
 
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.
602
 
</td>
 
568
<td>a <a class="link" href="WnckTasklist.html" title="WnckTasklist"><span class="type">WnckTasklist</span></a>.</td>
603
569
</tr>
604
570
<tr>
605
571
<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>
606
572
<td>return location for the number of elements in the array
607
 
returned by this function. This number should always be pair.
608
 
</td>
 
573
returned by this function. This number should always be pair.</td>
609
574
</tr>
610
575
<tr>
611
576
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
612
 
<td> a list of size hints that can be used to allocate an
613
 
appropriate size for <em class="parameter"><code>tasklist</code></em>.
614
 
</td>
 
577
<td>a list of size hints that can be used to allocate an
 
578
appropriate size for <em class="parameter"><code>tasklist</code></em>.</td>
615
579
</tr>
616
580
</tbody>
617
581
</table></div>