GI.Gtk.Objects.StatusIcon

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 StatusIcon 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 statusIconIsEmbedded, 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 Object. 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 Notification API which works well with Application 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.

Exported types

newtype StatusIcon

Memory-managed wrapper type.

Constructors

StatusIcon (ManagedPtr StatusIcon)

Instances

Eq StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

Methods

(==) :: StatusIcon -> StatusIcon -> Bool

(/=) :: StatusIcon -> StatusIcon -> Bool

GObject StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

ManagedPtrNewtype StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

Methods

toManagedPtr :: StatusIcon -> ManagedPtr StatusIcon

TypedObject StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

Methods

glibType :: IO GType

HasParentTypes StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

IsGValue (Maybe StatusIcon)

Convert StatusIcon to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.StatusIcon

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe StatusIcon -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe StatusIcon)

type ParentTypes StatusIcon

Defined in GI.Gtk.Objects.StatusIcon

type ParentTypes StatusIcon = '[Object]

class (GObject o, IsDescendantOf StatusIcon o) => IsStatusIcon o

Type class for types which can be safely cast to StatusIcon, for instance with toStatusIcon.

Instances

(GObject o, IsDescendantOf StatusIcon o) => IsStatusIcon o

Defined in GI.Gtk.Objects.StatusIcon

toStatusIcon :: (MonadIO m, IsStatusIcon o) => o -> m StatusIcon

Cast to StatusIcon, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isEmbedded, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getGeometry, getGicon, getHasTooltip, getIconName, getPixbuf, getProperty, getQdata, getScreen, getSize, getStock, getStorageType, getTitle, getTooltipMarkup, getTooltipText, getVisible, getX11WindowId.

Setters

setData, setDataFull, setFromFile, setFromGicon, setFromIconName, setFromPixbuf, setFromStock, setHasTooltip, setName, setProperty, setScreen, setTitle, setTooltipMarkup, setTooltipText, setVisible.

getGeometry

statusIconGetGeometry

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Bool, Screen, Rectangle, Orientation)

Returns: True if the location information has been filled in

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as the platform is responsible for the presentation of notifications

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 statusIconPositionMenu 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 statusIconIsEmbedded.

Since: 2.10

getGicon

statusIconGetGicon

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Icon)

Returns: the displayed icon, or Nothing if the image is empty

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Retrieves the Icon being displayed by the StatusIcon. The storage type of the status icon must be ImageTypeEmpty or ImageTypeGicon (see statusIconGetStorageType). The caller of this function does not own a reference to the returned Icon.

If this function fails, icon is left unchanged;

Since: 2.14

getHasTooltip

statusIconGetHasTooltip

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Bool

Returns: current value of has-tooltip on statusIcon.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Returns the current value of the has-tooltip property. See StatusIcon:hasTooltip for more information.

Since: 2.16

getIconName

statusIconGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Text)

Returns: name of the displayed icon, or Nothing if the image is empty.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Gets the name of the icon being displayed by the StatusIcon. The storage type of the status icon must be ImageTypeEmpty or ImageTypeIconName (see statusIconGetStorageType). The returned string is owned by the StatusIcon and should not be freed or modified.

Since: 2.10

getPixbuf

statusIconGetPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Pixbuf)

Returns: the displayed pixbuf, or Nothing if the image is empty.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Gets the Pixbuf being displayed by the StatusIcon. The storage type of the status icon must be ImageTypeEmpty or ImageTypePixbuf (see statusIconGetStorageType). The caller of this function does not own a reference to the returned pixbuf.

Since: 2.10

getScreen

statusIconGetScreen

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Screen

Returns: a Screen.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform

Returns the Screen associated with statusIcon.

Since: 2.12

getSize

statusIconGetSize

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Int32

Returns: the size that is available for the image

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as the representation of a notification is left to the platform

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 statusIconIsEmbedded).

Since: 2.10

getStock

statusIconGetStock

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Text)

Returns: stock id of the displayed stock icon, or Nothing if the image is empty.

Deprecated: (Since version 3.10)Use statusIconGetIconName instead.

Gets the id of the stock icon being displayed by the StatusIcon. The storage type of the status icon must be ImageTypeEmpty or ImageTypeStock (see statusIconGetStorageType). The returned string is owned by the StatusIcon and should not be freed or modified.

Since: 2.10

getStorageType

statusIconGetStorageType

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m ImageType

