Top |
Functions
Properties
gboolean | enable-popup | Read / Write |
char * | group-name | Read / Write |
int | page | Read / Write |
GListModel * | pages | Read |
gboolean | scrollable | Read / Write |
gboolean | show-border | Read / Write |
gboolean | show-tabs | Read / Write |
GtkPositionType | tab-pos | Read / Write |
GtkWidget * | child | Read / Write / Construct Only |
gboolean | detachable | Read / Write |
GtkWidget * | menu | Read / Write / Construct Only |
char * | menu-label | Read / Write |
int | position | Read / Write |
gboolean | reorderable | Read / Write |
GtkWidget * | tab | Read / Write / Construct Only |
gboolean | tab-expand | Read / Write |
gboolean | tab-fill | Read / Write |
char * | tab-label | Read / Write |
Signals
gboolean | change-current-page | Action |
GtkNotebook* | create-window | Run Last |
gboolean | focus-tab | Action |
void | move-focus-out | Action |
void | page-added | Run Last |
void | page-removed | Run Last |
void | page-reordered | Run Last |
gboolean | reorder-tab | Action |
gboolean | select-page | Action |
void | switch-page | Run Last |
Object Hierarchy
GObject ├── GInitiallyUnowned │ ╰── GtkWidget │ ╰── GtkNotebook ╰── GtkNotebookPage
Description
The GtkNotebook widget is a layout container whose children are pages that can be switched between using tab labels along one edge.
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()
, gtk_notebook_popup_disable()
)
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:
1 2 3 4 5 6 7 8 9 10 11 12 |
<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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
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 widgetGTK_ACCESSIBLE_ROLE_TAB_LIST
for the list of tabsGTK_ACCESSIBLE_ROLE_TAB
role for each tabGTK_ACCESSIBLE_ROLE_TAB_PANEL
for each page
Functions
gtk_notebook_new ()
GtkWidget *
gtk_notebook_new (void
);
Creates a new GtkNotebook widget with no pages.
gtk_notebook_get_page ()
GtkNotebookPage * gtk_notebook_get_page (GtkNotebook *notebook
,GtkWidget *child
);
Returns the GtkNotebookPage for child
.
gtk_notebook_get_pages ()
GListModel *
gtk_notebook_get_pages (GtkNotebook *notebook
);
Returns a GListModel that contains the pages of the notebook, and can be used to keep an up-to-date view.
gtk_notebook_page_get_child ()
GtkWidget *
gtk_notebook_page_get_child (GtkNotebookPage *page
);
Returns the notebook child to which page
belongs.
gtk_notebook_append_page ()
int gtk_notebook_append_page (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
);
Appends a page to notebook
.
gtk_notebook_append_page_menu ()
int gtk_notebook_append_page_menu (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
,GtkWidget *menu_label
);
Appends a page to notebook
, specifying the widget to use as the
label in the popup menu.
Parameters
notebook |
||
child |
the GtkWidget to use as the contents of the page |
|
tab_label |
the GtkWidget to be used as the label
for the page, or |
[allow-none] |
menu_label |
the widget to use as a label for the
page-switch menu, if that is enabled. If |
[allow-none] |
gtk_notebook_prepend_page ()
int gtk_notebook_prepend_page (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
);
Prepends a page to notebook
.
gtk_notebook_prepend_page_menu ()
int gtk_notebook_prepend_page_menu (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
,GtkWidget *menu_label
);
Prepends a page to notebook
, specifying the widget to use as the
label in the popup menu.
Parameters
notebook |
||
child |
the GtkWidget to use as the contents of the page |
|
tab_label |
the GtkWidget to be used as the label
for the page, or |
[allow-none] |
menu_label |
the widget to use as a label for the
page-switch menu, if that is enabled. If |
[allow-none] |
gtk_notebook_insert_page ()
int gtk_notebook_insert_page (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
,int position
);
Insert a page into notebook
at the given position.
Parameters
gtk_notebook_insert_page_menu ()
int gtk_notebook_insert_page_menu (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
,GtkWidget *menu_label
,int position
);
Insert a page into notebook
at the given position, specifying
the widget to use as the label in the popup menu.
Parameters
notebook |
||
child |
the GtkWidget to use as the contents of the page |
|
tab_label |
the GtkWidget to be used as the label
for the page, or |
[allow-none] |
menu_label |
the widget to use as a label for the
page-switch menu, if that is enabled. If |
[allow-none] |
position |
the index (starting at 0) at which to insert the page, or -1 to append the page after all other pages. |
gtk_notebook_remove_page ()
void gtk_notebook_remove_page (GtkNotebook *notebook
,int page_num
);
Removes a page from the notebook given its index in the notebook.
gtk_notebook_detach_tab ()
void gtk_notebook_detach_tab (GtkNotebook *notebook
,GtkWidget *child
);
Removes the child from the notebook.
This function is very similar to gtk_notebook_remove_page()
,
but additionally informs the notebook that the removal
is happening as part of a tab DND operation, which should
not be cancelled.
gtk_notebook_page_num ()
int gtk_notebook_page_num (GtkNotebook *notebook
,GtkWidget *child
);
Finds the index of the page which contains the given child widget.
gtk_notebook_next_page ()
void
gtk_notebook_next_page (GtkNotebook *notebook
);
Switches to the next page. Nothing happens if the current page is the last page.
gtk_notebook_prev_page ()
void
gtk_notebook_prev_page (GtkNotebook *notebook
);
Switches to the previous page. Nothing happens if the current page is the first page.
gtk_notebook_reorder_child ()
void gtk_notebook_reorder_child (GtkNotebook *notebook
,GtkWidget *child
,int position
);
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.
gtk_notebook_set_tab_pos ()
void gtk_notebook_set_tab_pos (GtkNotebook *notebook
,GtkPositionType pos
);
Sets the edge at which the tabs for switching pages in the notebook are drawn.
gtk_notebook_set_show_tabs ()
void gtk_notebook_set_show_tabs (GtkNotebook *notebook
,gboolean show_tabs
);
Sets whether to show the tabs for the notebook or not.
gtk_notebook_set_show_border ()
void gtk_notebook_set_show_border (GtkNotebook *notebook
,gboolean show_border
);
Sets whether a bevel will be drawn around the notebook pages.
This only has a visual effect when the tabs are not shown.
See gtk_notebook_set_show_tabs()
.
gtk_notebook_set_scrollable ()
void gtk_notebook_set_scrollable (GtkNotebook *notebook
,gboolean scrollable
);
Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area.
gtk_notebook_popup_enable ()
void
gtk_notebook_popup_enable (GtkNotebook *notebook
);
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.
gtk_notebook_popup_disable ()
void
gtk_notebook_popup_disable (GtkNotebook *notebook
);
Disables the popup menu.
gtk_notebook_get_current_page ()
int
gtk_notebook_get_current_page (GtkNotebook *notebook
);
Returns the page number of the current page.
gtk_notebook_get_menu_label ()
GtkWidget * gtk_notebook_get_menu_label (GtkNotebook *notebook
,GtkWidget *child
);
Retrieves the menu label widget of the page containing child
.
gtk_notebook_get_nth_page ()
GtkWidget * gtk_notebook_get_nth_page (GtkNotebook *notebook
,int page_num
);
Returns the child widget contained in page number page_num
.
gtk_notebook_get_n_pages ()
int
gtk_notebook_get_n_pages (GtkNotebook *notebook
);
Gets the number of pages in a notebook.
gtk_notebook_get_tab_label ()
GtkWidget * gtk_notebook_get_tab_label (GtkNotebook *notebook
,GtkWidget *child
);
Returns the tab label widget for the page child
.
NULL
is returned if child
is not in notebook
or
if no tab label has specifically been set for child
.
gtk_notebook_set_menu_label ()
void gtk_notebook_set_menu_label (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *menu_label
);
Changes the menu label for the page containing child
.
gtk_notebook_set_menu_label_text ()
void gtk_notebook_set_menu_label_text (GtkNotebook *notebook
,GtkWidget *child
,const char *menu_text
);
Creates a new label and sets it as the menu label of child
.
gtk_notebook_set_tab_label ()
void gtk_notebook_set_tab_label (GtkNotebook *notebook
,GtkWidget *child
,GtkWidget *tab_label
);
Changes the tab label for child
.
If NULL
is specified for tab_label
, then the page will
have the label “page N”.
gtk_notebook_set_tab_label_text ()
void gtk_notebook_set_tab_label_text (GtkNotebook *notebook
,GtkWidget *child
,const char *tab_text
);
Creates a new label and sets it as the tab label for the page
containing child
.
gtk_notebook_set_tab_reorderable ()
void gtk_notebook_set_tab_reorderable (GtkNotebook *notebook
,GtkWidget *child
,gboolean reorderable
);
Sets whether the notebook tab can be reordered via drag and drop or not.
gtk_notebook_set_tab_detachable ()
void gtk_notebook_set_tab_detachable (GtkNotebook *notebook
,GtkWidget *child
,gboolean detachable
);
Sets whether the tab can be detached from notebook
to another
notebook or widget.
Note that 2 notebooks must share a common group identificator
(see gtk_notebook_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 gtk_notebook_detach_tab()
instead of
gtk_notebook_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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
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.
gtk_notebook_get_menu_label_text ()
const char * gtk_notebook_get_menu_label_text (GtkNotebook *notebook
,GtkWidget *child
);
Retrieves the text of the menu label for the page containing
child
.
Returns
the text of the tab label, or NULL
if the widget does
not have a menu label other than the default menu label, or the menu label
widget is not a GtkLabel. The string is owned by the widget and must not be
freed.
[nullable]
gtk_notebook_get_scrollable ()
gboolean
gtk_notebook_get_scrollable (GtkNotebook *notebook
);
Returns whether the tab label area has arrows for scrolling.
See gtk_notebook_set_scrollable()
.
gtk_notebook_get_show_border ()
gboolean
gtk_notebook_get_show_border (GtkNotebook *notebook
);
Returns whether a bevel will be drawn around the notebook pages.
See gtk_notebook_set_show_border()
.
gtk_notebook_get_show_tabs ()
gboolean
gtk_notebook_get_show_tabs (GtkNotebook *notebook
);
Returns whether the tabs of the notebook are shown.
See gtk_notebook_set_show_tabs()
.
gtk_notebook_get_tab_label_text ()
const char * gtk_notebook_get_tab_label_text (GtkNotebook *notebook
,GtkWidget *child
);
Retrieves the text of the tab label for the page containing
child
.
Returns
the text of the tab label, or NULL
if the tab label
widget is not a GtkLabel. The string is owned by the widget and must not be
freed.
[nullable]
gtk_notebook_get_tab_pos ()
GtkPositionType
gtk_notebook_get_tab_pos (GtkNotebook *notebook
);
Gets the edge at which the tabs for switching pages in the notebook are drawn.
gtk_notebook_get_tab_reorderable ()
gboolean gtk_notebook_get_tab_reorderable (GtkNotebook *notebook
,GtkWidget *child
);
Gets whether the tab can be reordered via drag and drop or not.
gtk_notebook_get_tab_detachable ()
gboolean gtk_notebook_get_tab_detachable (GtkNotebook *notebook
,GtkWidget *child
);
Returns whether the tab contents can be detached from notebook
.
gtk_notebook_set_current_page ()
void gtk_notebook_set_current_page (GtkNotebook *notebook
,int page_num
);
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.
gtk_notebook_set_group_name ()
void gtk_notebook_set_group_name (GtkNotebook *notebook
,const char *group_name
);
Sets a group name for notebook
.
Notebooks with the same name will be able to exchange tabs
via drag and drop. A notebook with a NULL
group name will
not be able to exchange tabs with any other notebook.
gtk_notebook_get_group_name ()
const char *
gtk_notebook_get_group_name (GtkNotebook *notebook
);
Gets the current group name for notebook
.
gtk_notebook_set_action_widget ()
void gtk_notebook_set_action_widget (GtkNotebook *notebook
,GtkWidget *widget
,GtkPackType pack_type
);
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 GtkBox if you need to pack more than one widget on the same side.
gtk_notebook_get_action_widget ()
GtkWidget * gtk_notebook_get_action_widget (GtkNotebook *notebook
,GtkPackType pack_type
);
Gets one of the action widgets. See gtk_notebook_set_action_widget()
.
Types and Values
GtkNotebookPage
typedef struct _GtkNotebookPage GtkNotebookPage;
A page in the GtkNotebook.
The GtkNotebookPage
structure only contains private data.
Property Details
The “enable-popup”
property
“enable-popup” gboolean
If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page.
Owner: GtkNotebook
Flags: Read / Write
Default value: FALSE
The “group-name”
property
“group-name” char *
Group name for tab drag and drop.
Owner: GtkNotebook
Flags: Read / Write
Default value: NULL
The “page”
property
“page” int
The index of the current page.
Owner: GtkNotebook
Flags: Read / Write
Allowed values: >= -1
Default value: -1
The “scrollable”
property
“scrollable” gboolean
If TRUE, scroll arrows are added if there are too many tabs to fit.
Owner: GtkNotebook
Flags: Read / Write
Default value: FALSE
The “show-border”
property
“show-border” gboolean
Whether the border should be shown.
Owner: GtkNotebook
Flags: Read / Write
Default value: TRUE
The “show-tabs”
property
“show-tabs” gboolean
Whether tabs should be shown.
Owner: GtkNotebook
Flags: Read / Write
Default value: TRUE
The “tab-pos”
property
“tab-pos” GtkPositionType
Which side of the notebook holds the tabs.
Owner: GtkNotebook
Flags: Read / Write
Default value: GTK_POS_TOP
The “child”
property
“child” GtkWidget *
The child for this page.
Owner: GtkNotebookPage
Flags: Read / Write / Construct Only
The “detachable”
property
“detachable” gboolean
Whether the tab is detachable.
Owner: GtkNotebookPage
Flags: Read / Write
Default value: FALSE
The “menu”
property
“menu” GtkWidget *
The label widget displayed in the child’s menu entry.
Owner: GtkNotebookPage
Flags: Read / Write / Construct Only
The “menu-label”
property
“menu-label” char *
The text of the menu widget.
Owner: GtkNotebookPage
Flags: Read / Write
Default value: NULL
The “position”
property
“position” int
The index of the child in the parent.
Owner: GtkNotebookPage
Flags: Read / Write
Allowed values: >= -1
Default value: 0
The “reorderable”
property
“reorderable” gboolean
Whether the tab is reorderable by user action.
Owner: GtkNotebookPage
Flags: Read / Write
Default value: FALSE
The “tab”
property
“tab” GtkWidget *
The tab widget for this page.
Owner: GtkNotebookPage
Flags: Read / Write / Construct Only
The “tab-expand”
property
“tab-expand” gboolean
Whether to expand the child’s tab.
Owner: GtkNotebookPage
Flags: Read / Write
Default value: FALSE
The “tab-fill”
property
“tab-fill” gboolean
Whether the child’s tab should fill the allocated area.
Owner: GtkNotebookPage
Flags: Read / Write
Default value: TRUE
Signal Details
The “change-current-page”
signal
gboolean user_function (GtkNotebook *notebook, int arg1, gpointer user_data)
Flags: Action
The “create-window”
signal
GtkNotebook* user_function (GtkNotebook *notebook, GtkWidget *page, gpointer user_data)
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 “group-name” ).
Parameters
notebook |
the GtkNotebook emitting the signal |
|
page |
the tab of |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “focus-tab”
signal
gboolean user_function (GtkNotebook *notebook, GtkNotebookTab arg1, gpointer user_data)
Flags: Action
The “move-focus-out”
signal
void user_function (GtkNotebook *notebook, GtkDirectionType arg1, gpointer user_data)
Flags: Action
The “page-added”
signal
void user_function (GtkNotebook *notebook, GtkWidget *child, guint page_num, gpointer user_data)
the ::page-added signal is emitted in the notebook right after a page is added to the notebook.
Parameters
notebook |
the GtkNotebook |
|
child |
the child GtkWidget affected |
|
page_num |
the new page number for |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “page-removed”
signal
void user_function (GtkNotebook *notebook, GtkWidget *child, guint page_num, gpointer user_data)
the ::page-removed signal is emitted in the notebook right after a page is removed from the notebook.
Parameters
notebook |
the GtkNotebook |
|
child |
the child GtkWidget affected |
|
page_num |
the |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “page-reordered”
signal
void user_function (GtkNotebook *notebook, GtkWidget *child, guint page_num, gpointer user_data)
the ::page-reordered signal is emitted in the notebook right after a page has been reordered.
Parameters
notebook |
the GtkNotebook |
|
child |
the child GtkWidget affected |
|
page_num |
the new page number for |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “reorder-tab”
signal
gboolean user_function (GtkNotebook *notebook, GtkDirectionType arg1, gboolean arg2, gpointer user_data)
Flags: Action
The “select-page”
signal
gboolean user_function (GtkNotebook *notebook, gboolean arg1, gpointer user_data)
Flags: Action
The “switch-page”
signal
void user_function (GtkNotebook *notebook, GtkWidget *page, guint page_num, gpointer user_data)
Emitted when the user or a function changes the current page.
Parameters
notebook |
the object which received the signal. |
|
page |
the new current page |
|
page_num |
the index of the page |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last