GI.Gio.Objects.SimpleAction

A SimpleAction is the obvious simple implementation of the Action interface. This is the easiest way to create an action for purposes of adding it to a SimpleActionGroup.

See also GtkAction.

Exported types

newtype SimpleAction

Constructors

SimpleAction (ManagedPtr SimpleAction)

Instances

GObject SimpleAction

Methods

gobjectType :: SimpleAction -> IO GType

IsObject SimpleAction

IsSimpleAction SimpleAction

IsAction SimpleAction

((~) * info (ResolveSimpleActionMethod t SimpleAction), MethodInfo * info SimpleAction p) => IsLabel t (SimpleAction -> p)

Methods

fromLabel :: Proxy# Symbol t -> SimpleAction -> p

((~) * info (ResolveSimpleActionMethod t SimpleAction), MethodInfo * info SimpleAction p) => IsLabelProxy t (SimpleAction -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> SimpleAction -> p

HasAttributeList * SimpleAction

type AttributeList SimpleAction

type AttributeList SimpleAction

type SignalList SimpleAction

type SignalList SimpleAction

class GObject o => IsSimpleAction o

Instances

(GObject a, UnknownAncestorError Constraint SimpleAction a) => IsSimpleAction a

IsSimpleAction SimpleAction

toSimpleAction :: IsSimpleAction o => o -> IO SimpleAction

noSimpleAction :: Maybe SimpleAction

Methods

new

simpleActionNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the action

-> Maybe VariantType

parameterType: the type of parameter to the activate function

-> m SimpleAction

Returns: a new SimpleAction

Creates a new action.

The created action is stateless. See simpleActionNewStateful.

Since: 2.28

newStateful

simpleActionNewStateful

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the action

-> Maybe VariantType

parameterType: the type of the parameter to the activate function

-> GVariant

state: the initial state of the action

-> m SimpleAction

Returns: a new SimpleAction

Creates a new stateful action.

state is the initial state of the action. All future state values must have the same VariantType as the initial state.

If the state GVariant is floating, it is consumed.

Since: 2.28

setEnabled

data SimpleActionSetEnabledMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSimpleAction a) => MethodInfo * SimpleActionSetEnabledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SimpleActionSetEnabledMethodInfo a -> signature -> s

simpleActionSetEnabled

Arguments

:: (HasCallStack, MonadIO m, IsSimpleAction a)

=> a

simple: a SimpleAction

-> Bool

enabled: whether the action is enabled

-> m ()

Sets the action as enabled or not.

An action must be enabled in order to be activated or in order to have its state changed from outside callers.

This should only be called by the implementor of the action. Users of the action should not attempt to modify its enabled flag.

Since: 2.28

setState

data SimpleActionSetStateMethodInfo

Instances

((~) * signature (GVariant -> m ()), MonadIO m, IsSimpleAction a) => MethodInfo * SimpleActionSetStateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SimpleActionSetStateMethodInfo a -> signature -> s

simpleActionSetState

Arguments

:: (HasCallStack, MonadIO m, IsSimpleAction a)

=> a

simple: a SimpleAction

-> GVariant

value: the new GVariant for the state

-> m ()

Sets the state of the action.

This directly updates the 'state' property to the given value.

This should only be called by the implementor of the action. Users of the action should not attempt to directly modify the 'state' property. Instead, they should call actionChangeState to request the change.

If the value GVariant is floating, it is consumed.

Since: 2.30

setStateHint

data SimpleActionSetStateHintMethodInfo

Instances

((~) * signature (Maybe GVariant -> m ()), MonadIO m, IsSimpleAction a) => MethodInfo * SimpleActionSetStateHintMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SimpleActionSetStateHintMethodInfo a -> signature -> s

simpleActionSetStateHint

Arguments

:: (HasCallStack, MonadIO m, IsSimpleAction a)

=> a

simple: a SimpleAction

-> Maybe GVariant

stateHint: a GVariant representing the state hint

-> m ()

Sets the state hint for the action.

See actionGetStateHint for more information about action state hints.

Since: 2.44

Properties

enabled

data SimpleActionEnabledPropertyInfo

Instances

AttrInfo SimpleActionEnabledPropertyInfo

Associated Types

type AttrAllowedOps SimpleActionEnabledPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SimpleActionEnabledPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo :: * -> Constraint

