← Back to branch summary

~ubuntu-branches/ubuntu/trusty/guile-gnome-platform/trusty-proposed

« back to all changes in this revision

Viewing changes to gtk/doc/gtk/defuns-gtkstatusicon.xml.texi

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2009-03-01 22:51:48 UTC
  • mfrom: (1.1.2 upstream) (3.2.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090301225148-5cubt342wiv8jpmf
Tags: 2.16.1-1
* New upstream release.
* Upstream bumped API, hence all package names changed from
  guile-gnome0-* to guile-gnome2-*.
* Standards-Version 3.8.0 (no changes).
* Remove unused guile-gnome2-cairo.install file.
* Added ${misc:Depends} to all packages.
* Do not build-depend on a -1 revision of the g-wrap packages.
* Add a proper "Copyright YEARS AUTHORS" line to debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
gtk/doc/gtk/defuns-gtkstatusicon.xml.texi
2
2
@c %start of fragment
3
3
 
4
4
@deftp Class <gtk-status-icon>
5
 
This @code{<gobject>} class defines the following properties:
 
5
Derives from @code{<gobject>}.
 
6
 
 
7
This class defines the following slots:
6
8
 
7
9
@table @code
8
10
@item pixbuf
9
 
A GdkPixbuf to display@item file
10
 
Filename to load and display@item stock
11
 
Stock ID for a stock image to display@item icon-name
12
 
The name of the icon from the icon theme@item storage-type
13
 
The representation being used for image data@item size
14
 
The size of the icon@item screen
15
 
The screen where this status icon will be displayed@item visible
16
 
Whether or not the status icon is visible@item orientation
17
 
The orientation of the tray@item embedded
18
 
Whether or not the status icon is embedded@item blinking
19
 
Whether or not the status icon is blinking@end table
 
11
A GdkPixbuf to display
 
12
 
 
13
@item file
 
14
Filename to load and display
 
15
 
 
16
@item stock
 
17
Stock ID for a stock image to display
 
18
 
 
19
@item icon-name
 
20
The name of the icon from the icon theme
 
21
 
 
22
@item storage-type
 
23
The representation being used for image data
 
24
 
 
25
@item size
 
26
The size of the icon
 
27
 
 
28
@item screen
 
29
The screen where this status icon will be displayed
 
30
 
 
31
@item visible
 
32
Whether or not the status icon is visible
 
33
 
 
34
@item orientation
 
35
The orientation of the tray
 
36
 
 
37
@item embedded
 
38
Whether or not the status icon is embedded
 
39
 
 
40
@item blinking
 
41
Whether or not the status icon is blinking
 
42
 
 
43
@end table
20
44
 
21
45
@end deftp
22
46
 
414
438
 
415
439
@end deffn
416
440
 
417
 
@deffn Function gtk-status-icon-position-menu  (menu@tie{}@code{<gtk-menu>}) (user_data@tie{}@code{<gpointer>}) @result{}@tie{} (x@tie{}@code{int}) (y@tie{}@code{int}) (push_in@tie{}@code{bool})
418
 
Menu positioning function to use with @code{gtk-menu-popup} to position
419
 
@var{menu} aligned to the status icon @var{user-data}.
420
 
 
421
 
@table @var
422
 
@item menu
423
 
the @code{<gtk-menu>}
424
 
 
425
 
@item x
426
 
return location for the x position
427
 
 
428
 
@item y
429
 
return location for the y position
430
 
 
431
 
@item push-in
432
 
return location for whether the menu should be pushed in to be completely inside
433
 
the screen instead of just clamped to the size to the screen.
434
 
 
435
 
@item user-data
436
 
the status icon to position the menu on
437
 
 
438
 
@end table
439
 
 
440
 
Since 2.10
441
 
 
442
 
@end deffn
443
 
 
444
 
@deffn Function gtk-status-icon-get-geometry  (self@tie{}@code{<gtk-status-icon>}) (screen@tie{}@code{<gdk-screen**>}) (area@tie{}@code{<gdk-rectangle>}) (orientation@tie{}@code{<gtk-orientation*>}) @result{}@tie{} (ret@tie{}@code{bool})
445
 
@deffnx Method get-geometry
446
 
Obtains information about the location of the status icon on screen. This
447
 
information can be used to e.g. position popups like notification bubbles.
448
 
 
449
 
See @code{gtk-status-icon-position-menu} for a more convenient alternative for
450
 
positioning menus.
451
 
 
452
 
Note that some platforms do not allow GTK+ to provide this information, and even
453
 
on platforms that do allow it, the information is not reliable unless the status
454
 
icon is embedded in a notification area, see @code{gtk-status-icon-is-embedded}.
455
 
 
456
 
@table @var
457
 
@item status-icon
458
 
a @code{<gtk-status-icon>}
459
 
 
460
 
@item screen
461
 
return location for the screen, or @samp{@code{#f}} if the information is not
462
 
needed
463
 
 
464
 
@item area
465
 
return location for the area occupied by the status icon, or @samp{@code{#f}}
466
 
 
467
 
@item orientation
468
 
return location for the orientation of the panel in which the status icon is
469
 
embedded, or @samp{@code{#f}}. A panel at the top or bottom of the screen is
470
 
horizontal, a panel at the left or right is vertical.
471
 
 
472
 
@item ret
473
 
@samp{@code{#t}} if the location information has been filled in
474
 
 
475
 
@end table
476
 
 
477
 
Since 2.10
478
 
 
479
 
@end deffn
480
 
 
481
441
 
482
442
@c %end of fragment