gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.RadioButton

Contents

- Exported types
- Methods
  - getGroup
  - joinGroup
  - new
  - newFromWidget
  - newWithLabel
  - newWithLabelFromWidget
  - newWithMnemonic
  - newWithMnemonicFromWidget
  - setGroup
- Properties
  - group
- Signals
  - groupChanged

Description

A single radio button performs the same basic function as a `CheckButton`, as its position in the object hierarchy reflects. It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right.

Every radio button is a member of some group of radio buttons. When one is selected, all other radio buttons in the same group are deselected. A `RadioButton` is one way of giving the user a choice from many options.

Radio button widgets are created with `radioButtonNew`, passing `Nothing` as the argument if this is the first radio button in a group. In subsequent calls, the group you wish to add this button to should be passed as an argument. Optionally, `radioButtonNewWithLabel` can be used if you want a text label on the radio button.

Alternatively, when adding widgets to an existing group of radio buttons, use `radioButtonNewFromWidget` with a `RadioButton` that already has a group assigned to it. The convenience function `radioButtonNewWithLabelFromWidget` is also provided.

To retrieve the group a `RadioButton` is assigned to, use `radioButtonGetGroup`.

To remove a `RadioButton` from one group and make it part of a new one, use `radioButtonSetGroup`.

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

# CSS nodes

### plain code

    radiobutton
    ├── radio
    ╰── <child>

A GtkRadioButton with indicator (see `toggleButtonSetMode`) has a main CSS node with name radiobutton and a subnode with name radio.

### plain code

    button.radio
    ├── radio
    ╰── <child>

A GtkRadioButton without indicator changes the name of its main node to button and adds a .radio style class to it. The subnode is invisible in this case.

## How to create a group of two radio buttons.

### C code

    void create_radio_buttons (void) {

       GtkWidget *window, *radio1, *radio2, *box, *entry;
       window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
       box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 2);
       gtk_box_set_homogeneous (GTK_BOX (box), TRUE);

       // Create a radio button with a GtkEntry widget
       radio1 = gtk_radio_button_new (NULL);
       entry = gtk_entry_new ();
       gtk_container_add (GTK_CONTAINER (radio1), entry);

       // Create a radio button with a label
       radio2 = gtk_radio_button_new_with_label_from_widget (GTK_RADIO_BUTTON (radio1),
                                                             "I’m the second radio button.");

       // Pack them into a box, then show all the widgets
       gtk_box_pack_start (GTK_BOX (box), radio1);
       gtk_box_pack_start (GTK_BOX (box), radio2);
       gtk_container_add (GTK_CONTAINER (window), box);
       gtk_widget_show_all (window);
       return;
    }

When an unselected button in the group is clicked the clicked button receives the ToggleButton::toggled signal, as does the previously selected button. Inside the ToggleButton::toggled handler, `toggleButtonGetActive` can be used to determine if the button has been selected or deselected.

Synopsis

