GI.Gtk.Objects.RadioAction

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.

Exported types

newtype RadioAction

Constructors

RadioAction (ManagedPtr RadioAction)

Instances

GObject RadioAction

Methods

gobjectType :: RadioAction -> IO GType

IsObject RadioAction

IsToggleAction RadioAction

IsAction RadioAction

IsBuildable RadioAction

IsRadioAction RadioAction

((~) * info (ResolveRadioActionMethod t RadioAction), MethodInfo * info RadioAction p) => IsLabel t (RadioAction -> p)

Methods

fromLabel :: Proxy# Symbol t -> RadioAction -> p

((~) * info (ResolveRadioActionMethod t RadioAction), MethodInfo * info RadioAction p) => IsLabelProxy t (RadioAction -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> RadioAction -> p

HasAttributeList * RadioAction

type AttributeList RadioAction

type AttributeList RadioAction

type SignalList RadioAction

type SignalList RadioAction

class GObject o => IsRadioAction o

Instances

(GObject a, UnknownAncestorError Constraint RadioAction a) => IsRadioAction a

IsRadioAction RadioAction

toRadioAction :: IsRadioAction o => o -> IO RadioAction

noRadioAction :: Maybe RadioAction

Methods

getCurrentValue

data RadioActionGetCurrentValueMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsRadioAction a) => MethodInfo * RadioActionGetCurrentValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RadioActionGetCurrentValueMethodInfo a -> signature -> s

radioActionGetCurrentValue

Arguments

:: (HasCallStack, MonadIO m, IsRadioAction a)

=> a

action: a RadioAction

-> m Int32

Returns: The value of the currently active group member

Deprecated: (Since version 3.10)

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

Since: 2.4

getGroup

data RadioActionGetGroupMethodInfo

Instances

((~) * signature (m [RadioAction]), MonadIO m, IsRadioAction a) => MethodInfo * RadioActionGetGroupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RadioActionGetGroupMethodInfo a -> signature -> s

radioActionGetGroup

Arguments

:: (HasCallStack, MonadIO m, IsRadioAction a)

=> a

action: the action object

-> m [RadioAction]

Returns: the list representing the radio group for this object

Deprecated: (Since version 3.10)

Returns the list representing the radio group for this object. Note that the returned list is only valid until the next change to the group.

A common way to set up a group of radio group is the following:

C code

 GSList *group = NULL;
 GtkRadioAction *action;

 while ( ...more actions to add... /)
   {
      action = gtk_radio_action_new (...);
      
      gtk_radio_action_set_group (action, group);
      group = gtk_radio_action_get_group (action);
   }

Since: 2.4

joinGroup

data RadioActionJoinGroupMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsRadioAction a, IsRadioAction b) => MethodInfo * RadioActionJoinGroupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RadioActionJoinGroupMethodInfo a -> signature -> s

radioActionJoinGroup

Arguments

:: (HasCallStack, MonadIO m, IsRadioAction a, IsRadioAction b)

=> a

action: the action object

-> Maybe b

groupSource: a radio action object whos group we are joining, or Nothing to remove the radio action from its group

-> m ()

Deprecated: (Since version 3.10)

Joins a radio action object to the group of another radio action object.

Use this in language bindings instead of the radioActionGetGroup and radioActionSetGroup methods

A common way to set up a group of radio actions is the following:

C code

 GtkRadioAction *action;
 GtkRadioAction *last_action;

 while ( ...more actions to add... /)
   {
      action = gtk_radio_action_new (...);
      
      gtk_radio_action_join_group (action, last_action);
      last_action = action;
   }

Since: 3.0

new

radioActionNew

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 this action, or Nothing

-> Maybe Text

stockId: The stock icon to display in widgets representing this action, or Nothing

-> Int32

value: The value which radioActionGetCurrentValue should return if this action is selected.

-> m RadioAction

Returns: a new RadioAction

Deprecated: (Since version 3.10)

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

Since: 2.4

setCurrentValue

data RadioActionSetCurrentValueMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsRadioAction a) => MethodInfo * RadioActionSetCurrentValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RadioActionSetCurrentValueMethodInfo a -> signature -> s

radioActionSetCurrentValue

Arguments

:: (HasCallStack, MonadIO m, IsRadioAction a)

=> a

action: a RadioAction

-> Int32

currentValue: the new value

-> m ()

Deprecated: (Since version 3.10)

Sets the currently active group member to the member with value property currentValue.

Since: 2.10

setGroup

data RadioActionSetGroupMethodInfo

Instances

((~) * signature ([b] -> m ()), MonadIO m, IsRadioAction a, IsRadioAction b) => MethodInfo * RadioActionSetGroupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RadioActionSetGroupMethodInfo a -> signature -> s

radioActionSetGroup

Arguments

:: (HasCallStack, MonadIO m, IsRadioAction a, IsRadioAction b)

=> a

action: the action object

-> [b]

group: a list representing a radio group, or Nothing

-> m ()

Deprecated: (Since version 3.10)

Sets the radio group for the radio action object.

Since: 2.4

Properties

currentValue

data RadioActionCurrentValuePropertyInfo

Instances

AttrInfo RadioActionCurrentValuePropertyInfo

Associated Types

type AttrAllowedOps RadioActionCurrentValuePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RadioActionCurrentValuePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo :: * -> Constraint

type AttrGetType RadioActionCurrentValuePropertyInfo :: *

type AttrLabel RadioActionCurrentValuePropertyInfo :: Symbol

type AttrOrigin RadioActionCurrentValuePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo o => Proxy * RadioActionCurrentValuePropertyInfo -> o -> IO (AttrGetType RadioActionCurrentValuePropertyInfo)

attrSet :: (AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo o, AttrSetTypeConstraint RadioActionCurrentValuePropertyInfo b) => Proxy * RadioActionCurrentValuePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo o => Proxy * RadioActionCurrentValuePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo o, AttrSetTypeConstraint RadioActionCurrentValuePropertyInfo b) => Proxy * RadioActionCurrentValuePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RadioActionCurrentValuePropertyInfo

type AttrOrigin RadioActionCurrentValuePropertyInfo = RadioAction

type AttrLabel RadioActionCurrentValuePropertyInfo

type AttrLabel RadioActionCurrentValuePropertyInfo = "current-value"

type AttrGetType RadioActionCurrentValuePropertyInfo

type AttrGetType RadioActionCurrentValuePropertyInfo = Int32

type AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo

type AttrBaseTypeConstraint RadioActionCurrentValuePropertyInfo = IsRadioAction

type AttrSetTypeConstraint RadioActionCurrentValuePropertyInfo

type AttrSetTypeConstraint RadioActionCurrentValuePropertyInfo = * ~ Int32

type AttrAllowedOps RadioActionCurrentValuePropertyInfo

type AttrAllowedOps RadioActionCurrentValuePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructRadioActionCurrentValue :: IsRadioAction o => Int32 -> IO (GValueConstruct o)

getRadioActionCurrentValue :: (MonadIO m, IsRadioAction o) => o -> m Int32

radioActionCurrentValue :: AttrLabelProxy "currentValue"

setRadioActionCurrentValue :: (MonadIO m, IsRadioAction o) => o -> Int32 -> m ()

group

data RadioActionGroupPropertyInfo

Instances

AttrInfo RadioActionGroupPropertyInfo

Associated Types

type AttrAllowedOps RadioActionGroupPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RadioActionGroupPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RadioActionGroupPropertyInfo :: * -> Constraint

type AttrGetType RadioActionGroupPropertyInfo :: *

type AttrLabel RadioActionGroupPropertyInfo :: Symbol

type AttrOrigin RadioActionGroupPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RadioActionGroupPropertyInfo o => Proxy * RadioActionGroupPropertyInfo -> o -> IO (AttrGetType RadioActionGroupPropertyInfo)

attrSet :: (AttrBaseTypeConstraint RadioActionGroupPropertyInfo o, AttrSetTypeConstraint RadioActionGroupPropertyInfo b) => Proxy * RadioActionGroupPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RadioActionGroupPropertyInfo o => Proxy * RadioActionGroupPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RadioActionGroupPropertyInfo o, AttrSetTypeConstraint RadioActionGroupPropertyInfo b) => Proxy * RadioActionGroupPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RadioActionGroupPropertyInfo

type AttrOrigin RadioActionGroupPropertyInfo = RadioAction

type AttrLabel RadioActionGroupPropertyInfo

type AttrLabel RadioActionGroupPropertyInfo = "group"

type AttrGetType RadioActionGroupPropertyInfo

type AttrGetType RadioActionGroupPropertyInfo = ()

