gi-dazzle-1.0.2: libdazzle bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Dazzle.Objects.StateMachine

Description

No description available in the introspection data.

Synopsis

Exported types

newtype StateMachine Source #

Memory-managed wrapper type.

Constructors

StateMachine (ManagedPtr StateMachine) 

Instances

Instances details
Eq StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

GObject StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

ManagedPtrNewtype StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

Methods

toManagedPtr :: StateMachine -> ManagedPtr StateMachine

TypedObject StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

Methods

glibType :: IO GType

HasParentTypes StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

IsGValue (Maybe StateMachine) Source #

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

Instance details

Defined in GI.Dazzle.Objects.StateMachine

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes StateMachine Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

type ParentTypes StateMachine = '[Object, Buildable]

class (GObject o, IsDescendantOf StateMachine o) => IsStateMachine o Source #

Type class for types which can be safely cast to StateMachine, for instance with toStateMachine.

Instances

Instances details
(GObject o, IsDescendantOf StateMachine o) => IsStateMachine o Source # 
Instance details

Defined in GI.Dazzle.Objects.StateMachine

toStateMachine :: (MonadIO m, IsStateMachine o) => o -> m StateMachine Source #

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

Methods

addBinding

stateMachineAddBinding :: (HasCallStack, MonadIO m, IsStateMachine a) => a -> Text -> Ptr () -> Text -> Ptr () -> Text -> [BindingFlags] -> m () Source #

No description available in the introspection data.

addPropertyv

stateMachineAddPropertyv :: (HasCallStack, MonadIO m, IsStateMachine a) => a -> Text -> Ptr () -> Text -> GValue -> m () Source #

No description available in the introspection data.

addStyle

stateMachineAddStyle :: (HasCallStack, MonadIO m, IsStateMachine a, IsWidget b) => a -> Text -> b -> Text -> m () Source #

No description available in the introspection data.

createAction

stateMachineCreateAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsStateMachine a) 
=> a

self: An StateMachine

-> Text

name: the name of the action.

-> m Action

Returns: A newly created Action.

Creates a new Action with the name of name.

Setting the state of this action will toggle the state of the state machine. You should use variantNewString or similar to create the state.

getState

stateMachineGetState Source #

Arguments

:: (HasCallStack, MonadIO m, IsStateMachine a) 
=> a

self: the StateMachine.

-> m Text

Returns: The current state of the machine.

Gets the StateMachine:state property. This is the name of the current state of the machine.

isState

stateMachineIsState Source #

Arguments

:: (HasCallStack, MonadIO m, IsStateMachine a) 
=> a

self: a StateMachine

-> Maybe Text

state: the name of the state to check

-> m Bool

Returns: True if self is currently set to state.

Checks to see if the current state of the StateMachine matches state.

Since: 3.28

new

stateMachineNew :: (HasCallStack, MonadIO m) => m StateMachine Source #

No description available in the introspection data.

setState

stateMachineSetState Source #

Arguments

:: (HasCallStack, MonadIO m, IsStateMachine a) 
=> a

self: the StateMachine self: the #

-> Text 
-> m () 

Sets the StateMachine:state property.

Registered state transformations will be applied during the state transformation.

If the transition results in a cyclic operation, the state will stop at the last state before the cycle was detected.

Properties

state

No description available in the introspection data.

constructStateMachineState :: (IsStateMachine o, MonadIO m) => Text -> 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.

getStateMachineState :: (MonadIO m, IsStateMachine o) => o -> m Text Source #

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

get stateMachine #state

setStateMachineState :: (MonadIO m, IsStateMachine o) => o -> Text -> m () Source #

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

set stateMachine [ #state := value ]