Gtk.Notebook
Description: Reference for Gtk.Notebook

### Class

# GtkNotebook

since: 4.0

#### Description [src]

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

`GtkNotebook` is a container whose children are pages switched between using tabs.

There are many configuration options for `GtkNotebook`. Among other things, you can choose on which edge the tabs appear (see `gtk_notebook_set_tab_pos()`), whether, if there are too many tabs to fit the notebook should be made bigger or scrolling arrows added (see `gtk_notebook_set_scrollable()`), and whether there will be a popup menu allowing the users to switch pages. (see `gtk_notebook_popup_enable()`).

# GtkNotebook as GtkBuildable

The `GtkNotebook` implementation of the `GtkBuildable` interface supports placing children into tabs by specifying “tab” as the “type” attribute of a `<child>` element. Note that the content of the tab must be created before the tab can be filled. A tab child can be specified without specifying a `<child>` type attribute.

To add a child widget in the notebooks action area, specify “action-start” or “action-end” as the “type” attribute of the `<child>` element.

An example of a UI definition fragment with `GtkNotebook`:

    <object class="GtkNotebook">
      <child>
        <object class="GtkLabel" id="notebook-content">
          <property name="label">Content</property>
        </object>
      </child>
      <child type="tab">
        <object class="GtkLabel" id="notebook-tab">
          <property name="label">Tab</property>
        </object>
      </child>
    </object>

# CSS nodes

    notebook
    ├── header.top
    │   ├── [<action widget>]
    │   ├── tabs
    │   │   ├── [arrow]
    │   │   ├── tab
    │   │   │   ╰── <tab label>
    ┊   ┊   ┊
    │   │   ├── tab[.reorderable-page]
    │   │   │   ╰── <tab label>
    │   │   ╰── [arrow]
    │   ╰── [<action widget>]
    │
    ╰── stack
        ├── <child>
        ┊
        ╰── <child>

`GtkNotebook` has a main CSS node with name `notebook`, a subnode with name `header` and below that a subnode with name `tabs` which contains one subnode per tab with name `tab`.

If action widgets are present, their CSS nodes are placed next to the `tabs` node. If the notebook is scrollable, CSS nodes with name `arrow` are placed as first and last child of the `tabs` node.

The main node gets the `.frame` style class when the notebook has a border (see `gtk_notebook_set_show_border()`).

The header node gets one of the style class `.top`, `.bottom`, `.left` or `.right`, depending on where the tabs are placed. For reorderable pages, the tab node gets the `.reorderable-page` class.

A `tab` node gets the `.dnd` style class while it is moved with drag-and-drop.

The nodes are always arranged from left-to-right, regardless of text direction.

# Accessibility

`GtkNotebook` uses the following roles:

- `GTK_ACCESSIBLE_ROLE_GROUP` for the notebook widget
- `GTK_ACCESSIBLE_ROLE_TAB_LIST` for the list of tabs
- `GTK_ACCESSIBLE_ROLE_TAB` role for each tab
- `GTK_ACCESSIBLE_ROLE_TAB_PANEL` for each page.

Available since: 4.0

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget

#### Constructors

###### gtk_notebook_new

Creates a new `GtkNotebook` widget with no pages.

since: 4.0

#### Instance methods

###### gtk_notebook_append_page

Appends a page to `notebook`.

since: 4.0

###### gtk_notebook_append_page_menu

Appends a page to `notebook`, specifying the widget to use as the label in the popup menu.

since: 4.0

###### gtk_notebook_detach_tab

Removes the child from the notebook.

since: 4.0

###### gtk_notebook_get_action_widget

Gets one of the action widgets.

since: 4.0

###### gtk_notebook_get_current_page

Returns the page number of the current page.

since: 4.0

###### gtk_notebook_get_group_name

Gets the current group name for `notebook`.

since: 4.0

###### gtk_notebook_get_menu_label

Retrieves the menu label widget of the page containing `child`.

since: 4.0

###### gtk_notebook_get_menu_label_text

Retrieves the text of the menu label for the page containing `child`.

since: 4.0

###### gtk_notebook_get_n_pages

Gets the number of pages in a notebook.

since: 4.0

###### gtk_notebook_get_nth_page

Returns the child widget contained in page number `page_num`.

since: 4.0

###### gtk_notebook_get_page

Returns the `GtkNotebookPage` for `child`.

since: 4.0

###### gtk_notebook_get_pages

Returns a `GListModel` that contains the pages of the notebook.

since: 4.0

###### gtk_notebook_get_scrollable

