GtkNotebook

Description

A tabbed notebook container

Methods and Functions

gtkNotebookNew(show = TRUE)
gtkNotebookAppendPage(object, child, tab.label = NULL)
gtkNotebookAppendPageMenu(object, child, tab.label = NULL, menu.label = NULL)
gtkNotebookPrependPage(object, child, tab.label = NULL)
gtkNotebookPrependPageMenu(object, child, tab.label = NULL, menu.label = NULL)
gtkNotebookInsertPage(object, child, tab.label = NULL, position = -1)
gtkNotebookInsertPageMenu(object, child, tab.label = NULL, menu.label = NULL, position = -1)
gtkNotebookRemovePage(object, page.num)
gtkNotebookPageNum(object, child)
gtkNotebookNextPage(object)
gtkNotebookPrevPage(object)
gtkNotebookReorderChild(object, child, position)
gtkNotebookSetTabPos(object, pos)
gtkNotebookSetShowTabs(object, show.tabs)
gtkNotebookSetShowBorder(object, show.border)
gtkNotebookSetScrollable(object, scrollable)
gtkNotebookSetTabBorder(object, border.width)
gtkNotebookPopupEnable(object)
gtkNotebookPopupDisable(object)
gtkNotebookGetCurrentPage(object)
gtkNotebookGetMenuLabel(object, child)
gtkNotebookGetNthPage(object, page.num)
gtkNotebookGetNPages(object)
gtkNotebookGetTabLabel(object, child)
gtkNotebookQueryTabLabelPacking(object, child)
gtkNotebookSetHomogeneousTabs(object, homogeneous)
gtkNotebookSetMenuLabel(object, child, menu.label = NULL)
gtkNotebookSetMenuLabelText(object, child, menu.text)
gtkNotebookSetTabHborder(object, tab.hborder)
gtkNotebookSetTabLabel(object, child, tab.label = NULL)
gtkNotebookSetTabLabelPacking(object, child, expand, fill, pack.type)
gtkNotebookSetTabLabelText(object, child, tab.text)
gtkNotebookSetTabVborder(object, tab.vborder)
gtkNotebookSetTabReorderable(object, child, reorderable)
gtkNotebookSetTabDetachable(object, child, detachable)
gtkNotebookGetMenuLabelText(object, child)
gtkNotebookGetScrollable(object)
gtkNotebookGetShowBorder(object)
gtkNotebookGetShowTabs(object)
gtkNotebookGetTabLabelText(object, child)
gtkNotebookGetTabPos(object)
gtkNotebookGetTabReorderable(object, child)
gtkNotebookGetTabDetachable(object, child)
gtkNotebookSetCurrentPage(object, page.num)
gtkNotebookSetGroupId(object, group.id)
gtkNotebookSetGroupId(object, group.id)
gtkNotebookGetGroupId(object)
gtkNotebookGetGroupId(object)
gtkNotebookSetGroup(object, group)
gtkNotebookGetGroup(object)
gtkNotebookSetActionWidget(object, widget, pack.type)
gtkNotebookGetActionWidget(object, pack.type)
gtkNotebookSetWindowCreationHook(func, data)
gtkNotebook(show = TRUE)

Hierarchy

GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkNotebook

Interfaces

GtkNotebook implements AtkImplementorIface and GtkBuildable.

Detailed Description

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 gtkNotebookSetTabPos), 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 gtkNotebookPopupEnable, gtkNotebookPopupDisable)

GtkNotebook as GtkBuildable

The GtkNoteboopk 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.

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>

Structures

GtkNotebook

undocumented

tabPos

[GtkPositionType]

Convenient Construction

gtkNotebook is the equivalent of gtkNotebookNew.

User Functions

GtkNotebookWindowCreationFunc(source, page, x, y, data)

A function used by GtkNotebook when a detachable tab is dropped in the root window, it's used to create a window containing a notebook where the tab will be attached. This function will also be responsible of moving/resizing the window and adding the necessary properties to the notebook (i.e.: group-id). If the function returns NULL, the drag will be cancelled.

source

The source GtkNotebook of the drag operation

page

the child GtkWidget affected

x

the X coordinate where the drop happens

y

the Y coordinate where the drop happens

data

user data

Returns: [GtkNotebook] The created GtkNotebook where the tab will be attached, or NULL to cancel the drag

Signals

Properties

Style Properties

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://library.gnome.org/devel//gtk/GtkNotebook.html