Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvNotebookLFHandler Class Referenceabstract

Object Look-and-Feel class. More...

#include <ilviews/gadgets/notebook.h>

Inheritance diagram for IlvNotebookLFHandler:
IlvObjectLFHandler IlvDefaultNotebookLFHandler IlvNotebookMLFHandler IlvNotebookWLFHandler IlvNotebookVXLFHandler

Public Member Functions

 IlvNotebookLFHandler (IlvLookFeelHandler *lfh)
 Constructor. More...
 
virtual void draw (const IlvNotebook *notebook, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Draws a notebook. More...
 
virtual void drawTab (const IlvNotebook *notebook, IlUShort index, const IlvRect &rect, IlvPort *dst, const IlvRegion *clip) const =0
 Draws a notebook tab. More...
 
virtual void drawTabContents (const IlvNotebook *notebook, const IlvNotebookPage *page, const IlvRect &rect, IlvPort *dst, const IlvRegion *clip) const =0
 Draws the contents of a notebook tab. More...
 
virtual IlUShort getLastVisibleTab (const IlvNotebook *notebook, IlBoolean &arrows, IlBoolean &cuttab, IlBoolean &decr, IlBoolean &incr) const =0
 Computes the last visible tab of a notebook. More...
 
virtual void getTabRect (const IlvNotebook *notebook, IlUShort index, const IlvRect &bbox, IlvRect &rect) const =0
 Computes the bounding box of notebook tab. More...
 
virtual void getTabSize (const IlvNotebookPage *page, IlvDim &width, IlvDim &height) const =0
 Computes the size of a notebook tab. More...
 
virtual IlBoolean handleEvent (IlvNotebook *notebook, IlvEvent &event) const =0
 Handles the events of a notebook. More...
 

Detailed Description

Object Look-and-Feel class.

Library: ilvadvgdt

The base class for the object look-and-feel handlers of the notebook.

Constructor & Destructor Documentation

IlvNotebookLFHandler::IlvNotebookLFHandler ( IlvLookFeelHandler lfh)

Constructor.

Initializes a new IlvNotebookLFHandler instance.

Parameters
lfhThe look-and-feel handler which this handler will be associated to.

Member Function Documentation

virtual void IlvNotebookLFHandler::draw ( const IlvNotebook notebook,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Draws a notebook.

Parameters
notebookThe notebook.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvNotebookVXLFHandler, IlvNotebookWLFHandler, and IlvNotebookMLFHandler.

virtual void IlvNotebookLFHandler::drawTab ( const IlvNotebook notebook,
IlUShort  index,
const IlvRect rect,
IlvPort dst,
const IlvRegion clip 
) const
pure virtual

Draws a notebook tab.

Parameters
notebookThe notebook.
indexThe index of the tab to draw.
rectThe rectangle where to draw the tab.
dstThe destination port.
clipThe clipping region.

Implemented in IlvNotebookVXLFHandler, IlvNotebookWLFHandler, and IlvNotebookMLFHandler.

virtual void IlvNotebookLFHandler::drawTabContents ( const IlvNotebook notebook,
const IlvNotebookPage page,
const IlvRect rect,
IlvPort dst,
const IlvRegion clip 
) const
pure virtual

Draws the contents of a notebook tab.

Parameters
notebookThe notebook.
pageThe notebook page.
rectThe rectangle where to draw the tab contents.
dstThe destination port.
clipThe clipping region.

Implemented in IlvNotebookVXLFHandler, IlvNotebookWLFHandler, and IlvNotebookMLFHandler.

virtual IlUShort IlvNotebookLFHandler::getLastVisibleTab ( const IlvNotebook notebook,
IlBoolean arrows,
IlBoolean cuttab,
IlBoolean decr,
IlBoolean incr 
) const
pure virtual

Computes the last visible tab of a notebook.

Parameters
notebookThe notebook.
arrowsA Boolean value indicating whether arrows should be drawn.
cuttabA Boolean value indicating whether the last tab is partially visible.
decrA Boolean value indicating whether the decrement arrow is sensitive.
incrA Boolean value indicating whether the increment arrow is sensitive.
Returns
The index of the last visible tab of the notebook.

Implemented in IlvNotebookVXLFHandler, IlvNotebookWLFHandler, and IlvNotebookMLFHandler.

virtual void IlvNotebookLFHandler::getTabRect ( const IlvNotebook notebook,
IlUShort  index,
const IlvRect bbox,
IlvRect rect 
) const
pure virtual

Computes the bounding box of notebook tab.

Parameters
notebookThe notebook.
indexThe index of the tab.
bboxThe bounding box of all the tabs.
rectThe returned bounding box of the tab whose index is index.

Implemented in IlvNotebookVXLFHandler, IlvNotebookWLFHandler, and IlvNotebookMLFHandler.

virtual void IlvNotebookLFHandler::getTabSize ( const IlvNotebookPage page,
IlvDim width,
IlvDim height 
) const
pure virtual

Computes the size of a notebook tab.

Parameters
pageThe notebook page.
widthThe returned width of the tab.
heightThe returned height of the tab.

Implemented in IlvDefaultNotebookLFHandler, and IlvNotebookMLFHandler.

virtual IlBoolean IlvNotebookLFHandler::handleEvent ( IlvNotebook notebook,
IlvEvent event 
) const
pure virtual

Handles the events of a notebook.

Parameters
notebookThe notebook.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvDefaultNotebookLFHandler.


© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.