vdk 2.4.0
Public Member Functions | Public Attributes
VDKNotebook Class Reference

Provides a notebook widget. More...

#include <notebook.h>

Inheritance diagram for VDKNotebook:
VDKObjectContainer VDKObject VDKNotCopyAble

List of all members.

Public Member Functions

Public Attributes


Detailed Description

Provides a notebook widget.

SIGNALS
  • switch_page_signal received whenever user switches between notebook pages.
TIP
Add the notebook to the parent container before adding pages.
EXAMPLES
In ./testvdk/nbookwin.cc

Constructor & Destructor Documentation

VDKNotebook::VDKNotebook ( VDKForm owner = NULL)

Constructor

Parameters:
owner
VDKNotebook::~VDKNotebook ( ) [virtual]

Destructor


Member Function Documentation

void VDKNotebook::Add ( VDKObject obj,
int  ,
int  ,
int  ,
int   
) [inline, virtual]

Add a page containing <obj>

Parameters:
obj
othersunused

Reimplemented from VDKObjectContainer.

void VDKNotebook::AddPage ( VDKObject obj,
const char *  label,
char **  pixmap_closed = NULL,
char **  pixmap_open = NULL 
)

Add a page containing <obj>

Parameters:
objwidget to be added (normally a container)
labeltab label
pixmap_closed
pixmap_open
TIP
Tabs can show two different pixmaps, opened (when page is selected) or closed (when unselected)
void VDKNotebook::RemovePage ( int  page,
bool  removechild = true 
)

Remove a page from notebook

Parameters:
pagepage to be removed
removechildif false page child won't be removed
Tip
Normal user doesn't care about <removechild> arg and let it be <true> as default. Used to better support VDKBuilder notebook handling.

Member Data Documentation

ActivePageProperty VDKNotebook::ActivePage

Sets/gets currently active page

TIP
This property has also increment/decrement operator
    book->ActivePage++;
    book->ActivePage--;

Return a list of notebook pages You can access to a single page like this:

    // disables last page
    book->Pages[book->Pages.size()-1]->TabLabel->Enabled = false;

(run-time read only)

VDKReadWriteValueProp<VDKNotebook,bool> VDKNotebook::PopUp

Setting to true enables pop menu on notebook

VDKReadOnlyValueProp<VDKNotebook,int> VDKNotebook::PreviousActivePage

Gets previous active page

VDKReadWriteValueProp<VDKNotebook,bool> VDKNotebook::Scrollable

Sets/gets notebook scrollable flags

NotebookTabPosProperty VDKNotebook::TabPosition

Sets/gets notebook tabs position


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