Interface

Gtk-3.0GtkStatusIconSignalSignatures

interface SignalSignatures {
    activate: () => void;
    "button-press-event": (arg0: EventButton) => boolean | void;
    "button-release-event": (arg0: EventButton) => boolean | void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::embedded": (pspec: GObject.ParamSpec) => void;
    "notify::file": (pspec: GObject.ParamSpec) => void;
    "notify::gicon": (pspec: GObject.ParamSpec) => void;
    "notify::has-tooltip": (pspec: GObject.ParamSpec) => void;
    "notify::icon-name": (pspec: GObject.ParamSpec) => void;
    "notify::orientation": (pspec: GObject.ParamSpec) => void;
    "notify::pixbuf": (pspec: GObject.ParamSpec) => void;
    "notify::screen": (pspec: GObject.ParamSpec) => void;
    "notify::size": (pspec: GObject.ParamSpec) => void;
    "notify::stock": (pspec: GObject.ParamSpec) => void;
    "notify::storage-type": (pspec: GObject.ParamSpec) => void;
    "notify::title": (pspec: GObject.ParamSpec) => void;
    "notify::tooltip-markup": (pspec: GObject.ParamSpec) => void;
    "notify::tooltip-text": (pspec: GObject.ParamSpec) => void;
    "notify::visible": (pspec: GObject.ParamSpec) => void;
    "popup-menu": (arg0: number, arg1: number) => void;
    "query-tooltip": (
        arg0: number,
        arg1: number,
        arg2: boolean,
        arg3: Gtk.Tooltip,
    ) => boolean | void;
    "scroll-event": (arg0: EventScroll) => boolean | void;
    "size-changed": (arg0: number) => boolean | void;
}

Hierarchy (View Summary)

Index

Properties

activate: () => void

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.

2.10

"button-press-event": (arg0: EventButton) => boolean | void

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.

2.14

"button-release-event": (arg0: EventButton) => boolean | void

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.

2.14

"notify::embedded": (pspec: GObject.ParamSpec) => void
"notify::file": (pspec: GObject.ParamSpec) => void
"notify::gicon": (pspec: GObject.ParamSpec) => void
"notify::has-tooltip": (pspec: GObject.ParamSpec) => void
"notify::icon-name": (pspec: GObject.ParamSpec) => void
"notify::orientation": (pspec: GObject.ParamSpec) => void
"notify::pixbuf": (pspec: GObject.ParamSpec) => void
"notify::screen": (pspec: GObject.ParamSpec) => void
"notify::size": (pspec: GObject.ParamSpec) => void
"notify::stock": (pspec: GObject.ParamSpec) => void
"notify::storage-type": (pspec: GObject.ParamSpec) => void
"notify::title": (pspec: GObject.ParamSpec) => void
"notify::tooltip-markup": (pspec: GObject.ParamSpec) => void
"notify::tooltip-text": (pspec: GObject.ParamSpec) => void
"notify::visible": (pspec: GObject.ParamSpec) => void
"popup-menu": (arg0: number, arg1: number) => void

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.

2.10

"query-tooltip": (
    arg0: number,
    arg1: number,
    arg2: boolean,
    arg3: Gtk.Tooltip,
) => boolean | void

Emitted when the hover 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 keyboard_mode is true, the values of x and y are undefined and 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 Gtk.StatusIcon.tooltip_text in preference.

2.16

"scroll-event": (arg0: EventScroll) => boolean | void

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.

2.16

"size-changed": (arg0: number) => boolean | void

Gets emitted when the size available for the image changes, e.g. because the notification area got resized.

2.10

Properties - Inherited from GObject

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
G_CALLBACK (gtk_text_view_target_list_notify),
text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.