Notebook Class Reference

Inheritance diagram for Notebook:

Container List of all members.

Detailed Description

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.


Public Member Functions

 this ()
 Creates a new notebook.

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, 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)
 Remove one page from this notebook.

gint getCurrentPage ()
 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 nextPage ()
 Sets the next page as the current page.

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

void setScrollable (bit scrollable)
 Sets the scrollabe mode.

bit getScrollable ()
 Gets the scrollable mode.

void popupDisable ()
 Disables the popup menu.

void popupEnable (bit enabled)
 Enables the popup menu.

Widget getTabLabel (Widget child)
 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.

char[] 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, char[] menuText)
 Sets the menu label text for the tab containing a widget.


Member Function Documentation

void Notebook.appendPage Widget  child,
Widget  tabLabel
 

Appens a new page to the notebook.

Parameters:
child the widget to append
tabLabel the tab widget

void Notebook.appendPage Widget  child,
char[]  str
 

Appends a new page to the notebook.

Parameters:
child the widget to append
str the tab text

void Notebook.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

gint Notebook.getCurrentPage  ) 
 

Gets the current page number.

Returns:
the current page number

Widget Notebook.getMenuLabel Widget  child  ) 
 

Gets the menu for the tab containing a widget.

Parameters:
child the widget
Returns:
the menu

gint Notebook.getNPages  ) 
 

Gets the total number of page on this notebook.

Widget Notebook.getNthPage gint  pageNumber  ) 
 

Gets the widget on a page.

Parameters:
pageNumber 
Returns:
the widget on the page

bit Notebook.getScrollable  ) 
 

Gets the scrollable mode.

Returns:
the scrollable mode

gboolean Notebook.getShowBorder  ) 
 

Gets the border visibility.

Returns:
true if the border is vidible

gboolean Notebook.getShowTabs  ) 
 

Gets the tabs visibility.

Returns:
true if the tabs are visible

Widget Notebook.getTabLabel Widget  child  ) 
 

Gets the tab label from the tab that contains a widget.

Parameters:
child the widget
Returns:
the tab label widget

char [] Notebook.getTabLabelText Widget  child  ) 
 

Gets the tab label text for a tab that contains a specific child.

Parameters:
child the widget
Returns:

PositionType Notebook.getTabPos  ) 
 

Gets the current tab position.

Returns:
the current tab position

void Notebook.nextPage  ) 
 

Sets the next page as the current page.

gint Notebook.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

void Notebook.popupDisable  ) 
 

Disables the popup menu.

void Notebook.popupEnable bit  enabled  ) 
 

Enables the popup menu.

Parameters:
enabled if true enables else disables

void Notebook.popupEnable  ) 
 

Enables the popup menu.

void Notebook.prevPage  ) 
 

Sets the previous page as the current page.

void Notebook.removePage gint  pageNumber  ) 
 

Remove one page from this notebook.

Parameters:
pageNumber the page number to be removed

void Notebook.setCurrentPage int  pageNumber  ) 
 

Sets this notebook current page.

Parameters:
pageNumber the page number

void Notebook.setMenuLabel Widget  child,
Widget  menuLabel
 

Sets the menu for the tab containing a widget.

Parameters:
child the widget
menuLabel the menu

void Notebook.setMenuLabelText Widget  child,
char[]  menuText
 

Sets the menu label text for the tab containing a widget.

Parameters:
child the widget
menuText the menu label text

void Notebook.setScrollable bit  scrollable  ) 
 

Sets the scrollabe mode.

Parameters:
scrollable the new scrollable mode

void Notebook.setShowBorder bit  showBorder  ) 
 

Set the border visibility.

void Notebook.setShowTabs bit  showTabs  ) 
 

Sets the tabs visibility.

Parameters:
showTabs if true the tabs will be visible

void Notebook.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

void Notebook.setTabLabelText Widget  child,
char[]  tabText
 

Sets the tab label text.

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

void Notebook.setTabPos PositionType  tabPos  ) 
 

Sets the tab positions.

Parameters:
tabPos the new tab position

Notebook.this  ) 
 

Creates a new notebook.


Generated on Sun Dec 21 02:47:11 2003 for DUI by doxygen 1.3.4