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

Graphics.UI.Gtk.ActionMenuToolbar.RadioAction

Contents

Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals
Deprecated

Description

An action of which only one in a group can be active

Module available since Gtk+ version 2.4

Synopsis

Detail

A RadioAction is similar to RadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time.

Class Hierarchy

 | GObject
 | +----Action
 | +----ToggleAction
 | +----RadioAction

Types

data RadioAction Source

Instances

Eq RadioAction
Ord RadioAction
GObjectClass RadioAction
RadioActionClass RadioAction
ToggleActionClass RadioAction
ActionClass RadioAction

class ToggleActionClass o => RadioActionClass o Source

Instances

RadioActionClass RadioAction

castToRadioAction :: GObjectClass obj => obj -> RadioAction Source

gTypeRadioAction :: GType Source

toRadioAction :: RadioActionClass o => o -> RadioAction Source

Constructors

radioActionNew Source

Arguments

:: 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 this action
-> Maybe StockId	`stockId` - The stock icon to display in widgets representing this action
-> Int	`value` - The value which `radioActionGetCurrentValue` should return if this action is selected.
-> IO RadioAction

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

Methods

radioActionGetGroup Source

Arguments

:: RadioActionClass self
=> self
-> IO [RadioAction]	returns the members of the radio group

Returns the list representing the radio group for this object

radioActionSetGroup Source

Arguments

:: (RadioActionClass self, RadioActionClass groupMember)
=> self
-> groupMember	`groupMember` - an existing member of the radio group
-> IO ()

Sets the radio group for the radio action object.

radioActionGetCurrentValue Source

Arguments

:: RadioActionClass self
=> self
-> IO Int	returns the value of the currently active group member

Obtains the value property of the currently active member of the group to which the action belongs.

Attributes

radioActionValueAttr :: RadioActionClass self => Attr self Int Source

The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an ::activate or ::changed signal handler. See radioActionGetCurrentValue and RadioActionEntry for convenient ways to get and set this property.

Default value: 0

radioActionGroup :: RadioActionClass self => ReadWriteAttr self [RadioAction] RadioAction Source

Sets a new group for a radio action.

radioActionCurrentValue :: RadioActionClass self => Attr self Int Source

The value property of the currently active member of the group to which this action belongs.

Default value: 0

Available since Gtk+ version 2.10

Signals

radioActionChanged :: RadioActionClass self => Signal self (RadioAction -> IO ())Source

The radioActionChanged signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the actionActivated signals for the previous and current active members.

Deprecated

onRadioActionChanged :: RadioActionClass self => self -> (RadioAction -> IO ()) -> IO (ConnectId self)Source

The changed signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the activate signals for the previous and current active members.

afterRadioActionChanged :: RadioActionClass self => self -> (RadioAction -> IO ()) -> IO (ConnectId self)Source

The changed signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the activate signals for the previous and current active members.