Struct gtk4::Notebook

pub struct Notebook(_);

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

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

GtkNotebook as GtkBuildable

The Notebook implementation of the Buildable 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 Notebook:

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

Notebook 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 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

Notebook uses the following roles:

• AccessibleRole::Group for the notebook widget
• AccessibleRole::TabList for the list of tabs
• AccessibleRole::Tab role for each tab
• AccessibleRole::TabPanel for each page

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Notebook

pub fn new() -> Notebook

Creates a new Notebook widget with no pages.

Returns

the newly created Notebook

pub fn builder() -> NotebookBuilder

Creates a new builder-pattern struct instance to construct Notebook objects.

This method returns an instance of NotebookBuilder which can be used to create Notebook objects.

pub fn detach_tab<P: IsA<Widget>>(&self, child: &P)

Removes the child from the notebook.

This function is very similar to remove_page(), but additionally informs the notebook that the removal is happening as part of a tab DND operation, which should not be cancelled.

child

a child

pub fn action_widget(&self, pack_type: PackType) -> Option<Widget>

Gets one of the action widgets.

See set_action_widget().

pack_type

pack type of the action widget to receive

Returns

The action widget with the given pack_type or None when this action widget has not been set

pub fn group_name(&self) -> Option<GString>

Gets the current group name for self.

Returns

the group name, or None if none is set

pub fn menu_label<P: IsA<Widget>>(&self, child: &P) -> Option<Widget>

Retrieves the menu label widget of the page containing child.

child

a widget contained in a page of self

Returns

the menu label, or None if the notebook page does not have a menu label other than the default (the tab label).

pub fn menu_label_text<P: IsA<Widget>>(&self, child: &P) -> Option<GString>

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

child

the child widget of a page of the notebook.

Returns

the text of the tab label, or None if the widget does not have a menu label other than the default menu label, or the menu label widget is not a Label. The string is owned by the widget and must not be freed.

pub fn page<P: IsA<Widget>>(&self, child: &P) -> Option<NotebookPage>

Returns the NotebookPage for child.

child

a child of self

Returns

the NotebookPage for child

pub fn pages(&self) -> Option<ListModel>

Returns a GListModel that contains the pages of the notebook.

This can be used to keep an up-to-date view. The model also implements SelectionModel and can be used to track and modify the visible page.

Returns

a GListModel for the notebook’s children

pub fn is_scrollable(&self) -> bool

Returns whether the tab label area has arrows for scrolling.

Returns

true if arrows for scrolling are present

pub fn shows_border(&self) -> bool

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

Returns

true if the bevel is drawn

pub fn shows_tabs(&self) -> bool

Returns whether the tabs of the notebook are shown.

Returns

true if the tabs are shown

pub fn tab_is_detachable<P: IsA<Widget>>(&self, child: &P) -> bool

Returns whether the tab contents can be detached from self.

child

a child Widget

Returns

true if the tab is detachable.

pub fn tab_label<P: IsA<Widget>>(&self, child: &P) -> Option<Widget>

Returns the tab label widget for the page child.

None is returned if child is not in self or if no tab label has specifically been set for child.

child

the page

Returns

the tab label

pub fn tab_label_text<P: IsA<Widget>>(&self, child: &P) -> Option<GString>

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

child

a widget contained in a page of self

Returns

the text of the tab label, or None if the tab label idget is not a Label. The string is owned by the widget and must not be freed.

pub fn tab_pos(&self) -> PositionType

Gets the edge at which the tabs are drawn.

Returns

the edge at which the tabs are drawn

pub fn tab_is_reorderable<P: IsA<Widget>>(&self, child: &P) -> bool

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

child

a child Widget

Returns

true if the tab is reorderable.

pub fn next_page(&self)

Switches to the next page.

Nothing happens if the current page is the last page.

pub fn popup_disable(&self)

Disables the popup menu.

pub fn popup_enable(&self)

Enables the popup menu.

If the user clicks with the right mouse button on the tab labels, a menu with all the pages will be popped up.

pub fn prev_page(&self)

Switches to the previous page.

Nothing happens if the current page is the first page.

pub fn set_action_widget<P: IsA<Widget>>(&self, widget: &P, pack_type: PackType)

Sets widget as one of the action widgets.

Depending on the pack type the widget will be placed before or after the tabs. You can use a Box if you need to pack more than one widget on the same side.

widget

a Widget

pack_type

pack type of the action widget

pub fn set_group_name(&self, group_name: Option<&str>)

Sets a group name for self.

Notebooks with the same name will be able to exchange tabs via drag and drop. A notebook with a None group name will not be able to exchange tabs with any other notebook.

group_name

the name of the notebook group, or None to unset it

pub fn set_menu_label<P: IsA<Widget>, Q: IsA<Widget>>(
    &self,
    child: &P,
    menu_label: Option<&Q>
)