Returns: the image representation being used

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, and Notification only supports Icon instances

Gets the type of representation being used by the StatusIcon to store image data. If the StatusIcon has no image data, the return value will be ImageTypeEmpty.

Since: 2.10

getTitle

statusIconGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Text

Returns: the title of the status icon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Gets the title of this tray icon. See statusIconSetTitle.

Since: 2.18

getTooltipMarkup

statusIconGetTooltipMarkup

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Text)

Returns: the tooltip text, or Nothing. You should free the returned string with free when done.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Gets the contents of the tooltip for statusIcon.

Since: 2.16

getTooltipText

statusIconGetTooltipText

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m (Maybe Text)

Returns: the tooltip text, or Nothing. You should free the returned string with free when done.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Gets the contents of the tooltip for statusIcon.

Since: 2.16

getVisible

statusIconGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Bool

Returns: True if the status icon is visible

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

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 statusIconIsEmbedded.

Since: 2.10

getX11WindowId

statusIconGetX11WindowId

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Word32

Returns: An 32 bit unsigned integer identifier for the underlying X11 Window

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

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 statusIconPositionMenu.

Since: 2.14

isEmbedded

statusIconIsEmbedded

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> m Bool

Returns: True if the status icon is embedded in a notification area.

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Returns whether the status icon is embedded in a notification area.

Since: 2.10

new

statusIconNew

Arguments

:: (HasCallStack, MonadIO m)

=> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates an empty status icon object.

Since: 2.10

newFromFile

statusIconNewFromFile

Arguments

:: (HasCallStack, MonadIO m)

=> [Char]

filename: a filename

-> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates a status icon displaying the file filename.

The image will be scaled down to fit in the available space in the notification area, if necessary.

Since: 2.10

newFromGicon

statusIconNewFromGicon

Arguments

:: (HasCallStack, MonadIO m, IsIcon a)

=> a

icon: a Icon

-> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates a status icon displaying a Icon. If the icon is a themed icon, it will be updated when the theme changes.

Since: 2.14

newFromIconName

statusIconNewFromIconName

Arguments

:: (HasCallStack, MonadIO m)

=> Text

iconName: an icon name

-> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately.

Since: 2.10

newFromPixbuf

statusIconNewFromPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)

=> a

pixbuf: a Pixbuf

-> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates a status icon displaying pixbuf.

The image will be scaled down to fit in the available space in the notification area, if necessary.

Since: 2.10

newFromStock

statusIconNewFromStock

Arguments

:: (HasCallStack, MonadIO m)

=> Text

stockId: a stock icon id

-> m StatusIcon

Returns: a new StatusIcon

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications

Creates a status icon displaying a stock icon. Sample stock icon names are STOCK_OPEN, STOCK_QUIT. You can register your own stock icon names, see iconFactoryAddDefault and iconFactoryAdd.

Since: 2.10

positionMenu

statusIconPositionMenu

Arguments

:: (HasCallStack, MonadIO m, IsMenu a, IsStatusIcon b)

=> a

menu: the Menu

-> Int32

x: return location for the x position

-> Int32

y: return location for the y position

-> b

userData: the status icon to position the menu on

-> m (Int32, Int32, Bool)

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; notifications do not have menus, but can have buttons, and actions associated with each button

Menu positioning function to use with menuPopup to position menu aligned to the status icon userData.

Since: 2.10

setFromFile

statusIconSetFromFile

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> [Char]

filename: a filename

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; you can use notificationSetIcon to associate a Icon with a notification

Makes statusIcon display the file filename. See statusIconNewFromFile for details.

Since: 2.10

setFromGicon

statusIconSetFromGicon

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a, IsIcon b)

=> a

statusIcon: a StatusIcon

-> b

icon: a GIcon

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; you can use notificationSetIcon to associate a Icon with a notification

Makes statusIcon display the Icon. See statusIconNewFromGicon for details.

Since: 2.14

setFromIconName

statusIconSetFromIconName

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Text

iconName: an icon name

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; you can use notificationSetIcon to associate a Icon with a notification

Makes statusIcon display the icon named iconName from the current icon theme. See statusIconNewFromIconName for details.

Since: 2.10

setFromPixbuf

statusIconSetFromPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a, IsPixbuf b)

=> a

statusIcon: a StatusIcon

-> Maybe b

pixbuf: a Pixbuf or Nothing

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; you can use notificationSetIcon to associate a Icon with a notification

