Notebook

Object Hierarchy:

Description:

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

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

Content:

Properties:

• public bool enable_popup { get; set; }
• public string group_name { get; set; }
  Group name for tab drag and drop.
• public int page { get; set; }
• public bool scrollable { get; set; }
• public bool show_border { get; set; }
• public bool show_tabs { get; set; }
• public PositionType tab_pos { get; set; }

Creation methods:

• public Notebook ()
  Creates a new Notebook widget with no pages.

Methods:

• public int append_page (Widget child, Widget? tab_label = null)
  Appends a page to this.
• public int append_page_menu (Widget child, Widget? tab_label, Widget? menu_label)
  Appends a page to this, specifying the widget to use as the label in the popup menu.
• public void detach_tab (Widget child)
  Removes the child from the notebook.
• public unowned Widget? get_action_widget (PackType pack_type)
  Gets one of the action widgets.
• public int get_current_page ()
  Returns the page number of the current page.
• public unowned string? get_group_name ()
  Gets the current group name for this .
• public unowned Widget? get_menu_label (Widget child)
  Retrieves the menu label widget of the page containing child .
• public unowned string? get_menu_label_text (Widget child)
  Retrieves the text of the menu label for the page containing child.
• public int get_n_pages ()
  Gets the number of pages in a notebook.
• public unowned Widget? get_nth_page (int page_num)
  Returns the child widget contained in page number page_num .
• public bool get_scrollable ()
  Returns whether the tab label area has arrows for scrolling.
• public bool get_show_border ()
  Returns whether a bevel will be drawn around the notebook pages.
• public bool get_show_tabs ()
  Returns whether the tabs of the notebook are shown.
• public bool get_tab_detachable (Widget child)
  Returns whether the tab contents can be detached from this.
• public uint16 get_tab_hborder ()
  Returns the horizontal width of a tab border.
• public unowned Widget? get_tab_label (Widget child)
  Returns the tab label widget for the page child.
• public unowned string? get_tab_label_text (Widget child)
  Retrieves the text of the tab label for the page containing child.
• public PositionType get_tab_pos ()
  Gets the edge at which the tabs for switching pages in the notebook are drawn.
• public bool get_tab_reorderable (Widget child)
  Gets whether the tab can be reordered via drag and drop or not.
• public uint16 get_tab_vborder ()
  Returns the vertical width of a tab border.
• public int insert_page (Widget child, Widget? tab_label, int position)
  Insert a page into this at the given position.
• public virtual int insert_page_menu (Widget child, Widget? tab_label, Widget? menu_label, int position)
  Insert a page into this at the given position, specifying the widget to use as the label in the popup menu.
• public void next_page ()
  Switches to the next page.
• public int page_num (Widget child)
  Finds the index of the page which contains the given child widget.
• public void popup_disable ()
  Disables the popup menu.
• public void popup_enable ()
  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.
• public int prepend_page (Widget child, Widget? tab_label = null)
  Prepends a page to this.
• public int prepend_page_menu (Widget child, Widget? tab_label, Widget? menu_label)
  Prepends a page to this, specifying the widget to use as the label in the popup menu.
• public void prev_page ()
  Switches to the previous page.
• public void remove_page (int page_num)
  Removes a page from the notebook given its index in the notebook.
• public void reorder_child (Widget child, int position)
  Reorders the page containing child, so that it appears in position position.
• public void set_action_widget (Widget widget, PackType pack_type)
  Sets widget as one of the action widgets.
• public void set_current_page (int page_num)
  Switches to the page number page_num.
• public void set_group_name (string? group_name)
  Sets a group name for this.
• public void set_menu_label (Widget child, Widget? menu_label)
  Changes the menu label for the page containing child.
• public void set_menu_label_text (Widget child, string menu_text)
  Creates a new label and sets it as the menu label of child .
• public void set_scrollable (bool scrollable)
  Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area.
• public void set_show_border (bool show_border)
  Sets whether a bevel will be drawn around the notebook pages.
• public void set_show_tabs (bool show_tabs)
  Sets whether to show the tabs for the notebook or not.
• public void set_tab_detachable (Widget child, bool detachable)
  Sets whether the tab can be detached from this to another notebook or widget.
• public void set_tab_label (Widget child, Widget? tab_label)
  Changes the tab label for child.
• public void set_tab_label_text (Widget child, string tab_text)
  Creates a new label and sets it as the tab label for the page containing child.
• public void set_tab_pos (PositionType pos)
  Sets the edge at which the tabs for switching pages in the notebook are drawn.
• public void set_tab_reorderable (Widget child, bool reorderable)
  Sets whether the notebook tab can be reordered via drag and drop or not.

Signals:

• public virtual signal bool change_current_page (int offset)
• public signal unowned Notebook create_window (Widget page, int x, int y)
  The create_window signal is emitted when a detachable tab is dropped on the root window.
• public virtual signal bool focus_tab (NotebookTab type)
• public virtual signal void move_focus_out (DirectionType direction)
• public virtual signal void page_added (Widget child, uint page_num)
  the page_added signal is emitted in the notebook right after a page is added to the notebook.
• public virtual signal void page_removed (Widget child, uint page_num)
  the page_removed signal is emitted in the notebook right after a page is removed from the notebook.
• public virtual signal void page_reordered (Widget child, uint page_num)
  the page_reordered signal is emitted in the notebook right after a page has been reordered.
• public virtual signal bool reorder_tab (DirectionType direction, bool move_to_last)
• public virtual signal bool select_page (bool move_focus)
• public virtual signal void switch_page (Widget page, uint page_num)
  Emitted when the user or a function changes the current page.

Inherited Members: