Adw.ToggleGroup
Description: Reference for Adw.ToggleGroup

### Class

# AdwToggleGroup

since: 1.7

#### Description [src]

    final class Adw.ToggleGroup : Gtk.Widget
      implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
      /* No available fields */
    }

A group of exclusive toggles.

`AdwToggleGroup` presents a set of exclusive toggles, represented as `AdwToggle` objects. Each toggle can display an icon, a label, an icon and a label, or a custom child.

Toggles are indexed by their position, with the first toggle being equivalent to 0, and so on. Use the `AdwToggleGroup:active` to get that position.

Toggles can also have optional names, set via the `AdwToggle:name` property. The name of the active toggle can be accessed via the `AdwToggleGroup:active-name` property.

`AdwToggle` objects can be retrieved via their index or name, using `adw_toggle_group_get_toggle()` or `adw_toggle_group_get_toggle_by_name()` respectively. `AdwToggleGroup` also provides a `GtkSelectionModel` of its toggles via the `AdwToggleGroup:toggles` property.

`AdwToggleGroup` is orientable, and the toggles can be displayed horizontally or vertically. This is mostly useful for icon-only toggles.

Use the `AdwToggleGroup:homogeneous` property to make the toggles take the same size, and the `AdwToggleGroup:can-shrink` to control whether the toggles can ellipsize.

Example of an `AdwToggleGroup` UI definition:

     <object class="AdwToggleGroup">
       <property name="active-name">picture</property>
       <child>
         <object class="AdwToggle">
           <property name="icon-name">camera-photo-symbolic</property>
           <property name="tooltip" translatable="yes">Picture Mode</property>
           <property name="name">picture</property>
         </object>
       </child>
       <child>
         <object class="AdwToggle">
           <property name="icon-name">camera-video-symbolic</property>
           <property name="tooltip" translatable="yes">Recording Mode</property>
           <property name="name">recording</property>
         </object>
       </child>
     </object>

See also: `AdwInlineViewSwitcher`.

## CSS nodes

`AdwToggleGroup` has a main CSS node with the name `toggle-group`.

Its toggles have CSS nodes with the name `toggle`, and its separators have nodes with the name `separator`.

Toggle nodes will have a different style classes depending on their content: `.text-button` for labels, `.image-button` for icons, `.image-text-button` for both or no style class for custom children.

The hidden separators use the `.hidden` style class.

## Style classes

`AdwToggleGroup` can use the `.flat` style class to remove its background and make it look like a group of buttons.

It can also use the `.round` style class to make its toggles and the group itself rounded.

They can also be combined with each other.

## Accessibility

`AdwToggleGroup` uses the `GTK_ACCESSIBLE_ROLE_RADIO_GROUP` role. Its toggles use the `GTK_ACCESSIBLE_ROLE_RADIO` role.

Available since: 1.7

#### Hierarchy

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable

#### Constructors

###### adw_toggle_group_new

Creates a new `AdwToggleGroup`.

since: 1.7

#### Instance methods

###### adw_toggle_group_add

Adds a toggle to `self`.

since: 1.7

###### adw_toggle_group_get_active

Gets the index of the active toggle in `self`.

since: 1.7

###### adw_toggle_group_get_active_name

Gets the name of the active toggle in `self`.

since: 1.7

###### adw_toggle_group_get_can_shrink

Gets whether the toggles can be smaller than the natural size of their contents.

since: 1.7

###### adw_toggle_group_get_homogeneous

Gets whether all toggles take the same size.

since: 1.7

###### adw_toggle_group_get_n_toggles

Gets the number of toggles within `self`.

since: 1.7

###### adw_toggle_group_get_toggle

Gets the toggle with `index` from `self`.

since: 1.7

###### adw_toggle_group_get_toggle_by_name

Gets the toggle with the name `name` from `self`.

since: 1.7

###### adw_toggle_group_get_toggles

Returns a `GListModel` that contains the toggles of the group.

###### adw_toggle_group_remove

Removes `toggle` from `self`.

since: 1.7

###### adw_toggle_group_remove_all

Removes all toggles from `self`.

since: 1.7

###### adw_toggle_group_set_active

Sets the active toggle for `self`.

since: 1.7

###### adw_toggle_group_set_active_name

Sets the active toggle for `self`.

since: 1.7

###### adw_toggle_group_set_can_shrink

Sets whether the toggles can be smaller than the natural size of their contents.

since: 1.7

###### adw_toggle_group_set_homogeneous

Sets whether all toggles take the same size.

since: 1.7

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (21)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

###### gtk_accessible_get_accessible_id

Retrieves the accessible identifier for the accessible object.

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

##### Methods inherited from GtkOrientable (2)

###### gtk_orientable_get_orientation

Retrieves the orientation of the `orientable`.

###### gtk_orientable_set_orientation

Sets the orientation of the `orientable`.

#### Properties

###### Adw.ToggleGroup:active

The index of the active toggle.

since: 1.7

###### Adw.ToggleGroup:active-name

The name of the active toggle.

since: 1.7

###### Adw.ToggleGroup:can-shrink

Whether the toggles can be smaller than the natural size of their contents.

since: 1.7

###### Adw.ToggleGroup:homogeneous

Whether all toggles take the same size.

since: 1.7

###### Adw.ToggleGroup:n-toggles

The number of toggles within the group.

since: 1.7

###### Adw.ToggleGroup:toggles

A selection model with the groups’s toggles.

since: 1.7

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

##### Properties inherited from GtkOrientable (1)

###### Gtk.Orientable:orientation

The orientation of the orientable.

#### Signals

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AdwToggleGroupClass {
      GtkWidgetClass parent_class;

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`

  No description available.