Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.AyatanaAppIndicator3.Objects.Indicator

Contents

Exported types
Methods
Properties
Signals

Description

An application indicator 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.

Synopsis

newtype Indicator = Indicator (ManagedPtr Indicator)
class (GObject o, IsDescendantOf Indicator o) => IsIndicator o
toIndicator :: (MonadIO m, IsIndicator o) => o -> m Indicator
indicatorBuildMenuFromDesktop :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> Text -> m ()
indicatorGetAttentionIcon :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetAttentionIconDesc :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetCategory :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m IndicatorCategory
indicatorGetIcon :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetIconDesc :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetIconThemePath :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetId :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetLabel :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetLabelGuide :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorGetMenu :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Menu
indicatorGetOrderingIndex :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Word32
indicatorGetSecondaryActivateTarget :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Widget
indicatorGetStatus :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m IndicatorStatus
indicatorGetTitle :: (HasCallStack, MonadIO m, IsIndicator a) => a -> m Text
indicatorNew :: (HasCallStack, MonadIO m) => Text -> Text -> IndicatorCategory -> m Indicator
indicatorNewWithPath :: (HasCallStack, MonadIO m) => Text -> Text -> IndicatorCategory -> Text -> m Indicator
indicatorSetAttentionIcon :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> m ()
indicatorSetAttentionIconFull :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> Maybe Text -> m ()
indicatorSetIcon :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> m ()
indicatorSetIconFull :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> Maybe Text -> m ()
indicatorSetIconThemePath :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> m ()
indicatorSetLabel :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Text -> Text -> m ()
indicatorSetMenu :: (HasCallStack, MonadIO m, IsIndicator a, IsMenu b) => a -> Maybe b -> m ()
indicatorSetOrderingIndex :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Word32 -> m ()
indicatorSetSecondaryActivateTarget :: (HasCallStack, MonadIO m, IsIndicator a, IsWidget b) => a -> Maybe b -> m ()
indicatorSetStatus :: (HasCallStack, MonadIO m, IsIndicator a) => a -> IndicatorStatus -> m ()
indicatorSetTitle :: (HasCallStack, MonadIO m, IsIndicator a) => a -> Maybe Text -> m ()
clearIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorAttentionIconDesc :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
clearIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorAttentionIconName :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text)
setIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
constructIndicatorCategory :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorCategory :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text)
getIndicatorConnected :: (MonadIO m, IsIndicator o) => o -> m Bool
clearIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorIconDesc :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
clearIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorIconName :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text)
setIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
constructIndicatorIconThemePath :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorIconThemePath :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorIconThemePath :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
constructIndicatorId :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorId :: (MonadIO m, IsIndicator o) => o -> m Text
clearIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorLabel :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
clearIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorLabelGuide :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
constructIndicatorOrderingIndex :: (IsIndicator o, MonadIO m) => Word32 -> m (GValueConstruct o)
getIndicatorOrderingIndex :: (MonadIO m, IsIndicator o) => o -> m Word32
setIndicatorOrderingIndex :: (MonadIO m, IsIndicator o) => o -> Word32 -> m ()
clearIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorStatus :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text)
setIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
clearIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> m ()
constructIndicatorTitle :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o)
getIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> m Text
setIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> Text -> m ()
type IndicatorConnectionChangedCallback = Bool -> IO ()
afterIndicatorConnectionChanged :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorConnectionChangedCallback) -> m SignalHandlerId
onIndicatorConnectionChanged :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorConnectionChangedCallback) -> m SignalHandlerId
type IndicatorNewAttentionIconCallback = IO ()
afterIndicatorNewAttentionIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewAttentionIconCallback) -> m SignalHandlerId
onIndicatorNewAttentionIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewAttentionIconCallback) -> m SignalHandlerId
type IndicatorNewIconCallback = IO ()
afterIndicatorNewIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconCallback) -> m SignalHandlerId
onIndicatorNewIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconCallback) -> m SignalHandlerId
type IndicatorNewIconThemePathCallback = Text -> IO ()
afterIndicatorNewIconThemePath :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconThemePathCallback) -> m SignalHandlerId
onIndicatorNewIconThemePath :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconThemePathCallback) -> m SignalHandlerId
type IndicatorNewLabelCallback = Text -> Text -> IO ()
afterIndicatorNewLabel :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewLabelCallback) -> m SignalHandlerId
onIndicatorNewLabel :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewLabelCallback) -> m SignalHandlerId
type IndicatorNewStatusCallback = Text -> IO ()
afterIndicatorNewStatus :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewStatusCallback) -> m SignalHandlerId
onIndicatorNewStatus :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewStatusCallback) -> m SignalHandlerId
type IndicatorScrollEventCallback = Int32 -> ScrollDirection -> IO ()
afterIndicatorScrollEvent :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorScrollEventCallback) -> m SignalHandlerId
onIndicatorScrollEvent :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorScrollEventCallback) -> m SignalHandlerId

