Graphics.UI.AppIndicator

Detail

The applications indication area is used for menus that provide some kind of status about the system; there are several predefined menus (for example, relating to sound, mail), and additional ones can be added. On platforms not supporting this functionality, the library will fallback to using a status icon (see Graphics.UI.Gtk.Display.StatusIcon in the gtk package).

Class Hierarchy

 |  GObject
 |   +----AppIndicator

Types

data AppIndicator

Instances

Eq AppIndicator

Ord AppIndicator

GObjectClass AppIndicator

AppIndicatorClass AppIndicator

class GObjectClass o => AppIndicatorClass o

Instances

AppIndicatorClass AppIndicator

toAppIndicator :: AppIndicatorClass o => o -> AppIndicator

data AppIndicatorCategory

Represents the category of an Application Indicator.

Constructors

AppIndicatorCategoryApplicationStatus

AppIndicatorCategoryCommunications

AppIndicatorCategorySystemServices

AppIndicatorCategoryHardware

AppIndicatorCategoryOther

Instances

Bounded AppIndicatorCategory

Enum AppIndicatorCategory

Eq AppIndicatorCategory

Show AppIndicatorCategory

data AppIndicatorStatus

Represents the status of an Application Indicator.

Constructors

AppIndicatorStatusPassive

AppIndicatorStatusActive

AppIndicatorStatusAttention

Instances

Bounded AppIndicatorStatus

Enum AppIndicatorStatus

Eq AppIndicatorStatus

Show AppIndicatorStatus

Constructors

appIndicatorNew :: (GlibString id', GlibString iconName) => id' -> iconName -> AppIndicatorCategory -> IO AppIndicator

Creates an empty AppIndicator object, setting the properties: id with id, | category with category and icon-name with icon_name.

appIndicatorNewWithPath :: (GlibString id', GlibString iconName, GlibString iconThemePath) => id' -> iconName -> AppIndicatorCategory -> iconThemePath -> IO AppIndicator

Creates a new AppIndicator setting the properties: id with id, category | with category, icon-name with icon_name and icon-theme-path with | icon_theme_path.

Methods

appIndicatorBuildMenuFromDesktop :: (AppIndicatorClass self, GlibString desktopFile, GlibString desktopProfile) => self -> desktopFile -> desktopProfile -> IO ()

This function allows for building the Application Indicator menu from a static | desktop file.

appIndicatorGetMenu :: AppIndicatorClass self => self -> IO Menu

This function retrieves the Application Indicator menu.

appIndicatorSetMenu :: (AppIndicatorClass self, MenuClass menu) => self -> menu -> IO ()

This function sets the Application Indicator menu.

appIndicatorGetStatus :: AppIndicatorClass self => self -> IO AppIndicatorStatus

This function retrieves the current status of the Application Indicator.

appIndicatorSetStatus :: AppIndicatorClass self => self -> AppIndicatorStatus -> IO ()

This function set the status of the Application Indicator.

appIndicatorGetCategory :: AppIndicatorClass self => self -> IO AppIndicatorCategory

This function retrieves the category of the Application Indicator.

Attributes

appIndicatorAttentionIconDesc :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

If the indicator sets it's status to APP_INDICATOR_STATUS_ATTENTION then this textual description of the icon shown.

appIndicatorAttentionIconName :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

If the indicator sets it's status to APP_INDICATOR_STATUS_ATTENTION then this icon is shown.

appIndicatorCategory :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

The type of indicator that this represents. Please don't use Other. Defaults to ApplicationStatus.

appIndicatorConnected :: AppIndicatorClass self => ReadAttr self Bool

Pretty simple, TRUE if we have a reasonable expectation of being displayed through this object. You should hide your TrayIcon if so.

appIndicatorIconDesc :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

The description of the regular icon that is shown for the indicator.

appIndicatorIconName :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

The name of the regular icon that is shown for the indicator.

appIndicatorIconThemePath :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

An additional place to look for icon names that may be installed by the application.

appIndicatorId :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

The ID for this indicator, which should be unique, but used consistently by this program and its indicator.

appIndicatorLabel :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

A label that can be shown next to the string in the application indicator. The label will not be shown unless there is an icon as well. The label is useful for numerical and other frequently updated information. In general, it shouldn't be shown unless a user requests it as it can take up a significant amount of space on the user's panel. This may not be shown in all visualizations.

appIndicatorLabelGuide :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

An optional string to provide guidance to the panel on how big the label string could get. If this is set correctly then the panel should never jiggle as the string adjusts through out the range of options. For instance, if you were providing a percentage like 54% thrust in label you'd want to set this string to 100% thrust to ensure space when Scotty can get you enough power.

appIndicatorOrderingIndex :: AppIndicatorClass self => Attr self Int

The ordering index is an odd parameter, and if you think you don't need it you're probably right. In general, the application indicator try to place the applications in a recreatable place taking into account which category they're in to try and group them. But, there are some cases where you'd want to ensure indicators are next to each other. To do that you can override the generated ordering index and replace it with a new one. Again, you probably don't want to be doing this, but in case you do, this is the way.

appIndicatorStatus :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)

Whether the indicator is shown or requests attention. Defaults to Passive.

Signals

appIndicatorNewIcon :: AppIndicatorClass self => Signal self (IO ())

Emitted when icon-name is changed

appIndicatorNewAttentionIcon :: AppIndicatorClass self => Signal self (IO ())

Emitted when attention-icon-name is changed

appIndicatorNewStatus :: (AppIndicatorClass self, GlibString str) => Signal self (str -> IO ())

Emitted when status is changed

appIndicatorNewLabel :: (AppIndicatorClass self, GlibString label, GlibString guide) => Signal self (label -> guide -> IO ())

Emitted when either label or label-guide are changed.

appIndicatorConnectionChanged :: AppIndicatorClass self => Signal self (Bool -> IO ())

Emitted when we connect to a watcher, or when it drops away.

appIndicatorNewIconThemePath :: (AppIndicatorClass self, GlibString str) => Signal self (str -> IO ())

Emitted when there is a new icon set for the object.

appIndicatorScrollEvent :: AppIndicatorClass self => Signal self (Int -> Int -> IO ())

Emitted when the AppIndicator receives a scroll event.