StatusIconProtocol
public protocol StatusIconProtocol : ObjectProtocol
The “system tray” or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog.
A GtkStatusIcon object can be used to display an icon in a “system tray”.
The icon can have a tooltip, and the user can interact with it by
activating it or popping up a context menu.
It is very important to notice that status icons depend on the existence
of a notification area being available to the user; you should not use status
icons as the only way to convey critical information regarding your application,
as the notification area may not exist on the user’s environment, or may have
been removed. You should always check that a status icon has been embedded into
a notification area by using gtk_status_icon_is_embedded(), and gracefully
recover if the function returns false.
On X11, the implementation follows the FreeDesktop System Tray Specification. Implementations of the “tray” side of this specification can be found e.g. in the GNOME 2 and KDE panel applications.
Note that a GtkStatusIcon is not a widget, but just a GObject. Making it a
widget would be impractical, since the system tray on Windows doesn’t allow
to embed arbitrary widgets.
GtkStatusIcon has been deprecated in 3.14. You should consider using
notifications or more modern platform-specific APIs instead. GLib provides
the GNotification API which works well with GtkApplication on multiple
platforms and environments, and should be the preferred mechanism to notify
the users of transient status updates. See this HowDoI
for code examples.
The StatusIconProtocol protocol exposes the methods and properties of an underlying GtkStatusIcon instance.
The default implementation of these can be found in the protocol extension below.
For a concrete class that implements these methods and properties, see StatusIcon.
Alternatively, use StatusIconRef as a lighweight, unowned reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GtkStatusIconinstance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get } -
status_icon_ptrDefault implementationTyped pointer to the underlying
GtkStatusIconinstance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GtkStatusIconinstance.Declaration
Swift
var status_icon_ptr: UnsafeMutablePointer<GtkStatusIcon>! { get } -
Required Initialiser for types conforming to
StatusIconProtocolDeclaration
Swift
init(raw: UnsafeMutableRawPointer)
-
bind(property:Extension methodto: _: flags: transformFrom: transformTo: ) Bind a
StatusIconPropertyNamesource property to a given target object.Declaration
Swift
@discardableResult @inlinable func bind<Q, T>(property source_property: StatusIconPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocolParameters
source_propertythe source property to bind
targetthe target object to bind to
target_propertythe target property to bind to
flagsthe flags to pass to the
Bindingtransform_fromValueTransformerto use for forward transformationtransform_toValueTransformerto use for backwards transformationReturn Value
binding reference or
nilin case of an error -
get(property:Extension method) Get the value of a StatusIcon property
Declaration
Swift
@inlinable func get(property: StatusIconPropertyName) -> GLibObject.ValueParameters
propertythe property to get the value for
Return Value
the value of the named property
-
set(property:Extension methodvalue: ) Set the value of a StatusIcon property. Note that this will only have an effect on properties that are writable and not construct-only!
Declaration
Swift
@inlinable func set(property: StatusIconPropertyName, value v: GLibObject.Value)Parameters
propertythe property to get the value for
Return Value
the value of the named property
-
connect(signal:Extension methodflags: handler: ) Connect a Swift signal handler to the given, typed
StatusIconSignalNamesignalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: StatusIconSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> IntParameters
signalThe signal to connect
flagsThe connection flags to use
dataA pointer to user data to provide to the callback
destroyDataA
GClosureNotifyC function to destroy the data pointed to byuserDatahandlerThe Swift signal handler (function or callback) to invoke on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
connect(signal:Extension methodflags: data: destroyData: signalHandler: ) Connect a C signal handler to the given, typed
StatusIconSignalNamesignalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: StatusIconSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> IntParameters
signalThe signal to connect
flagsThe connection flags to use
dataA pointer to user data to provide to the callback
destroyDataA
GClosureNotifyC function to destroy the data pointed to byuserDatasignalHandlerThe C function to be called on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
onActivate(flags:Extension methodhandler: ) 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.
Note
This represents the underlyingactivatesignalDeclaration
Swift
@discardableResult @inlinable func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
handlerThe signal handler to call Run the given callback whenever the
activatesignal is emitted -
activateSignalExtension methodTyped
activatesignal for using theconnect(signal:)methodsDeclaration
Swift
static var activateSignal: StatusIconSignalName { get } -
onButtonPressEvent(flags:Extension methodhandler: ) The
button-press-eventsignal will be emitted when a button (typically from a mouse) is pressed.Whether this event is emitted is platform-dependent. Use the
activateandpopup-menusignals in preference.Note
This represents the underlyingbutton-press-eventsignalDeclaration
Swift
@discardableResult @inlinable func onButtonPressEvent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ event: Gdk.EventButtonRef) -> Bool) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
eventthe
GdkEventButtonwhich triggered this signalhandlertrueto stop other handlers from being invoked for the event.falseto propagate the event further. Run the given callback whenever thebuttonPressEventsignal is emitted -
buttonPressEventSignalExtension methodTyped
button-press-eventsignal for using theconnect(signal:)methodsDeclaration
Swift
static var buttonPressEventSignal: StatusIconSignalName { get } -
onButtonReleaseEvent(flags:Extension methodhandler: ) The
button-release-eventsignal will be emitted when a button (typically from a mouse) is released.Whether this event is emitted is platform-dependent. Use the
activateandpopup-menusignals in preference.Note
This represents the underlyingbutton-release-eventsignalDeclaration
Swift
@discardableResult @inlinable func onButtonReleaseEvent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ event: Gdk.EventButtonRef) -> Bool) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
eventthe
GdkEventButtonwhich triggered this signalhandlertrueto stop other handlers from being invoked for the event.falseto propagate the event further. Run the given callback whenever thebuttonReleaseEventsignal is emitted -
buttonReleaseEventSignalExtension methodTyped
button-release-eventsignal for using theconnect(signal:)methodsDeclaration
Swift
static var buttonReleaseEventSignal: StatusIconSignalName { get } -
onPopupMenu(flags:Extension methodhandler: ) 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
buttonandactivate_timeparameters should be passed as the last to arguments togtk_menu_popup().Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings.
Note
This represents the underlyingpopup-menusignalDeclaration
Swift
@discardableResult @inlinable func onPopupMenu(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ button: UInt, _ activateTime: UInt) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
buttonthe button that was pressed, or 0 if the signal is not emitted in response to a button press event
activateTimethe timestamp of the event that triggered the signal emission
handlerThe signal handler to call Run the given callback whenever the
popupMenusignal is emitted -
popupMenuSignalExtension methodTyped
popup-menusignal for using theconnect(signal:)methodsDeclaration
Swift
static var popupMenuSignal: StatusIconSignalName { get } -
onQueryTooltip(flags:Extension methodhandler: ) Emitted when the hover timeout has expired with the cursor hovering above
status_icon; or emitted whenstatus_icongot 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 casetrueshould be returned,falseotherwise. Note that ifkeyboard_modeistrue, the values ofxandyare undefined and should not be used.The signal handler is free to manipulate
tooltipwith the therefore destined function calls.Whether this signal is emitted is platform-dependent. For plain text tooltips, use
GtkStatusIcon:tooltip-textin preference.Note
This represents the underlyingquery-tooltipsignalDeclaration
Swift
@discardableResult @inlinable func onQueryTooltip(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ x: Int, _ y: Int, _ keyboardMode: Bool, _ tooltip: TooltipRef) -> Bool) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
xthe x coordinate of the cursor position where the request has been emitted, relative to
status_iconythe y coordinate of the cursor position where the request has been emitted, relative to
status_iconkeyboardModetrueif the tooltip was trigged using the keyboardtooltipa
GtkTooltiphandlertrueiftooltipshould be shown right now,falseotherwise. Run the given callback whenever thequeryTooltipsignal is emitted -
queryTooltipSignalExtension methodTyped
query-tooltipsignal for using theconnect(signal:)methodsDeclaration
Swift
static var queryTooltipSignal: StatusIconSignalName { get } -
onScrollEvent(flags:Extension methodhandler: ) The
scroll-eventsignal 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.
Note
This represents the underlyingscroll-eventsignalDeclaration
Swift
@discardableResult @inlinable func onScrollEvent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ event: Gdk.EventScrollRef) -> Bool) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
eventthe
GdkEventScrollwhich triggered this signalhandlertrueto stop other handlers from being invoked for the event.falseto propagate the event further. Run the given callback whenever thescrollEventsignal is emitted -
scrollEventSignalExtension methodTyped
scroll-eventsignal for using theconnect(signal:)methodsDeclaration
Swift
static var scrollEventSignal: StatusIconSignalName { get } -
onSizeChanged(flags:Extension methodhandler: ) Gets emitted when the size available for the image changes, e.g. because the notification area got resized.
Note
This represents the underlyingsize-changedsignalDeclaration
Swift
@discardableResult @inlinable func onSizeChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ size: Int) -> Bool) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
sizethe new size
handlertrueif the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary. Run the given callback whenever thesizeChangedsignal is emitted -
sizeChangedSignalExtension methodTyped
size-changedsignal for using theconnect(signal:)methodsDeclaration
Swift
static var sizeChangedSignal: StatusIconSignalName { get } -
onNotifyEmbedded(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::embeddedsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyEmbedded(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyEmbeddedsignal is emitted -
notifyEmbeddedSignalExtension methodTyped
notify::embeddedsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyEmbeddedSignal: StatusIconSignalName { get } -
onNotifyFile(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::filesignalDeclaration
Swift
@discardableResult @inlinable func onNotifyFile(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyFilesignal is emitted -
notifyFileSignalExtension methodTyped
notify::filesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyFileSignal: StatusIconSignalName { get } -
onNotifyIcon(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::giconsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyIcon(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyIconsignal is emitted -
notifyIconSignalExtension methodTyped
notify::giconsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyIconSignal: StatusIconSignalName { get } -
onNotifyHasTooltip(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::has-tooltipsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyHasTooltip(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyHasTooltipsignal is emitted -
notifyHasTooltipSignalExtension methodTyped
notify::has-tooltipsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyHasTooltipSignal: StatusIconSignalName { get } -
onNotifyIconName(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::icon-namesignalDeclaration
Swift
@discardableResult @inlinable func onNotifyIconName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyIconNamesignal is emitted -
notifyIconNameSignalExtension methodTyped
notify::icon-namesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyIconNameSignal: StatusIconSignalName { get } -
onNotifyOrientation(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::orientationsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyOrientation(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyOrientationsignal is emitted -
notifyOrientationSignalExtension methodTyped
notify::orientationsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyOrientationSignal: StatusIconSignalName { get } -
onNotifyPixbuf(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::pixbufsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyPixbuf(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyPixbufsignal is emitted -
notifyPixbufSignalExtension methodTyped
notify::pixbufsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyPixbufSignal: StatusIconSignalName { get } -
onNotifyScreen(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::screensignalDeclaration
Swift
@discardableResult @inlinable func onNotifyScreen(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyScreensignal is emitted -
notifyScreenSignalExtension methodTyped
notify::screensignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyScreenSignal: StatusIconSignalName { get } -
onNotifySize(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::sizesignalDeclaration
Swift
@discardableResult @inlinable func onNotifySize(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifySizesignal is emitted -
notifySizeSignalExtension methodTyped
notify::sizesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifySizeSignal: StatusIconSignalName { get } -
onNotifyStock(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::stocksignalDeclaration
Swift
@discardableResult @inlinable func onNotifyStock(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyStocksignal is emitted -
notifyStockSignalExtension methodTyped
notify::stocksignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyStockSignal: StatusIconSignalName { get } -
onNotifyStorageType(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::storage-typesignalDeclaration
Swift
@discardableResult @inlinable func onNotifyStorageType(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyStorageTypesignal is emitted -
notifyStorageTypeSignalExtension methodTyped
notify::storage-typesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyStorageTypeSignal: StatusIconSignalName { get } -
onNotifyTitle(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::titlesignalDeclaration
Swift
@discardableResult @inlinable func onNotifyTitle(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyTitlesignal is emitted -
notifyTitleSignalExtension methodTyped
notify::titlesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyTitleSignal: StatusIconSignalName { get } -
onNotifyTooltipMarkup(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::tooltip-markupsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyTooltipMarkup(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyTooltipMarkupsignal is emitted -
notifyTooltipMarkupSignalExtension methodTyped
notify::tooltip-markupsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyTooltipMarkupSignal: StatusIconSignalName { get } -
onNotifyTooltipText(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::tooltip-textsignalDeclaration
Swift
@discardableResult @inlinable func onNotifyTooltipText(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyTooltipTextsignal is emitted -
notifyTooltipTextSignalExtension methodTyped
notify::tooltip-textsignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyTooltipTextSignal: StatusIconSignalName { get } -
onNotifyVisible(flags:Extension methodhandler: ) 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
G_PARAM_EXPLICIT_NOTIFY, then any call tog_object_set_property()results innotifybeing emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly callg_object_notify()org_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:(C Language Example):
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 as detail strings for the notify signal.
Note
This represents the underlyingnotify::visiblesignalDeclaration
Swift
@discardableResult @inlinable func onNotifyVisible(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: StatusIconRef, _ pspec: ParamSpecRef) -> Void) -> IntParameters
flagsFlags
unownedSelfReference to instance of self
pspecthe
GParamSpecof the property which changed.handlerThe signal handler to call Run the given callback whenever the
notifyVisiblesignal is emitted -
notifyVisibleSignalExtension methodTyped
notify::visiblesignal for using theconnect(signal:)methodsDeclaration
Swift
static var notifyVisibleSignal: StatusIconSignalName { get }
-
getGeometry(screen:Extension methodarea: orientation: ) 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().get_geometry is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as the platform is responsible for the presentation of notifications
Declaration
Swift
@available(*, deprecated) @inlinable func getGeometry(screen: UnsafeMutablePointer<UnsafeMutablePointer<GdkScreen>?>! = nil, area: Gdk.RectangleRef? = nil, orientation: UnsafeMutablePointer<GtkOrientation>! = nil) -> Bool -
getGeometry(screen:Extension methodarea: orientation: ) 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().get_geometry is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as the platform is responsible for the presentation of notifications
Declaration
Swift
@available(*, deprecated) @inlinable func getGeometry<RectangleT>(screen: UnsafeMutablePointer<UnsafeMutablePointer<GdkScreen>?>! = nil, area: RectangleT?, orientation: UnsafeMutablePointer<GtkOrientation>! = nil) -> Bool where RectangleT : RectangleProtocol -
getIcon()Extension methodRetrieves the
GIconbeing displayed by theGtkStatusIcon. The storage type of the status icon must beGTK_IMAGE_EMPTYorGTK_IMAGE_GICON(seegtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returnedGIcon.If this function fails,
iconis left unchanged;get_gicon is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getIcon() -> GIO.IconRef! -
getHasTooltip()Extension methodReturns the current value of the has-tooltip property. See
GtkStatusIcon:has-tooltipfor more information.get_has_tooltip is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getHasTooltip() -> Bool -
getIconName()Extension methodGets the name of the icon being displayed by the
GtkStatusIcon. The storage type of the status icon must beGTK_IMAGE_EMPTYorGTK_IMAGE_ICON_NAME(seegtk_status_icon_get_storage_type()). The returned string is owned by theGtkStatusIconand should not be freed or modified.get_icon_name is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getIconName() -> String! -
getPixbuf()Extension methodGets the
GdkPixbufbeing displayed by theGtkStatusIcon. The storage type of the status icon must beGTK_IMAGE_EMPTYorGTK_IMAGE_PIXBUF(seegtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returned pixbuf.get_pixbuf is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getPixbuf() -> PixbufRef! -
getScreen()Extension methodReturns the
GdkScreenassociated withstatus_icon.get_screen is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform
Declaration
Swift
@available(*, deprecated) @inlinable func getScreen() -> Gdk.ScreenRef! -
getSize()Extension methodGets 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()).get_size is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as the representation of a notification is left to the platform
Declaration
Swift
@available(*, deprecated) @inlinable func getSize() -> Int -
getStock()Extension methodGets the id of the stock icon being displayed by the
GtkStatusIcon. The storage type of the status icon must beGTK_IMAGE_EMPTYorGTK_IMAGE_STOCK(seegtk_status_icon_get_storage_type()). The returned string is owned by theGtkStatusIconand should not be freed or modified.get_stock is deprecated: Use gtk_status_icon_get_icon_name() instead.
Declaration
Swift
@available(*, deprecated) @inlinable func getStock() -> String! -
getStorageType()Extension methodGets the type of representation being used by the
GtkStatusIconto store image data. If theGtkStatusIconhas no image data, the return value will beGTK_IMAGE_EMPTY.get_storage_type is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, and #GNotification only supports #GIcon instances
Declaration
Swift
@available(*, deprecated) @inlinable func getStorageType() -> GtkImageType -
getTitle()Extension methodGets the title of this tray icon. See
gtk_status_icon_set_title().get_title is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getTitle() -> String! -
getTooltipMarkup()Extension methodGets the contents of the tooltip for
status_icon.get_tooltip_markup is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getTooltipMarkup() -> String! -
getTooltipText()Extension methodGets the contents of the tooltip for
status_icon.get_tooltip_text is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getTooltipText() -> String! -
getVisible()Extension methodReturns 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().get_visible is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getVisible() -> Bool -
getX11WindowID()Extension methodThis 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().get_x11_window_id is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func getX11WindowID() -> guint32 -
setFromFile(filename:Extension method) Makes
status_icondisplay the filefilename. Seegtk_status_icon_new_from_file()for details.set_from_file is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() to associate a #GIcon with a notification
Declaration
Swift
@available(*, deprecated) @inlinable func setFromFile(filename: UnsafePointer<gchar>!) -
setFromIcon(icon:Extension method) Makes
status_icondisplay theGIcon. Seegtk_status_icon_new_from_gicon()for details.set_from_gicon is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() to associate a #GIcon with a notification
Declaration
Swift
@available(*, deprecated) @inlinable func setFromIcon<IconT>(icon: IconT) where IconT : IconProtocol -
setFrom(iconName:Extension method) Makes
status_icondisplay the icon namedicon_namefrom the current icon theme. Seegtk_status_icon_new_from_icon_name()for details.set_from_icon_name is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() to associate a #GIcon with a notification
Declaration
Swift
@available(*, deprecated) @inlinable func setFrom(iconName: UnsafePointer<gchar>!) -
setFrom(pixbuf:Extension method) Makes
status_icondisplaypixbuf. Seegtk_status_icon_new_from_pixbuf()for details.set_from_pixbuf is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() to associate a #GIcon with a notification
Declaration
Swift
@available(*, deprecated) @inlinable func setFrom(pixbuf: PixbufRef? = nil) -
setFrom(pixbuf:Extension method) Makes
status_icondisplaypixbuf. Seegtk_status_icon_new_from_pixbuf()for details.set_from_pixbuf is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you can use g_notification_set_icon() to associate a #GIcon with a notification
Declaration
Swift
@available(*, deprecated) @inlinable func setFrom<PixbufT>(pixbuf: PixbufT?) where PixbufT : PixbufProtocol -
setFromStock(stockID:Extension method) Makes
status_icondisplay the stock icon with the idstock_id. Seegtk_status_icon_new_from_stock()for details.set_from_stock is deprecated: Use gtk_status_icon_set_from_icon_name() instead.
Declaration
Swift
@available(*, deprecated) @inlinable func setFromStock(stockID: UnsafePointer<gchar>!) -
set(hasTooltip:Extension method) Sets the has-tooltip property on
status_icontohas_tooltip. SeeGtkStatusIcon:has-tooltipfor more information.set_has_tooltip is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, but notifications can display an arbitrary amount of text using g_notification_set_body()
Declaration
Swift
@available(*, deprecated) @inlinable func set(hasTooltip: Bool) -
set(name:Extension method) 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.
set_name is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as notifications are associated with a unique application identifier by #GApplication
Declaration
Swift
@available(*, deprecated) @inlinable func set(name: UnsafePointer<gchar>!) -
set(screen:Extension method) Sets the
GdkScreenwherestatus_iconis displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen.set_screen is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as GTK typically only has one #GdkScreen and notifications are managed by the platform
Declaration
Swift
@available(*, deprecated) @inlinable func set<ScreenT>(screen: ScreenT) where ScreenT : ScreenProtocol -
set(title:Extension method) 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.
set_title is deprecated: Use #GNotification and #GtkApplication to provide status notifications; you should use g_notification_set_title() and g_notification_set_body() to present text inside your notification
Declaration
Swift
@available(*, deprecated) @inlinable func set(title: UnsafePointer<gchar>!) -
setTooltip(markup:Extension method) Sets
markupas the contents of the tooltip, which is marked up with the Pango text markup language.This function will take care of setting
GtkStatusIcon:has-tooltiptotrueand of the default handler for theGtkStatusIcon::query-tooltipsignal.See also the
GtkStatusIcon:tooltip-markupproperty andgtk_tooltip_set_markup().set_tooltip_markup is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func setTooltip(markup: UnsafePointer<gchar>? = nil) -
setTooltip(text:Extension method) Sets
textas the contents of the tooltip.This function will take care of setting
GtkStatusIcon:has-tooltiptotrueand of the default handler for theGtkStatusIcon::query-tooltipsignal.See also the
GtkStatusIcon:tooltip-textproperty andgtk_tooltip_set_text().set_tooltip_text is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@available(*, deprecated) @inlinable func setTooltip(text: UnsafePointer<gchar>!) -
set(visible:Extension method) Shows or hides a status icon.
set_visible is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform
Declaration
Swift
@available(*, deprecated) @inlinable func set(visible: Bool) -
position(menu:Extension methodx: y: pushIn: ) Menu positioning function to use with
gtk_menu_popup()to positionmenualigned to the status iconuser_data.position_menu is deprecated: Use #GNotification and #GtkApplication to provide status notifications; notifications do not have menus, but can have buttons, and actions associated with each button
Declaration
Swift
@available(*, deprecated) @inlinable func position<MenuT>(menu: MenuT, x: UnsafeMutablePointer<gint>!, y: UnsafeMutablePointer<gint>!, pushIn: UnsafeMutablePointer<gboolean>!) where MenuT : MenuProtocol -
giconExtension methodThe
GIcondisplayed in theGtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes.Declaration
Swift
@inlinable var gicon: GIO.IconRef! { get } -
hasTooltipExtension methodReturns the current value of the has-tooltip property. See
GtkStatusIcon:has-tooltipfor more information.get_has_tooltip is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var hasTooltip: Bool { get nonmutating set } -
iconNameExtension methodGets the name of the icon being displayed by the
GtkStatusIcon. The storage type of the status icon must beGTK_IMAGE_EMPTYorGTK_IMAGE_ICON_NAME(seegtk_status_icon_get_storage_type()). The returned string is owned by theGtkStatusIconand should not be freed or modified.get_icon_name is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var iconName: String! { get } -
isEmbeddedExtension methodReturns whether the status icon is embedded in a notification area.
is_embedded is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var isEmbedded: Bool { get } -
pixbufExtension methodUndocumented
Declaration
Swift
@inlinable var pixbuf: PixbufRef! { get } -
screenExtension methodUndocumented
Declaration
Swift
@inlinable var screen: Gdk.ScreenRef! { get nonmutating set } -
sizeExtension methodUndocumented
Declaration
Swift
@inlinable var size: Int { get } -
stockExtension methodstock is deprecated: Use #GtkStatusIcon:icon-name instead.
Declaration
Swift
@inlinable var stock: String! { get } -
storageTypeExtension methodGets the type of representation being used by the
GtkStatusIconto store image data. If theGtkStatusIconhas no image data, the return value will beGTK_IMAGE_EMPTY.get_storage_type is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function, and #GNotification only supports #GIcon instances
Declaration
Swift
@inlinable var storageType: GtkImageType { get } -
titleExtension methodThe 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.
Declaration
Swift
@inlinable var title: String! { get nonmutating set } -
tooltipMarkupExtension methodGets the contents of the tooltip for
status_icon.get_tooltip_markup is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var tooltipMarkup: String! { get nonmutating set } -
tooltipTextExtension methodGets the contents of the tooltip for
status_icon.get_tooltip_text is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var tooltipText: String! { get nonmutating set } -
visibleExtension methodUndocumented
Declaration
Swift
@inlinable var visible: Bool { get nonmutating set } -
x11WindowIDExtension methodThis 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().get_x11_window_id is deprecated: Use #GNotification and #GtkApplication to provide status notifications; there is no direct replacement for this function
Declaration
Swift
@inlinable var x11WindowID: guint32 { get } -
parentInstanceExtension methodUndocumented
Declaration
Swift
@inlinable var parentInstance: GObject { get }
View on GitHub
Install in Dash
StatusIconProtocol Protocol Reference