Exported types

newtype Indicator Source #

Memory-managed wrapper type.

Constructors

Indicator (ManagedPtr Indicator)

Instances

Instances details

Eq Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator Methods (==) :: Indicator -> Indicator -> Bool # (/=) :: Indicator -> Indicator -> Bool #
GObject Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator
ManagedPtrNewtype Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator Methods toManagedPtr :: Indicator -> ManagedPtr Indicator
TypedObject Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator Methods glibType :: IO GType
HasParentTypes Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator
IsGValue (Maybe Indicator) Source #	Convert `Indicator` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Indicator -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Indicator)
type ParentTypes Indicator Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator type ParentTypes Indicator = '[Object]

class (GObject o, IsDescendantOf Indicator o) => IsIndicator o Source #

Type class for types which can be safely cast to Indicator, for instance with toIndicator.

Instances

Instances details

(GObject o, IsDescendantOf Indicator o) => IsIndicator o Source #
Instance details Defined in GI.AyatanaAppIndicator3.Objects.Indicator

toIndicator :: (MonadIO m, IsIndicator o) => o -> m Indicator Source #

Cast to Indicator, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

buildMenuFromDesktop

indicatorBuildMenuFromDesktop Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`desktopFile`: A path to the desktop file to build the menu from
-> Text	`desktopProfile`: Which entries should be used from the desktop file
-> m ()

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

getAttentionIcon

indicatorGetAttentionIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current attention icon name.

Wrapper function for property Indicator:attentionIconName.

getAttentionIconDesc

indicatorGetAttentionIconDesc Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current attention icon description.

Wrapper function for property Indicator:attentionIconDesc.

getCategory

indicatorGetCategory Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m IndicatorCategory	Returns: The current category.

Wrapper function for property Indicator:category.

getIcon

indicatorGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current icon name.

Wrapper function for property Indicator:iconName.

getIconDesc

indicatorGetIconDesc Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current icon description.

Wrapper function for property Indicator:iconDesc.

getIconThemePath

indicatorGetIconThemePath Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current icon theme path.

Wrapper function for property Indicator:iconThemePath.

getId

indicatorGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current ID

Wrapper function for property Indicator:id.

getLabel

indicatorGetLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current label.

Wrapper function for property Indicator:label.

getLabelGuide

indicatorGetLabelGuide Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current label guide.

Wrapper function for property Indicator:labelGuide.

getMenu

indicatorGetMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Menu	Returns: A `Menu` object or `Nothing` if one hasn't been set.

Gets the menu being used for this application indicator. Wrapper function for property Indicator:menu.

getOrderingIndex

indicatorGetOrderingIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Word32	Returns: The current ordering index.

Wrapper function for property Indicator:orderingIndex.

getSecondaryActivateTarget

indicatorGetSecondaryActivateTarget Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Widget	Returns: A `Widget` object or `Nothing` if none has been set.

Gets the menuitem being called on secondary-activate event.

getStatus

indicatorGetStatus Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m IndicatorStatus	Returns: The current status.

Wrapper function for property Indicator:status.

getTitle

indicatorGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> m Text	Returns: The current title.

Gets the title of the application indicator. See the function indicatorSetTitle for information on the title.

Since: 0.5

new

indicatorNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`id`: The unique id of the indicator to create.
-> Text	`iconName`: The icon name for this indicator
-> IndicatorCategory	`category`: The category of indicator.
-> m Indicator	Returns: A pointer to a new `Indicator` object.

