vtkKWNotebook Class Reference

a tabbed notebook of UI pages More...

#include <vtkKWNotebook.h>

Inheritance diagram for vtkKWNotebook:

[legend]

Collaboration diagram for vtkKWNotebook:

[legend]

List of all members.

Classes
class	Page
Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	RemovePagesMatchingTag (int tag)
int	GetVisiblePageId (int idx)
int	GetMostRecentPageId (int idx)
unsigned int	GetNumberOfPinnedPages ()
int	GetPinnedPageId (int idx)
virtual int	GetPageIdContainingCoordinatesInTab (int x, int y)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWNotebook *	New ()
static int	IsTypeOf (const char *type)
static vtkKWNotebook *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWNotebook ()
	~vtkKWNotebook ()
virtual void	CreateWidget ()
Page *	GetPage (int id)
Page *	GetPage (const char *title)
Page *	GetPage (const char *title, int tag)
Page *	GetFirstVisiblePage ()
Page *	GetFirstPageMatchingTag (int tag)
Page *	GetFirstPackedPageNotMatchingTag (int tag)
void	SetPageTag (Page *, int tag)
void	RaisePage (Page *)
void	ShowPageTab (Page *)
void	ShowPageTabAsLow (Page *)
void	LowerPage (Page *)
int	RemovePage (Page *)
void	ShowPage (Page *)
void	HidePage (Page *)
void	PinPage (Page *)
void	UnpinPage (Page *)
void	TogglePagePinned (Page *)
int	GetPageVisibility (Page *)
void	TogglePageVisibility (Page *)
int	CanBeHidden (Page *)
int	GetPageTag (Page *)
int	GetPagePinned (Page *)
const char *	GetPageTitle (Page *)
const char *	GetPageBalloonHelpString (Page *)
vtkKWIcon *	GetPageIcon (Page *)
void	SetPageEnabled (Page *, int flag)
void	BuildPage (Page *, const char *title, const char *balloon, vtkKWIcon *icon)
int	AddToMostRecentPages (Page *)
int	RemoveFromMostRecentPages (Page *)
int	PutOnTopOfMostRecentPages (Page *)
virtual void	UpdatePageTabAspect (Page *)
virtual void	UpdateAllPagesTabAspect ()
int	AreTabsVisible ()
void	UpdateBodyPosition ()
void	UpdateMaskPosition ()
void	ConstrainVisiblePages ()
void	SendEventForPage (unsigned long event, int id)
Protected Attributes
int	MinimumWidth
int	MinimumHeight
int	AlwaysShowTabs
int	ShowIcons
int	ShowAllPagesWithSameTag
int	ShowOnlyPagesWithSameTag
int	ShowOnlyMostRecentPages
int	NumberOfMostRecentPages
int	PagesCanBePinned
int	EnablePageTabContextMenu
int	UseFrameWithScrollbars
double	PageTabColor [3]
double	SelectedPageTabColor [3]
double	PageTabTextColor [3]
double	SelectedPageTabTextColor [3]
double	PinnedPageTabOutlineColor [3]
int	SelectedPageTabPadding
vtkKWFrame *	TabsFrame
vtkKWFrame *	Body
vtkKWFrame *	Mask
vtkKWMenu *	TabPopupMenu
vtkKWNotebookInternals *	Internals
int	IdCounter
int	CurrentId
int	Expanding
vtkKWBalloonHelpManager *	TabBalloonHelpManager
Friends
class	vtkKWNotebookInternals
int	AddPage (const char *title, const char *balloon, vtkKWIcon *icon, int tag)
int	AddPage (const char *title, const char *balloon, vtkKWIcon *icon)
int	AddPage (const char *title, const char *balloon)
int	AddPage (const char *title)
int	HasPage (int id)
int	HasPage (const char *title, int tag)
int	GetPageId (const char *title, int tag)
const char *	GetPageTitle (int id)
virtual void	SetPageTitle (int id, const char *title)
const char *	GetPageBalloonHelpString (int id)
virtual void	SetPageBalloonHelpString (int id, const char *str)
vtkKWIcon *	GetPageIcon (int id)
virtual void	SetPageIcon (int id, vtkKWIcon *icon)
virtual void	SetPageIconToPredefinedIcon (int id, int icon_index)
int	GetPageSmallCounterValue (int id)
virtual void	SetPageSmallCounterValue (int id, int v)
unsigned int	GetNumberOfPages ()
unsigned int	GetNumberOfPagesMatchingTag (int tag)
void	SetPageTag (int id, int tag)
void	SetPageTag (const char *title, int tag)
int	GetPageTag (int id)
int	GetPageTag (const char *title)
void	RaisePage (int id)
void	RaisePage (const char *title)
void	RaisePage (const char *title, int tag)
int	GetRaisedPageId ()
void	RaiseFirstPageMatchingTag (int tag)
vtkKWFrame *	GetFrame (int id)
vtkKWFrame *	GetFrame (const char *title)
vtkKWFrame *	GetFrame (const char *title, int tag)
int	GetPageIdFromFrameWidgetName (const char *frame_wname)
int	RemovePage (int id)
int	RemovePage (const char *title)
void	ShowPage (int id)
void	ShowPage (const char *title)
void	ShowPage (const char *title, int tag)
void	HidePage (int id)
void	HidePage (const char *title)
void	HidePage (const char *title, int tag)
void	SetPageVisibility (int id, int flag)
void	SetPageVisibility (const char *title, int flag)
void	SetPageVisibility (const char *title, int tag, int flag)
int	GetPageVisibility (int id)
int	GetPageVisibility (const char *title)
int	GetPageVisibility (const char *title, int tag)
void	TogglePageVisibility (int id)
void	TogglePageVisibility (const char *title)
void	TogglePageVisibility (const char *title, int tag)
int	CanBeHidden (int id)
int	CanBeHidden (const char *title)
int	CanBeHidden (const char *title, int tag)
void	HideAllPages ()
void	SetPageEnabled (int id, int flag)
void	SetPageEnabled (const char *title, int flag)
void	SetPageEnabled (const char *title, int tag, int fkag)
unsigned int	GetNumberOfVisiblePages ()
unsigned int	GetNumberOfVisiblePagesMatchingTag (int tag)
void	HidePagesMatchingTag (int tag)
void	ShowPagesMatchingTag (int tag)
void	ShowPagesMatchingTagReverse (int tag)
void	HidePagesNotMatchingTag (int tag)
void	ShowPagesNotMatchingTag (int tag)
virtual void	SetShowAllPagesWithSameTag (int)
virtual int	GetShowAllPagesWithSameTag ()
virtual void	ShowAllPagesWithSameTagOn ()
virtual void	ShowAllPagesWithSameTagOff ()
virtual void	SetShowOnlyPagesWithSameTag (int)
virtual int	GetShowOnlyPagesWithSameTag ()
virtual void	ShowOnlyPagesWithSameTagOn ()
virtual void	ShowOnlyPagesWithSameTagOff ()
virtual void	SetShowOnlyMostRecentPages (int)
virtual int	GetShowOnlyMostRecentPages ()
virtual void	ShowOnlyMostRecentPagesOn ()
virtual void	ShowOnlyMostRecentPagesOff ()
virtual void	SetNumberOfMostRecentPages (int)
virtual int	GetNumberOfMostRecentPages ()
void	PinPage (int id)
void	PinPage (const char *title)
void	PinPage (const char *title, int tag)
void	UnpinPage (int id)
void	UnpinPage (const char *title)
void	UnpinPage (const char *title, int tag)
void	TogglePagePinned (int id)
void	TogglePagePinned (const char *title)
void	TogglePagePinned (const char *title, int tag)
int	GetPagePinned (int id)
int	GetPagePinned (const char *title)
int	GetPagePinned (const char *title, int tag)
void	PinPagesMatchingTag (int tag)
void	UnpinPagesMatchingTag (int tag)
virtual void	SetPagesCanBePinned (int)
virtual int	GetPagesCanBePinned ()
virtual void	PagesCanBePinnedOn ()
virtual void	PagesCanBePinnedOff ()
virtual void	SetUseFrameWithScrollbars (int)
virtual int	GetUseFrameWithScrollbars ()
virtual void	UseFrameWithScrollbarsOn ()
virtual void	UseFrameWithScrollbarsOff ()
virtual void	SetMinimumWidth (int)
virtual int	GetMinimumWidth ()
virtual void	SetMinimumHeight (int)
virtual int	GetMinimumHeight ()
virtual void	SetAlwaysShowTabs (int)
virtual int	GetAlwaysShowTabs ()
virtual void	AlwaysShowTabsOn ()
virtual void	AlwaysShowTabsOff ()
virtual void	SetShowIcons (int)
virtual int	GetShowIcons ()
virtual void	ShowIconsOn ()
virtual void	ShowIconsOff ()
virtual void	SetEnablePageTabContextMenu (int)
virtual int	GetEnablePageTabContextMenu ()
virtual void	EnablePageTabContextMenuOn ()
virtual void	EnablePageTabContextMenuOff ()
virtual void	SetBackgroundColor (double r, double g, double b)
virtual void	SetBackgroundColor (double rgb[3])
virtual double *	GetPageTabColor ()
virtual void	GetPageTabColor (double &, double &, double &)
virtual void	GetPageTabColor (double[3])
virtual void	SetPageTabColor (double r, double g, double b)
virtual void	SetPageTabColor (double rgb[3])
virtual double *	GetSelectedPageTabColor ()
virtual void	GetSelectedPageTabColor (double &, double &, double &)
virtual void	GetSelectedPageTabColor (double[3])
virtual void	SetSelectedPageTabColor (double r, double g, double b)
virtual void	SetSelectedPageTabColor (double rgb[3])
virtual double *	GetPinnedPageTabOutlineColor ()
virtual void	GetPinnedPageTabOutlineColor (double &, double &, double &)
virtual void	GetPinnedPageTabOutlineColor (double[3])
virtual void	SetPinnedPageTabOutlineColor (double r, double g, double b)
virtual void	SetPinnedPageTabOutlineColor (double rgb[3])
virtual double *	GetPageTabTextColor ()
virtual void	GetPageTabTextColor (double &, double &, double &)
virtual void	GetPageTabTextColor (double[3])
virtual void	SetPageTabTextColor (double r, double g, double b)
virtual void	SetPageTabTextColor (double rgb[3])
virtual double *	GetSelectedPageTabTextColor ()
virtual void	GetSelectedPageTabTextColor (double &, double &, double &)
virtual void	GetSelectedPageTabTextColor (double[3])
virtual void	SetSelectedPageTabTextColor (double r, double g, double b)
virtual void	SetSelectedPageTabTextColor (double rgb[3])
virtual int	GetSelectedPageTabPadding ()
virtual void	SetSelectedPageTabPadding (int arg)
virtual void	ScheduleResize ()
virtual void	Resize ()
virtual void	PageTabContextMenuCallback (int id, int x, int y)
virtual void	RaiseCallback (int id)
virtual void	TogglePagePinnedCallback (int id)
virtual void	TogglePageVisibilityCallback (int id)
virtual void	Bind ()
virtual void	UnBind ()

