Safe Haskell | None |
---|
- data AppIndicator
- class GObjectClass o => AppIndicatorClass o
- castToAppIndicator :: GObjectClass obj => obj -> AppIndicator
- gTypeAppIndicator :: GType
- toAppIndicator :: AppIndicatorClass o => o -> AppIndicator
- data AppIndicatorCategory
- data AppIndicatorStatus
- appIndicatorNew :: (GlibString id, GlibString iconName) => id -> iconName -> AppIndicatorCategory -> IO AppIndicator
- appIndicatorNewWithPath :: (GlibString id, GlibString iconName, GlibString iconThemePath) => id -> iconName -> AppIndicatorCategory -> iconThemePath -> IO AppIndicator
- appIndicatorBuildMenuFromDesktop :: (AppIndicatorClass self, GlibString desktopFile, GlibString desktopProfile) => self -> desktopFile -> desktopProfile -> IO ()
- appIndicatorGetMenu :: AppIndicatorClass self => self -> IO Menu
- appIndicatorSetMenu :: (AppIndicatorClass self, MenuClass menu) => self -> menu -> IO ()
- appIndicatorGetStatus :: AppIndicatorClass self => self -> IO AppIndicatorStatus
- appIndicatorSetStatus :: AppIndicatorClass self => self -> AppIndicatorStatus -> IO ()
- appIndicatorGetCategory :: AppIndicatorClass self => self -> IO AppIndicatorCategory
- appIndicatorAttentionIconDesc :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorAttentionIconName :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorCategory :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorConnected :: AppIndicatorClass self => ReadAttr self Bool
- appIndicatorIconDesc :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorIconName :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorIconThemePath :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorId :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorLabel :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorLabelGuide :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorOrderingIndex :: AppIndicatorClass self => Attr self Int
- appIndicatorStatus :: (AppIndicatorClass self, GlibString str) => Attr self (Maybe str)
- appIndicatorNewIcon :: AppIndicatorClass self => Signal self (IO ())
- appIndicatorNewAttentionIcon :: AppIndicatorClass self => Signal self (IO ())
- appIndicatorNewStatus :: (AppIndicatorClass self, GlibString str) => Signal self (str -> IO ())
- appIndicatorNewLabel :: (AppIndicatorClass self, GlibString label, GlibString guide) => Signal self (label -> guide -> IO ())
- appIndicatorConnectionChanged :: AppIndicatorClass self => Signal self (Bool -> IO ())
- appIndicatorNewIconThemePath :: (AppIndicatorClass self, GlibString str) => Signal self (str -> IO ())
- appIndicatorScrollEvent :: AppIndicatorClass self => Signal self (Int -> Int -> IO ())
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
class GObjectClass o => AppIndicatorClass o Source
castToAppIndicator :: GObjectClass obj => obj -> AppIndicatorSource
toAppIndicator :: AppIndicatorClass o => o -> AppIndicatorSource
data AppIndicatorCategory Source
The category of an AppIndicator
.
data AppIndicatorStatus Source
The status of an AppIndicator
.
Constructors
:: (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 |
-> IO AppIndicator | Returns the new |
Creates a new AppIndicator
object.
:: (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 |
-> iconThemePath | An additional place to look for icon names that may be installed by the application. |
-> IO AppIndicator | Returns the new |
Creates a new AppIndicator
object with an additional place to look for
icon names that may be installed by the application.
Methods
appIndicatorBuildMenuFromDesktopSource
:: (AppIndicatorClass self, GlibString desktopFile, GlibString desktopProfile) | |
=> self | The |
-> 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.
:: AppIndicatorClass self | |
=> self | The |
-> IO Menu | Returns the current |
Returns the current Menu
of the given AppIndicator
.
:: (AppIndicatorClass self, MenuClass menu) | |
=> self | The |
-> menu | The |
-> IO () |
Sets the Menu
of the given AppIndicator
.
:: AppIndicatorClass self | |
=> self | The |
-> IO AppIndicatorStatus | Returns the current |
Returns the current ApplicationStatus
of the given AppIndicator
.
:: AppIndicatorClass self | |
=> self | The |
-> AppIndicatorStatus | The |
-> IO () |
Sets the ApplicationStatus
of the given AppIndicator
.
:: AppIndicatorClass self | |
=> self | The |
-> IO AppIndicatorCategory | Returns the |
Returns the AppIndicatorCategory
of the given AppIndicator
.
Attributes
appIndicatorAttentionIconDescSource
:: (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.
appIndicatorAttentionIconNameSource
:: (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.
:: (AppIndicatorClass self, GlibString str) | |
=> Attr self (Maybe str) | The type of |
The type of AppIndicator
that this represents. Please don't use
"Other".
:: AppIndicatorClass self | |
=> ReadAttr self Bool |
|
Pretty simple, True
if we have a reasonable expectation of being
displayed through this object. You should hide your
StatusIcon
if so.
:: (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
.
:: (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
.
appIndicatorIconThemePathSource
:: (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.
:: (AppIndicatorClass self, GlibString str) | |
=> Attr self (Maybe str) | The ID for this |
The ID for this AppIndicator
, which should be unique, but used
consistently by this program and its AppIndicator
.
:: (AppIndicatorClass self, GlibString str) | |
=> Attr self (Maybe str) | A label that can be shown next to the string in
the |
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.
:: (AppIndicatorClass self, GlibString str) | |
=> Attr self (Maybe str) | An optional string to provide guidance to the
panel on how big the |
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.
appIndicatorOrderingIndexSource
:: 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 AppIndicator
s 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.
:: (AppIndicatorClass self, GlibString str) | |
=> Attr self (Maybe str) | The |
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.