Notebook
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 method@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 method@Gtk.Notebook.set_scrollable), and whether there will be a popup menu allowing the users to switch pages. (see method@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>Shortcuts and Gestures
GtkNotebook supports the following keyboard shortcuts:
Shift+F10 or Menu opens the context menu.
Home moves the focus to the first tab.
End moves the focus to the last tab.
Additionally, the following signals have default keybindings:
signal@Gtk.Notebook::change-current-page
signal@Gtk.Notebook::focus-tab
signal@Gtk.Notebook::move-focus-out
signal@Gtk.Notebook::reorder-tab
signal@Gtk.Notebook::select-page
Tabs support drag-and-drop between notebooks sharing the same group-name, or to new windows by handling the ::create-window signal.
Actions
GtkNotebook defines a set of built-in actions:
menu.popupopens the tabs context menu.
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 method@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
Skipped during bindings generation
method
enable-popup: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
A list of css classes applied to this widget.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
If true, scroll arrows are added if there are too many pages to fit.
Whether the border should be shown.
Which side of the notebook holds the tabs.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Whether to use the vexpand property.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Requests the user's screen reader to announce the given message.
Appends a page to @notebook.
Appends a page to @notebook, specifying the widget to use as the label in the popup menu.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the current page should be changed.
The ::create-window signal is emitted when a detachable tab is dropped on the root window.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when a tab should be focused.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when focus was moved out.
the ::page-added signal is emitted in the notebook right after a page is added to the notebook.
the ::page-removed signal is emitted in the notebook right after a page is removed from the notebook.
the ::page-reordered signal is emitted in the notebook right after a page has been reordered.
Emitted when the widget’s tooltip is about to be shown.
Emitted when @widget is associated with a GdkSurface.
Emitted when the tab should be reordered.
Emitted when a page should be selected.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when the user or a function changes the current page.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Gets one of the action widgets.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Returns the current focus child of @widget.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Returns the widget’s last child.
Retrieves the menu label widget of the page containing @child.
Retrieves the text of the menu label for the page containing
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
Returns the child widget contained in page number @page_num.
Returns the GtkNotebookPage for @child.
Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Returns whether the tab contents can be detached from @notebook.
Returns the tab label widget for the page @child.
Retrieves the text of the tab label for the page containing
Gets whether the tab can be reordered via drag and drop or not.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Determines whether the widget is visible.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Insert a page into @notebook at the given position.
Insert a page into @notebook at the given position, specifying the widget to use as the label in the popup menu.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Disables the popup menu.
Enables the popup menu.
Prepends a page to @notebook.
Prepends a page to @notebook, specifying the widget to use as the label in the popup menu.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a page from the notebook given its index in the notebook.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Reorders the page containing @child, so that it appears in position
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Sets the parent and sibling of an accessible object.
Sets @widget as one of the action widgets.
Sets whether @widget should be mapped along with its parent.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Changes the menu label for the page containing @child.
Creates a new label and sets it as the menu label of @child.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets whether the tab can be detached from @notebook to another notebook or widget.
Changes the tab label for @child.
Creates a new label and sets it as the tab label for the page containing @child.
Sets whether the notebook tab can be reordered via drag and drop or not.
Sets the visibility state of @widget.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.