Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- getGeometry
- getGicon
- getHasTooltip
- getIconName
- getPixbuf
- getScreen
- getSize
- getStock
- getStorageType
- getTitle
- getTooltipMarkup
- getTooltipText
- getVisible
- getX11WindowId
- isEmbedded
- new
- newFromFile
- newFromGicon
- newFromIconName
- newFromPixbuf
- newFromStock
- positionMenu
- setFromFile
- setFromGicon
- setFromIconName
- setFromPixbuf
- setFromStock
- setHasTooltip
- setName
- setScreen
- setTitle
- setTooltipMarkup
- setTooltipText
- setVisible
- Properties
- Signals
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. Critical information should
not solely be displayed in a StatusIcon
, since it may not be
visible (e.g. when the user doesn’t have a notification area on his panel).
This can be checked with statusIconIsEmbedded
.
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 Win32 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
. Also see this
HowDoI.
- newtype StatusIcon = StatusIcon (ManagedPtr StatusIcon)
- class GObject o => IsStatusIcon o
- toStatusIcon :: (MonadIO m, IsStatusIcon o) => o -> m StatusIcon
- noStatusIcon :: Maybe StatusIcon
- statusIconGetGeometry :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Bool, Screen, Rectangle, Orientation)
- statusIconGetGicon :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Icon)
- statusIconGetHasTooltip :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Bool
- statusIconGetIconName :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Text)
- statusIconGetPixbuf :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Pixbuf)
- statusIconGetScreen :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Screen
- statusIconGetSize :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Int32
- statusIconGetStock :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Text)
- statusIconGetStorageType :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m ImageType
- statusIconGetTitle :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Text
- statusIconGetTooltipMarkup :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Text)
- statusIconGetTooltipText :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m (Maybe Text)
- statusIconGetVisible :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Bool
- statusIconGetX11WindowId :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Word32
- statusIconIsEmbedded :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> m Bool
- statusIconNew :: (HasCallStack, MonadIO m) => m StatusIcon
- statusIconNewFromFile :: (HasCallStack, MonadIO m) => [Char] -> m StatusIcon
- statusIconNewFromGicon :: (HasCallStack, MonadIO m, IsIcon a) => a -> m StatusIcon
- statusIconNewFromIconName :: (HasCallStack, MonadIO m) => Text -> m StatusIcon
- statusIconNewFromPixbuf :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m StatusIcon
- statusIconNewFromStock :: (HasCallStack, MonadIO m) => Text -> m StatusIcon
- statusIconPositionMenu :: (HasCallStack, MonadIO m, IsMenu a, IsStatusIcon b) => a -> Int32 -> Int32 -> b -> m (Int32, Int32, Bool)
- statusIconSetFromFile :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> [Char] -> m ()
- statusIconSetFromGicon :: (HasCallStack, MonadIO m, IsStatusIcon a, IsIcon b) => a -> b -> m ()
- statusIconSetFromIconName :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Text -> m ()
- statusIconSetFromPixbuf :: (HasCallStack, MonadIO m, IsStatusIcon a, IsPixbuf b) => a -> Maybe b -> m ()
- statusIconSetFromStock :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Text -> m ()
- statusIconSetHasTooltip :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Bool -> m ()
- statusIconSetName :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Text -> m ()
- statusIconSetScreen :: (HasCallStack, MonadIO m, IsStatusIcon a, IsScreen b) => a -> b -> m ()
- statusIconSetTitle :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Text -> m ()
- statusIconSetTooltipMarkup :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Maybe Text -> m ()
- statusIconSetTooltipText :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Text -> m ()
- statusIconSetVisible :: (HasCallStack, MonadIO m, IsStatusIcon a) => a -> Bool -> m ()
- getStatusIconEmbedded :: (MonadIO m, IsStatusIcon o) => o -> m Bool
- clearStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconFile :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- setStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- clearStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconGicon :: (IsStatusIcon o, IsIcon a) => a -> IO (GValueConstruct o)
- getStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Icon)
- setStatusIconGicon :: (MonadIO m, IsStatusIcon o, IsIcon a) => o -> a -> m ()
- constructStatusIconHasTooltip :: IsStatusIcon o => Bool -> IO (GValueConstruct o)
- getStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> m Bool
- setStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m ()
- clearStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconIconName :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- getStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)
- setStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- getStatusIconOrientation :: (MonadIO m, IsStatusIcon o) => o -> m Orientation
- clearStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconPixbuf :: (IsStatusIcon o, IsPixbuf a) => a -> IO (GValueConstruct o)
- getStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Pixbuf)
- setStatusIconPixbuf :: (MonadIO m, IsStatusIcon o, IsPixbuf a) => o -> a -> m ()
- constructStatusIconScreen :: (IsStatusIcon o, IsScreen a) => a -> IO (GValueConstruct o)
- getStatusIconScreen :: (MonadIO m, IsStatusIcon o) => o -> m Screen
- setStatusIconScreen :: (MonadIO m, IsStatusIcon o, IsScreen a) => o -> a -> m ()
- getStatusIconSize :: (MonadIO m, IsStatusIcon o) => o -> m Int32
- clearStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconStock :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- getStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)
- setStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- getStatusIconStorageType :: (MonadIO m, IsStatusIcon o) => o -> m ImageType
- constructStatusIconTitle :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- getStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> m Text
- setStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- clearStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m ()
- constructStatusIconTooltipMarkup :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- getStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)
- setStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- constructStatusIconTooltipText :: IsStatusIcon o => Text -> IO (GValueConstruct o)
- getStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text)
- setStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> Text -> m ()
- constructStatusIconVisible :: IsStatusIcon o => Bool -> IO (GValueConstruct o)
- getStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> m Bool
- setStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m ()
- type C_StatusIconActivateCallback = Ptr () -> Ptr () -> IO ()
- type StatusIconActivateCallback = IO ()
- afterStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> StatusIconActivateCallback -> m SignalHandlerId
- genClosure_StatusIconActivate :: StatusIconActivateCallback -> IO Closure
- mk_StatusIconActivateCallback :: C_StatusIconActivateCallback -> IO (FunPtr C_StatusIconActivateCallback)
- noStatusIconActivateCallback :: Maybe StatusIconActivateCallback
- onStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> StatusIconActivateCallback -> m SignalHandlerId
- wrap_StatusIconActivateCallback :: StatusIconActivateCallback -> Ptr () -> Ptr () -> IO ()
- type C_StatusIconButtonPressEventCallback = Ptr () -> Ptr EventButton -> Ptr () -> IO CInt
- type StatusIconButtonPressEventCallback = EventButton -> IO Bool
- afterStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonPressEventCallback -> m SignalHandlerId
- genClosure_StatusIconButtonPressEvent :: StatusIconButtonPressEventCallback -> IO Closure
- mk_StatusIconButtonPressEventCallback :: C_StatusIconButtonPressEventCallback -> IO (FunPtr C_StatusIconButtonPressEventCallback)
- noStatusIconButtonPressEventCallback :: Maybe StatusIconButtonPressEventCallback
- onStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonPressEventCallback -> m SignalHandlerId
- wrap_StatusIconButtonPressEventCallback :: StatusIconButtonPressEventCallback -> Ptr () -> Ptr EventButton -> Ptr () -> IO CInt
- type C_StatusIconButtonReleaseEventCallback = Ptr () -> Ptr EventButton -> Ptr () -> IO CInt
- type StatusIconButtonReleaseEventCallback = EventButton -> IO Bool
- afterStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonReleaseEventCallback -> m SignalHandlerId
- genClosure_StatusIconButtonReleaseEvent :: StatusIconButtonReleaseEventCallback -> IO Closure
- mk_StatusIconButtonReleaseEventCallback :: C_StatusIconButtonReleaseEventCallback -> IO (FunPtr C_StatusIconButtonReleaseEventCallback)
- noStatusIconButtonReleaseEventCallback :: Maybe StatusIconButtonReleaseEventCallback
- onStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonReleaseEventCallback -> m SignalHandlerId
- wrap_StatusIconButtonReleaseEventCallback :: StatusIconButtonReleaseEventCallback -> Ptr () -> Ptr EventButton -> Ptr () -> IO CInt
- type C_StatusIconPopupMenuCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()
- type StatusIconPopupMenuCallback = Word32 -> Word32 -> IO ()
- afterStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> StatusIconPopupMenuCallback -> m SignalHandlerId
- genClosure_StatusIconPopupMenu :: StatusIconPopupMenuCallback -> IO Closure
- mk_StatusIconPopupMenuCallback :: C_StatusIconPopupMenuCallback -> IO (FunPtr C_StatusIconPopupMenuCallback)
- noStatusIconPopupMenuCallback :: Maybe StatusIconPopupMenuCallback
- onStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> StatusIconPopupMenuCallback -> m SignalHandlerId
- wrap_StatusIconPopupMenuCallback :: StatusIconPopupMenuCallback -> Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()
- type C_StatusIconQueryTooltipCallback = Ptr () -> Int32 -> Int32 -> CInt -> Ptr Tooltip -> Ptr () -> IO CInt
- type StatusIconQueryTooltipCallback = Int32 -> Int32 -> Bool -> Tooltip -> IO Bool
- afterStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> StatusIconQueryTooltipCallback -> m SignalHandlerId
- genClosure_StatusIconQueryTooltip :: StatusIconQueryTooltipCallback -> IO Closure
- mk_StatusIconQueryTooltipCallback :: C_StatusIconQueryTooltipCallback -> IO (FunPtr C_StatusIconQueryTooltipCallback)
- noStatusIconQueryTooltipCallback :: Maybe StatusIconQueryTooltipCallback
- onStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> StatusIconQueryTooltipCallback -> m SignalHandlerId
- wrap_StatusIconQueryTooltipCallback :: StatusIconQueryTooltipCallback -> Ptr () -> Int32 -> Int32 -> CInt -> Ptr Tooltip -> Ptr () -> IO CInt
- type C_StatusIconScrollEventCallback = Ptr () -> Ptr EventScroll -> Ptr () -> IO CInt
- type StatusIconScrollEventCallback = EventScroll -> IO Bool
- afterStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconScrollEventCallback -> m SignalHandlerId
- genClosure_StatusIconScrollEvent :: StatusIconScrollEventCallback -> IO Closure
- mk_StatusIconScrollEventCallback :: C_StatusIconScrollEventCallback -> IO (FunPtr C_StatusIconScrollEventCallback)
- noStatusIconScrollEventCallback :: Maybe StatusIconScrollEventCallback
- onStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconScrollEventCallback -> m SignalHandlerId
- wrap_StatusIconScrollEventCallback :: StatusIconScrollEventCallback -> Ptr () -> Ptr EventScroll -> Ptr () -> IO CInt
- type C_StatusIconSizeChangedCallback = Ptr () -> Int32 -> Ptr () -> IO CInt
- type StatusIconSizeChangedCallback = Int32 -> IO Bool
- afterStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> StatusIconSizeChangedCallback -> m SignalHandlerId
- genClosure_StatusIconSizeChanged :: StatusIconSizeChangedCallback -> IO Closure
- mk_StatusIconSizeChangedCallback :: C_StatusIconSizeChangedCallback -> IO (FunPtr C_StatusIconSizeChangedCallback)
- noStatusIconSizeChangedCallback :: Maybe StatusIconSizeChangedCallback
- onStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> StatusIconSizeChangedCallback -> m SignalHandlerId
- wrap_StatusIconSizeChangedCallback :: StatusIconSizeChangedCallback -> Ptr () -> Int32 -> Ptr () -> IO CInt
Exported types
newtype StatusIcon Source #
class GObject o => IsStatusIcon o Source #
toStatusIcon :: (MonadIO m, IsStatusIcon o) => o -> m StatusIcon Source #
Methods
getGeometry
statusIconGetGeometry Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Bool, Screen, Rectangle, Orientation) | Returns: |
Deprecated: (Since version 3.14)Use 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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Icon) | Returns: the displayed icon, or |
Deprecated: (Since version 3.14)Use notifications
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 Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Bool | Returns: current value of has-tooltip on |
Deprecated: (Since version 3.14)Use notifications
Returns the current value of the has-tooltip property.
See StatusIcon
:has-tooltip
for more information.
Since: 2.16
getIconName
statusIconGetIconName Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Text) | Returns: name of the displayed icon, or |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Pixbuf) | Returns: the displayed pixbuf,
or |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Screen | Returns: a |
Deprecated: (Since version 3.14)Use notifications
Returns the Screen
associated with statusIcon
.
Since: 2.12
getSize
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Int32 | Returns: the size that is available for the image |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Text) | Returns: stock id of the displayed stock icon,
or |
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 Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m ImageType | Returns: the image representation being used |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Text | Returns: the title of the status icon |
Deprecated: (Since version 3.14)Use notifications
Gets the title of this tray icon. See statusIconSetTitle
.
Since: 2.18
getTooltipMarkup
statusIconGetTooltipMarkup Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Text) | Returns: the tooltip text, or |
Deprecated: (Since version 3.14)Use notifications
Gets the contents of the tooltip for statusIcon
.
Since: 2.16
getTooltipText
statusIconGetTooltipText Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m (Maybe Text) | Returns: the tooltip text, or |
Deprecated: (Since version 3.14)Use notifications
Gets the contents of the tooltip for statusIcon
.
Since: 2.16
getVisible
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 3.14)Use notifications
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 Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Word32 | Returns: An 32 bit unsigned integer identifier for the underlying X11 Window |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 3.14)Use notifications
Returns whether the status icon is embedded in a notification area.
Since: 2.10
new
:: (HasCallStack, MonadIO m) | |
=> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.14)Use notifications
Creates an empty status icon object.
Since: 2.10
newFromFile
statusIconNewFromFile Source #
:: (HasCallStack, MonadIO m) | |
=> [Char] |
|
-> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.14)Use 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 Source #
:: (HasCallStack, MonadIO m, IsIcon a) | |
=> a |
|
-> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.14)Use 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 Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.14)Use 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 Source #
:: (HasCallStack, MonadIO m, IsPixbuf a) | |
=> a |
|
-> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.14)Use 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 Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m StatusIcon | Returns: a new |
Deprecated: (Since version 3.10)Use statusIconNewFromIconName
instead.
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 Source #
:: (HasCallStack, MonadIO m, IsMenu a, IsStatusIcon b) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> b |
|
-> m (Int32, Int32, Bool) |
Deprecated: (Since version 3.14)Use notifications
Menu positioning function to use with menuPopup
to position menu
aligned to the status icon userData
.
Since: 2.10
setFromFile
statusIconSetFromFile Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> [Char] |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
Makes statusIcon
display the file filename
.
See statusIconNewFromFile
for details.
Since: 2.10
setFromGicon
statusIconSetFromGicon Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a, IsIcon b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
Makes statusIcon
display the Icon
.
See statusIconNewFromGicon
for details.
Since: 2.14
setFromIconName
statusIconSetFromIconName Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
Makes statusIcon
display the icon named iconName
from the
current icon theme.
See statusIconNewFromIconName
for details.
Since: 2.10
setFromPixbuf
statusIconSetFromPixbuf Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a, IsPixbuf b) | |
=> a |
|
-> Maybe b | |
-> m () |
Deprecated: (Since version 3.14)Use notifications
Makes statusIcon
display pixbuf
.
See statusIconNewFromPixbuf
for details.
Since: 2.10
setFromStock
statusIconSetFromStock Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Text |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
Sets the has-tooltip property on statusIcon
to hasTooltip
.
See StatusIcon
:has-tooltip
for more information.
Since: 2.16
setName
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a, IsScreen b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
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
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
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 Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
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
:has-tooltip
to True
and of the default handler for the StatusIcon
::query-tooltip
signal.
See also the StatusIcon
:tooltip-markup
property and
tooltipSetMarkup
.
Since: 2.16
setTooltipText
statusIconSetTooltipText Source #
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 3.14)Use notifications
Sets text
as the contents of the tooltip.
This function will take care of setting StatusIcon
:has-tooltip
to
True
and of the default handler for the StatusIcon
::query-tooltip
signal.
See also the StatusIcon
:tooltip-text
property and
tooltipSetText
.
Since: 2.16
setVisible
:: (HasCallStack, MonadIO m, IsStatusIcon a) | |
=> a |
|
-> Bool | |
-> m () |
Deprecated: (Since version 3.14)Use notifications
Shows or hides a status icon.
Since: 2.10
Properties
embedded
getStatusIconEmbedded :: (MonadIO m, IsStatusIcon o) => o -> m Bool Source #
file
clearStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconFile :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
setStatusIconFile :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
gicon
clearStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconGicon :: (IsStatusIcon o, IsIcon a) => a -> IO (GValueConstruct o) Source #
getStatusIconGicon :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Icon) Source #
setStatusIconGicon :: (MonadIO m, IsStatusIcon o, IsIcon a) => o -> a -> m () Source #
hasTooltip
constructStatusIconHasTooltip :: IsStatusIcon o => Bool -> IO (GValueConstruct o) Source #
getStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> m Bool Source #
setStatusIconHasTooltip :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m () Source #
iconName
clearStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconIconName :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
getStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text) Source #
setStatusIconIconName :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
orientation
getStatusIconOrientation :: (MonadIO m, IsStatusIcon o) => o -> m Orientation Source #
pixbuf
clearStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconPixbuf :: (IsStatusIcon o, IsPixbuf a) => a -> IO (GValueConstruct o) Source #
getStatusIconPixbuf :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Pixbuf) Source #
setStatusIconPixbuf :: (MonadIO m, IsStatusIcon o, IsPixbuf a) => o -> a -> m () Source #
screen
constructStatusIconScreen :: (IsStatusIcon o, IsScreen a) => a -> IO (GValueConstruct o) Source #
getStatusIconScreen :: (MonadIO m, IsStatusIcon o) => o -> m Screen Source #
setStatusIconScreen :: (MonadIO m, IsStatusIcon o, IsScreen a) => o -> a -> m () Source #
size
getStatusIconSize :: (MonadIO m, IsStatusIcon o) => o -> m Int32 Source #
stock
clearStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconStock :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
getStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text) Source #
setStatusIconStock :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
storageType
getStatusIconStorageType :: (MonadIO m, IsStatusIcon o) => o -> m ImageType Source #
title
constructStatusIconTitle :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
getStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> m Text Source #
setStatusIconTitle :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
tooltipMarkup
clearStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m () Source #
constructStatusIconTooltipMarkup :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
getStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text) Source #
setStatusIconTooltipMarkup :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
tooltipText
constructStatusIconTooltipText :: IsStatusIcon o => Text -> IO (GValueConstruct o) Source #
getStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> m (Maybe Text) Source #
setStatusIconTooltipText :: (MonadIO m, IsStatusIcon o) => o -> Text -> m () Source #
visible
constructStatusIconVisible :: IsStatusIcon o => Bool -> IO (GValueConstruct o) Source #
getStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> m Bool Source #
setStatusIconVisible :: (MonadIO m, IsStatusIcon o) => o -> Bool -> m () Source #
Signals
activate
type StatusIconActivateCallback = IO () Source #
afterStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> StatusIconActivateCallback -> m SignalHandlerId Source #
mk_StatusIconActivateCallback :: C_StatusIconActivateCallback -> IO (FunPtr C_StatusIconActivateCallback) Source #
onStatusIconActivate :: (IsStatusIcon a, MonadIO m) => a -> StatusIconActivateCallback -> m SignalHandlerId Source #
wrap_StatusIconActivateCallback :: StatusIconActivateCallback -> Ptr () -> Ptr () -> IO () Source #
buttonPressEvent
type C_StatusIconButtonPressEventCallback = Ptr () -> Ptr EventButton -> Ptr () -> IO CInt Source #
type StatusIconButtonPressEventCallback = EventButton -> IO Bool Source #
afterStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonPressEventCallback -> m SignalHandlerId Source #
mk_StatusIconButtonPressEventCallback :: C_StatusIconButtonPressEventCallback -> IO (FunPtr C_StatusIconButtonPressEventCallback) Source #
onStatusIconButtonPressEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonPressEventCallback -> m SignalHandlerId Source #
wrap_StatusIconButtonPressEventCallback :: StatusIconButtonPressEventCallback -> Ptr () -> Ptr EventButton -> Ptr () -> IO CInt Source #
buttonReleaseEvent
type C_StatusIconButtonReleaseEventCallback = Ptr () -> Ptr EventButton -> Ptr () -> IO CInt Source #
type StatusIconButtonReleaseEventCallback = EventButton -> IO Bool Source #
afterStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonReleaseEventCallback -> m SignalHandlerId Source #
genClosure_StatusIconButtonReleaseEvent :: StatusIconButtonReleaseEventCallback -> IO Closure Source #
mk_StatusIconButtonReleaseEventCallback :: C_StatusIconButtonReleaseEventCallback -> IO (FunPtr C_StatusIconButtonReleaseEventCallback) Source #
onStatusIconButtonReleaseEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconButtonReleaseEventCallback -> m SignalHandlerId Source #
wrap_StatusIconButtonReleaseEventCallback :: StatusIconButtonReleaseEventCallback -> Ptr () -> Ptr EventButton -> Ptr () -> IO CInt Source #
popupMenu
afterStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> StatusIconPopupMenuCallback -> m SignalHandlerId Source #
mk_StatusIconPopupMenuCallback :: C_StatusIconPopupMenuCallback -> IO (FunPtr C_StatusIconPopupMenuCallback) Source #
onStatusIconPopupMenu :: (IsStatusIcon a, MonadIO m) => a -> StatusIconPopupMenuCallback -> m SignalHandlerId Source #
wrap_StatusIconPopupMenuCallback :: StatusIconPopupMenuCallback -> Ptr () -> Word32 -> Word32 -> Ptr () -> IO () Source #
queryTooltip
type C_StatusIconQueryTooltipCallback = Ptr () -> Int32 -> Int32 -> CInt -> Ptr Tooltip -> Ptr () -> IO CInt Source #
afterStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> StatusIconQueryTooltipCallback -> m SignalHandlerId Source #
mk_StatusIconQueryTooltipCallback :: C_StatusIconQueryTooltipCallback -> IO (FunPtr C_StatusIconQueryTooltipCallback) Source #
onStatusIconQueryTooltip :: (IsStatusIcon a, MonadIO m) => a -> StatusIconQueryTooltipCallback -> m SignalHandlerId Source #
wrap_StatusIconQueryTooltipCallback :: StatusIconQueryTooltipCallback -> Ptr () -> Int32 -> Int32 -> CInt -> Ptr Tooltip -> Ptr () -> IO CInt Source #
scrollEvent
type C_StatusIconScrollEventCallback = Ptr () -> Ptr EventScroll -> Ptr () -> IO CInt Source #
type StatusIconScrollEventCallback = EventScroll -> IO Bool Source #
afterStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconScrollEventCallback -> m SignalHandlerId Source #
mk_StatusIconScrollEventCallback :: C_StatusIconScrollEventCallback -> IO (FunPtr C_StatusIconScrollEventCallback) Source #
onStatusIconScrollEvent :: (IsStatusIcon a, MonadIO m) => a -> StatusIconScrollEventCallback -> m SignalHandlerId Source #
wrap_StatusIconScrollEventCallback :: StatusIconScrollEventCallback -> Ptr () -> Ptr EventScroll -> Ptr () -> IO CInt Source #
sizeChanged
afterStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> StatusIconSizeChangedCallback -> m SignalHandlerId Source #
mk_StatusIconSizeChangedCallback :: C_StatusIconSizeChangedCallback -> IO (FunPtr C_StatusIconSizeChangedCallback) Source #
onStatusIconSizeChanged :: (IsStatusIcon a, MonadIO m) => a -> StatusIconSizeChangedCallback -> m SignalHandlerId Source #
wrap_StatusIconSizeChangedCallback :: StatusIconSizeChangedCallback -> Ptr () -> Int32 -> Ptr () -> IO CInt Source #