Creates a new Indicator setting the properties: Indicator:id with id, Indicator:category with category and Indicator:iconName with iconName.

newWithPath

indicatorNewWithPath Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`id`: The unique id of the indicator to create.
-> Text	`iconName`: The icon name for this indicator
-> IndicatorCategory	`category`: The category of indicator.
-> Text	`iconThemePath`: A custom path for finding icons.
-> m Indicator	Returns: A pointer to a new `Indicator` object.

Creates a new Indicator setting the properties: Indicator:id with id, Indicator:category with category, Indicator:iconName with iconName and Indicator:iconThemePath with iconThemePath.

setAttentionIcon

indicatorSetAttentionIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`iconName`: The name of the attention icon to set for this indicator
-> m ()

Deprecated: Use indicatorSetAttentionIconFull instead.

Wrapper for indicatorSetAttentionIconFull with a NULL description.

setAttentionIconFull

indicatorSetAttentionIconFull Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`iconName`: The name of the attention icon to set for this indicator
-> Maybe Text	`iconDesc`: A textual description of the icon
-> m ()

Wrapper function for property Indicator:attentionIconName.

setIcon

indicatorSetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`iconName`: The icon name to set.
-> m ()

Deprecated: Use indicatorSetIconFull

Wrapper function for indicatorSetIconFull with a NULL description.

setIconFull

indicatorSetIconFull Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`iconName`: The icon name to set.
-> Maybe Text	`iconDesc`: A textual description of the icon for accessibility
-> m ()

Sets the default icon to use when the status is active but not set to attention. In most cases, this should be the application icon for the program.

Wrapper function for property Indicator:iconName and Indicator::icon-desc.

setIconThemePath

indicatorSetIconThemePath Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`iconThemePath`: The icon theme path to set.
-> m ()

Sets the path to use when searching for icons.

setLabel

indicatorSetLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> Text	`label`: The label to show next to the icon.
-> Text	`guide`: A guide to size the label correctly.
-> m ()

This is a wrapper function for the Indicator:label and Indicator:guide properties. This function can take NULL as either label or guide and will clear the entries.

setMenu

indicatorSetMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a, IsMenu b)
=> a	`self`: The `Indicator`
-> Maybe b	`menu`: A `Menu` to set
-> m ()

Sets the menu that should be shown when the Application Indicator is clicked on in the panel. An application indicator will not be rendered unless it has a menu.

Wrapper function for property Indicator:menu.

setOrderingIndex

indicatorSetOrderingIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator`
-> Word32	`orderingIndex`: A value for the ordering of this app indicator
-> m ()

Sets the ordering index for the app indicator which effects the placement of it on the panel. For almost all app indicator this is not the function you're looking for.

Wrapper function for property Indicator:orderingIndex.

setSecondaryActivateTarget

indicatorSetSecondaryActivateTarget Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a, IsWidget b)
=> a	`self`: The `Indicator`
-> Maybe b	`menuitem`: A `Widget` to be activated on secondary activation
-> m ()

Set the menuitem to be activated when a secondary activation event (i.e. a middle-click) is emitted over the Indicator icon/label.

The menuitem can be also a complex Widget, but to get activated when a secondary activation occurs in the Appindicator, it must be a visible and active child (or inner-child) of the Indicator:menu.

Setting menuitem to Nothing causes to disable this feature.

setStatus

indicatorSetStatus Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator` object to use
-> IndicatorStatus	`status`: The status to set for this indicator
-> m ()

Wrapper function for property Indicator:status.

setTitle

indicatorSetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsIndicator a)
=> a	`self`: The `Indicator`
-> Maybe Text	`title`: Title of the app indicator
-> m ()

Sets the title of the application indicator, or how it should be referred in a human readable form. This string should be UTF-8 and localized as it expected that users will set it.

In the Unity desktop the most prominent place that this is show will be in the HUD. HUD listings for this application indicator will start with the title as the first part of the line for the menu items.

Setting title to Nothing removes the title.

Since: 0.5

Properties

attentionIconDesc

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

clearIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “attention-icon-desc” property to Nothing. When overloading is enabled, this is equivalent to

clear #attentionIconDesc

