Methods Index

NNotebook

Heritage

Superclass: CNativeView

Description

NNotebook is the shell that contains the CFaceWindow the user interface. NNotebook directs the navigation of its enclosure, and navigation to and from the CFaceWindow. NNotebook also handles the Tab to Tab and Tab hot key navigation.

Usage

NNotebook *aNotebook = new NNotebook(theParentWindow, theCRectSize);
CFaceWindow* aFace = new CFaceWindow(theDocument, aNotebook);
aNotebook->AddTab (theTabNum, theTitle);

aNotebook->AddPage (theTabNum, thePageNum, theTitle);
aNotebook->SetFace (aFace, theTabNum, thePageNum);

Public Methods

Constructor, Destructor, and Initializer Methods

NNotebook (CSubview *theEnclosure, const CRect& theRegion)

Constructor that creates the notebook of size theRegion and parented to theEnclosure.

NNotebook (const NNotebook& theNotebook)

Class copy constructor.

~NNotebook ()

Class destructor.

BOOLEAN INotebook ()

Method used to intialize the notebook. Returns TRUE if successful.

Event Handling

virtual void DoHit (CONTROL_INFO theCtlInfo)

Method called when a Tab is selected. This method updates the NNotebook's subnavigator to point to the CFaceWindow that represents the top tab and page.

Tab and Page Methods

virtual AddPage (short theTab, short thePage, const CStringRW& theTitle)

Adds a page to the specified tab and page with title theTitle. Page titles are never displayed.

virtual AddTab (short theTab, const CStringRW& theTitle, CImage theTabImage)

Method used to add a Tab. theTitle and theImage are set as well.

virtual const CStringRW GetTitle (void) const;

Method to get the title of the notebook.

virtual CFaceWindow* GetFace (short theTab, short thePage)

Method to retrieve the CFaceWindow of a particular tab and page.

virtual CFaceWindow* GetFacePage (CFaceWindow* theFace, short* theTab, short* thePage)

Method used to get the tab and page of a particular CFaceWindow.

virtual CFaceWindow* GetFrontPage (short* theTab, short* thePage)

Method used to get the current top CFaceWindow.

virtual CStringRW GetPageTitle (short theTab, short thePage) const

Method to get the title of thePage of theTab.

virtual CStringRW GetTabTitle (short theTab) const

Method to get theTab's title.

virtual CImage GetTabImage (short theTab)

Method used to retrieve a copy of theTab's image.

virtual short GetNumPages (short theTab)

Method that returns the number of pages in theTab.

virtual short GetNumTabs ()

Method that returns the number of tabs.

virtual void RemovePage (short theTab, short thePage)

Method to remove a thePage from theTab of the notebook. This method will close the associated CFaceWindow.

virtual void RemoveTab (short theTab)

Method to remove a tab. This method will first remove all pages of the tab.

virtual void SetFace (CFaceWindow* theFace, short theTab, short thePage, long theId)

Method to register a CFaceWindow to a particular tab and page in a notebook. theId represents the resource id of the face window, otherwise NULL.

virtual void SetPageTitle (short theTab, short thePage, CStringRW theTitle)

Method to set the page title of a particular tab and page. The page title is never displayed.

virtual void SetFrontPage (short theTab, short thePage)

Method to change the current tab and page. The CFaceWindow asscoiated the the tab and page will be made visible.

virtual void SetTabTitle (short theTab, CStringRW theTitle)

Method to set the title of a particular tab.

virtual void SetTabImage (short theTab, CImage theImage)

Method to set a particular tab's image. The Tab's title is displayed to the right of this image.

Navigation Methods

virtual void SetTabHotKey (short theTab, short thePage, const CKey& theKey)

Method to associate a hot key with a tab and page. Upon activation of the hot key, the CFaceWindow associated with the tab and page will become visible.

virtual CNavigator* GetNavigator ()

Method that returns the notebook's subnavigator. This subnavigator points to the current visible CFaceWindow.

[Classes] [Prev] [Next] [Methods]

support@xvt.com