- addOnChangeCurrentPage
void addOnChangeCurrentPage(bool delegate(int, Notebook) dlg, ConnectFlags connectFlags)
- addOnCreateWindow
void 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
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, uint, Notebook) dlg, ConnectFlags connectFlags)
the ::page-added signal is emitted in the notebook
right after a page is added to the notebook.
- addOnPageRemoved
void 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
void 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
void addOnReorderTab(bool delegate(GtkDirectionType, bool, Notebook) dlg, ConnectFlags connectFlags)
- addOnSelectPage
void addOnSelectPage(bool delegate(bool, Notebook) dlg, ConnectFlags connectFlags)
- addOnSwitchPage
void 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 gtk_notebook_set_action_widget().
- 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()
- 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 gtk_notebook_set_scrollable().
- getShowBorder
bool getShowBorder()
Returns whether a bevel will be drawn around the notebook pages.
See gtk_notebook_set_show_border().
- getShowTabs
bool 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
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()
- 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.
- 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 gtk_notebook_set_show_tabs().
- setShowTabs
void setShowTabs(bool 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, 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.
- callBackChangeCurrentPage
int callBackChangeCurrentPage(GtkNotebook* notebookStruct, int object, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCreateWindow
GtkNotebook* callBackCreateWindow(GtkNotebook* notebookStruct, GtkWidget* page, int x, int y, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackFocusTab
int callBackFocusTab(GtkNotebook* notebookStruct, GtkNotebookTab object, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackMoveFocusOut
void callBackMoveFocusOut(GtkNotebook* notebookStruct, GtkDirectionType object, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackPageAdded
void callBackPageAdded(GtkNotebook* notebookStruct, GtkWidget* child, uint 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, uint 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, uint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackReorderTab
int callBackReorderTab(GtkNotebook* notebookStruct, GtkDirectionType object, bool p0, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackSelectPage
int callBackSelectPage(GtkNotebook* notebookStruct, bool object, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackSwitchPage
void callBackSwitchPage(GtkNotebook* notebookStruct, GtkWidget* page, uint pageNum, Notebook _notebook)
Undocumented in source. Be warned that the author may not have intended to support it.
- getType
GType getType()
- connectedSignals
int[string] connectedSignals;
Undocumented in source.
- gtkNotebook
GtkNotebook* gtkNotebook;
- onChangeCurrentPageListeners
bool delegate(int, Notebook)[] onChangeCurrentPageListeners;
Undocumented in source.
- onCreateWindowListeners
Notebook delegate(Widget, int, int, 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, uint, Notebook)[] onPageAddedListeners;
Undocumented in source.
- onPageRemovedListeners
void delegate(Widget, uint, Notebook)[] onPageRemovedListeners;
Undocumented in source.
- onPageReorderedListeners
void delegate(Widget, uint, Notebook)[] onPageReorderedListeners;
Undocumented in source.
- onReorderTabListeners
bool delegate(GtkDirectionType, bool, Notebook)[] onReorderTabListeners;
Undocumented in source.
- onSelectPageListeners
bool delegate(bool, Notebook)[] onSelectPageListeners;
Undocumented in source.
- onSwitchPageListeners
void delegate(Widget, uint, Notebook)[] onSwitchPageListeners;
Undocumented in source.
- gtkContainer
GtkContainer* gtkContainer;
- getContainerStruct
GtkContainer* getContainerStruct()
- 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
- getType
GType getType()
- 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.
- 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 #GtkWidget::child-notify signal for the
[child property][child-properties]
@child_property on the child.
- childNotifyByPspec
void childNotifyByPspec(Widget child, ParamSpec pspec)
Emits a #GtkWidget::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.
- 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. 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
gtk_container_set_border_width().
- getChildren
ListG getChildren()
Returns the container’s non-internal children. See
gtk_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
gtk_window_get_focus().
- 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
gtk_container_set_focus_vadjustment().
- 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 #GtkWidget::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 #GtkWidget::draw function,
calls gtk_container_propagate_draw() 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 gtk_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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
the adjustment and gtk_container_set_focus_vadjustment() 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
gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
the adjustment and gtk_container_set_focus_hadjustment() 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 gtk_container_set_focus_chain().
- connectedSignals
int[string] connectedSignals;
Undocumented in source.
- 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* object, 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* object, 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* object, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
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.
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 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, regarldess of text direction.