Project:DUI

Class List Class Hierarchy
Summary: Ctors Methods Mixins

Module dui.Notebook

Class Notebook

dui.ObjectG.ObjectG
        dui.DUIObject.DUIObject
                dui.Widget.Widget
                        dui.Container.Container
                                dui.Notebook.Notebook

Implemented interfaces:

public class

Notebook



A container where the children share the same display space.
THe active child can be selected from a set of buttons displayed by the noteboook.

Constructor Summary
public (GtkWidget* gtkWidget)
          
public ()
          Creates a new notebook

Methods Summary
protected alias EventHandler11!(Notebook , uint )
          
void addOnSwitchPage(void delegate(Notebook, uint) dlg)
          
void setTabPos(PositionType tabPos)
          Sets the tab positions
PositionType getTabPos()
          Gets the current tab position
void appendPage(Widget child, char str)
          Appends a new page to the notebook
void appendPage(Widget child, String str)
          
void appendPage(Widget child, Widget tabLabel)
          Appens a new page to the notebook
void appendPageMenu(Widget child, Widget tabLabel, Widget menuLabel)
          Appends a new page witha menu to the notebook
void popupEnable()
          Enables the popup menu
void setShowBorder(bit showBorder)
          Set the border visibility
gboolean getShowBorder()
          Gets the border visibility
void setShowTabs(bit showTabs)
          Sets the tabs visibility
gboolean getShowTabs()
          Gets the tabs visibility
void removePage(gint pageNumber)
          
gint getCurrentPage()
          ********************************************************* query, set current NoteebookPage * ********************************************************* Gets the current page number
Widget getNthPage(gint pageNumber)
          Gets the widget on a page
gint getNPages()
          Gets the total number of page on this notebook
gint pageNum(Widget child)
          Gets the page number for a widget
void setCurrentPage(int pageNumber)
          Sets this notebook current page
void setCurrentPage(Widget child)
          
void nextPage()
          Sets the next page as the current page
void prevPage()
          Sets the previous page as the current page
void setScrollable(bit scrollable)
          ********************************************************* set Notebook, NotebookTab style * ********************************************************* Sets the scrollabe mode
bit getScrollable()
          Gets the scrollable mode
void popupDisable()
          ********************************************************* enable/disable PopupMenu * ********************************************************* Disables the popup menu
void popupEnable(bit enabled)
          Enables the popup menu
Widget getTabLabel(Widget child)
          ********************************************************* query/set NotebookPage Properties * ********************************************************* Gets the tab label from the tab that contains a widget
void setTabLabel(Widget child, Widget tabLabel)
          Sets the tab label widget for a tab that contains a widget
void setTabLabelText(Widget child, char tabText)
          Sets the tab label text
String getTabLabelText(Widget child)
          Gets the tab label text for a tab that contains a specific child
Widget getMenuLabel(Widget child)
          Gets the menu for the tab containing a widget
void setMenuLabel(Widget child, Widget menuLabel)
          Sets the menu for the tab containing a widget
void setMenuLabelText(Widget child, String menuText)
          Sets the menu label text for the tab containing a widget
String getMenuLabelText(Widget child)
          

EventHandler11!

protected alias EventHandler11!(Notebook , uint )


public ctor(Notebook)(GtkWidget* gtkWidget)


public ctor(Notebook)()
Creates a new notebook
addOnSwitchPage

void addOnSwitchPage(void delegate(Notebook, uint) dlg)
setTabPos

void setTabPos(PositionType tabPos)
Sets the tab positions

Parameters:
tabPos - the new tab position
getTabPos

PositionType getTabPos()
Gets the current tab position

Returns:
the current tab position
appendPage

void appendPage(Widget child, char str)
Appends a new page to the notebook

Parameters:
child - the widget to append
str - the tab text
appendPage

void appendPage(Widget child, String str)
appendPage

void appendPage(Widget child, Widget tabLabel)
Appens a new page to the notebook

Parameters:
child - the widget to append
tabLabel - the tab widget
appendPageMenu

void appendPageMenu(Widget child, Widget tabLabel, Widget menuLabel)
Appends a new page witha menu to the notebook

Parameters:
child - the widget to append
tabLabel - the tab widget
menuLabel - the menu
popupEnable

void popupEnable()
Enables the popup menu
setShowBorder

void setShowBorder(bit showBorder)
Set the border visibility
getShowBorder

gboolean getShowBorder()
Gets the border visibility

Returns:
true if the border is vidible
setShowTabs

void setShowTabs(bit showTabs)
Sets the tabs visibility

Parameters:
showTabs - if true the tabs will be visible
getShowTabs

gboolean getShowTabs()
Gets the tabs visibility

Returns:
true if the tabs are visible
removePage

void removePage(gint pageNumber)
getCurrentPage

gint getCurrentPage()
********************************************************* query, set current NoteebookPage * ********************************************************* Gets the current page number

Returns:
the current page number
getNthPage

Widget getNthPage(gint pageNumber)
Gets the widget on a page

Parameters:
pageNumber -

Returns:
the widget on the page
getNPages

gint getNPages()
Gets the total number of page on this notebook
pageNum

gint pageNum(Widget child)
Gets the page number for a widget

Parameters:
child - the widget

Returns:
the page number for the widget or ??? if not found
setCurrentPage

void setCurrentPage(int pageNumber)
Sets this notebook current page

Parameters:
pageNumber - the page number
setCurrentPage

void setCurrentPage(Widget child)
nextPage

void nextPage()
Sets the next page as the current page
prevPage

void prevPage()
Sets the previous page as the current page
setScrollable

void setScrollable(bit scrollable)
********************************************************* set Notebook, NotebookTab style * ********************************************************* Sets the scrollabe mode

Parameters:
scrollable - the new scrollable mode
getScrollable

bit getScrollable()
Gets the scrollable mode

Returns:
the scrollable mode
popupDisable

void popupDisable()
********************************************************* enable/disable PopupMenu * ********************************************************* Disables the popup menu
popupEnable

void popupEnable(bit enabled)
Enables the popup menu

Parameters:
enabled - if true enables else disables
getTabLabel

Widget getTabLabel(Widget child)
********************************************************* query/set NotebookPage Properties * ********************************************************* Gets the tab label from the tab that contains a widget

Parameters:
child - the widget

Returns:
the tab label widget
setTabLabel

void setTabLabel(Widget child, Widget tabLabel)
Sets the tab label widget for a tab that contains a widget

Parameters:
child - the widget on the tab
tabLabel - the widget to set as the tab
setTabLabelText

void setTabLabelText(Widget child, char tabText)
Sets the tab label text

Parameters:
child - the widget contained on the tab to set
tabText - the new tabText
getTabLabelText

String getTabLabelText(Widget child)
Gets the tab label text for a tab that contains a specific child

Parameters:
child - the widget

Returns:
getMenuLabel

Widget getMenuLabel(Widget child)
Gets the menu for the tab containing a widget

Parameters:
child - the widget

Returns:
the menu
setMenuLabel

void setMenuLabel(Widget child, Widget menuLabel)
Sets the menu for the tab containing a widget

Parameters:
child - the widget
menuLabel - the menu
setMenuLabelText

void setMenuLabelText(Widget child, String menuText)
Sets the menu label text for the tab containing a widget

Parameters:
child - the widget
menuText - the menu label text
getMenuLabelText

String getMenuLabelText(Widget child)