Graphics.UI.Gtk.ActionMenuToolbar.RadioAction

Gtk2Hs

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

Contents

Detail
Class Hierarchy
Types
Constructors
Methods
Attributes
Signals

Description

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

Module available since Gtk+ version 2.4

Synopsis

data RadioAction

class ToggleActionClass o => RadioActionClass o

castToRadioAction :: GObjectClass obj => obj -> RadioAction

toRadioAction :: RadioActionClass o => o -> RadioAction

radioActionNew :: String -> String -> Maybe String -> Maybe String -> Int -> IO RadioAction

radioActionGetGroup :: RadioActionClass self => self -> IO [RadioAction]

radioActionSetGroup :: (RadioActionClass self, RadioActionClass groupMember) => self -> groupMember -> IO ()

radioActionGetCurrentValue :: RadioActionClass self => self -> IO Int

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

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

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

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

Instances

ActionClass RadioAction

GObjectClass RadioAction

RadioActionClass RadioAction

ToggleActionClass RadioAction

class ToggleActionClass o => RadioActionClass o

Instances

RadioActionClass RadioAction

castToRadioAction :: GObjectClass obj => obj -> RadioAction

toRadioAction :: RadioActionClass o => o -> RadioAction

Constructors

radioActionNew

:: 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 String	`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

:: RadioActionClass self
=> self
-> IO [RadioAction]	returns the members of the radio group
Returns the list representing the radio group for this object

radioActionSetGroup

:: (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

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

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

Sets a new group for a radio action.

Signals

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

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)

Produced by Haddock version 0.8