class Gtk::Notebook

• Gtk::Notebook
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

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

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

Gtk::Notebook as Gtk::Buildable

The Gtk::Notebook implementation of the Gtk::Buildable interface supports placing children into tabs by specifying “tab” as the “type” attribute of a 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 type attribute.

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

An example of a UI definition fragment with Gtk::Notebook:

WARNING ⚠️ The following code is in xml ⚠️

<object class="Gtk::Notebook">
  <child>
    <object class="Gtk::Label" id="notebook-content">
      <property name="label">Content</property>
    </object>
  </child>
  <child type="tab">
    <object class="Gtk::Label" 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>

Gtk::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 Gtk::Notebook#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

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

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget

Defined in:

Constructors

• .new : self

  Creates a new Gtk::Notebook widget with no pages.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, enable_popup : Bool | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, group_name : String | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, page : Int32 | Nil = nil, pages : Gio::ListModel | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, scrollable : Bool | Nil = nil, sensitive : Bool | Nil = nil, show_border : Bool | Nil = nil, show_tabs : Bool | Nil = nil, tab_pos : Gtk::PositionType | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #action_widget(pack_type : Gtk::PackType) : Gtk::Widget | Nil

  Gets one of the action widgets.

• #append_page(child : Gtk::Widget, tab_label : Gtk::Widget | Nil) : Int32

  Appends a page to notebook.

• #append_page_menu(child : Gtk::Widget, tab_label : Gtk::Widget | Nil, menu_label : Gtk::Widget | Nil) : Int32

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

• #change_current_page_signal
• #create_window_signal
• #current_page : Int32

  Returns the page number of the current page.

• #current_page=(page_num : Int32) : Nil

  Switches to the page number page_num.

• #detach_tab(child : Gtk::Widget) : Nil

  Removes the child from the notebook.

• #enable_popup=(value : Bool) : Bool
• #enable_popup? : Bool
• #focus_tab_signal
• #group_name : String | Nil

  Gets the current group name for notebook.

• #group_name=(value : String) : String
• #group_name=(value : Nil) : Nil

  Set #group_name property to nil.

• #group_name=(group_name : String | Nil) : Nil

  Sets a group name for notebook.

• #group_name? : String | Nil

  Same as #group_name, but can return nil.

• #hash(hasher)

  See Object#hash(hasher)

• #insert_page(child : Gtk::Widget, tab_label : Gtk::Widget | Nil, position : Int32) : Int32

  Insert a page into notebook at the given position.

• #insert_page_menu(child : Gtk::Widget, tab_label : Gtk::Widget | Nil, menu_label : Gtk::Widget | Nil, position : Int32) : Int32

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

• #menu_label(child : Gtk::Widget) : Gtk::Widget | Nil

  Retrieves the menu label widget of the page containing child.

• #menu_label_text(child : Gtk::Widget) : String | Nil

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

• #move_focus_out_signal
• #n_pages : Int32

  Gets the number of pages in a notebook.

• #next_page : Nil

  Switches to the next page.

• #nth_page(page_num : Int32) : Gtk::Widget | Nil

  Returns the child widget contained in page number page_num.

• #page(child : Gtk::Widget) : Gtk::NotebookPage

  Returns the Gtk::NotebookPage for child.

• #page : Int32
• #page=(value : Int32) : Int32
• #page_added_signal
• #page_num(child : Gtk::Widget) : Int32

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

• #page_removed_signal
• #page_reordered_signal
• #pages : Gio::ListModel

  Returns a GListModel that contains the pages of the notebook.

• #popup_disable : Nil

  Disables the popup menu.

• #popup_enable : Nil

  Enables the popup menu.

• #prepend_page(child : Gtk::Widget, tab_label : Gtk::Widget | Nil) : Int32

  Prepends a page to notebook.

• #prepend_page_menu(child : Gtk::Widget, tab_label : Gtk::Widget | Nil, menu_label : Gtk::Widget | Nil) : Int32

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

• #prev_page : Nil

  Switches to the previous page.

• #remove_page(page_num : Int32) : Nil

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

• #reorder_child(child : Gtk::Widget, position : Int32) : Nil

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

• #reorder_tab_signal
• #scrollable : Bool

  Returns whether the tab label area has arrows for scrolling.

• #scrollable=(scrollable : Bool) : Nil

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

• #scrollable? : Bool
• #select_page_signal
• #set_action_widget(widget : Gtk::Widget, pack_type : Gtk::PackType) : Nil

  Sets widget as one of the action widgets.

• #set_menu_label(child : Gtk::Widget, menu_label : Gtk::Widget | Nil) : Nil

  Changes the menu label for the page containing child.

• #set_menu_label_text(child : Gtk::Widget, menu_text : String) : Nil

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

• #set_tab_detachable(child : Gtk::Widget, detachable : Bool) : Nil

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

• #set_tab_label(child : Gtk::Widget, tab_label : Gtk::Widget | Nil) : Nil

  Changes the tab label for child.

• #set_tab_label_text(child : Gtk::Widget, tab_text : String) : Nil

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

• #set_tab_reorderable(child : Gtk::Widget, reorderable : Bool) : Nil

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

• #show_border : Bool

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

• #show_border=(show_border : Bool) : Nil

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

• #show_border? : Bool
• #show_tabs : Bool

  Returns whether the tabs of the notebook are shown.

• #show_tabs=(show_tabs : Bool) : Nil

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

• #show_tabs? : Bool
• #switch_page_signal
• #tab_detachable(child : Gtk::Widget) : Bool

  Returns whether the tab contents can be detached from notebook.

• #tab_label(child : Gtk::Widget) : Gtk::Widget | Nil

  Returns the tab label widget for the page child.

• #tab_label_text(child : Gtk::Widget) : String | Nil

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

• #tab_pos : Gtk::PositionType

  Gets the edge at which the tabs are drawn.

• #tab_pos=(pos : Gtk::PositionType) : Nil

  Sets the edge at which the tabs are drawn.

• #tab_reorderable(child : Gtk::Widget) : Bool

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

Constructor Detail

Class Method Detail

Instance Method Detail

static void
on_drag_data_received (Gtk::Widget        *widget,
                       Gdk::Drop          *drop,
                       Gtk::SelectionData *data,
                       guint             time,
                       gpointer          user_data)
{
  Gtk::Drag *drag;
  Gtk::Widget *notebook;
  Gtk::Widget **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);
}