- newtype RadioButton = RadioButton (ManagedPtr RadioButton)
- class (GObject o, IsDescendantOf RadioButton o) => IsRadioButton o
- toRadioButton :: (MonadIO m, IsRadioButton o) => o -> m RadioButton
- radioButtonGetGroup :: (HasCallStack, MonadIO m, IsRadioButton a) => a -> m [RadioButton]
- radioButtonJoinGroup :: (HasCallStack, MonadIO m, IsRadioButton a, IsRadioButton b) => a -> Maybe b -> m ()
- radioButtonNew :: (HasCallStack, MonadIO m, IsRadioButton a) => [a] -> m RadioButton
- radioButtonNewFromWidget :: (HasCallStack, MonadIO m, IsRadioButton a) => Maybe a -> m RadioButton
- radioButtonNewWithLabel :: (HasCallStack, MonadIO m, IsRadioButton a) => [a] -> Text -> m RadioButton
- radioButtonNewWithLabelFromWidget :: (HasCallStack, MonadIO m, IsRadioButton a) => Maybe a -> Text -> m RadioButton
- radioButtonNewWithMnemonic :: (HasCallStack, MonadIO m, IsRadioButton a) => [a] -> Text -> m RadioButton
- radioButtonNewWithMnemonicFromWidget :: (HasCallStack, MonadIO m, IsRadioButton a) => Maybe a -> Text -> m RadioButton
- radioButtonSetGroup :: (HasCallStack, MonadIO m, IsRadioButton a, IsRadioButton b) => a -> [b] -> m ()
- clearRadioButtonGroup :: (MonadIO m, IsRadioButton o) => o -> m ()
- constructRadioButtonGroup :: (IsRadioButton o, MonadIO m, IsRadioButton a) => a -> m (GValueConstruct o)
- setRadioButtonGroup :: (MonadIO m, IsRadioButton o, IsRadioButton a) => o -> a -> m ()
- type RadioButtonGroupChangedCallback = IO ()
- afterRadioButtonGroupChanged :: (IsRadioButton a, MonadIO m) => a -> ((?self :: a) => RadioButtonGroupChangedCallback) -> m SignalHandlerId
- onRadioButtonGroupChanged :: (IsRadioButton a, MonadIO m) => a -> ((?self :: a) => RadioButtonGroupChangedCallback) -> m SignalHandlerId

# Exported types

newtype RadioButton Source #

Memory-managed wrapper type.

Constructors

RadioButton (ManagedPtr RadioButton) |

#### Instances

Instances details

Eq RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton Methods (==) :: RadioButton -> RadioButton -> Bool Source # (/=) :: RadioButton -> RadioButton -> Bool Source #
GObject RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton
ManagedPtrNewtype RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton Methods toManagedPtr :: RadioButton -> ManagedPtr RadioButton Source #
TypedObject RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton Methods glibType :: IO GType Source #
HasParentTypes RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton
IsGValue (Maybe RadioButton) Source # | Convert `RadioButton` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.RadioButton Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe RadioButton -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe RadioButton) Source #
type ParentTypes RadioButton Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton type ParentTypes RadioButton = '[CheckButton, ToggleButton, Button, Bin, Container, Widget, Object, ImplementorIface, Actionable, Activatable, Buildable]

class (GObject o, IsDescendantOf RadioButton o) => IsRadioButton o Source #

Type class for types which can be safely cast to `RadioButton`, for instance with `toRadioButton`.

#### Instances

Instances details

(GObject o, IsDescendantOf RadioButton o) => IsRadioButton o Source # |
Instance details Defined in GI.Gtk.Objects.RadioButton

toRadioButton :: (MonadIO m, IsRadioButton o) => o -> m RadioButton Source #

Cast to `RadioButton`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, clicked, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, doSetRelatedAction, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, enter, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, joinGroup, keynavFailed, leave, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, pressed, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, released, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, toggled, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getActionName, getActionTargetValue, getActive, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAlwaysShowImage, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEventWindow, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getImage, getImagePosition, getInconsistent, getInternalChild, getLabel, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMode, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRelatedAction, getRelief, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseStock, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelPath, setActionName, setActionTargetValue, setActive, setAlignment, setAllocation, setAlwaysShowImage, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setGroup, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setImage, setImagePosition, setInconsistent, setLabel, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMode, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setRelief, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setUseStock, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## getGroup

radioButtonGetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> a | `radioButton`: a `RadioButton`.
-> m [RadioButton] | Returns: a linked list containing all the radio buttons in the same group as `radioButton`. The returned list is owned by the radio button and must not be modified or freed.

Retrieves the group assigned to a radio button.

## joinGroup

radioButtonJoinGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a, IsRadioButton b) |
=> a | `radioButton`: the `RadioButton` object
-> Maybe b | `groupSource`: a radio button object whos group we are joining, or `Nothing` to remove the radio button from its group
-> m () |

Joins a `RadioButton` object to the group of another `RadioButton` object

Use this in language bindings instead of the `radioButtonGetGroup` and `radioButtonSetGroup` methods

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

