Graphics.UI.Gtk.ActionMenuToolbar.ToggleAction

gtk3-0.14.6: Binding to the Gtk+ 3 graphical user interface library

Maintainer | gtk2hs-users@lists.sourceforge.net
Stability | provisional
Portability | portable (depends on GHC)
Safe Haskell | None
Language | Haskell98

Graphics.UI.Gtk.ActionMenuToolbar.ToggleAction

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Attributes
- Signals
- Deprecated

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
- gTypeToggleAction :: GType
- toToggleAction :: ToggleActionClass o => o -> ToggleAction
- toggleActionNew :: GlibString string => string -> string -> Maybe string -> Maybe StockId -> 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
- actionToggled :: ToggleActionClass self => Signal self (IO ())

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

Instances

Eq ToggleAction # |
Methods (==) :: ToggleAction -> ToggleAction -> Bool # (/=) :: ToggleAction -> ToggleAction -> Bool #
Ord ToggleAction # |
Methods compare :: ToggleAction -> ToggleAction -> Ordering # (<) :: ToggleAction -> ToggleAction -> Bool # (<=) :: ToggleAction -> ToggleAction -> Bool # (>) :: ToggleAction -> ToggleAction -> Bool # (>=) :: ToggleAction -> ToggleAction -> Bool # max :: ToggleAction -> ToggleAction -> ToggleAction # min :: ToggleAction -> ToggleAction -> ToggleAction #
GObjectClass ToggleAction # |
Methods toGObject :: ToggleAction -> GObject # unsafeCastGObject :: GObject -> ToggleAction #
ToggleActionClass ToggleAction # |
ActionClass ToggleAction # |

class ActionClass o => ToggleActionClass o #

Instances

ToggleActionClass RadioAction # |
ToggleActionClass ToggleAction # |

castToToggleAction :: GObjectClass obj => obj -> ToggleAction #

gTypeToggleAction :: GType #

toToggleAction :: ToggleActionClass o => o -> ToggleAction #

# Constructors

toggleActionNew #

Arguments

:: GlibString string |
=> string | `name` - A unique name for the action
-> string | `label` - The label displayed in menu items and on buttons
-> Maybe string | `tooltip` - A tooltip for the action
-> Maybe StockId | `stockId` - 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 #

Arguments

:: ToggleActionClass self |
=> self |
-> Bool | `isActive` - 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 #

If the toggle action should be active in or not.

Default value: `False`

- Available since Gtk+ version 2.10

# Signals

actionToggled :: ToggleActionClass self => Signal self (IO ()) #

# Deprecated