constructIndicatorAttentionIconDesc :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “attention-icon-desc” property. This is rarely needed directly, but it is used by new.

getIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “attention-icon-desc” property. When overloading is enabled, this is equivalent to

get indicator #attentionIconDesc

setIndicatorAttentionIconDesc :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “attention-icon-desc” property. When overloading is enabled, this is equivalent to

set indicator [ #attentionIconDesc := value ]

attentionIconName

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

clearIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “attention-icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #attentionIconName

constructIndicatorAttentionIconName :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “attention-icon-name” property. This is rarely needed directly, but it is used by new.

getIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text) Source #

Get the value of the “attention-icon-name” property. When overloading is enabled, this is equivalent to

get indicator #attentionIconName

setIndicatorAttentionIconName :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “attention-icon-name” property. When overloading is enabled, this is equivalent to

set indicator [ #attentionIconName := value ]

connected

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

getIndicatorConnected :: (MonadIO m, IsIndicator o) => o -> m Bool Source #

Get the value of the “connected” property. When overloading is enabled, this is equivalent to

get indicator #connected

iconDesc

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

clearIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “icon-desc” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconDesc

constructIndicatorIconDesc :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon-desc” property. This is rarely needed directly, but it is used by new.

getIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “icon-desc” property. When overloading is enabled, this is equivalent to

get indicator #iconDesc

setIndicatorIconDesc :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “icon-desc” property. When overloading is enabled, this is equivalent to

set indicator [ #iconDesc := value ]

iconName

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

clearIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructIndicatorIconName :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon-name” property. This is rarely needed directly, but it is used by new.

getIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text) Source #

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get indicator #iconName

setIndicatorIconName :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “icon-name” property. When overloading is enabled, this is equivalent to

set indicator [ #iconName := value ]

iconThemePath

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

constructIndicatorIconThemePath :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon-theme-path” property. This is rarely needed directly, but it is used by new.

getIndicatorIconThemePath :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “icon-theme-path” property. When overloading is enabled, this is equivalent to

get indicator #iconThemePath

setIndicatorIconThemePath :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “icon-theme-path” property. When overloading is enabled, this is equivalent to

set indicator [ #iconThemePath := value ]

id

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

constructIndicatorId :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “id” property. This is rarely needed directly, but it is used by new.

getIndicatorId :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “id” property. When overloading is enabled, this is equivalent to

get indicator #id

label

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.

clearIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “label” property to Nothing. When overloading is enabled, this is equivalent to

clear #label

constructIndicatorLabel :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

getIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get indicator #label

setIndicatorLabel :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set indicator [ #label := value ]

labelGuide

An optional string to provide guidance to the panel on how big the Indicator: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 Indicator:label you'd want to set this string to "100% thrust" to ensure space when Scotty can get you enough power.

clearIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “label-guide” property to Nothing. When overloading is enabled, this is equivalent to

clear #labelGuide

constructIndicatorLabelGuide :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “label-guide” property. This is rarely needed directly, but it is used by new.

getIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “label-guide” property. When overloading is enabled, this is equivalent to

get indicator #labelGuide

setIndicatorLabelGuide :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “label-guide” property. When overloading is enabled, this is equivalent to

set indicator [ #labelGuide := value ]

orderingIndex

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.

constructIndicatorOrderingIndex :: (IsIndicator o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “ordering-index” property. This is rarely needed directly, but it is used by new.

getIndicatorOrderingIndex :: (MonadIO m, IsIndicator o) => o -> m Word32 Source #

Get the value of the “ordering-index” property. When overloading is enabled, this is equivalent to

get indicator #orderingIndex

setIndicatorOrderingIndex :: (MonadIO m, IsIndicator o) => o -> Word32 -> m () Source #

Set the value of the “ordering-index” property. When overloading is enabled, this is equivalent to

set indicator [ #orderingIndex := value ]

status

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

clearIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “status” property to Nothing. When overloading is enabled, this is equivalent to

clear #status

constructIndicatorStatus :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “status” property. This is rarely needed directly, but it is used by new.

getIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> m (Maybe Text) Source #

Get the value of the “status” property. When overloading is enabled, this is equivalent to

get indicator #status

setIndicatorStatus :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “status” property. When overloading is enabled, this is equivalent to

set indicator [ #status := value ]

title

Provides a way to refer to this application indicator in a human readable form. This is used in the Unity desktop in the HUD as the first part of the menu entries to distinguish them from the focused application's entries.

clearIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> m () Source #

Set the value of the “title” property to Nothing. When overloading is enabled, this is equivalent to

clear #title

constructIndicatorTitle :: (IsIndicator o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> m Text Source #

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get indicator #title

setIndicatorTitle :: (MonadIO m, IsIndicator o) => o -> Text -> m () Source #

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set indicator [ #title := value ]

Signals

connectionChanged

type IndicatorConnectionChangedCallback Source #

Arguments

= Bool	`arg1`: Whether we're connected or not
-> IO ()

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

afterIndicatorConnectionChanged :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorConnectionChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the connectionChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #connectionChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorConnectionChanged :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorConnectionChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the connectionChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #connectionChanged callback

newAttentionIcon

type IndicatorNewAttentionIconCallback = IO () Source #

Emitted when Indicator:attentionIconName is changed

afterIndicatorNewAttentionIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewAttentionIconCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newAttentionIcon signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #newAttentionIcon callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorNewAttentionIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewAttentionIconCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newAttentionIcon signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #newAttentionIcon callback

newIcon

type IndicatorNewIconCallback = IO () Source #

when Indicator:iconName is changed

afterIndicatorNewIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newIcon signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #newIcon callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorNewIcon :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newIcon signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #newIcon callback

newIconThemePath

type IndicatorNewIconThemePathCallback Source #

Arguments

= Text	`arg1`: The icon theme path
-> IO ()

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

afterIndicatorNewIconThemePath :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconThemePathCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newIconThemePath signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #newIconThemePath callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorNewIconThemePath :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewIconThemePathCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newIconThemePath signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #newIconThemePath callback

newLabel

type IndicatorNewLabelCallback Source #

Arguments

= Text	`arg1`: The string for the label
-> Text	`arg2`: The string for the guide
-> IO ()

Emitted when either Indicator:label or Indicator:labelGuide are changed.

afterIndicatorNewLabel :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewLabelCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newLabel signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #newLabel callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorNewLabel :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewLabelCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newLabel signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #newLabel callback

newStatus

type IndicatorNewStatusCallback Source #

Arguments

= Text	`arg1`: The string value of the `IndicatorStatus` enum.
-> IO ()

Emitted when Indicator:status is changed

afterIndicatorNewStatus :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewStatusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newStatus signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #newStatus callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorNewStatus :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorNewStatusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the newStatus signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #newStatus callback

scrollEvent

type IndicatorScrollEventCallback Source #

Arguments

= Int32	`arg1`: How many steps the scroll wheel has taken
-> ScrollDirection	`arg2`: Which direction the wheel went in
-> IO ()

Signaled when the Indicator receives a scroll event.

afterIndicatorScrollEvent :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorScrollEventCallback) -> m SignalHandlerId Source #

Connect a signal handler for the scrollEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after indicator #scrollEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onIndicatorScrollEvent :: (IsIndicator a, MonadIO m) => a -> ((?self :: a) => IndicatorScrollEventCallback) -> m SignalHandlerId Source #

Connect a signal handler for the scrollEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on indicator #scrollEvent callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

buildMenuFromDesktop

getAttentionIcon

getAttentionIconDesc

getCategory

getIcon

getIconDesc

getIconThemePath

getId

getLabel

getLabelGuide

getMenu

getOrderingIndex

getSecondaryActivateTarget

getStatus

getTitle

new

newWithPath

setAttentionIcon

setAttentionIconFull

setIcon

setIconFull

setIconThemePath

setLabel

setMenu

setOrderingIndex

setSecondaryActivateTarget

setStatus

setTitle

Properties

attentionIconDesc

attentionIconName

category

connected

iconDesc

iconName

iconThemePath

id

label

labelGuide

orderingIndex

status

title

Signals

connectionChanged

newAttentionIcon

newIcon

newIconThemePath

newLabel

newStatus

scrollEvent