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.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWNotebook, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
const char *	GetPageTitle (int id)
void	RemovePagesMatchingTag (int tag)
int	GetVisiblePageId (int idx)
int	GetMostRecentPageId (int idx)
unsigned int	GetNumberOfPinnedPages ()
int	GetPinnedPageId (int idx)
int	GetPageIdContainingCoordinatesInTab (int x, int y)
virtual void	UpdateEnableState ()
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)
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	Raise (int id)
void	Raise (const char *title)
void	Raise (const char *title, int tag)
int	GetRaisedPageId ()
void	RaiseFirstPageMatchingTag (int tag)
vtkKWWidget *	GetFrame (int id)
vtkKWWidget *	GetFrame (const char *title)
vtkKWWidget *	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 ()
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	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 ()
void	ScheduleResize ()
void	Resize ()
void	PageTabContextMenuCallback (int id, int x, int y)
void	RaiseCallback (int id)
void	TogglePagePinnedCallback (int id)
void	TogglePageVisibilityCallback (int id)
Static Public Member Functions
vtkKWNotebook *	New ()
Protected Member Functions
	vtkKWNotebook ()
	~vtkKWNotebook ()
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 *)
void	BindPage (Page *)
void	UnBindPage (Page *)
int	AddToMostRecentPages (Page *)
int	RemoveFromMostRecentPages (Page *)
int	PutOnTopOfMostRecentPages (Page *)
void	UpdatePageTabBackgroundColor (Page *, int selected)
int	AreTabsVisible ()
void	UpdateBodyPosition ()
void	UpdateMaskPosition ()
void	ConstrainVisiblePages ()
void	SendEventForPage (unsigned long event, int id)
virtual void	Bind ()
virtual void	UnBind ()
Protected Attributes
int	MinimumWidth
int	MinimumHeight
int	AlwaysShowTabs
int	ShowIcons
int	ShowAllPagesWithSameTag
int	ShowOnlyPagesWithSameTag
int	ShowOnlyMostRecentPages
int	NumberOfMostRecentPages
int	PagesCanBePinned
int	EnablePageTabContextMenu
vtkKWFrame *	TabsFrame
vtkKWFrame *	Body
vtkKWFrame *	Mask
vtkKWMenu *	TabPopupMenu
vtkKWNotebookInternals *	Internals
int	IdCounter
int	CurrentId
int	Expanding
Friends
class	vtkKWNotebookInternals

---

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 33 of file vtkKWNotebook.h.

---

Constructor & Destructor Documentation

vtkKWNotebook::vtkKWNotebook (   )  [protected]

vtkKWNotebook::~vtkKWNotebook (   )  [protected]

---

Member Function Documentation

vtkKWNotebook* vtkKWNotebook::New (   )  [static]

Reimplemented from vtkKWCompositeWidget.

vtkKWNotebook::vtkTypeRevisionMacro (  vtkKWNotebook  , vtkKWCompositeWidget  )

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

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWNotebook::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. 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. 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). Finally, an optional 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. 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). Finally, an optional 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. 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). Finally, an optional 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. 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). Finally, an optional 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 )

Does it have a given page

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

Does it have a given page

const char* vtkKWNotebook::GetPageTitle (  int  id  )

Accessors

unsigned int vtkKWNotebook::GetNumberOfPages (   )

Return the number of pages in the notebook.

unsigned int vtkKWNotebook::GetNumberOfPagesMatchingTag (  int  tag  )

Return the number of pages in the notebook.

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 )

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.

int vtkKWNotebook::GetPageTag (  int  id  )

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.

int vtkKWNotebook::GetPageTag (  const char *  title  )

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::Raise (  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() is a convenience method use to raise the first page matching a given tag.

void vtkKWNotebook::Raise (  const char *  title  )

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() is a convenience method use to raise the first page matching a given tag.

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

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() is a convenience method use to raise the first page matching a given tag.

int vtkKWNotebook::GetRaisedPageId (   )

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() is a convenience method use to raise the first page matching a given tag.

void vtkKWNotebook::RaiseFirstPageMatchingTag (  int  tag  )

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() is a convenience method use to raise the first page matching a given tag.

vtkKWWidget* 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.

vtkKWWidget* vtkKWNotebook::GetFrame (  const char *  title  )

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.

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

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.

int vtkKWNotebook::GetPageIdFromFrameWidgetName (  const char *  frame_wname  )

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.

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  )

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.

