GI.Gtk.Objects.RadioMenuItem

A radio menu item is a check menu item that belongs to a group. At each instant exactly one of the radio menu items from a group is selected.

The group list does not need to be freed, as each RadioMenuItem will remove itself and its list item when it is destroyed.

The correct way to create a group of radio menu items is approximatively this:

How to create a group of radio menu items.

C code

GSList *group = NULL;
GtkWidget *item;
gint i;

for (i = 0; i < 5; i++)
{
  item = gtk_radio_menu_item_new_with_label (group, "This is an example");
  group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
  if (i == 1)
    gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
}

CSS nodes

plain code

menuitem
├── radio.left
╰── <child>

GtkRadioMenuItem has a main CSS node with name menuitem, and a subnode with name radio, which gets the .left or .right style class.

Exported types

newtype RadioMenuItem

Constructors

RadioMenuItem (ManagedPtr RadioMenuItem)

Instances

GObject RadioMenuItem

Methods

gobjectType :: RadioMenuItem -> IO GType

IsImplementorIface RadioMenuItem

IsObject RadioMenuItem

IsWidget RadioMenuItem

IsMenuItem RadioMenuItem

IsContainer RadioMenuItem

IsCheckMenuItem RadioMenuItem

IsBin RadioMenuItem

IsBuildable RadioMenuItem

IsActivatable RadioMenuItem

IsActionable RadioMenuItem

IsRadioMenuItem RadioMenuItem

((~) * info (ResolveRadioMenuItemMethod t RadioMenuItem), MethodInfo * info RadioMenuItem p) => IsLabel t (RadioMenuItem -> p)

Methods

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

((~) * info (ResolveRadioMenuItemMethod t RadioMenuItem), MethodInfo * info RadioMenuItem p) => IsLabelProxy t (RadioMenuItem -> p)

Methods

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

HasAttributeList * RadioMenuItem

type AttributeList RadioMenuItem

type AttributeList RadioMenuItem

type SignalList RadioMenuItem

type SignalList RadioMenuItem

class GObject o => IsRadioMenuItem o

Instances

(GObject a, UnknownAncestorError Constraint RadioMenuItem a) => IsRadioMenuItem a

IsRadioMenuItem RadioMenuItem

toRadioMenuItem :: IsRadioMenuItem o => o -> IO RadioMenuItem

noRadioMenuItem :: Maybe RadioMenuItem

Methods

getGroup

data RadioMenuItemGetGroupMethodInfo

Instances

((~) * signature (m [RadioMenuItem]), MonadIO m, IsRadioMenuItem a) => MethodInfo * RadioMenuItemGetGroupMethodInfo a signature

Methods

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

radioMenuItemGetGroup

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> a

radioMenuItem: a RadioMenuItem

-> m [RadioMenuItem]

Returns: the group of radioMenuItem

Returns the group to which the radio menu item belongs, as a List of RadioMenuItem. The list belongs to GTK+ and should not be freed.

joinGroup

data RadioMenuItemJoinGroupMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsRadioMenuItem a, IsRadioMenuItem b) => MethodInfo * RadioMenuItemJoinGroupMethodInfo a signature

Methods

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

radioMenuItemJoinGroup

Arguments

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

=> a

radioMenuItem: a RadioMenuItem

-> Maybe b

groupSource: a RadioMenuItem whose group we are joining, or Nothing to remove the radioMenuItem from its current group

-> m ()

Joins a RadioMenuItem object to the group of another RadioMenuItem object.

This function should be used by language bindings to avoid the memory manangement of the opaque SList of radioMenuItemGetGroup and radioMenuItemSetGroup.

A common way to set up a group of RadioMenuItem instances is:

 GtkRadioMenuItem *last_item = NULL;

 while ( ...more items to add... )
   {
     GtkRadioMenuItem *radio_item;

     radio_item = gtk_radio_menu_item_new (...);

     gtk_radio_menu_item_join_group (radio_item, last_item);
     last_item = radio_item;
   }

Since: 3.18

new

radioMenuItemNew

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> [a]

group: the group to which the radio menu item is to be attached, or Nothing

-> m RadioMenuItem

Returns: a new RadioMenuItem

Creates a new RadioMenuItem.

newFromWidget

radioMenuItemNewFromWidget

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> Maybe a

group: An existing RadioMenuItem

-> m RadioMenuItem

Returns: The new RadioMenuItem

Creates a new RadioMenuItem adding it to the same group as group.

Since: 2.4

newWithLabel

radioMenuItemNewWithLabel

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> [a]

group: group the radio menu item is inside, or Nothing

-> Text

label: the text for the label

-> m RadioMenuItem

Returns: A new RadioMenuItem

Creates a new RadioMenuItem whose child is a simple Label.

newWithLabelFromWidget

radioMenuItemNewWithLabelFromWidget

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> Maybe a

group: an existing RadioMenuItem

-> Maybe Text

label: the text for the label

-> m RadioMenuItem

Returns: The new RadioMenuItem

Creates a new GtkRadioMenuItem whose child is a simple GtkLabel. The new RadioMenuItem is added to the same group as group.

Since: 2.4

newWithMnemonic

radioMenuItemNewWithMnemonic

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> [a]

group: group the radio menu item is inside, or Nothing

-> Text

label: the text of the button, with an underscore in front of the mnemonic character

-> m RadioMenuItem

Returns: a new RadioMenuItem

Creates a new RadioMenuItem containing a label. The label will be created using labelNewWithMnemonic, so underscores in label indicate the mnemonic for the menu item.

newWithMnemonicFromWidget

radioMenuItemNewWithMnemonicFromWidget

Arguments

:: (HasCallStack, MonadIO m, IsRadioMenuItem a)

=> Maybe a

group: An existing RadioMenuItem

-> Maybe Text

label: the text of the button, with an underscore in front of the mnemonic character

-> m RadioMenuItem

Returns: The new RadioMenuItem

Creates a new GtkRadioMenuItem containing a label. The label will be created using labelNewWithMnemonic, so underscores in label indicate the mnemonic for the menu item.

The new RadioMenuItem is added to the same group as group.

Since: 2.4

setGroup

data RadioMenuItemSetGroupMethodInfo

Instances

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

Methods

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

radioMenuItemSetGroup

Arguments

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

=> a

radioMenuItem: a RadioMenuItem.

-> [b]

group: the new group, or Nothing.

-> m ()

Sets the group of a radio menu item, or changes it.

Properties

group

data RadioMenuItemGroupPropertyInfo

Instances

AttrInfo RadioMenuItemGroupPropertyInfo

Associated Types

type AttrAllowedOps RadioMenuItemGroupPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RadioMenuItemGroupPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RadioMenuItemGroupPropertyInfo :: * -> Constraint

type AttrGetType RadioMenuItemGroupPropertyInfo :: *

type AttrLabel RadioMenuItemGroupPropertyInfo :: Symbol

type AttrOrigin RadioMenuItemGroupPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin RadioMenuItemGroupPropertyInfo

type AttrOrigin RadioMenuItemGroupPropertyInfo = RadioMenuItem

type AttrLabel RadioMenuItemGroupPropertyInfo

type AttrLabel RadioMenuItemGroupPropertyInfo = "group"

type AttrGetType RadioMenuItemGroupPropertyInfo

type AttrGetType RadioMenuItemGroupPropertyInfo = ()

type AttrBaseTypeConstraint RadioMenuItemGroupPropertyInfo

type AttrBaseTypeConstraint RadioMenuItemGroupPropertyInfo = IsRadioMenuItem

type AttrSetTypeConstraint RadioMenuItemGroupPropertyInfo

type AttrSetTypeConstraint RadioMenuItemGroupPropertyInfo = IsRadioMenuItem

type AttrAllowedOps RadioMenuItemGroupPropertyInfo

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

clearRadioMenuItemGroup :: (MonadIO m, IsRadioMenuItem o) => o -> m ()

constructRadioMenuItemGroup :: (IsRadioMenuItem o, IsRadioMenuItem a) => a -> IO (GValueConstruct o)

radioMenuItemGroup :: AttrLabelProxy "group"

setRadioMenuItemGroup :: (MonadIO m, IsRadioMenuItem o, IsRadioMenuItem a) => o -> a -> m ()

Signals

groupChanged

type C_RadioMenuItemGroupChangedCallback = Ptr () -> Ptr () -> IO ()

type RadioMenuItemGroupChangedCallback = IO ()

data RadioMenuItemGroupChangedSignalInfo

Instances

SignalInfo RadioMenuItemGroupChangedSignalInfo

Associated Types

type HaskellCallbackType RadioMenuItemGroupChangedSignalInfo :: *

Methods

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

type HaskellCallbackType RadioMenuItemGroupChangedSignalInfo

type HaskellCallbackType RadioMenuItemGroupChangedSignalInfo = RadioMenuItemGroupChangedCallback

afterRadioMenuItemGroupChanged :: (GObject a, MonadIO m) => a -> RadioMenuItemGroupChangedCallback -> m SignalHandlerId

genClosure_RadioMenuItemGroupChanged :: RadioMenuItemGroupChangedCallback -> IO Closure

mk_RadioMenuItemGroupChangedCallback :: C_RadioMenuItemGroupChangedCallback -> IO (FunPtr C_RadioMenuItemGroupChangedCallback)

noRadioMenuItemGroupChangedCallback :: Maybe RadioMenuItemGroupChangedCallback

onRadioMenuItemGroupChanged :: (GObject a, MonadIO m) => a -> RadioMenuItemGroupChangedCallback -> m SignalHandlerId

wrap_RadioMenuItemGroupChangedCallback :: RadioMenuItemGroupChangedCallback -> Ptr () -> Ptr () -> IO ()