Portability	portable (depends on GHC)
Stability	provisional
Maintainer	gtk2hs-users@lists.sourceforge.net
Safe Haskell	None

Graphics.UI.Gtk.Display.StatusIcon

Contents

Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals
Deprecated

Description

Display an icon in the system tray

Module available since Gtk+ version 2.10

Synopsis

Detail

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.org "System Tray" specification. Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications.

Note that a StatusIcon is not a widget, but just a GObject. Making it a widget would be impractical, since the system tray on Win32 doesn't allow to embed arbitrary widgets.

Class Hierarchy

 | GObject
 | +----StatusIcon

Types

data StatusIcon Source

Instances

Eq StatusIcon
Ord StatusIcon
GObjectClass StatusIcon
StatusIconClass StatusIcon
TooltipClass StatusIcon

class TooltipClass o => StatusIconClass o Source

Instances

StatusIconClass StatusIcon

castToStatusIcon :: GObjectClass obj => obj -> StatusIcon Source

gTypeStatusIcon :: GType Source

toStatusIcon :: StatusIconClass o => o -> StatusIcon Source

Constructors

statusIconNew :: IO StatusIcon Source

Creates an empty status icon object.

statusIconNewFromPixbuf Source

Arguments

:: Pixbuf	`pixbuf` - a `Pixbuf`
-> IO StatusIcon

Creates a status icon displaying pixbuf.

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

statusIconNewFromFile Source

Arguments

:: String	`filename` - a filename
-> IO StatusIcon

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.

statusIconNewFromStock Source

Arguments

:: StockId	`stockId` - a stock icon id
-> IO StatusIcon

statusIconNewFromIconName Source

Arguments

:: String	`iconName` - an icon name
-> IO StatusIcon

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.

Methods

statusIconSetFromPixbuf Source

Arguments

:: StatusIconClass self
=> self
-> Pixbuf	`pixbuf` - a `Pixbuf`
-> IO ()

Makes statusIcon display pixbuf. See statusIconNewFromPixbuf for details.

statusIconSetFromFile Source

Arguments

:: StatusIconClass self
=> self
-> String	`filename` - a filename
-> IO ()

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

statusIconSetFromStock Source

Arguments

:: StatusIconClass self
=> self
-> StockId	`stockId` - a stock icon id
-> IO ()

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

statusIconSetFromIconName Source

Arguments

:: StatusIconClass self
=> self
-> String	`iconName` - an icon name
-> IO ()

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

statusIconGetStorageType Source

Arguments

:: StatusIconClass self
=> self
-> IO ImageType	returns the image representation being used

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

statusIconGetPixbuf Source

Arguments

:: StatusIconClass self
=> self
-> IO (Maybe Pixbuf)	returns the displayed pixbuf, or `Nothing` if the image is empty.

statusIconGetStock Source

Arguments

:: StatusIconClass self
=> self
-> IO (Maybe StockId)	returns stock id of the displayed stock icon, or `Nothing` if the image is empty.

statusIconGetIconName Source

Arguments

:: StatusIconClass self
=> self
-> IO (Maybe String)	returns name of the displayed icon, or `Nothing` if the image is empty.

statusIconGetSize Source

Arguments

:: StatusIconClass self
=> self
-> IO Int	returns the size that is available for the image

Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the sizeChanged signal can be used to react to size changes.

statusIconSetTooltip Source

Arguments

:: StatusIconClass self
=> self
-> String	`tooltipText` - the tooltip text
-> IO ()

Sets the tooltip of the status icon.

statusIconSetVisible Source

Arguments

:: StatusIconClass self
=> self
-> Bool	`visible` - `True` to show the status icon, `False` to hide it
-> IO ()

Shows or hides a status icon.

statusIconGetVisible Source

Arguments

:: StatusIconClass self
=> self
-> IO Bool	returns `True` if the status icon is visible

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.

statusIconSetBlinking Source

Arguments