Changes the menu label for the page containing child.

child

the child widget

menu_label

the menu label, or None for default

pub fn set_menu_label_text<P: IsA<Widget>>(&self, child: &P, menu_text: &str)

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

child

the child widget

menu_text

the label text

pub fn set_scrollable(&self, scrollable: bool)

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

scrollable

true if scroll arrows should be added

pub fn set_show_border(&self, show_border: bool)

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

This only has a visual effect when the tabs are not shown.

show_border

true if a bevel should be drawn around the notebook

pub fn set_show_tabs(&self, show_tabs: bool)

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

show_tabs

true if the tabs should be shown

pub fn set_tab_detachable<P: IsA<Widget>>(&self, child: &P, detachable: bool)

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

Note that two notebooks must share a common group identificator (see set_group_name()) to allow automatic tabs interchange between them.

If you want a widget to interact with a notebook through DnD (i.e.: accept dragged tabs from it) it must be set as a drop destination and accept the target “GTK_NOTEBOOK_TAB”. The notebook will fill the selection with a GtkWidget** pointing to the child widget that corresponds to the dropped tab.

Note that you should use detach_tab() instead of remove_page() if you want to remove the tab from the source notebook as part of accepting a drop. Otherwise, the source notebook will think that the dragged tab was removed from underneath the ongoing drag operation, and will initiate a drag cancel animation.

⚠️ The following code is in c ⚠️

static void
on_drag_data_received (GtkWidget        *widget,
                       GdkDrop          *drop,
                       GtkSelectionData *data,
                       guint             time,
                       gpointer          user_data)
{
  GtkDrag *drag;
  GtkWidget *notebook;
  GtkWidget **child;

  drag = gtk_drop_get_drag (drop);
  notebook = g_object_get_data (drag, "gtk-notebook-drag-origin");
  child = (void*) gtk_selection_data_get_data (data);

  // process_widget (*child);

  gtk_notebook_detach_tab (GTK_NOTEBOOK (notebook), *child);
}

If you want a notebook to accept drags from other widgets, you will have to set your own DnD code to do it.

child

a child Widget

detachable

whether the tab is detachable or not

pub fn set_tab_label<P: IsA<Widget>, Q: IsA<Widget>>(
    &self,
    child: &P,
    tab_label: Option<&Q>
)

Changes the tab label for child.

If None is specified for tab_label, then the page will have the label “page N”.

child

the page

tab_label

the tab label widget to use, or None for default tab label

pub fn set_tab_label_text<P: IsA<Widget>>(&self, child: &P, tab_text: &str)

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

child

the page

tab_text

the label text

pub fn set_tab_pos(&self, pos: PositionType)

Sets the edge at which the tabs are drawn.

pos

the edge to draw the tabs at

pub fn set_tab_reorderable<P: IsA<Widget>>(&self, child: &P, reorderable: bool)

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

child

a child Widget

reorderable

whether the tab is reorderable or not

pub fn enables_popup(&self) -> bool

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

pub fn set_enable_popup(&self, enable_popup: bool)

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

pub fn set_page(&self, page: i32)

The index of the current page.

pub fn connect_change_current_page<F: Fn(&Self, i32) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn emit_change_current_page(&self, object: i32) -> bool

pub fn connect_create_window<F: Fn(&Self, &Widget) -> Option<Notebook> + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

A handler for this signal can create a window containing a notebook where the tab will be attached. It is also responsible for moving/resizing the window and adding the necessary properties to the notebook (e.g. the Notebook:group-name ).

page

the tab of notebook that is being detached

Returns

a Notebook that page should be added to

pub fn connect_focus_tab<F: Fn(&Self, NotebookTab) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn emit_focus_tab(&self, object: NotebookTab) -> bool

pub fn connect_move_focus_out<F: Fn(&Self, DirectionType) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn emit_move_focus_out(&self, object: DirectionType)

pub fn connect_page_added<F: Fn(&Self, &Widget, u32) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

child

the child Widget affected

page_num

the new page number for child

pub fn connect_page_removed<F: Fn(&Self, &Widget, u32) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

child

the child Widget affected

page_num

the child page number

pub fn connect_page_reordered<F: Fn(&Self, &Widget, u32) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

child

the child Widget affected

page_num

the new page number for child

pub fn connect_reorder_tab<F: Fn(&Self, DirectionType, bool) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn emit_reorder_tab(&self, object: DirectionType, p0: bool) -> bool

pub fn connect_select_page<F: Fn(&Self, bool) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn emit_select_page(&self, object: bool) -> bool

pub fn connect_switch_page<F: Fn(&Self, &Widget, u32) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

page

the new current page

page_num

the index of the page

pub fn connect_enable_popup_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_group_name_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_page_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_pages_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_scrollable_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_show_border_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_show_tabs_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_tab_pos_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl Notebook

