GI.Gtk.Objects.ToggleAction

A ToggleAction corresponds roughly to a CheckMenuItem. It has an “active” state specifying whether the action has been checked or not.

Exported types

newtype ToggleAction

Constructors

ToggleAction (ManagedPtr ToggleAction)

Instances

GObject ToggleAction

Methods

gobjectType :: ToggleAction -> IO GType

IsObject ToggleAction

IsToggleAction ToggleAction

IsAction ToggleAction

IsBuildable ToggleAction

class GObject o => IsToggleAction o

Instances

(GObject a, UnknownAncestorError Constraint ToggleAction a) => IsToggleAction a

IsToggleAction ToggleAction

IsToggleAction RadioAction

toToggleAction :: (MonadIO m, IsToggleAction o) => o -> m ToggleAction

noToggleAction :: Maybe ToggleAction

Methods

getActive

toggleActionGetActive

Arguments

:: (HasCallStack, MonadIO m, IsToggleAction a)

=> a

action: the action object

-> m Bool

Returns: the checked state of the toggle action

Deprecated: (Since version 3.10)

Returns the checked state of the toggle action.

Since: 2.4

getDrawAsRadio

toggleActionGetDrawAsRadio

Arguments

:: (HasCallStack, MonadIO m, IsToggleAction a)

=> a

action: the action object

-> m Bool

Returns: whether the action should have proxies like a radio action.

Deprecated: (Since version 3.10)

Returns whether the action should have proxies like a radio action.

Since: 2.4

new

toggleActionNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: A unique name for the action

-> Maybe Text

label: The label displayed in menu items and on buttons, or Nothing

-> Maybe Text

tooltip: A tooltip for the action, or Nothing

-> Maybe Text

stockId: The stock icon to display in widgets representing the action, or Nothing

-> m ToggleAction

Returns: a new ToggleAction

Deprecated: (Since version 3.10)

Creates a new ToggleAction object. To add the action to a ActionGroup and set the accelerator for the action, call actionGroupAddActionWithAccel.

Since: 2.4

setActive

toggleActionSetActive

Arguments

:: (HasCallStack, MonadIO m, IsToggleAction a)

=> a

action: the action object

-> Bool

isActive: whether the action should be checked or not

-> m ()

Deprecated: (Since version 3.10)

Sets the checked state on the toggle action.

Since: 2.4

setDrawAsRadio

toggleActionSetDrawAsRadio

Arguments

:: (HasCallStack, MonadIO m, IsToggleAction a)

=> a

action: the action object

-> Bool

drawAsRadio: whether the action should have proxies like a radio action

-> m ()

Deprecated: (Since version 3.10)

Sets whether the action should have proxies like a radio action.

Since: 2.4

toggled

toggleActionToggled

Arguments

:: (HasCallStack, MonadIO m, IsToggleAction a)

=> a

action: the action object

-> m ()

Deprecated: (Since version 3.10)

Emits the “toggled” signal on the toggle action.

Since: 2.4

Properties

active

constructToggleActionActive :: IsToggleAction o => Bool -> IO (GValueConstruct o)

getToggleActionActive :: (MonadIO m, IsToggleAction o) => o -> m Bool

setToggleActionActive :: (MonadIO m, IsToggleAction o) => o -> Bool -> m ()

drawAsRadio

constructToggleActionDrawAsRadio :: IsToggleAction o => Bool -> IO (GValueConstruct o)

getToggleActionDrawAsRadio :: (MonadIO m, IsToggleAction o) => o -> m Bool

setToggleActionDrawAsRadio :: (MonadIO m, IsToggleAction o) => o -> Bool -> m ()

Signals

toggled

type C_ToggleActionToggledCallback = Ptr () -> Ptr () -> IO ()

type ToggleActionToggledCallback = IO ()

Deprecated: (Since version 3.10)

afterToggleActionToggled :: (IsToggleAction a, MonadIO m) => a -> ToggleActionToggledCallback -> m SignalHandlerId

genClosure_ToggleActionToggled :: ToggleActionToggledCallback -> IO Closure

mk_ToggleActionToggledCallback :: C_ToggleActionToggledCallback -> IO (FunPtr C_ToggleActionToggledCallback)

noToggleActionToggledCallback :: Maybe ToggleActionToggledCallback

onToggleActionToggled :: (IsToggleAction a, MonadIO m) => a -> ToggleActionToggledCallback -> m SignalHandlerId

wrap_ToggleActionToggledCallback :: ToggleActionToggledCallback -> Ptr () -> Ptr () -> IO ()