---

Detailed Description

a tabbed notebook of UI pages

The notebook represents a tabbed notebook component where you can add or remove pages.

Definition at line 34 of file vtkKWNotebook.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWNotebook::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 39 of file vtkKWNotebook.h.

---

Constructor & Destructor Documentation

vtkKWNotebook::vtkKWNotebook

(

)

[protected]

vtkKWNotebook::~vtkKWNotebook

(

)

[protected]

---

Member Function Documentation

static vtkKWNotebook* vtkKWNotebook::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWNotebook::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWNotebook::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWNotebook::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWNotebook* vtkKWNotebook::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

void vtkKWNotebook::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkKWCompositeWidget.

int vtkKWNotebook::AddPage	(	const char *	title,
		const char *	balloon,
		vtkKWIcon *	icon,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::AddPage	(	const char *	title,
		const char *	balloon,
		vtkKWIcon *	icon
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::AddPage	(	const char *	title,
		const char *	balloon
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::AddPage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::HasPage

(

int

id

)

Does it have a given page

int vtkKWNotebook::HasPage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageId	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

const char* vtkKWNotebook::GetPageTitle

(

int

id

)

Set/Get a page's title

virtual void vtkKWNotebook::SetPageTitle	(	int	id,
		const char *	title
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

const char* vtkKWNotebook::GetPageBalloonHelpString

(

int

id

)

Set/Get a page's balloon help string

virtual void vtkKWNotebook::SetPageBalloonHelpString	(	int	id,
		const char *	str
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

vtkKWIcon* vtkKWNotebook::GetPageIcon

(

int

id

)

Set/Get a page's icon. No reference is kept to the icon object, its contents is copied locally.

virtual void vtkKWNotebook::SetPageIcon	(	int	id,
		vtkKWIcon *	icon
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPageIconToPredefinedIcon	(	int	id,
		int	icon_index
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageSmallCounterValue

(

int

id

)

Set/Get a page's small counter. This is a small icon representing a counter on top of the page tab. Set it to 0 (default) to hide the icon, 1 to 9 to reflect that value. Any value over 9 will be represented as 9+. Since only one page is visible at any one time in a notebook, such counter can be used for example to reflect a change that was made to another tab that is not currently visible (the counter would be the number of changes for example).

virtual void vtkKWNotebook::SetPageSmallCounterValue	(	int	id,
		int	v
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

unsigned int vtkKWNotebook::GetNumberOfPages

(

)

Return the number of pages in the notebook.

unsigned int vtkKWNotebook::GetNumberOfPagesMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageTag	(	int	id,
		int	tag
	)

Set/Get a page tag. A tag (int) can be associated to a page (given the page id). This provides a way to group pages. The default tag, if not provided, is 0. If a page title is provided instead of a page id, the first page matching that title is considered.

void vtkKWNotebook::SetPageTag	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageTag

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageTag

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::RaisePage

(

int

id

)

Raise the specified page to be on the top (i.e. the one selected). If a page title is provided instead of a page id, the first page matching that title is considered. In the same way, if a tag is provided with the title, the page which match both title *and* tag is considered. GetRaisedPageId() returns the id of the page raised at the moment, -1 if none is raised. RaiseFirstPageMatchingTag() raises the first page matching a given tag.

void vtkKWNotebook::RaisePage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::RaisePage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetRaisedPageId

(

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::RaiseFirstPageMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

vtkKWFrame* vtkKWNotebook::GetFrame

(

int

id

)

Get the vtkKWWidget corresponding to the frame of a specified page (Tab). This is where the UI components should be inserted. If a page title is provided instead of a page id, the first page matching that title is considered. In the same way, if a tag is provided with the title, the page which match both title *and* tag is considered. Return NULL on error.

vtkKWFrame* vtkKWNotebook::GetFrame

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

vtkKWFrame* vtkKWNotebook::GetFrame	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageIdFromFrameWidgetName

(

const char *

frame_wname

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::RemovePage

(

int

id

)

Remove a page from the notebook. If a page title is provided instead of a page id, the first page matching that title is considered. If the currently selected page is removed, it is unselected first and the first visible tab (if any) becomes selected instead. Return 1 on success, 0 on error.

int vtkKWNotebook::RemovePage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::RemovePagesMatchingTag

(

int

tag

)

Remove all pages matching a tag.

void vtkKWNotebook::ShowPage

(

int

id

)

Show/hide a page tab (i.e. Set/Get the page visibility). Showing a page tab does not raise the page, it just makes the page selectable by displaying its tab. A hidden page tab is not displayed in the tabs: the corresponding page can not be selected. If a page title is provided instead of a page id, the first page matching that title is considered. In the same way, if a tag is provided with the title, the page which match both title *and* tag is considered. If the currently selected page is hidden, it is unselected first and the first visible tab (if any) becomes selected instead. A pinned page tab can not be hidden (see PinPage()/UnpinPage()).

void vtkKWNotebook::ShowPage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::ShowPage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::HidePage

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::HidePage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::HidePage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageVisibility	(	int	id,
		int	flag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageVisibility	(	const char *	title,
		int	flag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageVisibility	(	const char *	title,
		int	tag,
		int	flag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageVisibility

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageVisibility

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPageVisibility	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePageVisibility

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePageVisibility

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePageVisibility	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::CanBeHidden

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::CanBeHidden

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::CanBeHidden	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::HideAllPages

(

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageEnabled	(	int	id,
		int	flag
	)

Enable/Disable a page. Note that this differs from show/hide a tab in the sense that the tab will still be visible but disabled. All tabs are enabled by default. Calling SetEnabled(flag) on this notebook will set the state of all pages to 'flag' unless the page itself has been disabled. The only way to re-enable a page that was disabled using SetPageEnabled is to call SetPageEnabled again.

void vtkKWNotebook::SetPageEnabled	(	const char *	title,
		int	flag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::SetPageEnabled	(	const char *	title,
		int	tag,
		int	fkag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

unsigned int vtkKWNotebook::GetNumberOfVisiblePages

(

)

Return the number of visible pages in the notebook.

unsigned int vtkKWNotebook::GetNumberOfVisiblePagesMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetVisiblePageId

(

int

idx

)

Get the n-th visible page id (starting at index 0, i.e. the first visible page is at index 0, although it does not necessary reflects the way the page tab are packed/ordered in the tab row). Return -1 if the index is out of the range, or if there is no visible page for that index.

void vtkKWNotebook::HidePagesMatchingTag

(

int

tag

)

Show/Hide all page tabs matching or not matching a given tag. ShowPagesMatchingTagReverse processes pages starting from the last one.

void vtkKWNotebook::ShowPagesMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::ShowPagesMatchingTagReverse

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::HidePagesNotMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::ShowPagesNotMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetShowAllPagesWithSameTag

(

int

)

[virtual]

Make the notebook automatically bring up page tabs with the same tag (i.e. all page tabs that have the same tag are always shown).

virtual int vtkKWNotebook::GetShowAllPagesWithSameTag

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowAllPagesWithSameTagOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowAllPagesWithSameTagOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetShowOnlyPagesWithSameTag

(

int

)

[virtual]

Make the notebook automatically show only those page tabs that have the same tag as the currently selected page (i.e. once a page tab has been selected, all pages not sharing the same tag are hidden).

virtual int vtkKWNotebook::GetShowOnlyPagesWithSameTag

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowOnlyPagesWithSameTagOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowOnlyPagesWithSameTagOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetShowOnlyMostRecentPages

(

int

)

[virtual]

Make the notebook automatically maintain a list of most recently used page. The size of this list can be set (defaults to 4). Once it is full, any new shown page will make the least recent page hidden. It is suggested that ShowAllPagesWithSameTag and ShowOnlyPagesWithSameTag shoud be Off for this feature to work properly.

virtual int vtkKWNotebook::GetShowOnlyMostRecentPages

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowOnlyMostRecentPagesOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowOnlyMostRecentPagesOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetNumberOfMostRecentPages

(

int

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual int vtkKWNotebook::GetNumberOfMostRecentPages

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetMostRecentPageId

(

int

idx

)

Get the n-th most recent page id. Most recent pages indexes start at 0 (i.e. the most recent page is at index 0). Return -1 if the index is out of the range, or if there is no most recent page for that index.

void vtkKWNotebook::PinPage

(

int

id

)

Pin/unpin a page tab. A pinned page tab can not be hidden. If a page title is provided instead of a page id, the first page matching that title is considered. In the same way, if a tag is provided with the title, the page which match both title *and* tag is considered.

void vtkKWNotebook::PinPage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::PinPage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::UnpinPage

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::UnpinPage

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::UnpinPage	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePagePinned

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePagePinned

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::TogglePagePinned	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPagePinned

(

int

id

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPagePinned

(

const char *

title

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

int vtkKWNotebook::GetPagePinned	(	const char *	title,
		int	tag
	)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

void vtkKWNotebook::PinPagesMatchingTag

(

int

tag

)

Pin/Unpin all page tabs matching a given tag.

void vtkKWNotebook::UnpinPagesMatchingTag

(

int

tag

)

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPagesCanBePinned

(

int

)

[virtual]

Allow pages to be pinned.

virtual int vtkKWNotebook::GetPagesCanBePinned

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::PagesCanBePinnedOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::PagesCanBePinnedOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

unsigned int vtkKWNotebook::GetNumberOfPinnedPages

(

)

Return the number of pinned pages in the notebook.

int vtkKWNotebook::GetPinnedPageId

(

int

idx

)

Get the n-th pinned page id (starting at index 0, i.e. the first pinned page is at index 0). Return -1 if the index is out of the range, or if there is no pinned page for that index.

virtual void vtkKWNotebook::SetUseFrameWithScrollbars

(

int

)

[virtual]

By default, pages are vtkKWFrame. If the user needs scrollbars, he can make the page the parent of a vtkKWFrameWithScrollbar. For convenience, this option can be turned on so that pages that are added from now on are automatically put inside a vtkKWFrameWithScrollbar. Note that HorizontalScrollbarVisibility is set to Off by default on the vtkKWFrameWithScrollbar created by this class.

virtual int vtkKWNotebook::GetUseFrameWithScrollbars

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::UseFrameWithScrollbarsOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::UseFrameWithScrollbarsOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetMinimumWidth

(

int

)

[virtual]

The notebook will automatically resize itself to fit its contents. This can lead to a lot of resizing. So you can specify a minimum width and height for the notebook. This can be used to significantly reduce or eliminate the resizing of the notebook.

virtual int vtkKWNotebook::GetMinimumWidth

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetMinimumHeight

(

int

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual int vtkKWNotebook::GetMinimumHeight

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetAlwaysShowTabs

(

int

)

[virtual]

Normally, the tab frame is not shown when there is only one page. Turn this on to override that behaviour.

virtual int vtkKWNotebook::GetAlwaysShowTabs

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::AlwaysShowTabsOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::AlwaysShowTabsOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetShowIcons

(

int

)

[virtual]

Show/hide all tab icons (if any).

virtual int vtkKWNotebook::GetShowIcons

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowIconsOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::ShowIconsOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetEnablePageTabContextMenu

(

int

)

[virtual]

Enable the page tab context menu.

virtual int vtkKWNotebook::GetEnablePageTabContextMenu

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::EnablePageTabContextMenuOn

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::EnablePageTabContextMenuOff

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetBackgroundColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Set/Get the background color of the widget. Override the super to make sure all elements are set correctly.

Reimplemented from vtkKWFrame.

virtual void vtkKWNotebook::SetBackgroundColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Reimplemented from vtkKWFrame.

Definition at line 350 of file vtkKWNotebook.h.

virtual double* vtkKWNotebook::GetPageTabColor

(

)

[virtual]

Set/Get the color of the page tabs, the outline of the pinned page tabs and the selected page tab. Note that PageTabColor, and SelectedPageTabColor are undefined by default (i.e. one of the RGB component is < 0), meaning that the background color of the native window system will be used in place of SelectedTabColor, and a slightly darker shade of that background color in place of TabColor.

virtual void vtkKWNotebook::GetPageTabColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetPageTabColor

(

double

[3]

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPageTabColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPageTabColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Definition at line 363 of file vtkKWNotebook.h.

virtual double* vtkKWNotebook::GetSelectedPageTabColor

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetSelectedPageTabColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetSelectedPageTabColor

(

double

[3]

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetSelectedPageTabColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetSelectedPageTabColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Definition at line 367 of file vtkKWNotebook.h.

virtual double* vtkKWNotebook::GetPinnedPageTabOutlineColor

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetPinnedPageTabOutlineColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetPinnedPageTabOutlineColor

(

double

[3]

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPinnedPageTabOutlineColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPinnedPageTabOutlineColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Definition at line 371 of file vtkKWNotebook.h.

virtual double* vtkKWNotebook::GetPageTabTextColor

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetPageTabTextColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetPageTabTextColor

(

double

[3]

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPageTabTextColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetPageTabTextColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Definition at line 375 of file vtkKWNotebook.h.

virtual double* vtkKWNotebook::GetSelectedPageTabTextColor

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetSelectedPageTabTextColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::GetSelectedPageTabTextColor

(

double

[3]

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetSelectedPageTabTextColor	(	double	r,
		double	g,
		double	b
	)			[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::SetSelectedPageTabTextColor

(

double

rgb[3]

)

[inline, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

Definition at line 379 of file vtkKWNotebook.h.

virtual int vtkKWNotebook::GetSelectedPageTabPadding

(

)

[virtual]

Set/Get the amount of padding that is to be added to the internal vertical padding of the selected tab (basically defines the additional height of the selected tab compared to an unselected tabs).

virtual void vtkKWNotebook::SetSelectedPageTabPadding

(

int

arg

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual int vtkKWNotebook::GetPageIdContainingCoordinatesInTab	(	int	x,
		int	y
	)			[virtual]

Get the id of the visible page which tab contains a given pair of screen coordinates (-1 if not found).

virtual void vtkKWNotebook::UpdateEnableState

(

)

[virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWWidget.

virtual void vtkKWNotebook::ScheduleResize

(

)

[virtual]

Schedule the widget to resize itself, or resize it right away

virtual void vtkKWNotebook::Resize

(

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::PageTabContextMenuCallback	(	int	id,
		int	x,
		int	y
	)			[virtual]

Events: the following events are send by a notebook instance. The below events are sent as a result of a direct user interaction (clicking, context menu), not as a result of a programmatical call. The following parameters are also passed as client data: - the title/tag pair for the page, as a const char *[2] (first item in the array is title (eventually NULL), second is its numerical tag, as a string) vtkKWEvent::NotebookRaisePageEvent: a page has been raised vtkKWEvent::NotebookPinPageEvent: a page has been pinned (context menu) vtkKWEvent::NotebookUnpinPageEvent: a page has been unpinned (context menu) vtkKWEvent::NotebookShowPageEvent: a page was shown (context menu?) vtkKWEvent::NotebookHidePageEvent: a page was hidden (context menu)

Callbacks. Internal, do not use.

virtual void vtkKWNotebook::RaiseCallback

(

int

id

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::TogglePagePinnedCallback

(

int

id

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::TogglePageVisibilityCallback

(

int

id

)

[virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

virtual void vtkKWNotebook::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

Page* vtkKWNotebook::GetPage

(

int

id

)

[protected]

Page* vtkKWNotebook::GetPage

(

const char *

title

)

[protected]

Page* vtkKWNotebook::GetPage	(	const char *	title,
		int	tag
	)			[protected]

Page* vtkKWNotebook::GetFirstVisiblePage

(

)

[protected]

Page* vtkKWNotebook::GetFirstPageMatchingTag

(

int

tag

)

[protected]

Page* vtkKWNotebook::GetFirstPackedPageNotMatchingTag

(

int

tag

)

[protected]

void vtkKWNotebook::SetPageTag	(	Page *	,
		int	tag
	)			[protected]

void vtkKWNotebook::RaisePage

(

Page *

)

[protected]

void vtkKWNotebook::ShowPageTab

(

Page *

)

[protected]

void vtkKWNotebook::ShowPageTabAsLow

(

Page *

)

[protected]

void vtkKWNotebook::LowerPage

(

Page *

)

[protected]

int vtkKWNotebook::RemovePage

(

Page *

)

[protected]

void vtkKWNotebook::ShowPage

(

Page *

)

[protected]

void vtkKWNotebook::HidePage

(

Page *

)

[protected]

void vtkKWNotebook::PinPage

(

Page *

)

[protected]

void vtkKWNotebook::UnpinPage

(

Page *

)

[protected]

void vtkKWNotebook::TogglePagePinned

(

Page *

)

[protected]

int vtkKWNotebook::GetPageVisibility

(

Page *

)

[protected]

void vtkKWNotebook::TogglePageVisibility

(

Page *

)

[protected]

int vtkKWNotebook::CanBeHidden

(

Page *

)

[protected]

int vtkKWNotebook::GetPageTag

(

Page *

)

[protected]

int vtkKWNotebook::GetPagePinned

(

Page *

)

[protected]

const char* vtkKWNotebook::GetPageTitle

(

Page *

)

[protected]

const char* vtkKWNotebook::GetPageBalloonHelpString

(

Page *

)

[protected]

vtkKWIcon* vtkKWNotebook::GetPageIcon

(

Page *

)

[protected]

void vtkKWNotebook::SetPageEnabled	(	Page *	,
		int	flag
	)			[protected]

void vtkKWNotebook::BuildPage	(	Page *	,
		const char *	title,
		const char *	balloon,
		vtkKWIcon *	icon
	)			[protected]

int vtkKWNotebook::AddToMostRecentPages

(

Page *

)

[protected]

int vtkKWNotebook::RemoveFromMostRecentPages

(

Page *

)

[protected]

int vtkKWNotebook::PutOnTopOfMostRecentPages

(

Page *

)

[protected]

virtual void vtkKWNotebook::UpdatePageTabAspect

(

Page *

)

[protected, virtual]

virtual void vtkKWNotebook::UpdateAllPagesTabAspect

(

)

[protected, virtual]

int vtkKWNotebook::AreTabsVisible

(

)

[protected]

void vtkKWNotebook::UpdateBodyPosition

(

)

[protected]

void vtkKWNotebook::UpdateMaskPosition

(

)

[protected]

void vtkKWNotebook::ConstrainVisiblePages

(

)

[protected]

void vtkKWNotebook::SendEventForPage	(	unsigned long	event,
		int	id
	)			[protected]

virtual void vtkKWNotebook::Bind

(

)

[protected, virtual]

Bind/Unbind events.

virtual void vtkKWNotebook::UnBind

(

)

[protected, virtual]

Add a new page to the notebook. By setting balloon string, the page will display a balloon help (tooltip). An optional icon can also be specified and will be displayed on the left side of the tab label (all icons can be hidden later on using the SetShowIcons() method). No reference is kept to the icon object, its contents is copied locally. An optional integer tag can be provided and will be associated to the page (see SetPageTag()); this/ tag will default to 0 otherwise. Return a unique positive ID corresponding to that page, or < 0 on error.

---

Friends And Related Function Documentation

friend class vtkKWNotebookInternals [friend]

Definition at line 494 of file vtkKWNotebook.h.

---

Member Data Documentation

int vtkKWNotebook::MinimumWidth [protected]

Definition at line 440 of file vtkKWNotebook.h.

int vtkKWNotebook::MinimumHeight [protected]

Definition at line 441 of file vtkKWNotebook.h.

int vtkKWNotebook::AlwaysShowTabs [protected]

Definition at line 442 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowIcons [protected]

Definition at line 443 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowAllPagesWithSameTag [protected]

Definition at line 444 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowOnlyPagesWithSameTag [protected]

Definition at line 445 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowOnlyMostRecentPages [protected]

Definition at line 446 of file vtkKWNotebook.h.

int vtkKWNotebook::NumberOfMostRecentPages [protected]

Definition at line 447 of file vtkKWNotebook.h.

int vtkKWNotebook::PagesCanBePinned [protected]

Definition at line 448 of file vtkKWNotebook.h.

int vtkKWNotebook::EnablePageTabContextMenu [protected]

Definition at line 449 of file vtkKWNotebook.h.

int vtkKWNotebook::UseFrameWithScrollbars [protected]

Definition at line 450 of file vtkKWNotebook.h.

double vtkKWNotebook::PageTabColor[3] [protected]

Definition at line 452 of file vtkKWNotebook.h.

double vtkKWNotebook::SelectedPageTabColor[3] [protected]

Definition at line 453 of file vtkKWNotebook.h.

double vtkKWNotebook::PageTabTextColor[3] [protected]

Definition at line 454 of file vtkKWNotebook.h.

double vtkKWNotebook::SelectedPageTabTextColor[3] [protected]

Definition at line 455 of file vtkKWNotebook.h.

double vtkKWNotebook::PinnedPageTabOutlineColor[3] [protected]

Definition at line 456 of file vtkKWNotebook.h.

int vtkKWNotebook::SelectedPageTabPadding [protected]

Definition at line 457 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::TabsFrame [protected]

Definition at line 459 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::Body [protected]

Definition at line 460 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::Mask [protected]

Definition at line 461 of file vtkKWNotebook.h.

vtkKWMenu* vtkKWNotebook::TabPopupMenu [protected]

Definition at line 462 of file vtkKWNotebook.h.

vtkKWNotebookInternals* vtkKWNotebook::Internals [protected]

PIMPL Encapsulation for STL containers

Reimplemented from vtkKWCoreWidget.

Definition at line 493 of file vtkKWNotebook.h.

int vtkKWNotebook::IdCounter [protected]

Definition at line 548 of file vtkKWNotebook.h.

int vtkKWNotebook::CurrentId [protected]

Definition at line 549 of file vtkKWNotebook.h.

int vtkKWNotebook::Expanding [protected]

Definition at line 550 of file vtkKWNotebook.h.

vtkKWBalloonHelpManager* vtkKWNotebook::TabBalloonHelpManager [protected]

Definition at line 578 of file vtkKWNotebook.h.

---

The documentation for this class was generated from the following file:

• vtkKWNotebook.h