### C code

     GtkRadioButton *radio_button;
     GtkRadioButton *last_button;

     while (some_condition)
       {
          radio_button = gtk_radio_button_new (NULL);

          gtk_radio_button_join_group (radio_button, last_button);
          last_button = radio_button;
       }

Since: 3.0

## new

radioButtonNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> [a] | `group`: an existing radio button group, or `Nothing` if you are creating a new group.
-> m RadioButton | Returns: a new radio button

Creates a new `RadioButton`. To be of any practical value, a widget should then be packed into the radio button.

## newFromWidget

radioButtonNewFromWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> Maybe a | `radioGroupMember`: an existing `RadioButton`.
-> m RadioButton | Returns: a new radio button.

Creates a new `RadioButton`, adding it to the same group as `radioGroupMember`. As with `radioButtonNew`, a widget should be packed into the radio button.

## newWithLabel

radioButtonNewWithLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> [a] | `group`: an existing radio button group, or `Nothing` if you are creating a new group.
-> Text | `label`: the text label to display next to the radio button.
-> m RadioButton | Returns: a new radio button.

Creates a new `RadioButton` with a text label.

## newWithLabelFromWidget

radioButtonNewWithLabelFromWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> Maybe a | `radioGroupMember`: widget to get radio group from or `Nothing`
-> Text | `label`: a text string to display next to the radio button.
-> m RadioButton | Returns: a new radio button.

Creates a new `RadioButton` with a text label, adding it to the same group as `radioGroupMember`.

## newWithMnemonic

radioButtonNewWithMnemonic Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> [a] | `group`: the radio button group, or `Nothing`
-> Text | `label`: the text of the button, with an underscore in front of the mnemonic character
-> m RadioButton | Returns: a new `RadioButton`

Creates a new `RadioButton` containing a label, adding it to the same group as `group`. The label will be created using `labelNewWithMnemonic`, so underscores in `label` indicate the mnemonic for the button.

## newWithMnemonicFromWidget

radioButtonNewWithMnemonicFromWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> Maybe a | `radioGroupMember`: widget to get radio group from or `Nothing`
-> Text | `label`: the text of the button, with an underscore in front of the mnemonic character
-> m RadioButton | Returns: a new `RadioButton`

Creates a new `RadioButton` containing a label. The label will be created using `labelNewWithMnemonic`, so underscores in `label` indicate the mnemonic for the button.

## setGroup

radioButtonSetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a, IsRadioButton b) |
=> a | `radioButton`: a `RadioButton`.
-> [b] | `group`: an existing radio button group, such as one returned from `radioButtonGetGroup`, or `Nothing`.
-> m () |

Sets a `RadioButton`’s group. It should be noted that this does not change the layout of your interface in any way, so if you are changing the group, it is likely you will need to re-arrange the user interface to reflect these changes.

# Properties

## group

Sets a new group for a radio button.

clearRadioButtonGroup :: (MonadIO m, IsRadioButton o) => o -> m () Source #

Set the value of the “`group`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #group

constructRadioButtonGroup :: (IsRadioButton o, MonadIO m, IsRadioButton a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`group`” property. This is rarely needed directly, but it is used by `new`.

setRadioButtonGroup :: (MonadIO m, IsRadioButton o, IsRadioButton a) => o -> a -> m () Source #

Set the value of the “`group`” property. When overloading is enabled, this is equivalent to

    set radioButton [ #group := value ]

# Signals

## groupChanged

type RadioButtonGroupChangedCallback = IO () Source #

Emitted when the group of radio buttons that a radio button belongs to changes. This is emitted when a radio button switches from being alone to being part of a group of 2 or more buttons, or vice-versa, and when a button is moved from one group of 2 or more buttons to a different one, but not when the composition of the group that a button belongs to changes.

Since: 2.4

afterRadioButtonGroupChanged :: (IsRadioButton a, MonadIO m) => a -> ((?self :: a) => RadioButtonGroupChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the groupChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after radioButton #groupChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onRadioButtonGroupChanged :: (IsRadioButton a, MonadIO m) => a -> ((?self :: a) => RadioButtonGroupChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the groupChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on radioButton #groupChanged callback