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.RadioToolButton

Contents

- Exported types
- Methods
  - getGroup
  - new
  - newFromStock
  - newFromWidget
  - newWithStockFromWidget
  - setGroup
- Properties
  - group

Description

A `RadioToolButton` is a `ToolItem` that contains a radio button, that is, a button that is part of a group of toggle buttons where only one button can be active at a time.

Use `radioToolButtonNew` to create a new GtkRadioToolButton. Use `radioToolButtonNewFromWidget` to create a new GtkRadioToolButton that is part of the same group as an existing GtkRadioToolButton.

# CSS nodes

GtkRadioToolButton has a single CSS node with name toolbutton.

Synopsis

- newtype RadioToolButton = RadioToolButton (ManagedPtr RadioToolButton)
- class (GObject o, IsDescendantOf RadioToolButton o) => IsRadioToolButton o
- toRadioToolButton :: (MonadIO m, IsRadioToolButton o) => o -> m RadioToolButton
- radioToolButtonGetGroup :: (HasCallStack, MonadIO m, IsRadioToolButton a) => a -> m [RadioButton]
- radioToolButtonNew :: (HasCallStack, MonadIO m, IsRadioButton a) => [a] -> m RadioToolButton
- radioToolButtonNewFromStock :: (HasCallStack, MonadIO m, IsRadioButton a) => [a] -> Text -> m RadioToolButton
- radioToolButtonNewFromWidget :: (HasCallStack, MonadIO m, IsRadioToolButton a) => Maybe a -> m RadioToolButton
- radioToolButtonNewWithStockFromWidget :: (HasCallStack, MonadIO m, IsRadioToolButton a) => Maybe a -> Text -> m RadioToolButton
- radioToolButtonSetGroup :: (HasCallStack, MonadIO m, IsRadioToolButton a, IsRadioButton b) => a -> [b] -> m ()
- clearRadioToolButtonGroup :: (MonadIO m, IsRadioToolButton o) => o -> m ()
- constructRadioToolButtonGroup :: (IsRadioToolButton o, MonadIO m, IsRadioToolButton a) => a -> m (GValueConstruct o)
- setRadioToolButtonGroup :: (MonadIO m, IsRadioToolButton o, IsRadioToolButton a) => o -> a -> m ()

# Exported types

newtype RadioToolButton Source #

Memory-managed wrapper type.

Constructors

RadioToolButton (ManagedPtr RadioToolButton) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf RadioToolButton o) => IsRadioToolButton o Source #

Type class for types which can be safely cast to `RadioToolButton`, for instance with `toRadioToolButton`.

#### Instances

Instances details

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

toRadioToolButton :: (MonadIO m, IsRadioToolButton o) => o -> m RadioToolButton Source #

Cast to `RadioToolButton`, 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, 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, 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, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, rebuildMenu, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, retrieveProxyMenuItem, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, toolbarReconfigured, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getActionName, getActionTargetValue, getActive, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEllipsizeMode, getEvents, getExpand, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getIconName, getIconSize, getIconWidget, getInternalChild, getIsImportant, getLabel, getLabelWidget, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getProxyMenuItem, getQdata, getRealized, getReceivesDefault, getRelatedAction, getReliefStyle, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStockId, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTextAlignment, getTextOrientation, getTextSizeGroup, getToolbarStyle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseDragWindow, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleHorizontal, getVisibleVertical, getVisual, getWindow.

#### Setters

setAccelPath, setActionName, setActionTargetValue, setActive, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setExpand, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setGroup, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setIconName, setIconWidget, setIsImportant, setLabel, setLabelWidget, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setProxyMenuItem, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStockId, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setUseDragWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisibleHorizontal, setVisibleVertical, setVisual, setWindow.

## getGroup

radioToolButtonGetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioToolButton a) |
=> a | `button`: a `RadioToolButton`
-> m [RadioButton] | Returns: The group `button` belongs to.

Returns the radio button group `button` belongs to.

Since: 2.4

## new

radioToolButtonNew Source #

Arguments

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

Creates a new `RadioToolButton`, adding it to `group`.

Since: 2.4

## newFromStock

radioToolButtonNewFromStock Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioButton a) |
=> [a] | `group`: an existing radio button group, or `Nothing` if you are creating a new group
-> Text | `stockId`: the name of a stock item
-> m RadioToolButton | Returns: The new `RadioToolButton`

Deprecated: (Since version 3.10)Use `radioToolButtonNew` instead.

Creates a new `RadioToolButton`, adding it to `group`. The new `RadioToolButton` will contain an icon and label from the stock item indicated by `stockId`.

Since: 2.4

## newFromWidget

radioToolButtonNewFromWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioToolButton a) |
=> Maybe a | `group`: An existing `RadioToolButton`, or `Nothing`
-> m RadioToolButton | Returns: The new `RadioToolButton`

Creates a new `RadioToolButton` adding it to the same group as `gruup`

Since: 2.4

## newWithStockFromWidget

radioToolButtonNewWithStockFromWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioToolButton a) |
=> Maybe a | `group`: An existing `RadioToolButton`.
-> Text | `stockId`: the name of a stock item
-> m RadioToolButton | Returns: A new `RadioToolButton`

Deprecated: (Since version 3.10)gtk_radio_tool_button_new_from_widget

Creates a new `RadioToolButton` adding it to the same group as `group`. The new `RadioToolButton` will contain an icon and label from the stock item indicated by `stockId`.

Since: 2.4

## setGroup

radioToolButtonSetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsRadioToolButton a, IsRadioButton b) |
=> a | `button`: a `RadioToolButton`
-> [b] | `group`: an existing radio button group, or `Nothing`
-> m () |

Adds `button` to `group`, removing it from the group it belonged to before.

Since: 2.4

# Properties

## group

Sets a new group for a radio tool button.

Since: 2.4

clearRadioToolButtonGroup :: (MonadIO m, IsRadioToolButton o) => o -> m () Source #

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

    clear #group

constructRadioToolButtonGroup :: (IsRadioToolButton o, MonadIO m, IsRadioToolButton 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`.

setRadioToolButtonGroup :: (MonadIO m, IsRadioToolButton o, IsRadioToolButton a) => o -> a -> m () Source #

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

    set radioToolButton [ #group := value ]