type AttrGetType SimpleActionEnabledPropertyInfo :: *

type AttrLabel SimpleActionEnabledPropertyInfo :: Symbol

type AttrOrigin SimpleActionEnabledPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo o => Proxy * SimpleActionEnabledPropertyInfo -> o -> IO (AttrGetType SimpleActionEnabledPropertyInfo)

attrSet :: (AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo o, AttrSetTypeConstraint SimpleActionEnabledPropertyInfo b) => Proxy * SimpleActionEnabledPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo o => Proxy * SimpleActionEnabledPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo o, AttrSetTypeConstraint SimpleActionEnabledPropertyInfo b) => Proxy * SimpleActionEnabledPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SimpleActionEnabledPropertyInfo

type AttrOrigin SimpleActionEnabledPropertyInfo = SimpleAction

type AttrLabel SimpleActionEnabledPropertyInfo

type AttrLabel SimpleActionEnabledPropertyInfo = "enabled"

type AttrGetType SimpleActionEnabledPropertyInfo

type AttrGetType SimpleActionEnabledPropertyInfo = Bool

type AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo

type AttrBaseTypeConstraint SimpleActionEnabledPropertyInfo = IsSimpleAction

type AttrSetTypeConstraint SimpleActionEnabledPropertyInfo

type AttrSetTypeConstraint SimpleActionEnabledPropertyInfo = * ~ Bool

type AttrAllowedOps SimpleActionEnabledPropertyInfo

type AttrAllowedOps SimpleActionEnabledPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSimpleActionEnabled :: IsSimpleAction o => Bool -> IO (GValueConstruct o)

getSimpleActionEnabled :: (MonadIO m, IsSimpleAction o) => o -> m Bool

setSimpleActionEnabled :: (MonadIO m, IsSimpleAction o) => o -> Bool -> m ()

simpleActionEnabled :: AttrLabelProxy "enabled"

name

data SimpleActionNamePropertyInfo

Instances

AttrInfo SimpleActionNamePropertyInfo

Associated Types

type AttrAllowedOps SimpleActionNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SimpleActionNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SimpleActionNamePropertyInfo :: * -> Constraint

type AttrGetType SimpleActionNamePropertyInfo :: *

type AttrLabel SimpleActionNamePropertyInfo :: Symbol

type AttrOrigin SimpleActionNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SimpleActionNamePropertyInfo o => Proxy * SimpleActionNamePropertyInfo -> o -> IO (AttrGetType SimpleActionNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SimpleActionNamePropertyInfo o, AttrSetTypeConstraint SimpleActionNamePropertyInfo b) => Proxy * SimpleActionNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SimpleActionNamePropertyInfo o => Proxy * SimpleActionNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SimpleActionNamePropertyInfo o, AttrSetTypeConstraint SimpleActionNamePropertyInfo b) => Proxy * SimpleActionNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SimpleActionNamePropertyInfo

type AttrOrigin SimpleActionNamePropertyInfo = SimpleAction

type AttrLabel SimpleActionNamePropertyInfo

type AttrLabel SimpleActionNamePropertyInfo = "name"

type AttrGetType SimpleActionNamePropertyInfo

type AttrGetType SimpleActionNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint SimpleActionNamePropertyInfo

type AttrBaseTypeConstraint SimpleActionNamePropertyInfo = IsSimpleAction

type AttrSetTypeConstraint SimpleActionNamePropertyInfo

type AttrSetTypeConstraint SimpleActionNamePropertyInfo = * ~ Text

type AttrAllowedOps SimpleActionNamePropertyInfo

type AttrAllowedOps SimpleActionNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructSimpleActionName :: IsSimpleAction o => Text -> IO (GValueConstruct o)

getSimpleActionName :: (MonadIO m, IsSimpleAction o) => o -> m (Maybe Text)

simpleActionName :: AttrLabelProxy "name"

parameterType

data SimpleActionParameterTypePropertyInfo

Instances

AttrInfo SimpleActionParameterTypePropertyInfo

Associated Types

type AttrAllowedOps SimpleActionParameterTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SimpleActionParameterTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo :: * -> Constraint

type AttrGetType SimpleActionParameterTypePropertyInfo :: *

type AttrLabel SimpleActionParameterTypePropertyInfo :: Symbol

