| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.PropertyAction
Contents
Description
A PropertyAction is a way to get a Action with a state value
reflecting and controlling the value of a Object property.
The state of the action will correspond to the value of the property.
Changing it will change the property (assuming the requested value
matches the requirements as specified in the ParamSpec).
Only the most common types are presently supported. Booleans are mapped to booleans, strings to strings, signed/unsigned integers to int32/uint32 and floats and doubles to doubles.
If the property is an enum then the state will be string-typed and
conversion will automatically be performed between the enum value and
"nick" string as per the EnumValue table.
Flags types are not currently supported.
Properties of object types, boxed types and pointer types are not supported and probably never will be.
Properties of GVariant types are not currently supported.
If the property is boolean-valued then the action will have a NULL parameter type, and activating the action (with no parameter) will toggle the value of the property.
In all other cases, the parameter type will correspond to the type of the property.
The general idea here is to reduce the number of locations where a
particular piece of state is kept (and therefore has to be synchronised
between). PropertyAction does not have a separate state that is kept
in sync with the property value -- its state is the property value.
For example, it might be useful to create a Action corresponding to
the "visible-child-name" property of a GtkStack so that the current
page can be switched from a menu. The active radio indication in the
menu is then directly determined from the active page of the
GtkStack.
An anti-example would be binding the "active-id" property on a
GtkComboBox. This is because the state of the combobox itself is
probably uninteresting and is actually being used to control
something else.
Another anti-example would be to bind to the "visible-child-name"
property of a GtkStack if this value is actually stored in
Settings. In that case, the real source of the value is
Settings. If you want a Action to control a setting stored in
Settings, see settingsCreateAction instead, and possibly
combine its use with settingsBind.
- newtype PropertyAction = PropertyAction (ManagedPtr PropertyAction)
- class GObject o => IsPropertyAction o
- toPropertyAction :: IsPropertyAction o => o -> IO PropertyAction
- noPropertyAction :: Maybe PropertyAction
- propertyActionNew :: (HasCallStack, MonadIO m, IsObject a) => Text -> a -> Text -> m PropertyAction
- data PropertyActionEnabledPropertyInfo
- getPropertyActionEnabled :: (MonadIO m, IsPropertyAction o) => o -> m Bool
- propertyActionEnabled :: AttrLabelProxy "enabled"
- data PropertyActionInvertBooleanPropertyInfo
- constructPropertyActionInvertBoolean :: IsPropertyAction o => Bool -> IO (GValueConstruct o)
- getPropertyActionInvertBoolean :: (MonadIO m, IsPropertyAction o) => o -> m Bool
- propertyActionInvertBoolean :: AttrLabelProxy "invertBoolean"
- data PropertyActionNamePropertyInfo
- constructPropertyActionName :: IsPropertyAction o => Text -> IO (GValueConstruct o)
- getPropertyActionName :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe Text)
- propertyActionName :: AttrLabelProxy "name"
- data PropertyActionObjectPropertyInfo
- constructPropertyActionObject :: (IsPropertyAction o, IsObject a) => a -> IO (GValueConstruct o)
- propertyActionObject :: AttrLabelProxy "object"
- data PropertyActionParameterTypePropertyInfo
- getPropertyActionParameterType :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe VariantType)
- propertyActionParameterType :: AttrLabelProxy "parameterType"
- data PropertyActionPropertyNamePropertyInfo
- constructPropertyActionPropertyName :: IsPropertyAction o => Text -> IO (GValueConstruct o)
- propertyActionPropertyName :: AttrLabelProxy "propertyName"
- data PropertyActionStatePropertyInfo
- getPropertyActionState :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe GVariant)
- propertyActionState :: AttrLabelProxy "state"
- data PropertyActionStateTypePropertyInfo
- getPropertyActionStateType :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe VariantType)
- propertyActionStateType :: AttrLabelProxy "stateType"
Exported types
newtype PropertyAction Source #
Constructors
| PropertyAction (ManagedPtr PropertyAction) |
Instances
| GObject PropertyAction Source # | |
| IsObject PropertyAction Source # | |
| IsAction PropertyAction Source # | |
| IsPropertyAction PropertyAction Source # | |
| ((~) * info (ResolvePropertyActionMethod t PropertyAction), MethodInfo * info PropertyAction p) => IsLabel t (PropertyAction -> p) Source # | |
| ((~) * info (ResolvePropertyActionMethod t PropertyAction), MethodInfo * info PropertyAction p) => IsLabelProxy t (PropertyAction -> p) Source # | |
| HasAttributeList * PropertyAction Source # | |
| type AttributeList PropertyAction Source # | |
| type SignalList PropertyAction Source # | |
class GObject o => IsPropertyAction o Source #
Instances
toPropertyAction :: IsPropertyAction o => o -> IO PropertyAction Source #
Methods
new
Arguments
| :: (HasCallStack, MonadIO m, IsObject a) | |
| => Text |
|
| -> a |
|
| -> Text |
|
| -> m PropertyAction | Returns: a new |
Creates a Action corresponding to the value of property
propertyName on object.
The property must be existent and readable and writable (and not construct-only).
This function takes a reference on object and doesn't release it
until the action is destroyed.
Since: 2.38
Properties
enabled
data PropertyActionEnabledPropertyInfo Source #
Instances
getPropertyActionEnabled :: (MonadIO m, IsPropertyAction o) => o -> m Bool Source #
propertyActionEnabled :: AttrLabelProxy "enabled" Source #
invertBoolean
data PropertyActionInvertBooleanPropertyInfo Source #
Instances
constructPropertyActionInvertBoolean :: IsPropertyAction o => Bool -> IO (GValueConstruct o) Source #
getPropertyActionInvertBoolean :: (MonadIO m, IsPropertyAction o) => o -> m Bool Source #
propertyActionInvertBoolean :: AttrLabelProxy "invertBoolean" Source #
name
data PropertyActionNamePropertyInfo Source #
Instances
constructPropertyActionName :: IsPropertyAction o => Text -> IO (GValueConstruct o) Source #
getPropertyActionName :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe Text) Source #
propertyActionName :: AttrLabelProxy "name" Source #
object
data PropertyActionObjectPropertyInfo Source #
Instances
constructPropertyActionObject :: (IsPropertyAction o, IsObject a) => a -> IO (GValueConstruct o) Source #
propertyActionObject :: AttrLabelProxy "object" Source #
parameterType
data PropertyActionParameterTypePropertyInfo Source #
Instances
getPropertyActionParameterType :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe VariantType) Source #
propertyActionParameterType :: AttrLabelProxy "parameterType" Source #
propertyName
data PropertyActionPropertyNamePropertyInfo Source #
Instances
constructPropertyActionPropertyName :: IsPropertyAction o => Text -> IO (GValueConstruct o) Source #
propertyActionPropertyName :: AttrLabelProxy "propertyName" Source #
state
data PropertyActionStatePropertyInfo Source #
Instances
getPropertyActionState :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe GVariant) Source #
propertyActionState :: AttrLabelProxy "state" Source #
stateType
data PropertyActionStateTypePropertyInfo Source #
Instances
getPropertyActionStateType :: (MonadIO m, IsPropertyAction o) => o -> m (Maybe VariantType) Source #
propertyActionStateType :: AttrLabelProxy "stateType" Source #