Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.StatusIcon

Class Gtk.StatusIcon

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkStatusIcon
Class :	StatusIcon
Subclasses:	Gkbd.Status
Extends:	GObject.Object

Properties
Properties		Defined By
	embedded : gboolean read only TRUE if the statusicon is embedded in a notification area. TRUE if the statusicon is embedded in a notification area.	Gtk.StatusIcon
	file : String	Gtk.StatusIcon
	gicon : Gio.Icon The GIcon displayed in the GtkStatusIcon. The GIcon displayed in the GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes.	Gtk.StatusIcon
	has_tooltip : gboolean Enables or disables the emission of GtkStatusIcon::query-tooltip on tooltip, in this case the status icon will be queried using GtkStatusIcon::query-tooltip to determine whether it will provide a tooltip or not. Enables or disables the emission of GtkStatusIcon::query-tooltip on tooltip, in this case the status icon will be queried using GtkStatusIcon::query-tooltip to determine whether it will provide a tooltip or not. Note that setting this property to TRUE for the first time will change the event masks of the windows of this status icon to include leave-notify and motion-notify events. This will not be undone when the property is set to FALSE again. Whether this property is respected is platform dependent. For plain text tooltips, use GtkStatusIcon:tooltip-text in preference.	Gtk.StatusIcon
	icon_name : String	Gtk.StatusIcon
	orientation : Gtk.Orientation read only The orientation of the tray in which the statusicon is embedded. The orientation of the tray in which the statusicon is embedded.	Gtk.StatusIcon
	parent_instance : GObject.Object read only	Gtk.StatusIcon
	pixbuf : GdkPixbuf.Pixbuf	Gtk.StatusIcon
	priv : Gtk.StatusIconPrivate read only	Gtk.StatusIcon
	screen : Gdk.Screen	Gtk.StatusIcon
	size : gint32 read only	Gtk.StatusIcon
	stock : String	Gtk.StatusIcon
	storage_type : Gtk.ImageType read only	Gtk.StatusIcon
	title : String The title of this tray icon. The title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon.	Gtk.StatusIcon
	tooltip_markup : String Sets the text of tooltip to be the given string, which is marked up with the Pango text markup language. Sets the text of tooltip to be the given string, which is marked up with the Pango text markup language. Also see gtk_tooltip_set_markup(). This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL. GtkStatusIcon:has-tooltip will automatically be set to TRUE and the default handler for the GtkStatusIcon::query-tooltip signal will take care of displaying the tooltip. On some platforms, embedded markup will be ignored.	Gtk.StatusIcon
	tooltip_text : String Sets the text of tooltip to be the given string. Sets the text of tooltip to be the given string. Also see gtk_tooltip_set_text(). This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL. GtkStatusIcon:has-tooltip will automatically be set to TRUE and the default handler for the GtkStatusIcon::query-tooltip signal will take care of displaying the tooltip. Note that some platforms have limitations on the length of tooltips that they allow on status icons, e.g. Windows only shows the first 64 characters.	Gtk.StatusIcon
	visible : gboolean	Gtk.StatusIcon

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.StatusIcon (Object *properties) Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: Object properties*
	new Gtk.StatusIcon.from_file (String *filename) : Gtk.StatusIcon Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: String filename* Required (not null) a filename Returns: Gtk.StatusIcon a new GtkStatusIcon
	new Gtk.StatusIcon.from_gicon (Icon *icon) : Gtk.StatusIcon Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: Gio.Icon icon* Required (not null) a GIcon Returns: Gtk.StatusIcon a new GtkStatusIcon
	new Gtk.StatusIcon.from_icon_name (String *icon_name) : Gtk.StatusIcon Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: String icon_name* Required (not null) an icon name Returns: Gtk.StatusIcon a new GtkStatusIcon
	new Gtk.StatusIcon.from_pixbuf (Pixbuf *pixbuf) : Gtk.StatusIcon Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: GdkPixbuf.Pixbuf pixbuf* Required (not null) a GdkPixbuf Returns: Gtk.StatusIcon a new GtkStatusIcon
	new Gtk.StatusIcon.from_stock (String *stock_id) : Gtk.StatusIcon Create a new Gtk.StatusIcon Create a new Gtk.StatusIcon Parameters: String stock_id* Required (not null) a stock icon id Returns: Gtk.StatusIcon a new GtkStatusIcon
	Gtk.StatusIcon.position_menu (Menu *menu, gint32 x, gint32 y, gboolean push_in, StatusIcon user_data) : Object Menu positioning function to use with gtk_menu_popup() to position menu* aligned to the status icon user_data. Menu positioning function to use with gtk_menu_popup() to position menu aligned to the status icon user_data. Parameters: Gtk.Menu menu Required (not null) the GtkMenu gint32 x Required (not null) return location for the x position gint32 y Required (not null) return location for the y position gboolean push_in Required (not null) whether the first menu item should be offset (pushed in) to be aligned with the menu popup position (only useful for GtkOptionMenu). Gtk.StatusIcon user_data Required (not null) the status icon to position the menu on Returns: x: gint32 return location for the x position y: gint32 return location for the y position push_in: gboolean whether the first menu item should be offset (pushed in) to be aligned with the menu popup position (only useful for GtkOptionMenu).	Gtk.StatusIcon
	get_geometry (Object *out_values) : gboolean Obtains information about the location of the status icon on screen. Obtains information about the location of the status icon on screen. This information can be used to e.g. position popups like notification bubbles. See gtk_status_icon_position_menu() for a more convenient alternative for positioning menus. Note that some platforms do not allow GTK+ to provide this information, and even on platforms that do allow it, the information is not reliable unless the status icon is embedded in a notification area, see gtk_status_icon_is_embedded(). been filled in Parameters: Object out_values* Gdk.Screen screen cairo.RectangleInt area Gtk.Orientation orientation Returns: gboolean TRUE if the location information has	Gtk.StatusIcon
	get_gicon () : Gio.Icon Retrieves the GIcon being displayed by the GtkStatusIcon. Retrieves the GIcon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returned GIcon. If this function fails, icon is left unchanged; Returns: Gio.Icon the displayed icon, or NULL if the image is empty	Gtk.StatusIcon
	get_has_tooltip () : gboolean Returns the current value of the has-tooltip property. Returns the current value of the has-tooltip property. See GtkStatusIcon:has-tooltip for more information. Returns: gboolean current value of has-tooltip on status_icon.	Gtk.StatusIcon
	get_icon_name () : String Gets the name of the icon being displayed by the GtkStatusIcon. Gets the name of the icon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()). The returned string is owned by the GtkStatusIcon and should not be freed or modified. Returns: String name of the displayed icon, or NULL if the image is empty.	Gtk.StatusIcon
	get_pixbuf () : GdkPixbuf.Pixbuf Gets the GdkPixbuf being displayed by the GtkStatusIcon. Gets the GdkPixbuf being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returned pixbuf. or NULL if the image is empty. Returns: GdkPixbuf.Pixbuf the displayed pixbuf,	Gtk.StatusIcon
	get_screen () : Gdk.Screen Returns the GdkScreen associated with status_icon. Returns the GdkScreen associated with status_icon. Returns: Gdk.Screen a GdkScreen.	Gtk.StatusIcon
	get_size () : gint32 Gets the size in pixels that is available for the image. Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the size-changed signal can be used to react to size changes. Note that the returned size is only meaningful while the status icon is embedded (see gtk_status_icon_is_embedded()). Returns: gint32 the size that is available for the image	Gtk.StatusIcon
	get_stock () : String Gets the id of the stock icon being displayed by the GtkStatusIcon. Gets the id of the stock icon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()). The returned string is owned by the GtkStatusIcon and should not be freed or modified. or NULL if the image is empty. Returns: String stock id of the displayed stock icon,	Gtk.StatusIcon
	get_storage_type () : Gtk.ImageType Gets the type of representation being used by the GtkStatusIcon to store image data. Gets the type of representation being used by the GtkStatusIcon to store image data. If the GtkStatusIcon has no image data, the return value will be GTK_IMAGE_EMPTY. Returns: Gtk.ImageType the image representation being used	Gtk.StatusIcon
	get_title () : String Gets the title of this tray icon. Gets the title of this tray icon. See gtk_status_icon_set_title(). Returns: String the title of the status icon	Gtk.StatusIcon
	get_tooltip_markup () : String Gets the contents of the tooltip for status_icon. Gets the contents of the tooltip for status_icon. returned string with g_free() when done. Returns: String the tooltip text, or NULL. You should free the	Gtk.StatusIcon
	get_tooltip_text () : String Gets the contents of the tooltip for status_icon. Gets the contents of the tooltip for status_icon. returned string with g_free() when done. Returns: String the tooltip text, or NULL. You should free the	Gtk.StatusIcon
	get_visible () : gboolean Returns whether the status icon is visible or not. Returns whether the status icon is visible or not. Note that being visible does not guarantee that the user can actually see the icon, see also gtk_status_icon_is_embedded(). Returns: gboolean TRUE if the status icon is visible	Gtk.StatusIcon
	get_x11_window_id () : guint32 This function is only useful on the X11/freedesktop.org platform. This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago notification service, which can send a window ID in the protocol in order for the server to position notification windows pointing to a status icon reliably. This function is not intended for other use cases which are more likely to be met by one of the non-X11 specific methods, such as gtk_status_icon_position_menu(). underlying X11 Window Returns: guint32 An 32 bit unsigned integer identifier for the	Gtk.StatusIcon
	is_embedded () : gboolean Returns whether the status icon is embedded in a notification area. Returns whether the status icon is embedded in a notification area. a notification area. Returns: gboolean TRUE if the status icon is embedded in	Gtk.StatusIcon
	set_from_file (String *filename) : none Makes status_icon* display the file filename. Makes status_icon display the file filename. See gtk_status_icon_new_from_file() for details. Parameters: String filename Required (not null) a filename Returns: none	Gtk.StatusIcon
	set_from_gicon (Icon *icon) : none Makes status_icon* display the GIcon. Makes status_icon display the GIcon. See gtk_status_icon_new_from_gicon() for details. Parameters: Gio.Icon icon Required (not null) a GIcon Returns: none	Gtk.StatusIcon
	set_from_icon_name (String *icon_name) : none Makes status_icon* display the icon named icon_name from the current icon theme. Makes status_icon display the icon named icon_name from the current icon theme. See gtk_status_icon_new_from_icon_name() for details. Parameters: String icon_name Required (not null) an icon name Returns: none	Gtk.StatusIcon
	set_from_pixbuf (Pixbuf *pixbuf) : none Makes status_icon* display pixbuf. Makes status_icon display pixbuf. See gtk_status_icon_new_from_pixbuf() for details. Parameters: GdkPixbuf.Pixbuf pixbuf a GdkPixbuf or NULL Returns: none	Gtk.StatusIcon
	set_from_stock (String *stock_id) : none Makes status_icon* display the stock icon with the id stock_id. Makes status_icon display the stock icon with the id stock_id. See gtk_status_icon_new_from_stock() for details. Parameters: String stock_id Required (not null) a stock icon id Returns: none	Gtk.StatusIcon
	set_has_tooltip (gboolean *has_tooltip) : none Sets the has-tooltip property on status_icon* to has_tooltip. Sets the has-tooltip property on status_icon to has_tooltip. See GtkStatusIcon:has-tooltip for more information. Parameters: gboolean has_tooltip Required (not null) whether or not status_icon has a tooltip Returns: none	Gtk.StatusIcon
	set_name (String *name) : none Sets the name of this tray icon. Sets the name of this tray icon. This should be a string identifying this icon. It is may be used for sorting the icons in the tray and will not be shown to the user. Parameters: String name* Required (not null) the name Returns: none	Gtk.StatusIcon
	set_screen (Screen *screen) : none Sets the GdkScreen* where status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen. Sets the GdkScreen where status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen. Parameters: Gdk.Screen screen Required (not null) a GdkScreen Returns: none	Gtk.StatusIcon
	set_title (String *title) : none Sets the title of this tray icon. Sets the title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. Parameters: String title* Required (not null) the title Returns: none	Gtk.StatusIcon
	set_tooltip_markup (String *markup) : none Sets markup* as the contents of the tooltip, which is marked up with the Pango text markup language. Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. This function will take care of setting GtkStatusIcon:has-tooltip to TRUE and of the default handler for the GtkStatusIcon::query-tooltip signal. See also the GtkStatusIcon:tooltip-markup property and gtk_tooltip_set_markup(). Parameters: String markup the contents of the tooltip for status_icon, or NULL Returns: none	Gtk.StatusIcon
	set_tooltip_text (String *text) : none Sets text* as the contents of the tooltip. Sets text as the contents of the tooltip. This function will take care of setting GtkStatusIcon:has-tooltip to TRUE and of the default handler for the GtkStatusIcon::query-tooltip signal. See also the GtkStatusIcon:tooltip-text property and gtk_tooltip_set_text(). Parameters: String text Required (not null) the contents of the tooltip for status_icon Returns: none	Gtk.StatusIcon
	set_visible (gboolean *visible) : none Shows or hides a status icon. Shows or hides a status icon. Parameters: gboolean visible* Required (not null) TRUE to show the status icon, FALSE to hide it Returns: none	Gtk.StatusIcon

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	activate (StatusIcon *self) : none Gets emitted when the user activates the status icon. Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent. Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings. Parameters: Gtk.StatusIcon self* Returns: {none}	Gtk.StatusIcon
	button_press_event (StatusIcon *self, EventButton event) : gboolean The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed. The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed. Whether this event is emitted is platform-dependent. Use the ::activate and ::popup-menu signals in preference. for the event. FALSE* to propagate the event further. Parameters: Gtk.StatusIcon self Gdk.EventButton event Returns: {gboolean}	Gtk.StatusIcon
	button_release_event (StatusIcon *self, EventButton event) : gboolean The ::button-release-event signal will be emitted when a button (typically from a mouse) is released. The ::button-release-event signal will be emitted when a button (typically from a mouse) is released. Whether this event is emitted is platform-dependent. Use the ::activate and ::popup-menu signals in preference. for the event. FALSE* to propagate the event further. Parameters: Gtk.StatusIcon self Gdk.EventButton event Returns: {gboolean}	Gtk.StatusIcon
	popup_menu (StatusIcon *self, guint32 button, guint32 activate_time) : none Gets emitted when the user brings up the context menu of the status icon. Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent. The button* and activate_time parameters should be passed as the last to arguments to gtk_menu_popup(). Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings. Parameters: Gtk.StatusIcon self guint32 button guint32 activate_time Returns: {none}	Gtk.StatusIcon
	query_tooltip (StatusIcon *self, gint32 x, gint32 y, gboolean keyboard_mode, Tooltip tooltip) : gboolean Emitted when the GtkSettings:gtk-tooltip-timeout has expired with the cursor hovering above status_icon; or emitted when status_icon* got focus in keyboard mode. Emitted when the GtkSettings:gtk-tooltip-timeout has expired with the cursor hovering above status_icon; or emitted when status_icon got focus in keyboard mode. Using the given coordinates, the signal handler should determine whether a tooltip should be shown for status_icon. If this is the case TRUE should be returned, FALSE otherwise. Note that if should not be used. The signal handler is free to manipulate tooltip with the therefore destined function calls. Whether this signal is emitted is platform-dependent. For plain text tooltips, use GtkStatusIcon:tooltip-text in preference. Parameters: Gtk.StatusIcon self gint32 x gint32 y gboolean keyboard_mode Gtk.Tooltip tooltip Returns: {gboolean}	Gtk.StatusIcon
	scroll_event (StatusIcon *self, EventScroll event) : gboolean The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned. Whether this event is emitted is platform-dependent. FALSE* to propagate the event further. Parameters: Gtk.StatusIcon self Gdk.EventScroll event Returns: {gboolean}	Gtk.StatusIcon
	size_changed (StatusIcon *self, gint32 size) : gboolean Gets emitted when the size available for the image changes, e.g. Gets emitted when the size available for the image changes, e.g. because the notification area got resized. size. Otherwise, GTK+ will scale the icon as necessary. Parameters: Gtk.StatusIcon self* gint32 size Returns: {gboolean}	Gtk.StatusIcon

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.StatusIcon