Makes statusIcon display pixbuf. See statusIconNewFromPixbuf for details.

Since: 2.10

setFromStock

statusIconSetFromStock

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Text

stockId: a stock icon id

-> m ()

Deprecated: (Since version 3.10)Use statusIconSetFromIconName instead.

Makes statusIcon display the stock icon with the id stockId. See statusIconNewFromStock for details.

Since: 2.10

setHasTooltip

statusIconSetHasTooltip

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Bool

hasTooltip: whether or not statusIcon has a tooltip

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, but notifications can display an arbitrary amount of text using notificationSetBody

Sets the has-tooltip property on statusIcon to hasTooltip. See StatusIcon:hasTooltip for more information.

Since: 2.16

setName

statusIconSetName

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Text

name: the name

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as notifications are associated with a unique application identifier by Application

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.

Since: 2.20

setScreen

statusIconSetScreen

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a, IsScreen b)

=> a

statusIcon: a StatusIcon

-> b

screen: a Screen

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as GTK typically only has one Screen and notifications are managed by the platform

Sets the Screen where statusIcon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen.

Since: 2.12

setTitle

statusIconSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Text

title: the title

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; you should use notificationSetTitle and notificationSetBody to present text inside your notification

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.

Since: 2.18

setTooltipMarkup

statusIconSetTooltipMarkup

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Maybe Text

markup: the contents of the tooltip for statusIcon, or Nothing

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Sets markup as the contents of the tooltip, which is marked up with the [Pango text markup language][PangoMarkupFormat].

This function will take care of setting StatusIcon:hasTooltip to True and of the default handler for the StatusIcon::queryTooltip signal.

See also the StatusIcon:tooltipMarkup property and tooltipSetMarkup.

Since: 2.16

setTooltipText

statusIconSetTooltipText

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Text

text: the contents of the tooltip for statusIcon

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function

Sets text as the contents of the tooltip.

This function will take care of setting StatusIcon:hasTooltip to True and of the default handler for the StatusIcon::queryTooltip signal.

See also the StatusIcon:tooltipText property and tooltipSetText.

Since: 2.16

setVisible

statusIconSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsStatusIcon a)

=> a

statusIcon: a StatusIcon

-> Bool

visible: True to show the status icon, False to hide it

-> m ()

Deprecated: (Since version 3.14)Use Notification and Application to provide status notifications; there is no direct replacement for this function, as notifications are managed by the platform

Shows or hides a status icon.

Since: 2.10

Properties

embedded

True if the statusicon is embedded in a notification area.

Since: 2.12

getStatusIconEmbedded :: (MonadIO m, IsStatusIcon o) => o -> m Bool

Get the value of the “embedded” property. When overloading is enabled, this is equivalent to

get statusIcon #embedded

file

No description available in the introspection data.

clearStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “file” property to Nothing. When overloading is enabled, this is equivalent to

clear #file

constructStatusIconFile :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “file” property. This is rarely needed directly, but it is used by new.

setStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “file” property. When overloading is enabled, this is equivalent to

