CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

Notebook
[Components]


Compounds

class  csNotebook
 A notebook (also called "property sheet") is a collection of dialogs enclosed in a single window. More...


Notebook styles

There are various styles of notebooks.

The position of the tabs, the border style and so on can be different. The masks below can be ORed together to form a compound notebook style; only one value from each group can be choosed.

#define CSNBS_TABPOS_MASK   0x00000003
 Notebook style: The mask for tab position bits. More...

#define CSNBS_TABPOS_TOP   0x00000000
 Notebook style: Use tabs along the top side of notebook (default value). More...

#define CSNBS_TABPOS_BOTTOM   0x00000001
 Notebook style: Use tabs along the bottom side of notebook. More...

#define CSNBS_TABPOS_LEFT   0x00000002
 Notebook style: Use tabs along the left side of notebook. More...

#define CSNBS_TABPOS_RIGHT   0x00000003
 Notebook style: Use tabs along the right side of notebook. More...

#define CSNBS_PAGEFRAME   0x00000010
 Notebook style: Draw a thin 3D frame around page dialogs. More...

#define CSNBS_PAGEINFO   0x00000020
 Notebook style: Display page information on the top of notebook. More...

#define CSNBS_THINTABS   0x00000040
 Notebook style: Display a flat thin border around tabs instead of 3D look. More...

#define CSNBS_DEFAULTVALUE   CSNBS_TABPOS_TOP | CSNBS_PAGEFRAME | CSNBS_PAGEINFO
 Notebook style: default style. More...


Enumerations

enum  {
  cscmdNotebookLeavePage = 0x00000c00, cscmdNotebookSelectPage, cscmdNotebookNextPage, cscmdNotebookPrevPage,
  cscmdNotebookScrollTabsForward, cscmdNotebookScrollTabsBackward
}
 Notebook messages. More...


Define Documentation

#define CSNBS_DEFAULTVALUE   CSNBS_TABPOS_TOP | CSNBS_PAGEFRAME | CSNBS_PAGEINFO
 

Notebook style: default style.

Definition at line 60 of file csnotebk.h.

#define CSNBS_PAGEFRAME   0x00000010
 

Notebook style: Draw a thin 3D frame around page dialogs.

Definition at line 54 of file csnotebk.h.

#define CSNBS_PAGEINFO   0x00000020
 

Notebook style: Display page information on the top of notebook.

Definition at line 56 of file csnotebk.h.

#define CSNBS_TABPOS_BOTTOM   0x00000001
 

Notebook style: Use tabs along the bottom side of notebook.

Definition at line 48 of file csnotebk.h.

#define CSNBS_TABPOS_LEFT   0x00000002
 

Notebook style: Use tabs along the left side of notebook.

Definition at line 50 of file csnotebk.h.

#define CSNBS_TABPOS_MASK   0x00000003
 

Notebook style: The mask for tab position bits.

Definition at line 44 of file csnotebk.h.

#define CSNBS_TABPOS_RIGHT   0x00000003
 

Notebook style: Use tabs along the right side of notebook.

Definition at line 52 of file csnotebk.h.

#define CSNBS_TABPOS_TOP   0x00000000
 

Notebook style: Use tabs along the top side of notebook (default value).

Definition at line 46 of file csnotebk.h.

#define CSNBS_THINTABS   0x00000040
 

Notebook style: Display a flat thin border around tabs instead of 3D look.

Definition at line 58 of file csnotebk.h.


Enumeration Type Documentation

anonymous enum
 

Notebook messages.

Enumeration values:
cscmdNotebookLeavePage  Sent to parent component to notify that the notebook is going to leave a page.

The parent can abort this process by returning 0 in Event.Command.Info field.

 IN:  (csComponent *)page
 OUT: unchanged or 0
 
cscmdNotebookSelectPage  Notify parent window that a page is going to be selected.

The parent can abort this process by returning 0 in the Event.Command.Info field or set the address of another component to be selected instead.

 IN:  (csComponent *)page
 OUT: (csComponent *)page_to_select or 0
 
cscmdNotebookNextPage  Tell notebook to switch to next page
 IN:  nothing
 OUT: nothing
 
.
cscmdNotebookPrevPage  Tell notebook to switch to previous page
 IN:  nothing
 OUT: nothing
 
.
cscmdNotebookScrollTabsForward  Tell notebook to scroll tab line forward
 IN:  nothing
 OUT: nothing
 
.
cscmdNotebookScrollTabsBackward  Tell notebook to scroll tab line backward
 IN:  nothing
 OUT: nothing
 
.

Definition at line 67 of file csnotebk.h.


Generated for Crystal Space by doxygen 1.2.14