type AttrOrigin SimpleActionParameterTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo o => Proxy * SimpleActionParameterTypePropertyInfo -> o -> IO (AttrGetType SimpleActionParameterTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo o, AttrSetTypeConstraint SimpleActionParameterTypePropertyInfo b) => Proxy * SimpleActionParameterTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo o => Proxy * SimpleActionParameterTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo o, AttrSetTypeConstraint SimpleActionParameterTypePropertyInfo b) => Proxy * SimpleActionParameterTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SimpleActionParameterTypePropertyInfo

type AttrOrigin SimpleActionParameterTypePropertyInfo = SimpleAction

type AttrLabel SimpleActionParameterTypePropertyInfo

type AttrLabel SimpleActionParameterTypePropertyInfo = "parameter-type"

type AttrGetType SimpleActionParameterTypePropertyInfo

type AttrGetType SimpleActionParameterTypePropertyInfo = Maybe VariantType

type AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo

type AttrBaseTypeConstraint SimpleActionParameterTypePropertyInfo = IsSimpleAction

type AttrSetTypeConstraint SimpleActionParameterTypePropertyInfo

type AttrSetTypeConstraint SimpleActionParameterTypePropertyInfo = * ~ VariantType

type AttrAllowedOps SimpleActionParameterTypePropertyInfo

type AttrAllowedOps SimpleActionParameterTypePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructSimpleActionParameterType :: IsSimpleAction o => VariantType -> IO (GValueConstruct o)

getSimpleActionParameterType :: (MonadIO m, IsSimpleAction o) => o -> m (Maybe VariantType)

simpleActionParameterType :: AttrLabelProxy "parameterType"

state

data SimpleActionStatePropertyInfo

Instances

AttrInfo SimpleActionStatePropertyInfo

Associated Types

type AttrAllowedOps SimpleActionStatePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SimpleActionStatePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SimpleActionStatePropertyInfo :: * -> Constraint

type AttrGetType SimpleActionStatePropertyInfo :: *

type AttrLabel SimpleActionStatePropertyInfo :: Symbol

type AttrOrigin SimpleActionStatePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SimpleActionStatePropertyInfo o => Proxy * SimpleActionStatePropertyInfo -> o -> IO (AttrGetType SimpleActionStatePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SimpleActionStatePropertyInfo o, AttrSetTypeConstraint SimpleActionStatePropertyInfo b) => Proxy * SimpleActionStatePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SimpleActionStatePropertyInfo o => Proxy * SimpleActionStatePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SimpleActionStatePropertyInfo o, AttrSetTypeConstraint SimpleActionStatePropertyInfo b) => Proxy * SimpleActionStatePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SimpleActionStatePropertyInfo

type AttrOrigin SimpleActionStatePropertyInfo = SimpleAction

type AttrLabel SimpleActionStatePropertyInfo

type AttrLabel SimpleActionStatePropertyInfo = "state"

type AttrGetType SimpleActionStatePropertyInfo

type AttrGetType SimpleActionStatePropertyInfo = Maybe GVariant

type AttrBaseTypeConstraint SimpleActionStatePropertyInfo

type AttrBaseTypeConstraint SimpleActionStatePropertyInfo = IsSimpleAction

type AttrSetTypeConstraint SimpleActionStatePropertyInfo

type AttrSetTypeConstraint SimpleActionStatePropertyInfo = * ~ GVariant

type AttrAllowedOps SimpleActionStatePropertyInfo

type AttrAllowedOps SimpleActionStatePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSimpleActionState :: IsSimpleAction o => GVariant -> IO (GValueConstruct o)

getSimpleActionState :: (MonadIO m, IsSimpleAction o) => o -> m (Maybe GVariant)

setSimpleActionState :: (MonadIO m, IsSimpleAction o) => o -> GVariant -> m ()

simpleActionState :: AttrLabelProxy "state"

stateType

data SimpleActionStateTypePropertyInfo

Instances

AttrInfo SimpleActionStateTypePropertyInfo

Associated Types

type AttrAllowedOps SimpleActionStateTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SimpleActionStateTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo :: * -> Constraint

type AttrGetType SimpleActionStateTypePropertyInfo :: *

type AttrLabel SimpleActionStateTypePropertyInfo :: Symbol