:: StatusIconClass self
=> self
-> Bool	`blinking` - `True` to turn blinking on, `False` to turn it off
-> IO ()

Makes the status icon start or stop blinking. Note that blinking user interface elements may be problematic for some users, and thus may be turned off, in which case this setting has no effect.

statusIconGetBlinking Source

Arguments

:: StatusIconClass self
=> self
-> IO Bool	returns `True` if the icon is blinking

Returns whether the icon is blinking, see statusIconSetBlinking.

statusIconIsEmbedded Source

Arguments

:: StatusIconClass self
=> self
-> IO Bool	returns `True` if the status icon is embedded in a notification area.

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

statusIconPositionMenu Source

Arguments

:: (MenuClass menu, StatusIconClass self)
=> menu	`menu` - the `Menu`
-> self	`userData` - the status icon to position the menu on
-> IO (Int, Int, Bool)	`(x,y,pushIn)` - `(x,y)` - coordinates. `pushIn` - whether the menu should be pushed in to be completely inside the screen instead of just clamped to the size to the screen.

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

statusIconGetGeometry :: StatusIconClass self => self -> IO (Maybe (Rectangle, Orientation))Source

Obtains information about the location of the status icon on screen. This information can be used to e.g. position popups like notification bubbles.

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.

statusIconSetName :: StatusIconClass self => self -> String -> IO ()Source

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.

Attributes

statusIconPixbuf :: StatusIconClass self => Attr self Pixbuf Source

A Pixbuf to display.

statusIconFile :: StatusIconClass self => WriteAttr self (Maybe String)Source

Filename to load and display.

Default value: Nothing

statusIconStock :: StatusIconClass self => Attr self (Maybe String)Source

Stock ID for a stock image to display.

Default value: Nothing

statusIconIconName :: StatusIconClass self => Attr self (Maybe String)Source

The name of the icon from the icon theme.

Default value: Nothing

statusIconStorageType :: StatusIconClass self => ReadAttr self ImageType Source

The representation being used for image data.

Default value: ImageEmpty

statusIconSize :: StatusIconClass self => ReadAttr self Int Source

The size of the icon.

Allowed values: >= 0

Default value: 0

statusIconBlinking :: StatusIconClass self => Attr self Bool Source

Whether or not the status icon is blinking.

Default value: False

statusIconVisible :: StatusIconClass self => Attr self Bool Source

Whether or not the status icon is visible.

Default value: True

Signals

statusIconSizeChanged :: StatusIconClass self => Signal self (Int -> IO Bool)Source

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

statusIconActivate :: StatusIconClass self => Signal self (IO ())Source

Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent.

statusIconPopupMenu :: StatusIconClass self => Signal self (Maybe MouseButton -> TimeStamp -> IO ())Source

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

Deprecated

onActivate :: StatusIconClass self => self -> IO () -> IO (ConnectId self)Source

Deprecated: instead of 'onActivate obj' use 'on obj activate'

afterActivate :: StatusIconClass self => self -> IO () -> IO (ConnectId self)Source

Deprecated: instead of 'afterActivate obj' use 'after obj activate'

onPopupMenu :: StatusIconClass self => self -> (Maybe MouseButton -> TimeStamp -> IO ()) -> IO (ConnectId self)Source

Deprecated: instead of 'onPopupMenu obj' use 'on obj popupMenu'

afterPopupMenu :: StatusIconClass self => self -> (Maybe MouseButton -> TimeStamp -> IO ()) -> IO (ConnectId self)Source

Deprecated: instead of 'afterPopupMenu obj' use 'after obj popupMenu'

onSizeChanged :: StatusIconClass self => self -> (Int -> IO Bool) -> IO (ConnectId self)Source

Deprecated: instead of 'onSizeChanged obj' use 'on obj sizeChanged'

afterSizeChanged :: StatusIconClass self => self -> (Int -> IO Bool) -> IO (ConnectId self)Source

Deprecated: instead of 'afterSizeChanged obj' use 'after obj sizeChanged'