Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

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

#include <ilviews/gadgets/tree.h>

Inheritance diagram for IlvTreeGadgetLFHandler:
IlvObjectLFHandler IlvDefaultTreeGadgetLFHandler IlvTreeGadgetCSSLFHandler IlvTreeGadgetMLFHandler IlvTreeGadgetWLFHandler IlvTreeGadgetVXLFHandler IlvTreeGadgetW95LFHandler

Public Member Functions

 IlvTreeGadgetLFHandler (IlvLookFeelHandler *lfh)
 Constructor. More...
 
virtual void drawBackground (const IlvTreeGadget *tree, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the background of a tree gadget. More...
 
virtual void drawButton (const IlvTreeGadget *tree, IlvPort *dst, const IlvTreeGadgetItem *item, const IlvRect &bbox, const IlvRegion *clip) const =0
 Is called to draw the expand/collapse button of a tree gadget item. More...
 
virtual void drawFrame (const IlvTreeGadget *tree, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the frame of a tree gadget. More...
 
virtual void drawGadgetContents (const IlvTreeGadget *tree, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the contents of a tree gadget. More...
 
virtual void drawGadgetItem (const IlvTreeGadget *tree, const IlvTreeGadgetItem *item, IlvPort *dst, const IlvRect &bbox, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw a tree gadget item. More...
 
virtual IlvPalettegetLinkPalette (const IlvTreeGadget *tree) const =0
 Returns the palette used to draw the links of the tree gadget. More...
 
virtual IlvPalettegetWindowBackground (const IlvTreeGadget *tree) const =0
 Returns the palette used to draw the background of the tree gadget. More...
 
virtual IlBoolean handleGadgetEvent (IlvTreeGadget *tree, IlvEvent &event) const =0
 Is called to handle the events of a tree gadget. More...
 

Detailed Description

Object Look-and-Feel class.

Library: ilvadvgdt

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

Constructor & Destructor Documentation

§ IlvTreeGadgetLFHandler()

IlvTreeGadgetLFHandler::IlvTreeGadgetLFHandler ( IlvLookFeelHandler lfh)

Constructor.

Initializes a new IlvTreeGadgetLFHandler instance.

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

Member Function Documentation

§ drawBackground()

virtual void IlvTreeGadgetLFHandler::drawBackground ( const IlvTreeGadget tree,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the background of a tree gadget.

Parameters
treeThe tree gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ drawButton()

virtual void IlvTreeGadgetLFHandler::drawButton ( const IlvTreeGadget tree,
IlvPort dst,
const IlvTreeGadgetItem item,
const IlvRect bbox,
const IlvRegion clip 
) const
pure virtual

Is called to draw the expand/collapse button of a tree gadget item.

Parameters
treeThe tree gadget.
dstThe destination port.
itemThe tree gadget item being drawn.
bboxThe rectangle where to draw the button.
clipThe clipping region.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ drawFrame()

virtual void IlvTreeGadgetLFHandler::drawFrame ( const IlvTreeGadget tree,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the frame of a tree gadget.

Parameters
treeThe tree gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ drawGadgetContents()

virtual void IlvTreeGadgetLFHandler::drawGadgetContents ( const IlvTreeGadget tree,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the contents of a tree gadget.

Parameters
treeThe tree gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ drawGadgetItem()

virtual void IlvTreeGadgetLFHandler::drawGadgetItem ( const IlvTreeGadget tree,
const IlvTreeGadgetItem item,
IlvPort dst,
const IlvRect bbox,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw a tree gadget item.

Parameters
treeThe tree gadget.
itemThe tree gadget item to draw.
dstThe destination port.
bboxThe rectangle where to draw the item.
tThe transformer. Not Used.
clipThe clipping region.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ getLinkPalette()

virtual IlvPalette* IlvTreeGadgetLFHandler::getLinkPalette ( const IlvTreeGadget tree) const
pure virtual

Returns the palette used to draw the links of the tree gadget.

Parameters
treeThe tree gadget.
Returns
The palette used to draw the links of the tree gadget.

Implemented in IlvTreeGadgetW95LFHandler, IlvTreeGadgetWLFHandler, IlvTreeGadgetVXLFHandler, IlvTreeGadgetCSSLFHandler, and IlvTreeGadgetMLFHandler.

§ getWindowBackground()

virtual IlvPalette* IlvTreeGadgetLFHandler::getWindowBackground ( const IlvTreeGadget tree) const
pure virtual

Returns the palette used to draw the background of the tree gadget.

Parameters
treeThe tree gadget.
Returns
The palette used to draw the background of the tree gadget.

Implemented in IlvDefaultTreeGadgetLFHandler.

§ handleGadgetEvent()

virtual IlBoolean IlvTreeGadgetLFHandler::handleGadgetEvent ( IlvTreeGadget tree,
IlvEvent event 
) const
pure virtual

Is called to handle the events of a tree gadget.

Parameters
treeThe tree gadget.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvDefaultTreeGadgetLFHandler.


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