void vtkKWNotebook::RemovePagesMatchingTag (  int  tag  )

Convenience method to 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  )

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, int  tag )

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::HidePage (  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::HidePage (  const char *  title  )

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::HidePage (  const char *  title, int  tag )

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::SetPageVisibility (  int  id, int  flag )

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::SetPageVisibility (  const char *  title, int  flag )

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::SetPageVisibility (  const char *  title, int  tag, int  flag )

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()).

int vtkKWNotebook::GetPageVisibility (  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()).

int vtkKWNotebook::GetPageVisibility (  const char *  title  )

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()).

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

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::TogglePageVisibility (  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::TogglePageVisibility (  const char *  title  )

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::TogglePageVisibility (  const char *  title, int  tag )

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()).

int vtkKWNotebook::CanBeHidden (  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()).

int vtkKWNotebook::CanBeHidden (  const char *  title  )

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()).

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

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::HideAllPages (   )

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()).

unsigned int vtkKWNotebook::GetNumberOfVisiblePages (   )

Return the number of visible pages in the notebook.

unsigned int vtkKWNotebook::GetNumberOfVisiblePagesMatchingTag (  int  tag  )

Return the number of visible pages in the notebook.

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  )

Convenience methods provided to 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  )

Convenience methods provided to show/hide all page tabs matching or not matching a given tag. ShowPagesMatchingTagReverse processes pages starting from the last one.

void vtkKWNotebook::ShowPagesMatchingTagReverse (  int  tag  )

Convenience methods provided to show/hide all page tabs matching or not matching a given tag. ShowPagesMatchingTagReverse processes pages starting from the last one.

void vtkKWNotebook::HidePagesNotMatchingTag (  int  tag  )

Convenience methods provided to show/hide all page tabs matching or not matching a given tag. ShowPagesMatchingTagReverse processes pages starting from the last one.

void vtkKWNotebook::ShowPagesNotMatchingTag (  int  tag  )