Returns whether the tab label area has arrows for scrolling.

since: 4.0

###### gtk_notebook_get_show_border

Returns whether a bevel will be drawn around the notebook pages.

since: 4.0

###### gtk_notebook_get_show_tabs

Returns whether the tabs of the notebook are shown.

since: 4.0

###### gtk_notebook_get_tab_detachable

Returns whether the tab contents can be detached from `notebook`.

since: 4.0

###### gtk_notebook_get_tab_label

Returns the tab label widget for the page `child`.

since: 4.0

###### gtk_notebook_get_tab_label_text

Retrieves the text of the tab label for the page containing `child`.

since: 4.0

###### gtk_notebook_get_tab_pos

Gets the edge at which the tabs are drawn.

since: 4.0

###### gtk_notebook_get_tab_reorderable

Gets whether the tab can be reordered via drag and drop or not.

since: 4.0

###### gtk_notebook_insert_page

Insert a page into `notebook` at the given position.

since: 4.0

###### gtk_notebook_insert_page_menu

Insert a page into `notebook` at the given position, specifying the widget to use as the label in the popup menu.

since: 4.0

###### gtk_notebook_next_page

Switches to the next page.

since: 4.0

###### gtk_notebook_page_num

Finds the index of the page which contains the given child widget.

since: 4.0

###### gtk_notebook_popup_disable

Disables the popup menu.

since: 4.0

###### gtk_notebook_popup_enable

Enables the popup menu.

since: 4.0

###### gtk_notebook_prepend_page

Prepends a page to `notebook`.

since: 4.0

###### gtk_notebook_prepend_page_menu

Prepends a page to `notebook`, specifying the widget to use as the label in the popup menu.

since: 4.0

###### gtk_notebook_prev_page

Switches to the previous page.

since: 4.0

###### gtk_notebook_remove_page

Removes a page from the notebook given its index in the notebook.

since: 4.0

###### gtk_notebook_reorder_child

Reorders the page containing `child`, so that it appears in position `position`.

since: 4.0

###### gtk_notebook_set_action_widget

Sets `widget` as one of the action widgets.

since: 4.0

###### gtk_notebook_set_current_page

Switches to the page number `page_num`.

since: 4.0

###### gtk_notebook_set_group_name

Sets a group name for `notebook`.

since: 4.0

###### gtk_notebook_set_menu_label

Changes the menu label for the page containing `child`.

since: 4.0

###### gtk_notebook_set_menu_label_text

Creates a new label and sets it as the menu label of `child`.

since: 4.0

###### gtk_notebook_set_scrollable

Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area.

since: 4.0

###### gtk_notebook_set_show_border

Sets whether a bevel will be drawn around the notebook pages.

since: 4.0

###### gtk_notebook_set_show_tabs

Sets whether to show the tabs for the notebook or not.

since: 4.0

###### gtk_notebook_set_tab_detachable

Sets whether the tab can be detached from `notebook` to another notebook or widget.

since: 4.0

###### gtk_notebook_set_tab_label

Changes the tab label for `child`.

since: 4.0

###### gtk_notebook_set_tab_label_text

Creates a new label and sets it as the tab label for the page containing `child`.

since: 4.0

###### gtk_notebook_set_tab_pos

Sets the edge at which the tabs are drawn.

since: 4.0

###### gtk_notebook_set_tab_reorderable

Sets whether the notebook tab can be reordered via drag and drop or not.

since: 4.0

##### Methods inherited from GtkWidget (162)

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 (18)

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

since: 4.0

###### gtk_accessible_get_at_context

Retrieves the accessible implementation for the given `GtkAccessible`.

since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

###### gtk_accessible_reset_property

Resets the accessible `property` to its default value.

since: 4.0

###### gtk_accessible_reset_relation

Resets the accessible `relation` to its default value.

since: 4.0

###### gtk_accessible_reset_state

Resets the accessible `state` to its default value.

