GI.IBus.Objects.Property

An IBusProperty is an UI component like a button or a menu item which shows the status of corresponding input method engine property. End user can operate and see the current status of IME through these components. For example, ibus-chewing users change the English/Chinese input mode by pressing ctrl-space or click on the Eng/Chi switch button. And the IBusProperty shows the change correspondingly.

see_also: PropList, Engine

Exported types

newtype Property

Memory-managed wrapper type.

Constructors

Property (ManagedPtr Property)

Instances

Eq Property

Defined in GI.IBus.Objects.Property

Methods

(==) :: Property -> Property -> Bool

(/=) :: Property -> Property -> Bool

GObject Property

Defined in GI.IBus.Objects.Property

ManagedPtrNewtype Property

Defined in GI.IBus.Objects.Property

Methods

toManagedPtr :: Property -> ManagedPtr Property

TypedObject Property

Defined in GI.IBus.Objects.Property

Methods

glibType :: IO GType

HasParentTypes Property

Defined in GI.IBus.Objects.Property

IsGValue (Maybe Property)

Convert Property to and from GValue. See toGValue and fromGValue.

Defined in GI.IBus.Objects.Property

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Property -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Property)

type ParentTypes Property

Defined in GI.IBus.Objects.Property

type ParentTypes Property = '[Serializable, Object, Object]

class (GObject o, IsDescendantOf Property o) => IsProperty o

Type class for types which can be safely cast to Property, for instance with toProperty.

Instances

(GObject o, IsDescendantOf Property o) => IsProperty o

Defined in GI.IBus.Objects.Property

toProperty :: (MonadIO m, IsProperty o) => o -> m Property

Cast to Property, 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

Methods

bindProperty, bindPropertyFull, copy, destroy, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeQattachment, runDispose, serializeObject, stealData, stealQdata, thawNotify, unref, update, watchClosure.

Getters

getData, getIcon, getKey, getLabel, getPropType, getProperty, getQattachment, getQdata, getSensitive, getState, getSubProps, getSymbol, getTooltip, getVisible.

Setters

setData, setDataFull, setIcon, setLabel, setProperty, setQattachment, setSensitive, setState, setSubProps, setSymbol, setTooltip, setVisible.

getIcon

propertyGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Text

Returns: the icon of Property. Should not be freed.

Get the icon of Property.

getKey

propertyGetKey

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Text

Returns: the key of Property. Should not be freed.

Get the key of Property.

getLabel

propertyGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Text

Returns: the label of Property. Should not be freed.

Get the label of Property.

getPropType

propertyGetPropType :: (HasCallStack, MonadIO m, IsProperty a) => a -> m PropType

No description available in the introspection data.

getSensitive

propertyGetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Bool

Returns: the sensitive of Property.

Get the sensitive of Property.

getState

propertyGetState

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m PropState

Returns: the state of Property.

Get the state of Property.

getSubProps

propertyGetSubProps

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m PropList

Returns: the IBusPropList of Property. Should not be freed.

Get the IBusPropList of Property.

getSymbol

propertyGetSymbol

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Text

Returns: the symbol of Property. Should not be freed.

Get the symbol of Property.

getTooltip

propertyGetTooltip

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Text

Returns: the tooltip of Property. Should not be freed.

Get the tooltip of Property.

getVisible

propertyGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> m Bool

Returns: the visible of Property.

Get the visible of Property.

new

propertyNew

Arguments

:: (HasCallStack, MonadIO m, IsText a, IsText b, IsPropList c)

=> Text

key: Unique Identity for the Property.

-> PropType

type: PropType of Property.

-> a

label: Text shown in UI.

-> Maybe Text

icon: Icon file for the Property.

-> b

tooltip: Message shown if mouse hovered the Property.

-> Bool

sensitive: Whether the Property is sensitive to keyboard and mouse event.

-> Bool

visible: Whether the Property is visible.

-> PropState

state: IBusPropState of Property.

-> Maybe c

propList: PropList that contains sub IBusProperties.

-> m Property

Returns: A newly allocated Property.

Creates a new Property.

setIcon

propertySetIcon

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> Text

icon: Icon shown in UI. It could be a full path of an icon file or an icon name.

-> m ()

Set the icon of Property.

setLabel

propertySetLabel

Arguments

:: (HasCallStack, MonadIO m, IsProperty a, IsText b)

=> a

prop: An Property.

-> b

label: Text shown in UI.

-> m ()

Set the label of Property.

setSensitive

propertySetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> Bool