pub fn append_page<T: IsA<Widget>, U: IsA<Widget>>(
    &self,
    child: &T,
    tab_label: Option<&U>
) -> u32

Appends a page to self.

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

Returns

the index (starting from 0) of the appended page in the notebook, or -1 if function fails

pub fn append_page_menu<T, U, V>(
    &self,
    child: &T,
    tab_label: Option<&U>,
    menu_label: Option<&V>
) -> u32 where
    T: IsA<Widget>,
    U: IsA<Widget>,
    V: IsA<Widget>, 

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

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

menu_label

the widget to use as a label for the page-switch menu, if that is enabled. If None, and tab_label is a Label or None, then the menu label will be a newly created label with the same text as tab_label; if tab_label is not a Label, menu_label must be specified if the page-switch menu is to be used.

Returns

the index (starting from 0) of the appended page in the notebook, or -1 if function fails

pub fn current_page(&self) -> Option<u32>

Returns the page number of the current page.

Returns

the index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned.

pub fn n_pages(&self) -> u32

Gets the number of pages in a notebook.

Returns

the number of pages in the notebook

pub fn nth_page(&self, page_num: Option<u32>) -> Option<Widget>

Returns the child widget contained in page number page_num.

page_num

the index of a page in the notebook, or -1 to get the last page

Returns

the child widget, or None if page_num is out of bounds

pub fn insert_page<T, U>(
    &self,
    child: &T,
    tab_label: Option<&U>,
    position: Option<u32>
) -> u32 where
    T: IsA<Widget>,
    U: IsA<Widget>, 

Insert a page into self at the given position.

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

position

the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages

Returns

the index (starting from 0) of the inserted page in the notebook, or -1 if function fails

pub fn insert_page_menu<T, U, V>(
    &self,
    child: &T,
    tab_label: Option<&U>,
    menu_label: Option<&V>,
    position: Option<u32>
) -> u32 where
    T: IsA<Widget>,
    U: IsA<Widget>,
    V: IsA<Widget>, 

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

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

menu_label

the widget to use as a label for the page-switch menu, if that is enabled. If None, and tab_label is a Label or None, then the menu label will be a newly created label with the same text as tab_label; if tab_label is not a Label, menu_label must be specified if the page-switch menu is to be used.

position

the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages.

Returns

the index (starting from 0) of the inserted page in the notebook

pub fn page_num<T: IsA<Widget>>(&self, child: &T) -> Option<u32>

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

child

a Widget

Returns

the index of the page containing child, or -1 if child is not in the notebook

pub fn prepend_page<T, U>(&self, child: &T, tab_label: Option<&U>) -> u32 where
    T: IsA<Widget>,
    U: IsA<Widget>, 

Prepends a page to self.

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

Returns

the index (starting from 0) of the prepended page in the notebook, or -1 if function fails

pub fn prepend_page_menu<T, U, V>(
    &self,
    child: &T,
    tab_label: Option<&U>,
    menu_label: Option<&V>
) -> u32 where
    T: IsA<Widget>,
    U: IsA<Widget>,
    V: IsA<Widget>, 

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

child

the Widget to use as the contents of the page

tab_label

the Widget to be used as the label for the page, or None to use the default label, “page N”

menu_label

the widget to use as a label for the page-switch menu, if that is enabled. If None, and tab_label is a Label or None, then the menu label will be a newly created label with the same text as tab_label; if tab_label is not a Label, menu_label must be specified if the page-switch menu is to be used.

Returns

the index (starting from 0) of the prepended page in the notebook, or -1 if function fails

pub fn remove_page(&self, page_num: Option<u32>)

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

page_num

the index of a notebook page, starting from 0. If -1, the last page will be removed.

pub fn reorder_child<T: IsA<Widget>>(&self, child: &T, position: Option<u32>)

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

If position is greater than or equal to the number of children in the list or negative, child will be moved to the end of the list.

child

the child to move

position

the new position, or -1 to move to the end

pub fn set_current_page(&self, page_num: Option<u32>)

Switches to the page number page_num.

Note that due to historical reasons, GtkNotebook refuses to switch to a page unless the child widget is visible. Therefore, it is recommended to show child widgets before adding them to a notebook.

page_num

index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the notebook, nothing will be done.

Trait Implementations

impl Clone for Notebook

fn clone(&self) -> Notebook

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Notebook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Notebook

fn default() -> Self

Returns the “default value” for a type.

impl Display for Notebook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Notebook

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Notebook

fn cmp(&self, other: &Notebook) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl ParentClassIs for Notebook

type Parent = Widget

impl<T: ObjectType> PartialEq<T> for Notebook

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Notebook

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Notebook

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Notebook

impl IsA<Accessible> for Notebook

impl IsA<Buildable> for Notebook

impl IsA<ConstraintTarget> for Notebook

impl IsA<Widget> for Notebook

impl StructuralEq for Notebook