Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

csNotebook Class Reference

A notebook (OS/2 term, Windows term "property shit") is a collection of dialogs enclosed in a single window. More...

#include <csnotebk.h>

Inheritance diagram for csNotebook:

csComponent List of all members.

Public Methods

 csNotebook (csComponent *iParent, int iStyle=CSNBS_DEFAULTVALUE)
 Create a notebook component with given parent and style.

virtual ~csNotebook ()
 Destroy the notebook object.

virtual void Draw ()
 Draw the notebook.

virtual bool HandleEvent (iEvent &Event)
 Handle external events.

virtual bool SetRect (int xmin, int ymin, int xmax, int ymax)
 Reposition knobs on resize.

int GetStyle ()
 Query notebook style.

void SetStyle (int iStyle)
 Change notebook style on-the-fly.

bool AddPrimaryTab (csComponent *iComponent, const char *iText, const char *iInfo=NULL, csComponent *iBefore=NULL)
 Add a primary tab: page info can differ from page title.

bool AddSecondaryTab (csComponent *iComponent, const char *iInfo, csComponent *iBefore=NULL)
 Add a secondary tab (no page title).

bool AddPrimaryTab (csComponent *iComponent, csPixmap *iPixmap, bool iDeletePixmap=true, const char *iInfo=NULL, csComponent *iBefore=NULL)
 Same but use a pixmap as tab label rather than a text string.

bool DeleteTab (int iIndex)
 Delete a tab and associated component by index.

bool DeleteTab (csComponent *iComponent)
 Delete a tab and associated component.

bool SelectTab (int iIndex)
 Select a particular tab (by index).

bool SelectTab (csComponent *iComponent)
 Select a particular tab (by component).


Protected Methods

void PlaceGadgets ()
 Reposition current page, forward/backward buttons etc.

bool AddTab (cspPageData *iPageData, const char *iInfo, csComponent *iBefore)
 Common part for AddXXXTab ().

void GetClientRect (csRect &oRect)
 Compute client rectangle size.

int InfoHeight ()
 Compute the height of information line.

bool GetTabSize (int iTab, int &oW, int &oH)
 Compute the size of a single tab.

bool InsideTab (int iIndex, int x, int y)
 Check if given x,y lies inside a tab.

int FindPage (csComponent *iComponent)
 Find page index given page pointer.


Protected Attributes

int tabx
 Secondary data (can be derived from other data but is cached for speed).

int taby
 Secondary data (can be derived from other data but is cached for speed).

int tabw
 Secondary data (can be derived from other data but is cached for speed).

int tabh
 Secondary data (can be derived from other data but is cached for speed).

int lasttab
 Secondary data (can be derived from other data but is cached for speed).

int lastpos
 Secondary data (can be derived from other data but is cached for speed).

int primary
 Secondary data (can be derived from other data but is cached for speed).


Detailed Description

A notebook (OS/2 term, Windows term "property shit") is a collection of dialogs enclosed in a single window.

The dialogs are divided into several groups, each group gets its own "tab" on one of the sides of the notebook. By clicking the "tab" you switch to that group of dialogs, every group can consist of several dialogs that are switched with a minor arrow control in one of the corners of the notebook.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000