Convenience methods provided to show/hide all page tabs matching or not matching a given tag. ShowPagesMatchingTagReverse processes pages starting from the last one.

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]

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 void vtkKWNotebook::ShowAllPagesWithSameTagOn (   )  [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 void vtkKWNotebook::ShowAllPagesWithSameTagOff (   )  [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 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]

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 void vtkKWNotebook::ShowOnlyPagesWithSameTagOn (   )  [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 void vtkKWNotebook::ShowOnlyPagesWithSameTagOff (   )  [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 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]

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 void vtkKWNotebook::ShowOnlyMostRecentPagesOn (   )  [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 void vtkKWNotebook::ShowOnlyMostRecentPagesOff (   )  [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 void vtkKWNotebook::SetNumberOfMostRecentPages (  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::GetNumberOfMostRecentPages (   )  [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.

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  )

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, int  tag )

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::UnpinPage (  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::UnpinPage (  const char *  title  )

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::UnpinPage (  const char *  title, int  tag )

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::TogglePagePinned (  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::TogglePagePinned (  const char *  title  )

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::TogglePagePinned (  const char *  title, int  tag )

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.

int vtkKWNotebook::GetPagePinned (  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.

int vtkKWNotebook::GetPagePinned (  const char *  title  )

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.

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

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::PinPagesMatchingTag (  int  tag  )

Convenience methods provided to pin/unpin all page tabs matching a given tag.

void vtkKWNotebook::UnpinPagesMatchingTag (  int  tag  )

Convenience methods provided to pin/unpin all page tabs matching a given tag.

virtual void vtkKWNotebook::SetPagesCanBePinned (  int   )  [virtual]

Allow pages to be pinned.

virtual int vtkKWNotebook::GetPagesCanBePinned (   )  [virtual]

Allow pages to be pinned.

virtual void vtkKWNotebook::PagesCanBePinnedOn (   )  [virtual]

Allow pages to be pinned.

virtual void vtkKWNotebook::PagesCanBePinnedOff (   )  [virtual]

Allow pages to be pinned.

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::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]

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 void vtkKWNotebook::SetMinimumHeight (  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::GetMinimumHeight (   )  [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 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]

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

virtual void vtkKWNotebook::AlwaysShowTabsOn (   )  [virtual]

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

virtual void vtkKWNotebook::AlwaysShowTabsOff (   )  [virtual]

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

virtual void vtkKWNotebook::SetShowIcons (  int   )  [virtual]

Show/hide all tab icons (if any).

virtual int vtkKWNotebook::GetShowIcons (   )  [virtual]

Show/hide all tab icons (if any).

virtual void vtkKWNotebook::ShowIconsOn (   )  [virtual]

Show/hide all tab icons (if any).

virtual void vtkKWNotebook::ShowIconsOff (   )  [virtual]

Show/hide all tab icons (if any).

virtual void vtkKWNotebook::SetEnablePageTabContextMenu (  int   )  [virtual]

Enable the page tab context menu.

virtual int vtkKWNotebook::GetEnablePageTabContextMenu (   )  [virtual]

Enable the page tab context menu.

virtual void vtkKWNotebook::EnablePageTabContextMenuOn (   )  [virtual]

Enable the page tab context menu.

virtual void vtkKWNotebook::EnablePageTabContextMenuOff (   )  [virtual]

Enable the page tab context menu.

int vtkKWNotebook::GetPageIdContainingCoordinatesInTab (  int  x, int  y )

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

void vtkKWNotebook::ScheduleResize (   )

Some callback routines.

void vtkKWNotebook::Resize (   )

Some callback routines.

void vtkKWNotebook::PageTabContextMenuCallback (  int  id, int  x, int  y )

Some callback routines.

void vtkKWNotebook::RaiseCallback (  int  id  )

Some callback routines.

void vtkKWNotebook::TogglePagePinnedCallback (  int  id  )

Some callback routines.

void vtkKWNotebook::TogglePageVisibilityCallback (  int  id  )

Some callback routines.

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.

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]

void vtkKWNotebook::BindPage (  Page *   )  [protected]

void vtkKWNotebook::UnBindPage (  Page *   )  [protected]

int vtkKWNotebook::AddToMostRecentPages (  Page *   )  [protected]

int vtkKWNotebook::RemoveFromMostRecentPages (  Page *   )  [protected]

int vtkKWNotebook::PutOnTopOfMostRecentPages (  Page *   )  [protected]

void vtkKWNotebook::UpdatePageTabBackgroundColor (  Page *  , int  selected )  [protected]

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]

Bind/Unbind events.

---

Friends And Related Function Documentation

friend class vtkKWNotebookInternals [friend]

Definition at line 360 of file vtkKWNotebook.h.

---

Member Data Documentation

int vtkKWNotebook::MinimumWidth [protected]

Definition at line 319 of file vtkKWNotebook.h.

int vtkKWNotebook::MinimumHeight [protected]

Definition at line 320 of file vtkKWNotebook.h.

int vtkKWNotebook::AlwaysShowTabs [protected]

Definition at line 321 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowIcons [protected]

Definition at line 322 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowAllPagesWithSameTag [protected]

Definition at line 323 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowOnlyPagesWithSameTag [protected]

Definition at line 324 of file vtkKWNotebook.h.

int vtkKWNotebook::ShowOnlyMostRecentPages [protected]

Definition at line 325 of file vtkKWNotebook.h.

int vtkKWNotebook::NumberOfMostRecentPages [protected]

Definition at line 326 of file vtkKWNotebook.h.

int vtkKWNotebook::PagesCanBePinned [protected]

Definition at line 327 of file vtkKWNotebook.h.

int vtkKWNotebook::EnablePageTabContextMenu [protected]

Definition at line 328 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::TabsFrame [protected]

Definition at line 330 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::Body [protected]

Definition at line 331 of file vtkKWNotebook.h.

vtkKWFrame* vtkKWNotebook::Mask [protected]

Definition at line 332 of file vtkKWNotebook.h.

vtkKWMenu* vtkKWNotebook::TabPopupMenu [protected]

Definition at line 333 of file vtkKWNotebook.h.

vtkKWNotebookInternals* vtkKWNotebook::Internals [protected]

PIMPL Encapsulation for STL containers Reimplemented from vtkKWWidget. Definition at line 359 of file vtkKWNotebook.h.

int vtkKWNotebook::IdCounter [protected]

Definition at line 411 of file vtkKWNotebook.h.

int vtkKWNotebook::CurrentId [protected]

Definition at line 412 of file vtkKWNotebook.h.

int vtkKWNotebook::Expanding [protected]

Definition at line 413 of file vtkKWNotebook.h.

---

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

• GUI/Widgets/vtkKWNotebook.h

---