Gtk2HsContentsIndex
Graphics.UI.Gtk.ActionMenuToolbar.ToggleAction
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Contents
Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals
Description

An action which can be toggled between two states

  • Module available since Gtk+ version 2.4
Synopsis
data ToggleAction
class ActionClass o => ToggleActionClass o
castToToggleAction :: GObjectClass obj => obj -> ToggleAction
toggleActionNew :: String -> String -> Maybe String -> Maybe String -> IO ToggleAction
toggleActionToggled :: ToggleActionClass self => self -> IO ()
toggleActionSetActive :: ToggleActionClass self => self -> Bool -> IO ()
toggleActionGetActive :: ToggleActionClass self => self -> IO Bool
toggleActionSetDrawAsRadio :: ToggleActionClass self => self -> Bool -> IO ()
toggleActionGetDrawAsRadio :: ToggleActionClass self => self -> IO Bool
toggleActionDrawAsRadio :: ToggleActionClass self => Attr self Bool
toggleActionActive :: ToggleActionClass self => Attr self Bool
onToggleActionToggled :: ToggleActionClass self => self -> IO () -> IO (ConnectId self)
afterToggleActionToggled :: ToggleActionClass self => self -> IO () -> IO (ConnectId self)
Detail
A ToggleAction corresponds roughly to a CheckMenuItem. It has an "active" state specifying whether the action has been checked or not.
Class Hierarchy 
 |  GObject
 |   +----Action
 |         +----ToggleAction
 |               +----RadioAction
Types
data ToggleAction
show/hide Instances
class ActionClass o => ToggleActionClass o
show/hide Instances
castToToggleAction :: GObjectClass obj => obj -> ToggleAction
Constructors
toggleActionNew
:: Stringname - A unique name for the action
-> Stringlabel - The label displayed in menu items and on buttons
-> Maybe Stringtooltip - A tooltip for the action
-> Maybe StringstockId - The stock icon to display in widgets representing the action
-> IO ToggleAction
Creates a new ToggleAction object. To add the action to a ActionGroup and set the accelerator for the action, call actionGroupAddActionWithAccel.
Methods
toggleActionToggled :: ToggleActionClass self => self -> IO ()
Emits the "toggled" signal on the toggle action.
toggleActionSetActive
:: ToggleActionClass self
=> self
-> BoolisActive - whether the action should be checked or not
-> IO ()
Sets the checked state on the toggle action.
toggleActionGetActive :: ToggleActionClass self => self -> IO Bool
Returns the checked state of the toggle action.
toggleActionSetDrawAsRadio :: ToggleActionClass self => self -> Bool -> IO ()
Sets whether the action should have proxies like a radio action.
toggleActionGetDrawAsRadio :: ToggleActionClass self => self -> IO Bool
Returns whether the action should have proxies like a radio action.
Attributes
toggleActionDrawAsRadio :: ToggleActionClass self => Attr self Bool

Whether the proxies for this action look like radio action proxies.

Default value: False

toggleActionActive :: ToggleActionClass self => Attr self Bool
'active' property. See toggleActionGetActive and toggleActionSetActive
Signals
onToggleActionToggled :: ToggleActionClass self => self -> IO () -> IO (ConnectId self)
afterToggleActionToggled :: ToggleActionClass self => self -> IO () -> IO (ConnectId self)
Produced by Haddock version 0.7