type AttrBaseTypeConstraint RadioActionGroupPropertyInfo

type AttrBaseTypeConstraint RadioActionGroupPropertyInfo = IsRadioAction

type AttrSetTypeConstraint RadioActionGroupPropertyInfo

type AttrSetTypeConstraint RadioActionGroupPropertyInfo = IsRadioAction

type AttrAllowedOps RadioActionGroupPropertyInfo

type AttrAllowedOps RadioActionGroupPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrClear ([] AttrOpTag)))

clearRadioActionGroup :: (MonadIO m, IsRadioAction o) => o -> m ()

constructRadioActionGroup :: (IsRadioAction o, IsRadioAction a) => a -> IO (GValueConstruct o)

radioActionGroup :: AttrLabelProxy "group"

setRadioActionGroup :: (MonadIO m, IsRadioAction o, IsRadioAction a) => o -> a -> m ()

value

data RadioActionValuePropertyInfo

Instances

AttrInfo RadioActionValuePropertyInfo

Associated Types

type AttrAllowedOps RadioActionValuePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RadioActionValuePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RadioActionValuePropertyInfo :: * -> Constraint

type AttrGetType RadioActionValuePropertyInfo :: *

type AttrLabel RadioActionValuePropertyInfo :: Symbol

type AttrOrigin RadioActionValuePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RadioActionValuePropertyInfo o => Proxy * RadioActionValuePropertyInfo -> o -> IO (AttrGetType RadioActionValuePropertyInfo)

attrSet :: (AttrBaseTypeConstraint RadioActionValuePropertyInfo o, AttrSetTypeConstraint RadioActionValuePropertyInfo b) => Proxy * RadioActionValuePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RadioActionValuePropertyInfo o => Proxy * RadioActionValuePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RadioActionValuePropertyInfo o, AttrSetTypeConstraint RadioActionValuePropertyInfo b) => Proxy * RadioActionValuePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RadioActionValuePropertyInfo

type AttrOrigin RadioActionValuePropertyInfo = RadioAction

type AttrLabel RadioActionValuePropertyInfo

type AttrLabel RadioActionValuePropertyInfo = "value"

type AttrGetType RadioActionValuePropertyInfo

type AttrGetType RadioActionValuePropertyInfo = Int32

type AttrBaseTypeConstraint RadioActionValuePropertyInfo

type AttrBaseTypeConstraint RadioActionValuePropertyInfo = IsRadioAction

type AttrSetTypeConstraint RadioActionValuePropertyInfo

type AttrSetTypeConstraint RadioActionValuePropertyInfo = * ~ Int32

type AttrAllowedOps RadioActionValuePropertyInfo

type AttrAllowedOps RadioActionValuePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructRadioActionValue :: IsRadioAction o => Int32 -> IO (GValueConstruct o)

getRadioActionValue :: (MonadIO m, IsRadioAction o) => o -> m Int32

radioActionValue :: AttrLabelProxy "value"

setRadioActionValue :: (MonadIO m, IsRadioAction o) => o -> Int32 -> m ()

Signals

changed

type C_RadioActionChangedCallback = Ptr () -> Ptr RadioAction -> Ptr () -> IO ()

type RadioActionChangedCallback = RadioAction -> IO ()

Deprecated: (Since version 3.10)

data RadioActionChangedSignalInfo

Instances

SignalInfo RadioActionChangedSignalInfo

Associated Types

type HaskellCallbackType RadioActionChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o RadioActionChangedSignalInfo -> o -> HaskellCallbackType RadioActionChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType RadioActionChangedSignalInfo

type HaskellCallbackType RadioActionChangedSignalInfo = RadioActionChangedCallback

afterRadioActionChanged :: (GObject a, MonadIO m) => a -> RadioActionChangedCallback -> m SignalHandlerId

genClosure_RadioActionChanged :: RadioActionChangedCallback -> IO Closure

mk_RadioActionChangedCallback :: C_RadioActionChangedCallback -> IO (FunPtr C_RadioActionChangedCallback)

noRadioActionChangedCallback :: Maybe RadioActionChangedCallback

onRadioActionChanged :: (GObject a, MonadIO m) => a -> RadioActionChangedCallback -> m SignalHandlerId

wrap_RadioActionChangedCallback :: RadioActionChangedCallback -> Ptr () -> Ptr RadioAction -> Ptr () -> IO ()