gi-gtk-3.0.31: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.RadioToolButton

Contents

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

Exported types

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

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

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

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, IsRadioToolButton a) => a -> IO (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 ]