Notebook

The gtk.Notebook widget is a gtk.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 Notebook.setTabPos), whether, if there are too many tabs to fit the notebook should be made bigger or scrolling arrows added (see Notebook.setScrollable), and whether there will be a popup menu allowing the users to switch pages. (see Notebook.popupEnable, Notebook.popupDisable)

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>

# CSS nodes

|[<!-- language="plain" -->
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 Notebook.setShowBorder).

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, regarldess of text direction.

class Notebook : Container {

GtkNotebook* gtkNotebook;

GtkNotebook* getNotebookStruct(bool transferOwnership);

void* getStruct();

this(GtkNotebook* gtkNotebook, bool ownedRef);

int appendPage(Widget child, string tabLabel);

void setCurrentPage(Widget child);

static GType getType();

int appendPage(Widget child, Widget tabLabel);

int appendPageMenu(Widget child, Widget tabLabel, Widget menuLabel);

void detachTab(Widget child);

Widget getActionWidget(GtkPackType packType);

int getCurrentPage();

string getGroupName();

Widget getMenuLabel(Widget child);

string getMenuLabelText(Widget child);

int getNPages();

Widget getNthPage(int pageNum);

bool getScrollable();

bool getShowBorder();

bool getShowTabs();

bool getTabDetachable(Widget child);

ushort getTabHborder();

Widget getTabLabel(Widget child);

string getTabLabelText(Widget child);

GtkPositionType getTabPos();

bool getTabReorderable(Widget child);

ushort getTabVborder();

int insertPage(Widget child, Widget tabLabel, int position);

int insertPageMenu(Widget child, Widget tabLabel, Widget menuLabel, int position);

void nextPage();

int pageNum(Widget child);

void popupDisable();

void popupEnable();

int prependPage(Widget child, Widget tabLabel);

int prependPageMenu(Widget child, Widget tabLabel, Widget menuLabel);

void prevPage();

void removePage(int pageNum);

void reorderChild(Widget child, int position);

void setActionWidget(Widget widget, GtkPackType packType);

void setCurrentPage(int pageNum);

void setGroupName(string groupName);

void setMenuLabel(Widget child, Widget menuLabel);

void setMenuLabelText(Widget child, string menuText);

void setScrollable(bool scrollable);

void setShowBorder(bool showBorder);

void setShowTabs(bool showTabs);

void setTabDetachable(Widget child, bool detachable);

void setTabLabel(Widget child, Widget tabLabel);

void setTabLabelText(Widget child, string tabText);

void setTabPos(GtkPositionType pos);

void setTabReorderable(Widget child, bool reorderable);

gulong addOnChangeCurrentPage(bool delegate(int, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnCreateWindow(Notebook delegate(Widget, int, int, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnFocusTab(bool delegate(GtkNotebookTab, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnMoveFocusOut(void delegate(GtkDirectionType, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnPageAdded(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnPageRemoved(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnPageReordered(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnReorderTab(bool delegate(GtkDirectionType, bool, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnSelectPage(bool delegate(bool, Notebook) dlg, ConnectFlags connectFlags);

gulong addOnSwitchPage(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkNotebook* gtkNotebook, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new gtk.Notebook widget with no pages.

Members

Functions

addOnChangeCurrentPage gulong addOnChangeCurrentPage(bool delegate(int, Notebook) dlg, ConnectFlags connectFlags)
addOnCreateWindow gulong addOnCreateWindow(Notebook delegate(Widget, int, int, Notebook) dlg, ConnectFlags connectFlags): The ::create-window signal is emitted when a detachable tab is dropped on the root window.
addOnFocusTab gulong addOnFocusTab(bool delegate(GtkNotebookTab, Notebook) dlg, ConnectFlags connectFlags)
addOnMoveFocusOut gulong addOnMoveFocusOut(void delegate(GtkDirectionType, Notebook) dlg, ConnectFlags connectFlags)
addOnPageAdded gulong addOnPageAdded(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags): the ::page-added signal is emitted in the notebook right after a page is added to the notebook.
addOnPageRemoved gulong addOnPageRemoved(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags): the ::page-removed signal is emitted in the notebook right after a page is removed from the notebook.
addOnPageReordered gulong addOnPageReordered(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags): the ::page-reordered signal is emitted in the notebook right after a page has been reordered.
addOnReorderTab gulong addOnReorderTab(bool delegate(GtkDirectionType, bool, Notebook) dlg, ConnectFlags connectFlags)
addOnSelectPage gulong addOnSelectPage(bool delegate(bool, Notebook) dlg, ConnectFlags connectFlags)
addOnSwitchPage gulong addOnSwitchPage(void delegate(Widget, uint, Notebook) dlg, ConnectFlags connectFlags): Emitted when the user or a function changes the current page.
appendPage int appendPage(Widget child, string tabLabel): Append a page with a widget and a text for a label
appendPage int appendPage(Widget child, Widget tabLabel): Appends a page to notebook.
appendPageMenu int appendPageMenu(Widget child, Widget tabLabel, Widget menuLabel): Appends a page to notebook, specifying the widget to use as the label in the popup menu.
detachTab void detachTab(Widget child): Removes the child from the notebook.
getActionWidget Widget getActionWidget(GtkPackType packType): Gets one of the action widgets. See Notebook.setActionWidget.
getCurrentPage int getCurrentPage(): Returns the page number of the current page.
getGroupName string getGroupName(): Gets the current group name for notebook.
getMenuLabel Widget getMenuLabel(Widget child): Retrieves the menu label widget of the page containing child.
getMenuLabelText string getMenuLabelText(Widget child): Retrieves the text of the menu label for the page containing child.
getNPages int getNPages(): Gets the number of pages in a notebook.
getNotebookStruct GtkNotebook* getNotebookStruct(bool transferOwnership): Get the main Gtk struct
getNthPage Widget getNthPage(int pageNum): Returns the child widget contained in page number page_num.
getScrollable bool getScrollable(): Returns whether the tab label area has arrows for scrolling. See Notebook.setScrollable.
getShowBorder bool getShowBorder(): Returns whether a bevel will be drawn around the notebook pages. See Notebook.setShowBorder.
getShowTabs bool getShowTabs(): Returns whether the tabs of the notebook are shown. See Notebook.setShowTabs.
getStruct void* getStruct(): the main Gtk struct as a void*
getTabDetachable bool getTabDetachable(Widget child): Returns whether the tab contents can be detached from notebook.
getTabHborder ushort getTabHborder(): Returns the horizontal width of a tab border.
getTabLabel Widget getTabLabel(Widget 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.
getTabLabelText string getTabLabelText(Widget child): Retrieves the text of the tab label for the page containing child.
getTabPos GtkPositionType getTabPos(): Gets the edge at which the tabs for switching pages in the notebook are drawn.
getTabReorderable bool getTabReorderable(Widget child): Gets whether the tab can be reordered via drag and drop or not.
getTabVborder ushort getTabVborder(): Returns the vertical width of a tab border.
insertPage int insertPage(Widget child, Widget tabLabel, int position): Insert a page into notebook at the given position.
insertPageMenu int insertPageMenu(Widget child, Widget tabLabel, Widget menuLabel, int position): Insert a page into notebook at the given position, specifying the widget to use as the label in the popup menu.
nextPage void nextPage(): Switches to the next page. Nothing happens if the current page is the last page.
pageNum int pageNum(Widget child): Finds the index of the page which contains the given child widget.
popupDisable void popupDisable(): Disables the popup menu.
popupEnable void popupEnable(): 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.
prependPage int prependPage(Widget child, Widget tabLabel): Prepends a page to notebook.
prependPageMenu int prependPageMenu(Widget child, Widget tabLabel, Widget menuLabel): Prepends a page to notebook, specifying the widget to use as the label in the popup menu.
prevPage void prevPage(): Switches to the previous page. Nothing happens if the current page is the first page.
removePage void removePage(int pageNum): Removes a page from the notebook given its index in the notebook.
reorderChild void reorderChild(Widget 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.
setActionWidget void setActionWidget(Widget widget, GtkPackType 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 gtk.Box if you need to pack more than one widget on the same side.
setCurrentPage void setCurrentPage(Widget child)
setCurrentPage void setCurrentPage(int pageNum): Switches to the page number page_num.
setGroupName void setGroupName(string groupName): Sets a group name for notebook.
setMenuLabel void setMenuLabel(Widget child, Widget menuLabel): Changes the menu label for the page containing child.
setMenuLabelText void setMenuLabelText(Widget child, string menuText): Creates a new label and sets it as the menu label of child.
setScrollable void setScrollable(bool scrollable): Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area.
setShowBorder void setShowBorder(bool showBorder): Sets whether a bevel will be drawn around the notebook pages. This only has a visual effect when the tabs are not shown. See Notebook.setShowTabs.
setShowTabs void setShowTabs(bool showTabs): Sets whether to show the tabs for the notebook or not.
setTabDetachable void setTabDetachable(Widget child, bool detachable): Sets whether the tab can be detached from notebook to another notebook or widget.
setTabLabel void setTabLabel(Widget child, Widget tabLabel): Changes the tab label for child. If NULL is specified for tab_label, then the page will have the label “page N”.
setTabLabelText void setTabLabelText(Widget child, string tabText): Creates a new label and sets it as the tab label for the page containing child.
setTabPos void setTabPos(GtkPositionType pos): Sets the edge at which the tabs for switching pages in the notebook are drawn.
setTabReorderable void setTabReorderable(Widget child, bool reorderable): Sets whether the notebook tab can be reordered via drag and drop or not.

Static functions

getType GType getType()

Variables

gtkNotebook GtkNotebook* gtkNotebook;: the main Gtk struct

Inherited Members

From Container

gtkContainer GtkContainer* gtkContainer;: the main Gtk struct
getContainerStruct GtkContainer* getContainerStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
removeAll void removeAll(): Removes all widgets from the container
getType GType getType()
add void add(Widget widget): Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(Widget child, string propertyName, Value value): Gets the value of a child property for child and container.
childGetValist void childGetValist(Widget child, string firstPropertyName, void* varArgs): Gets the values of one or more child properties for child and container.
childNotify void childNotify(Widget child, string childProperty): Emits a child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(Widget child, string propertyName, Value value): Sets a child property for child and container.
childSetValist void childSetValist(Widget child, string firstPropertyName, void* varArgs): Sets one or more child properties for child and container.
childType GType childType(): Returns the type of the children supported by the container.
forall void forall(GtkCallback callback, void* callbackData): Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreach_ void foreach_(GtkCallback callback, void* callbackData): Invokes callback on each non-internal child of container. See Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See Container.setBorderWidth.
getChildren ListG getChildren(): Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(ListG focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.
getFocusChild Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.
getFocusHadjustment Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.
getPathForChild WidgetPath getPathForChild(Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode GtkResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(Widget child, Context cr): When a container receives a call to the draw function, it must send synthetic draw calls to all children that don’t have their own gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.
remove void remove(Widget widget): Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(ListG focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(Widget child): Sets, or unsets if child is NULL, the focused child of container.
setFocusHadjustment void setFocusHadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(GtkResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with Container.setFocusChain.
addOnAdd gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)

gtk Notebook classes

Notebook