sensitive: Whether the Property is sensitive.

-> m ()

Set whether the Property is sensitive.

setState

propertySetState

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> PropState

state: The state of the Property.

-> m ()

Set the state of the Property.

setSubProps

propertySetSubProps

Arguments

:: (HasCallStack, MonadIO m, IsProperty a, IsPropList b)

=> a

prop: An Property.

-> b

propList: PropList that contains sub IBusProperties.

-> m ()

Set the sub IBusProperties.

setSymbol

propertySetSymbol

Arguments

:: (HasCallStack, MonadIO m, IsProperty a, IsText b)

=> a

prop: An Property.

-> b

symbol: Text shown in UI.

-> m ()

Set the symbol of Property.

setTooltip

propertySetTooltip

Arguments

:: (HasCallStack, MonadIO m, IsProperty a, IsText b)

=> a

prop: An Property.

-> b

tooltip: Text of the tooltip.

-> m ()

Set the tooltip of Property.

setVisible

propertySetVisible

Arguments

:: (HasCallStack, MonadIO m, IsProperty a)

=> a

prop: An Property.

-> Bool

visible: Whether the Property is visible.

-> m ()

Set whether the Property is visible.

update

propertyUpdate

Arguments

:: (HasCallStack, MonadIO m, IsProperty a, IsProperty b)

=> a

prop: An Property.

-> b

propUpdate: PropList that contains sub IBusProperties.

-> m Bool

Returns: TRUE if update succeeded; FALSE otherwise.

Update the content of an Property. Property propUpdate can either be sub-property of prop, or holds new values for prop.

Properties

icon

No description available in the introspection data.

constructPropertyIcon :: (IsProperty o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPropertyIcon :: (MonadIO m, IsProperty o) => o -> m Text

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

get property #icon

setPropertyIcon :: (MonadIO m, IsProperty o) => o -> Text -> m ()

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

set property [ #icon := value ]

key

No description available in the introspection data.

constructPropertyKey :: (IsProperty o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPropertyKey :: (MonadIO m, IsProperty o) => o -> m Text

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

get property #key

label

No description available in the introspection data.

constructPropertyLabel :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)

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

getPropertyLabel :: (MonadIO m, IsProperty o) => o -> m Text

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

get property #label

setPropertyLabel :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()

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

set property [ #label := value ]

propType

No description available in the introspection data.

constructPropertyPropType :: (IsProperty o, MonadIO m) => PropType -> m (GValueConstruct o)

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

getPropertyPropType :: (MonadIO m, IsProperty o) => o -> m PropType

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

get property #propType

sensitive

No description available in the introspection data.

constructPropertySensitive :: (IsProperty o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPropertySensitive :: (MonadIO m, IsProperty o) => o -> m Bool

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

get property #sensitive

setPropertySensitive :: (MonadIO m, IsProperty o) => o -> Bool -> m ()

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

set property [ #sensitive := value ]

state

No description available in the introspection data.

constructPropertyState :: (IsProperty o, MonadIO m) => PropState -> m (GValueConstruct o)

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

getPropertyState :: (MonadIO m, IsProperty o) => o -> m PropState

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

get property #state

setPropertyState :: (MonadIO m, IsProperty o) => o -> PropState -> m ()

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

set property [ #state := value ]

subProps

No description available in the introspection data.

constructPropertySubProps :: (IsProperty o, MonadIO m, IsPropList a) => a -> m (GValueConstruct o)

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

getPropertySubProps :: (MonadIO m, IsProperty o) => o -> m PropList

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

get property #subProps

setPropertySubProps :: (MonadIO m, IsProperty o, IsPropList a) => o -> a -> m ()

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

set property [ #subProps := value ]

symbol

No description available in the introspection data.

constructPropertySymbol :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)

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

getPropertySymbol :: (MonadIO m, IsProperty o) => o -> m Text

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

get property #symbol

setPropertySymbol :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()

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

set property [ #symbol := value ]

tooltip

No description available in the introspection data.

constructPropertyTooltip :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)

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

getPropertyTooltip :: (MonadIO m, IsProperty o) => o -> m Text

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

get property #tooltip

setPropertyTooltip :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()

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

set property [ #tooltip := value ]

visible

No description available in the introspection data.

constructPropertyVisible :: (IsProperty o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPropertyVisible :: (MonadIO m, IsProperty o) => o -> m Bool

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

get property #visible

setPropertyVisible :: (MonadIO m, IsProperty o) => o -> Bool -> m ()

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

set property [ #visible := value ]