set statusIcon [ #file := value ]

gicon

The Icon displayed in the StatusIcon. For themed icons, the image will be updated automatically if the theme changes.

Since: 2.14

clearStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “gicon” property to Nothing. When overloading is enabled, this is equivalent to

clear #gicon

constructStatusIconGicon :: (IsStatusIcon o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gicon” property. This is rarely needed directly, but it is used by new.

getStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Icon)

Get the value of the “gicon” property. When overloading is enabled, this is equivalent to

get statusIcon #gicon

setStatusIconGicon :: (MonadIO m, IsStatusIcon o, IsIcon a) => o -> a -> m ()

Set the value of the “gicon” property. When overloading is enabled, this is equivalent to

set statusIcon [ #gicon := value ]

hasTooltip

Enables or disables the emission of StatusIcon::queryTooltip on statusIcon. A value of True indicates that statusIcon can have a tooltip, in this case the status icon will be queried using StatusIcon::queryTooltip 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 StatusIcon:tooltipText in preference.

Since: 2.16

constructStatusIconHasTooltip :: (IsStatusIcon o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “has-tooltip” property. This is rarely needed directly, but it is used by new.

getStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> m Bool

Get the value of the “has-tooltip” property. When overloading is enabled, this is equivalent to

get statusIcon #hasTooltip

setStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m ()

Set the value of the “has-tooltip” property. When overloading is enabled, this is equivalent to

set statusIcon [ #hasTooltip := value ]

iconName

No description available in the introspection data.

clearStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructStatusIconIconName :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon-name” property. This is rarely needed directly, but it is used by new.

getStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get statusIcon #iconName

setStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “icon-name” property. When overloading is enabled, this is equivalent to

set statusIcon [ #iconName := value ]

orientation

The orientation of the tray in which the statusicon is embedded.

Since: 2.12

getStatusIconOrientation :: (MonadIO m, IsStatusIcon o) => o -> m Orientation

Get the value of the “orientation” property. When overloading is enabled, this is equivalent to

get statusIcon #orientation

pixbuf

No description available in the introspection data.

clearStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “pixbuf” property to Nothing. When overloading is enabled, this is equivalent to

clear #pixbuf

constructStatusIconPixbuf :: (IsStatusIcon o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pixbuf” property. This is rarely needed directly, but it is used by new.

getStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Pixbuf)

Get the value of the “pixbuf” property. When overloading is enabled, this is equivalent to

get statusIcon #pixbuf

setStatusIconPixbuf :: (MonadIO m, IsStatusIcon o, IsPixbuf a) => o -> a -> m ()

Set the value of the “pixbuf” property. When overloading is enabled, this is equivalent to

set statusIcon [ #pixbuf := value ]

screen

No description available in the introspection data.

constructStatusIconScreen :: (IsStatusIcon o, MonadIO m, IsScreen a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “screen” property. This is rarely needed directly, but it is used by new.

getStatusIconScreen :: (MonadIO m, IsStatusIcon o) => o -> m Screen

Get the value of the “screen” property. When overloading is enabled, this is equivalent to

get statusIcon #screen

setStatusIconScreen :: (MonadIO m, IsStatusIcon o, IsScreen a) => o -> a -> m ()

Set the value of the “screen” property. When overloading is enabled, this is equivalent to

set statusIcon [ #screen := value ]

size

No description available in the introspection data.

getStatusIconSize :: (MonadIO m, IsStatusIcon o) => o -> m Int32

Get the value of the “size” property. When overloading is enabled, this is equivalent to

get statusIcon #size

stock

No description available in the introspection data.

clearStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “stock” property to Nothing. When overloading is enabled, this is equivalent to

clear #stock

constructStatusIconStock :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “stock” property. This is rarely needed directly, but it is used by new.

getStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)

Get the value of the “stock” property. When overloading is enabled, this is equivalent to

get statusIcon #stock

setStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “stock” property. When overloading is enabled, this is equivalent to

set statusIcon [ #stock := value ]

storageType

No description available in the introspection data.

getStatusIconStorageType :: (MonadIO m, IsStatusIcon o) => o -> m ImageType

Get the value of the “storage-type” property. When overloading is enabled, this is equivalent to

get statusIcon #storageType

title

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.

Since: 2.18

constructStatusIconTitle :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> m Text

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get statusIcon #title

setStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set statusIcon [ #title := value ]

tooltipMarkup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see tooltipSetMarkup.

This is a convenience property which will take care of getting the tooltip shown if the given string is not Nothing. StatusIcon:hasTooltip will automatically be set to True and the default handler for the StatusIcon::queryTooltip signal will take care of displaying the tooltip.

On some platforms, embedded markup will be ignored.

Since: 2.16

clearStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m ()

Set the value of the “tooltip-markup” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipMarkup

constructStatusIconTooltipMarkup :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tooltip-markup” property. This is rarely needed directly, but it is used by new.

getStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)

Get the value of the “tooltip-markup” property. When overloading is enabled, this is equivalent to

get statusIcon #tooltipMarkup

setStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “tooltip-markup” property. When overloading is enabled, this is equivalent to

set statusIcon [ #tooltipMarkup := value ]

tooltipText

Sets the text of tooltip to be the given string.

Also see tooltipSetText.

This is a convenience property which will take care of getting the tooltip shown if the given string is not Nothing. StatusIcon:hasTooltip will automatically be set to True and the default handler for the StatusIcon::queryTooltip 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.

Since: 2.16

constructStatusIconTooltipText :: (IsStatusIcon o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tooltip-text” property. This is rarely needed directly, but it is used by new.

getStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)

Get the value of the “tooltip-text” property. When overloading is enabled, this is equivalent to

get statusIcon #tooltipText

setStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()

Set the value of the “tooltip-text” property. When overloading is enabled, this is equivalent to

set statusIcon [ #tooltipText := value ]

visible

No description available in the introspection data.

constructStatusIconVisible :: (IsStatusIcon o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “visible” property. This is rarely needed directly, but it is used by new.

getStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> m Bool

Get the value of the “visible” property. When overloading is enabled, this is equivalent to

get statusIcon #visible

setStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m ()

Set the value of the “visible” property. When overloading is enabled, this is equivalent to

set statusIcon [ #visible := value ]

Signals

activate

type StatusIconActivateCallback = IO ()

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.

Since: 2.10

afterStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconActivateCallback) -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #activate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconActivateCallback) -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #activate callback

buttonPressEvent

type StatusIconButtonPressEventCallback

Arguments

 = EventButton

event: the EventButton which triggered this signal

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

The buttonPressEvent 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 popupMenu signals in preference.

Since: 2.14

afterStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconButtonPressEventCallback) -> m SignalHandlerId

Connect a signal handler for the buttonPressEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #buttonPressEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconButtonPressEventCallback) -> m SignalHandlerId

Connect a signal handler for the buttonPressEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #buttonPressEvent callback

buttonReleaseEvent

type StatusIconButtonReleaseEventCallback

Arguments

 = EventButton

event: the EventButton which triggered this signal

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

The buttonReleaseEvent 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 popupMenu signals in preference.

Since: 2.14

afterStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconButtonReleaseEventCallback) -> m SignalHandlerId

Connect a signal handler for the buttonReleaseEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #buttonReleaseEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconButtonReleaseEventCallback) -> m SignalHandlerId

Connect a signal handler for the buttonReleaseEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #buttonReleaseEvent callback

popupMenu

type StatusIconPopupMenuCallback

Arguments

 = Word32

button: the button that was pressed, or 0 if the signal is not emitted in response to a button press event

-> Word32

activateTime: the timestamp of the event that triggered the signal emission

-> IO ()

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 activateTime parameters should be passed as the last to arguments to menuPopup.

Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings.

Since: 2.10

afterStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconPopupMenuCallback) -> m SignalHandlerId

Connect a signal handler for the popupMenu signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #popupMenu callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconPopupMenuCallback) -> m SignalHandlerId

Connect a signal handler for the popupMenu signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #popupMenu callback

queryTooltip

type StatusIconQueryTooltipCallback

Arguments

 = Int32

x: the x coordinate of the cursor position where the request has been emitted, relative to statusIcon

-> Int32

y: the y coordinate of the cursor position where the request has been emitted, relative to statusIcon

-> Bool

keyboardMode: True if the tooltip was trigged using the keyboard

-> Tooltip

tooltip: a Tooltip

-> IO Bool

Returns: True if tooltip should be shown right now, False otherwise.

Emitted when the hover timeout has expired with the cursor hovering above statusIcon; or emitted when statusIcon got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for statusIcon. If this is the case True should be returned, False otherwise. Note that if keyboardMode 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 StatusIcon:tooltipText in preference.

Since: 2.16

afterStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconQueryTooltipCallback) -> m SignalHandlerId

Connect a signal handler for the queryTooltip signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #queryTooltip callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconQueryTooltipCallback) -> m SignalHandlerId

Connect a signal handler for the queryTooltip signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #queryTooltip callback

scrollEvent

type StatusIconScrollEventCallback

Arguments

 = EventScroll

event: the EventScroll which triggered this signal

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

The scrollEvent 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.

Since: 2.16

afterStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconScrollEventCallback) -> m SignalHandlerId

Connect a signal handler for the scrollEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #scrollEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconScrollEventCallback) -> m SignalHandlerId

Connect a signal handler for the scrollEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #scrollEvent callback

sizeChanged

type StatusIconSizeChangedCallback

Arguments

 = Int32

size: the new size

-> IO Bool

Returns: True if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary.

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

Since: 2.10

afterStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconSizeChangedCallback) -> m SignalHandlerId

Connect a signal handler for the sizeChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusIcon #sizeChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> ((?self :: a) => StatusIconSizeChangedCallback) -> m SignalHandlerId

Connect a signal handler for the sizeChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusIcon #sizeChanged callback