gi-gtk-3.0.11: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.ToggleAction

Contents

Description

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

Synopsis

Exported types

Methods

getActive

toggleActionGetActive Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

data ToggleActionActivePropertyInfo Source #

Instances

AttrInfo ToggleActionActivePropertyInfo Source # 
type AttrOrigin ToggleActionActivePropertyInfo Source # 
type AttrLabel ToggleActionActivePropertyInfo Source # 
type AttrGetType ToggleActionActivePropertyInfo Source # 
type AttrBaseTypeConstraint ToggleActionActivePropertyInfo Source # 
type AttrSetTypeConstraint ToggleActionActivePropertyInfo Source # 
type AttrAllowedOps ToggleActionActivePropertyInfo Source # 

drawAsRadio

data ToggleActionDrawAsRadioPropertyInfo Source #

Instances

AttrInfo ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrOrigin ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrLabel ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrGetType ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrBaseTypeConstraint ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrSetTypeConstraint ToggleActionDrawAsRadioPropertyInfo Source # 
type AttrAllowedOps ToggleActionDrawAsRadioPropertyInfo Source # 

Signals

toggled

type ToggleActionToggledCallback = IO () Source #

Deprecated: (Since version 3.10)