Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

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

#include <ilviews/gadgets/scgadget.h>

Inheritance diagram for IlvScrolledGadgetLFHandler:
IlvObjectLFHandler IlvDefaultScrolledGadgetLFHandler IlvScrolledGadgetMLFHandler IlvScrolledGadgetWLFHandler IlvScrolledGadgetVXLFHandler IlvScrolledGadgetW95LFHandler

Public Member Functions

 IlvScrolledGadgetLFHandler (IlvLookFeelHandler *lfh)
 Constructor. More...
 
virtual void drawBackground (const IlvScrolledGadget *gadget, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the background of a scrolled gadget. More...
 
virtual void drawContents (const IlvScrolledGadget *gadget, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the contents of a scrolled gadget. More...
 
virtual void drawFrame (const IlvScrolledGadget *gadget, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the frame of a scrolled gadget. More...
 
virtual void drawScrollBar (const IlvScrolledGadget *gadget, IlvPort *dst, IlvDirection dir, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw an internal scroll bar of a scrolled gadget. More...
 
virtual IlvPalettegetWindowBackground (const IlvScrolledGadget *gadget) const =0
 Returns the palette that will be used to draw the background of the scrolled gadget. More...
 
virtual IlBoolean handleEvent (IlvScrolledGadget *gadget, IlvEvent &event) const =0
 Is called to handle the events of a scrolled gadget. More...
 
virtual IlBoolean handleScrollBarsEvent (IlvScrolledGadget *gadget, IlvEvent &event) const =0
 Is called to handle the events of the scroll bars of a scrolled gadget. More...
 
virtual void internalBBox (const IlvScrolledGadget *gadget, IlvRect &rect, const IlvTransformer *t) const =0
 Is called to compute the internal area of a scrolled gadget. More...
 
virtual void scrollBarBBox (const IlvScrolledGadget *gadget, IlvOrientation dir, IlvRect &rect, const IlvTransformer *t) const =0
 Is called to compute the size and position of the internal scroll bars. More...
 
virtual void visibleBBox (const IlvScrolledGadget *gadget, IlvRect &rect, const IlvTransformer *t) const =0
 Is called to compute the visible area of the scrolled gadget. More...
 

Detailed Description

Object Look-and-Feel class.

Library: ilvadvgdt

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

Constructor & Destructor Documentation

IlvScrolledGadgetLFHandler::IlvScrolledGadgetLFHandler ( IlvLookFeelHandler lfh)

Constructor.

Creates a new IlvScrolledGadgetLFHandler instance and initializes it with lfh.

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

Member Function Documentation

virtual void IlvScrolledGadgetLFHandler::drawBackground ( const IlvScrolledGadget gadget,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the background of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvScrolledGadgetWLFHandler, IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, and IlvScrolledGadgetW95LFHandler.

virtual void IlvScrolledGadgetLFHandler::drawContents ( const IlvScrolledGadget gadget,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the contents of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultScrolledGadgetLFHandler.

virtual void IlvScrolledGadgetLFHandler::drawFrame ( const IlvScrolledGadget gadget,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the frame of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvScrolledGadgetWLFHandler, IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, and IlvScrolledGadgetW95LFHandler.

virtual void IlvScrolledGadgetLFHandler::drawScrollBar ( const IlvScrolledGadget gadget,
IlvPort dst,
IlvDirection  dir,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw an internal scroll bar of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
dstThe destination port.
dirThe orientation of the scroll bar.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultScrolledGadgetLFHandler.

virtual IlvPalette* IlvScrolledGadgetLFHandler::getWindowBackground ( const IlvScrolledGadget gadget) const
pure virtual

Returns the palette that will be used to draw the background of the scrolled gadget.

Parameters
gadgetThe scrolled gadget.

Implemented in IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, IlvScrolledGadgetWLFHandler, and IlvScrolledGadgetMLFHandler.

virtual IlBoolean IlvScrolledGadgetLFHandler::handleEvent ( IlvScrolledGadget gadget,
IlvEvent event 
) const
pure virtual

Is called to handle the events of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvDefaultScrolledGadgetLFHandler.

virtual IlBoolean IlvScrolledGadgetLFHandler::handleScrollBarsEvent ( IlvScrolledGadget gadget,
IlvEvent event 
) const
pure virtual

Is called to handle the events of the scroll bars of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvDefaultScrolledGadgetLFHandler.

virtual void IlvScrolledGadgetLFHandler::internalBBox ( const IlvScrolledGadget gadget,
IlvRect rect,
const IlvTransformer t 
) const
pure virtual

Is called to compute the internal area of a scrolled gadget.

Parameters
gadgetThe scrolled gadget.
rectThe returned rectangle of the internal area.
tThe transformer.

Implemented in IlvScrolledGadgetWLFHandler, IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, and IlvScrolledGadgetW95LFHandler.

virtual void IlvScrolledGadgetLFHandler::scrollBarBBox ( const IlvScrolledGadget gadget,
IlvOrientation  dir,
IlvRect rect,
const IlvTransformer t 
) const
pure virtual

Is called to compute the size and position of the internal scroll bars.

Parameters
gadgetThe scrolled gadget.
dirThe orientation of the scroll bar.
rectThe returned bounding box of the specified scroll bar.
tThe transformer.

Implemented in IlvScrolledGadgetWLFHandler, IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, and IlvScrolledGadgetW95LFHandler.

virtual void IlvScrolledGadgetLFHandler::visibleBBox ( const IlvScrolledGadget gadget,
IlvRect rect,
const IlvTransformer t 
) const
pure virtual

Is called to compute the visible area of the scrolled gadget.

Parameters
gadgetThe scrolled gadget.
rectThe returned rectangle of the visible area.
tThe transformer.

Implemented in IlvDefaultScrolledGadgetLFHandler.


© 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.