type AttrOrigin SimpleActionStateTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo o => Proxy * SimpleActionStateTypePropertyInfo -> o -> IO (AttrGetType SimpleActionStateTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo o, AttrSetTypeConstraint SimpleActionStateTypePropertyInfo b) => Proxy * SimpleActionStateTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo o => Proxy * SimpleActionStateTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo o, AttrSetTypeConstraint SimpleActionStateTypePropertyInfo b) => Proxy * SimpleActionStateTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SimpleActionStateTypePropertyInfo

type AttrOrigin SimpleActionStateTypePropertyInfo = SimpleAction

type AttrLabel SimpleActionStateTypePropertyInfo

type AttrLabel SimpleActionStateTypePropertyInfo = "state-type"

type AttrGetType SimpleActionStateTypePropertyInfo

type AttrGetType SimpleActionStateTypePropertyInfo = Maybe VariantType

type AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo

type AttrBaseTypeConstraint SimpleActionStateTypePropertyInfo = IsSimpleAction

type AttrSetTypeConstraint SimpleActionStateTypePropertyInfo

type AttrSetTypeConstraint SimpleActionStateTypePropertyInfo = * ~ ()

type AttrAllowedOps SimpleActionStateTypePropertyInfo

type AttrAllowedOps SimpleActionStateTypePropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getSimpleActionStateType :: (MonadIO m, IsSimpleAction o) => o -> m (Maybe VariantType)

simpleActionStateType :: AttrLabelProxy "stateType"

Signals

activate

type C_SimpleActionActivateCallback = Ptr () -> Ptr GVariant -> Ptr () -> IO ()

type SimpleActionActivateCallback = Maybe GVariant -> IO ()

data SimpleActionActivateSignalInfo

Instances

SignalInfo SimpleActionActivateSignalInfo

Associated Types

type HaskellCallbackType SimpleActionActivateSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SimpleActionActivateSignalInfo -> o -> HaskellCallbackType SimpleActionActivateSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SimpleActionActivateSignalInfo

type HaskellCallbackType SimpleActionActivateSignalInfo = SimpleActionActivateCallback

afterSimpleActionActivate :: (GObject a, MonadIO m) => a -> SimpleActionActivateCallback -> m SignalHandlerId

genClosure_SimpleActionActivate :: SimpleActionActivateCallback -> IO Closure

mk_SimpleActionActivateCallback :: C_SimpleActionActivateCallback -> IO (FunPtr C_SimpleActionActivateCallback)

noSimpleActionActivateCallback :: Maybe SimpleActionActivateCallback

onSimpleActionActivate :: (GObject a, MonadIO m) => a -> SimpleActionActivateCallback -> m SignalHandlerId

wrap_SimpleActionActivateCallback :: SimpleActionActivateCallback -> Ptr () -> Ptr GVariant -> Ptr () -> IO ()

changeState

type C_SimpleActionChangeStateCallback = Ptr () -> Ptr GVariant -> Ptr () -> IO ()

type SimpleActionChangeStateCallback = Maybe GVariant -> IO ()

data SimpleActionChangeStateSignalInfo

Instances

SignalInfo SimpleActionChangeStateSignalInfo

Associated Types

type HaskellCallbackType SimpleActionChangeStateSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SimpleActionChangeStateSignalInfo -> o -> HaskellCallbackType SimpleActionChangeStateSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SimpleActionChangeStateSignalInfo

type HaskellCallbackType SimpleActionChangeStateSignalInfo = SimpleActionChangeStateCallback

afterSimpleActionChangeState :: (GObject a, MonadIO m) => a -> SimpleActionChangeStateCallback -> m SignalHandlerId

genClosure_SimpleActionChangeState :: SimpleActionChangeStateCallback -> IO Closure

mk_SimpleActionChangeStateCallback :: C_SimpleActionChangeStateCallback -> IO (FunPtr C_SimpleActionChangeStateCallback)

noSimpleActionChangeStateCallback :: Maybe SimpleActionChangeStateCallback

onSimpleActionChangeState :: (GObject a, MonadIO m) => a -> SimpleActionChangeStateCallback -> m SignalHandlerId

wrap_SimpleActionChangeStateCallback :: SimpleActionChangeStateCallback -> Ptr () -> Ptr GVariant -> Ptr () -> IO ()