rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvNotebookLFHandler Class Reference

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

#include <ilviews/gadgets/notebook.h>

Inheritance diagram for IlvNotebookLFHandler:
IlvObjectLFHandler IlvDefaultNotebookLFHandler IlvNotebookMLFHandler IlvNotebookWLFHandler IlvNotebookVXLFHandler

List of all members.

Public Member Functions

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

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.

Creates a new IlvNotebookLFHandler instance and initializes it with lfh.

Parameters:
lfh The 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]

Is called to draw a notebook.

Parameters:
notebook The notebook.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvNotebookMLFHandler, IlvNotebookVXLFHandler, and IlvNotebookWLFHandler.

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

Is called to draw a notebook tab.

Parameters:
notebook The notebook.
index The index of the tab to draw.
rect The rectangle where to draw the tab.
dst The destination port.
clip The clipping region.

Implemented in IlvNotebookMLFHandler, IlvNotebookVXLFHandler, and IlvNotebookWLFHandler.

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

Is called to draw the contents of a notebook tab.

Parameters:
notebook The notebook.
page The notebook page.
rect The rectangle where to draw the tab contents.
dst The destination port.
clip The clipping region.

Implemented in IlvNotebookMLFHandler, IlvNotebookVXLFHandler, and IlvNotebookWLFHandler.

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

Is called to compute the last visible tab of a notebook.

Parameters:
notebook The notebook.
arrows A Boolean value indicating whether arrows should be drawn.
cuttab A Boolean value indicating whether the last tab is partially visible.
decr A Boolean value indicating whether the decrement arrow is sensitive.
incr A Boolean value indicating whether the increment arrow is sensitive.
Returns:
The index of the last visible tab of the notebook.

Implemented in IlvNotebookMLFHandler, IlvNotebookVXLFHandler, and IlvNotebookWLFHandler.

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

Is called to compute the bounding box of notebook tab.

Parameters:
notebook The notebook.
index The index of the tab.
bbox The bounding box of all the tabs.
rect The returned bounding box of the tab whose index is index.

Implemented in IlvNotebookMLFHandler, IlvNotebookVXLFHandler, and IlvNotebookWLFHandler.

virtual void IlvNotebookLFHandler::getTabSize ( const IlvNotebookPage *  page,
IlvDim &  width,
IlvDim &  height 
) const [pure virtual]

Is called to compute the size of a notebook tab.

Parameters:
page The notebook page.
width The returned width of the tab.
height The returned height of the tab.

Implemented in IlvNotebookMLFHandler, and IlvDefaultNotebookLFHandler.

virtual IlBoolean IlvNotebookLFHandler::handleEvent ( IlvNotebook *  notebook,
IlvEvent &  event 
) const [pure virtual]

Is called to handle the events of a notebook.

Parameters:
notebook The notebook.
event The event to handle.
Returns:
IlTrue if the event has been consumed.

Implemented in IlvDefaultNotebookLFHandler.


© Copyright 2012, 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.