Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- newtype Property = Property (ManagedPtr Property)
- class (GObject o, IsDescendantOf Property o) => IsProperty o
- toProperty :: (MonadIO m, IsProperty o) => o -> m Property
- propertyGetIcon :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Text
- propertyGetKey :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Text
- propertyGetLabel :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Text
- propertyGetPropType :: (HasCallStack, MonadIO m, IsProperty a) => a -> m PropType
- propertyGetSensitive :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Bool
- propertyGetState :: (HasCallStack, MonadIO m, IsProperty a) => a -> m PropState
- propertyGetSubProps :: (HasCallStack, MonadIO m, IsProperty a) => a -> m PropList
- propertyGetSymbol :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Text
- propertyGetTooltip :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Text
- propertyGetVisible :: (HasCallStack, MonadIO m, IsProperty a) => a -> m Bool
- propertyNew :: (HasCallStack, MonadIO m, IsText a, IsText b, IsPropList c) => Text -> PropType -> a -> Maybe Text -> b -> Bool -> Bool -> PropState -> Maybe c -> m Property
- propertySetIcon :: (HasCallStack, MonadIO m, IsProperty a) => a -> Text -> m ()
- propertySetLabel :: (HasCallStack, MonadIO m, IsProperty a, IsText b) => a -> b -> m ()
- propertySetSensitive :: (HasCallStack, MonadIO m, IsProperty a) => a -> Bool -> m ()
- propertySetState :: (HasCallStack, MonadIO m, IsProperty a) => a -> PropState -> m ()
- propertySetSubProps :: (HasCallStack, MonadIO m, IsProperty a, IsPropList b) => a -> b -> m ()
- propertySetSymbol :: (HasCallStack, MonadIO m, IsProperty a, IsText b) => a -> b -> m ()
- propertySetTooltip :: (HasCallStack, MonadIO m, IsProperty a, IsText b) => a -> b -> m ()
- propertySetVisible :: (HasCallStack, MonadIO m, IsProperty a) => a -> Bool -> m ()
- propertyUpdate :: (HasCallStack, MonadIO m, IsProperty a, IsProperty b) => a -> b -> m Bool
- constructPropertyIcon :: (IsProperty o, MonadIO m) => Text -> m (GValueConstruct o)
- getPropertyIcon :: (MonadIO m, IsProperty o) => o -> m Text
- setPropertyIcon :: (MonadIO m, IsProperty o) => o -> Text -> m ()
- constructPropertyKey :: (IsProperty o, MonadIO m) => Text -> m (GValueConstruct o)
- getPropertyKey :: (MonadIO m, IsProperty o) => o -> m Text
- constructPropertyLabel :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)
- getPropertyLabel :: (MonadIO m, IsProperty o) => o -> m Text
- setPropertyLabel :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()
- constructPropertyPropType :: (IsProperty o, MonadIO m) => PropType -> m (GValueConstruct o)
- getPropertyPropType :: (MonadIO m, IsProperty o) => o -> m PropType
- constructPropertySensitive :: (IsProperty o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPropertySensitive :: (MonadIO m, IsProperty o) => o -> m Bool
- setPropertySensitive :: (MonadIO m, IsProperty o) => o -> Bool -> m ()
- constructPropertyState :: (IsProperty o, MonadIO m) => PropState -> m (GValueConstruct o)
- getPropertyState :: (MonadIO m, IsProperty o) => o -> m PropState
- setPropertyState :: (MonadIO m, IsProperty o) => o -> PropState -> m ()
- constructPropertySubProps :: (IsProperty o, MonadIO m, IsPropList a) => a -> m (GValueConstruct o)
- getPropertySubProps :: (MonadIO m, IsProperty o) => o -> m PropList
- setPropertySubProps :: (MonadIO m, IsProperty o, IsPropList a) => o -> a -> m ()
- constructPropertySymbol :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)
- getPropertySymbol :: (MonadIO m, IsProperty o) => o -> m Text
- setPropertySymbol :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()
- constructPropertyTooltip :: (IsProperty o, MonadIO m, IsText a) => a -> m (GValueConstruct o)
- getPropertyTooltip :: (MonadIO m, IsProperty o) => o -> m Text
- setPropertyTooltip :: (MonadIO m, IsProperty o, IsText a) => o -> a -> m ()
- constructPropertyVisible :: (IsProperty o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPropertyVisible :: (MonadIO m, IsProperty o) => o -> m Bool
- setPropertyVisible :: (MonadIO m, IsProperty o) => o -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Property Source # | |
GObject Property Source # | |
Defined in GI.IBus.Objects.Property | |
ManagedPtrNewtype Property Source # | |
Defined in GI.IBus.Objects.Property toManagedPtr :: Property -> ManagedPtr Property | |
TypedObject Property Source # | |
Defined in GI.IBus.Objects.Property | |
HasParentTypes Property Source # | |
Defined in GI.IBus.Objects.Property | |
IsGValue (Maybe Property) Source # | Convert |
Defined in GI.IBus.Objects.Property gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Property -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Property) | |
type ParentTypes Property Source # | |
Defined in GI.IBus.Objects.Property |
class (GObject o, IsDescendantOf Property o) => IsProperty o Source #
Type class for types which can be safely cast to Property
, for instance with toProperty
.
Instances
(GObject o, IsDescendantOf Property o) => IsProperty o Source # | |
Defined in GI.IBus.Objects.Property |
toProperty :: (MonadIO m, IsProperty o) => o -> m Property Source #
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
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Text | Returns: the icon of |
Get the icon of Property
.
getKey
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Text | Returns: the key of |
Get the key of Property
.
getLabel
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Text | Returns: the label of |
Get the label of Property
.
getPropType
propertyGetPropType :: (HasCallStack, MonadIO m, IsProperty a) => a -> m PropType Source #
No description available in the introspection data.
getSensitive
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Bool | Returns: the sensitive of |
Get the sensitive of Property
.
getState
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m PropState | Returns: the state of |
Get the state of Property
.
getSubProps
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m PropList | Returns: the IBusPropList of |
Get the IBusPropList of Property
.
getSymbol
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Text | Returns: the symbol of |
Get the symbol of Property
.
getTooltip
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Text | Returns: the tooltip of |
Get the tooltip of Property
.
getVisible
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> m Bool | Returns: the visible of |
Get the visible of Property
.
new
:: (HasCallStack, MonadIO m, IsText a, IsText b, IsPropList c) | |
=> Text |
|
-> PropType | |
-> a |
|
-> Maybe Text |
|
-> b |
|
-> Bool |
|
-> Bool |
|
-> PropState |
|
-> Maybe c |
|
-> m Property | Returns: A newly allocated |
Creates a new Property
.
setIcon
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> Text |
|
-> m () |
Set the icon of Property
.
setLabel
:: (HasCallStack, MonadIO m, IsProperty a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Set the label of Property
.
setSensitive
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether the Property
is sensitive.
setState
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> PropState |
|
-> m () |
Set the state of the Property
.
setSubProps
:: (HasCallStack, MonadIO m, IsProperty a, IsPropList b) | |
=> a |
|
-> b |
|
-> m () |
Set the sub IBusProperties.
setSymbol
:: (HasCallStack, MonadIO m, IsProperty a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Set the symbol of Property
.
setTooltip
:: (HasCallStack, MonadIO m, IsProperty a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Set the tooltip of Property
.
setVisible
:: (HasCallStack, MonadIO m, IsProperty a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether the Property
is visible.
update
:: (HasCallStack, MonadIO m, IsProperty a, IsProperty b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: TRUE if update succeeded; FALSE otherwise. |
Properties
icon
No description available in the introspection data.
constructPropertyIcon :: (IsProperty o, MonadIO m) => Text -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “visible
” property.
When overloading is enabled, this is equivalent to
set
property [ #visible:=
value ]