Notebook

The GtkNotebook widget is a GtkContainer 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.

class Notebook : Container {}

Constructors

this
this(GtkNotebook* gtkNotebook)

Sets our main struct and passes it to the parent class

this
this()

Creates a new GtkNotebook widget with no pages.

Members

Functions

addOnChangeCurrentPage
void addOnChangeCurrentPage(bool delegate(gint, Notebook) dlg, ConnectFlags connectFlags)
addOnCreateWindow
void addOnCreateWindow(GtkNotebook* delegate(Widget, gint, gint, Notebook) dlg, ConnectFlags connectFlags)

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" ). Since 2.12

addOnFocusTab
void addOnFocusTab(bool delegate(GtkNotebookTab, Notebook) dlg, ConnectFlags connectFlags)
addOnMoveFocusOut
void addOnMoveFocusOut(void delegate(GtkDirectionType, Notebook) dlg, ConnectFlags connectFlags)
addOnPageAdded
void addOnPageAdded(void delegate(Widget, guint, Notebook) dlg, ConnectFlags connectFlags)

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

addOnPageRemoved
void addOnPageRemoved(void delegate(Widget, guint, Notebook) dlg, ConnectFlags connectFlags)

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

addOnPageReordered
void addOnPageReordered(void delegate(Widget, guint, Notebook) dlg, ConnectFlags connectFlags)

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

addOnReorderTab
void addOnReorderTab(bool delegate(GtkDirectionType, gboolean, Notebook) dlg, ConnectFlags connectFlags)
addOnSelectPage
void addOnSelectPage(bool delegate(gboolean, Notebook) dlg, ConnectFlags connectFlags)
addOnSwitchPage
void addOnSwitchPage(void delegate(Widget, guint, Notebook) dlg, ConnectFlags connectFlags)

Emitted when the user or a function changes the current page. See Also GtkContainer

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.

getActionWidget
Widget getActionWidget(GtkPackType packType)

Gets one of the action widgets. See gtk_notebook_set_action_widget(). Since 2.20

getCurrentPage
int getCurrentPage()

Returns the page number of the current page.

getGroupName
string getGroupName()

Gets the current group name for notebook. Since 2.24

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. Since 2.2

getNotebookStruct
GtkNotebook* getNotebookStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getNthPage
Widget getNthPage(int pageNum)

Returns the child widget contained in page number page_num.

getScrollable
int getScrollable()

Returns whether the tab label area has arrows for scrolling. See gtk_notebook_set_scrollable().

getShowBorder
int getShowBorder()

Returns whether a bevel will be drawn around the notebook pages. See gtk_notebook_set_show_border().

getShowTabs
int getShowTabs()

Returns whether the tabs of the notebook are shown. See gtk_notebook_set_show_tabs().

getStruct
void* getStruct()

the main Gtk struct as a void*

getTabDetachable
int getTabDetachable(Widget child)

Returns whether the tab contents can be detached from notebook. Since 2.10

getTabHborder
ushort getTabHborder()

Warning gtk_notebook_get_tab_hborder has been deprecated since version 3.4 and should not be used in newly-written code. this function returns zero Returns the horizontal width of a tab border. Since 2.22

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
int getTabReorderable(Widget child)

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

getTabVborder
ushort getTabVborder()

Warning gtk_notebook_get_tab_vborder has been deprecated since version 3.4 and should not be used in newly-written code. this function returns zero Returns the vertical width of a tab border. Since 2.22

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 GtkBox if you need to pack more than one widget on the same side. Note that action widgets are "internal" children of the notebook and thus not included in the list returned from gtk_container_foreach(). Since 2.20

setCurrentPage
void setCurrentPage(Widget child)
setCurrentPage
void setCurrentPage(int pageNum)

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.

setGroupName
void setGroupName(string groupName)

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. Since 2.24

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(int 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(int 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 gtk_notebook_set_show_tabs().

setShowTabs
void setShowTabs(int showTabs)

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

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTabDetachable
void setTabDetachable(Widget child, int 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. If you want a notebook to accept drags from other widgets, you will have to set your own DnD code to do it. Since 2.10

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, int reorderable)

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

Static functions

callBackChangeCurrentPage
gboolean callBackChangeCurrentPage(GtkNotebook* notebookStruct, gint arg1, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCreateWindow
void callBackCreateWindow(GtkNotebook* notebookStruct, GtkWidget* page, gint x, gint y, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackFocusTab
gboolean callBackFocusTab(GtkNotebook* notebookStruct, GtkNotebookTab arg1, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveFocusOut
void callBackMoveFocusOut(GtkNotebook* notebookStruct, GtkDirectionType arg1, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPageAdded
void callBackPageAdded(GtkNotebook* notebookStruct, GtkWidget* child, guint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPageRemoved
void callBackPageRemoved(GtkNotebook* notebookStruct, GtkWidget* child, guint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPageReordered
void callBackPageReordered(GtkNotebook* notebookStruct, GtkWidget* child, guint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackReorderTab
gboolean callBackReorderTab(GtkNotebook* notebookStruct, GtkDirectionType arg1, gboolean arg2, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectPage
gboolean callBackSelectPage(GtkNotebook* notebookStruct, gboolean arg1, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSwitchPage
void callBackSwitchPage(GtkNotebook* notebookStruct, GtkWidget* page, guint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkNotebook
GtkNotebook* gtkNotebook;

the main Gtk struct

onChangeCurrentPageListeners
bool delegate(gint, Notebook)[] onChangeCurrentPageListeners;
Undocumented in source.
onCreateWindowListeners
GtkNotebook* delegate(Widget, gint, gint, Notebook)[] onCreateWindowListeners;
Undocumented in source.
onFocusTabListeners
bool delegate(GtkNotebookTab, Notebook)[] onFocusTabListeners;
Undocumented in source.
onMoveFocusOutListeners
void delegate(GtkDirectionType, Notebook)[] onMoveFocusOutListeners;
Undocumented in source.
onPageAddedListeners
void delegate(Widget, guint, Notebook)[] onPageAddedListeners;
Undocumented in source.
onPageRemovedListeners
void delegate(Widget, guint, Notebook)[] onPageRemovedListeners;
Undocumented in source.
onPageReorderedListeners
void delegate(Widget, guint, Notebook)[] onPageReorderedListeners;
Undocumented in source.
onReorderTabListeners
bool delegate(GtkDirectionType, gboolean, Notebook)[] onReorderTabListeners;
Undocumented in source.
onSelectPageListeners
bool delegate(gboolean, Notebook)[] onSelectPageListeners;
Undocumented in source.
onSwitchPageListeners
void delegate(Widget, guint, Notebook)[] onSwitchPageListeners;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as GtkWindow, GtkFrame, or GtkButton; for more complicated layout containers such as GtkBox or GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_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.

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 while it's not inside 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 gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode().

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

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 gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().

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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()

Warning gtk_container_resize_children is deprecated and should not be used in newly-written code. 3.10

childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

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

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets 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_property on widget. This is an analogue of g_object_notify() for child properties. Also see gtk_widget_child_notify().

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each 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. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). Virtual: forall

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

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 GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its "draw" function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received. gtk_container_propagate_draw() takes care of translating the origin of cr, and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling gtk_widget_draw() on the child directly. In most cases, a container can simply either inherit the "draw" implementation from GtkContainer, or do some drawing and then chain to the ::draw implementation from GtkContainer.

getFocusChain
int 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.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(GtkContainerClass* cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

classHandleBorderWidth
void classHandleBorderWidth(GtkContainerClass* klass)

Modifies a subclass of GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must "opt in" to the parent class handling border_width for them.

Meta