since: 4.0

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`.

since: 4.10

###### gtk_accessible_update_property

Updates a list of accessible properties.

since: 4.0

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

since: 4.0

###### gtk_accessible_update_relation

Updates a list of accessible relations.

since: 4.0

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

since: 4.0

###### gtk_accessible_update_state

Updates a list of accessible states. See the `GtkAccessibleState` documentation for the value types of accessible states.

since: 4.0

###### gtk_accessible_update_state_value

Updates an array of accessible states.

since: 4.0

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

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

since: 4.0

#### Properties

###### Gtk.Notebook:enable-popup

If `TRUE`, pressing the right mouse button on the notebook shows a page switching menu.

since: 4.0

###### Gtk.Notebook:group-name

Group name for tab drag and drop.

since: 4.0

###### Gtk.Notebook:page

The index of the current page.

since: 4.0

###### Gtk.Notebook:pages

A selection model with the pages.

since: 4.0

###### Gtk.Notebook:scrollable

If `TRUE`, scroll arrows are added if there are too many pages to fit.

since: 4.0

###### Gtk.Notebook:show-border

Whether the border should be shown.

since: 4.0

###### Gtk.Notebook:show-tabs

Whether tabs should be shown.

since: 4.0

###### Gtk.Notebook:tab-pos

Which side of the notebook holds the tabs.

since: 4.0

##### Properties inherited from GtkWidget (34)

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

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

since: 4.0

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

Whether the widget can receive pointer events.

since: 4.0

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

A list of css classes applied to this widget.

since: 4.0

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

The name of this widget in the CSS tree.

since: 4.0

###### Gtk.Widget:cursor

The cursor used by `widget`.

since: 4.0

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

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

since: 4.0

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

since: 4.0

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

since: 4.0

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

Whether the widget is the default widget.

since: 4.0

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

Whether the widget has the input focus.

since: 4.0

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

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

since: 4.0

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

Override for height request of the widget.

since: 4.0

###### Gtk.Widget:hexpand

Whether to expand horizontally.

since: 4.0

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

Whether to use the `hexpand` property.

since: 4.0

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

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

since: 4.0

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

Margin on bottom side of widget.

since: 4.0

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

Margin on end of widget, horizontally.

since: 4.0

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

Margin on start of widget, horizontally.

since: 4.0

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

Margin on top side of widget.

since: 4.0

###### Gtk.Widget:name

The name of the widget.

since: 4.0

###### Gtk.Widget:opacity

The requested opacity of the widget.

since: 4.0

###### Gtk.Widget:overflow

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

since: 4.0

###### Gtk.Widget:parent

The parent widget of this widget.

since: 4.0

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

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

since: 4.0

###### Gtk.Widget:root

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

since: 4.0

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

The scale factor of the widget.

since: 4.0

###### Gtk.Widget:sensitive

Whether the widget responds to input.

since: 4.0

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

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

since: 4.0

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

Sets the text of tooltip to be the given string.

since: 4.0

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

since: 4.0

###### Gtk.Widget:vexpand

Whether to expand vertically.

since: 4.0

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

Whether to use the `vexpand` property.

since: 4.0

###### Gtk.Widget:visible

Whether the widget is visible.

since: 4.0

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

Override for width request of the widget.

since: 4.0

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

###### GtkAccessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

since: 4.0

#### Signals

###### Gtk.Notebook::change-current-page

No description available.

since: 4.0

###### Gtk.Notebook::create-window

The ::create-window signal is emitted when a detachable tab is dropped on the root window.

since: 4.0

###### Gtk.Notebook::focus-tab

No description available.

since: 4.0

###### Gtk.Notebook::move-focus-out

No description available.

since: 4.0

###### Gtk.Notebook::page-added

The ::page-added signal is emitted in the notebook right after a page is added to the notebook.

since: 4.0

###### Gtk.Notebook::page-removed

The ::page-removed signal is emitted in the notebook right after a page is removed from the notebook.

since: 4.0

###### Gtk.Notebook::page-reordered

The ::page-reordered signal is emitted in the notebook right after a page has been reordered.

since: 4.0

###### Gtk.Notebook::reorder-tab

No description available.

since: 4.0

###### Gtk.Notebook::select-page

No description available.

since: 4.0

###### Gtk.Notebook::switch-page

Emitted when the user or a function changes the current page.

since: 4.0

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

###### GtkWidget::destroy

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

since: 4.0

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

Emitted when the text direction of a widget changes.

since: 4.0

###### GtkWidget::hide

Emitted when `widget` is hidden.

since: 4.0

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

Emitted if keyboard navigation fails.

since: 4.0

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

since: 4.0

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

Emitted when a widget is activated via a mnemonic.

since: 4.0

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

Emitted when the focus is moved.

since: 4.0

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

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

since: 4.0

###### GtkWidget::realize

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

since: 4.0

###### GtkWidget::show

Emitted when `widget` is shown.

since: 4.0

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

Emitted when the widget state changes.

since: 4.0

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

since: 4.0

###### GtkWidget::unrealize

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

since: 4.0

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

since: 2.0