Safe Haskell	None

Graphics.UI.AppIndicator

Contents

Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals

Synopsis

Detail

An AppIndicator represents the values that are needed to show a unique status in the panel for an application. In general, applications should try to fit in the other indicators that are available on the panel before using this. But, sometimes it is necissary.

Class Hierarchy

 |  GObject
 |   +----AppIndicator

Types

data AppIndicator Source

Instances

Eq AppIndicator
Ord AppIndicator
GObjectClass AppIndicator
AppIndicatorClass AppIndicator

class GObjectClass o => AppIndicatorClass o Source

Instances

AppIndicatorClass AppIndicator

castToAppIndicator :: GObjectClass obj => obj -> AppIndicator Source

gTypeAppIndicator :: GType Source

toAppIndicator :: AppIndicatorClass o => o -> AppIndicator Source

data AppIndicatorCategory Source

The category of an AppIndicator.

Constructors

AppIndicatorCategoryApplicationStatus
AppIndicatorCategoryCommunications
AppIndicatorCategorySystemServices
AppIndicatorCategoryHardware
AppIndicatorCategoryOther

Instances

Bounded AppIndicatorCategory
Enum AppIndicatorCategory
Eq AppIndicatorCategory
Show AppIndicatorCategory

data AppIndicatorStatus Source

The status of an AppIndicator.

Constructors

AppIndicatorStatusPassive
AppIndicatorStatusActive
AppIndicatorStatusAttention

Instances

Bounded AppIndicatorStatus
Enum AppIndicatorStatus
Eq AppIndicatorStatus
Show AppIndicatorStatus

Constructors

appIndicatorNew Source

Arguments

:: (GlibString id, GlibString iconName)
=> id	The ID for this indicator, which should be unique, but used consistently by this program and its indicator.
-> iconName	The name of the regular icon that is shown for the indicator.
-> AppIndicatorCategory	The type of `AppIndicator` that this represents. Please don't use `AppIndicatorCategoryOther`.
-> IO AppIndicator	Returns the new `AppIndicator`.

Creates a new AppIndicator object.

appIndicatorNewWithPath Source

Arguments

:: (GlibString id, GlibString iconName, GlibString iconThemePath)
=> id	The ID for this indicator, which should be unique, but used consistently by this program and its indicator.
-> iconName	The name of the regular icon that is shown for the indicator.
-> AppIndicatorCategory	The type of indicator that this represents. Please don't use `AppIndicatorCategoryOther`.
-> iconThemePath	An additional place to look for icon names that may be installed by the application.
-> IO AppIndicator	Returns the new `AppIndicator`.

Creates a new AppIndicator object with an additional place to look for icon names that may be installed by the application.

Methods

appIndicatorBuildMenuFromDesktop Source

Arguments

:: (AppIndicatorClass self, GlibString desktopFile, GlibString desktopProfile)
=> self	The `AppIndicator` being operated on.
-> desktopFile	The path to the desktop file.
-> desktopProfile	The name used by the "OnlyShowIn" sections of the desktop file.
-> IO ()

Updates an AppIndicator based on the specification of a provided desktop file and associated desktop profile that determines which actions are available.

This should rarely be used, and only with a freedesktop.org compliant desktop.

appIndicatorGetMenu Source

Arguments

:: AppIndicatorClass self
=> self	The `AppIndicator` being operated on.
-> IO Menu	Returns the current `Menu` of the given `AppIndicator`.

Returns the current Menu of the given AppIndicator.

appIndicatorSetMenu Source

Arguments

:: (AppIndicatorClass self, MenuClass menu)
=> self	The `AppIndicator` being operated on.
-> menu	The `Menu` being set.
-> IO ()

Sets the Menu of the given AppIndicator.

appIndicatorGetStatus Source

Arguments

:: AppIndicatorClass self
=> self	The `AppIndicator` being operated on.
-> IO AppIndicatorStatus	Returns the current `ApplicationStatus` of the given `AppIndicator`.

Returns the current ApplicationStatus of the given AppIndicator.

appIndicatorSetStatus Source

Arguments

:: AppIndicatorClass self
=> self	The `AppIndicator` being operated on.
-> AppIndicatorStatus	The `ApplicationStatus` being set.
-> IO ()

Sets the ApplicationStatus of the given AppIndicator.

appIndicatorGetCategory Source

Arguments

:: AppIndicatorClass self
=> self	The `AppIndicator` being operated on.
-> IO AppIndicatorCategory	Returns the `AppIndicatorCategory` of the given `AppIndicator`.

Returns the AppIndicatorCategory of the given AppIndicator.

Attributes

appIndicatorAttentionIconDesc Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The textual description of the icon being shown.

If the AppIndicator sets its AppIndicatorStatus to AppIndicatorStatusAttention, then this textual description of the icon is shown.

appIndicatorAttentionIconName Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The icon being shown.

If the AppIndicator sets its AppIndicatorStatus to AppIndicatorStatusAttention, then this icon is shown.

appIndicatorCategory Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The type of `AppIndicator` that this represents.

The type of AppIndicator that this represents. Please don't use "Other".

appIndicatorConnected Source

Arguments

:: AppIndicatorClass self
=> ReadAttr self Bool	`True` if we have a reasonable expectation of being displayed.

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

appIndicatorIconDesc Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The description of the regular icon that is shown.

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

appIndicatorIconName Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The name of the regular icon that is shown.

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

appIndicatorIconThemePath Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	Path to an additional place to look for icon names that may be installed by the application.

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

appIndicatorId Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The ID for this `AppIndicator`.

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

appIndicatorLabel Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	A label that can be shown next to the string in the `AppIndicator`.

A label that can be shown next to the string in the AppIndicator. 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 Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	An optional string to provide guidance to the panel on how big the `appIndicatorLabel` string could get.

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

appIndicatorOrderingIndex Source

Arguments

:: AppIndicatorClass self
=> Attr self Int	Overrides the generated ordering index and replaces it with a new one.

The ordering index is an odd parameter, and if you think you don't need it, you're probably right. In general, the AppIndicator tries to place the applications in a recreatable place taking into account which AppIndicatorCategory they're in to try and group them. But, there are some cases where you'd want to ensure AppIndicators 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 Source

Arguments

:: (AppIndicatorClass self, GlibString str)
=> Attr self (Maybe str)	The `AppIndicator` status.

Whether the AppIndicator is shown or requests attention. Defaults to "Passive".

Signals

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

Emitted when appIndicatorIconName is changed.

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

Emitted when appIndicatorAttentionIconName is changed.

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

Emitted when appIndicatorStatus is changed.

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

Emitted when either appIndicatorLabel or appIndicatorLabelGuide are changed.

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

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

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

Emitted when the appIndicatorIconThemePath is changed.

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

Emitted when the AppIndicator receives a scroll event.