rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvScrolledGadgetLFHandler Class Reference

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

#include <ilviews/gadgets/scgadget.h>

Inheritance diagram for IlvScrolledGadgetLFHandler:
IlvObjectLFHandler IlvDefaultScrolledGadgetLFHandler IlvScrolledGadgetMLFHandler IlvScrolledGadgetWLFHandler IlvScrolledGadgetVXLFHandler IlvScrolledGadgetW95LFHandler

List of all members.

Public Member Functions

 IlvScrolledGadgetLFHandler (IlvLookFeelHandler *lfh)
 Constructor.
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.
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.
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.
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.
virtual IlvPalettegetWindowBackground (const IlvScrolledGadget *gadget) const =0
 Returns the palette that will be used to draw the background of the scrolled gadget.
virtual IlBoolean handleEvent (IlvScrolledGadget *gadget, IlvEvent &event) const =0
 Is called to handle the events of a scrolled gadget.
virtual IlBoolean handleScrollBarsEvent (IlvScrolledGadget *gadget, IlvEvent &event) const =0
 Is called to handle the events of the scroll bars of a scrolled gadget.
virtual void internalBBox (const IlvScrolledGadget *gadget, IlvRect &rect, const IlvTransformer *t) const =0
 Is called to compute the internal area of a scrolled gadget.
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.
virtual void visibleBBox (const IlvScrolledGadget *gadget, IlvRect &rect, const IlvTransformer *t) const =0
 Is called to compute the visible area of the scrolled gadget.

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:
lfh The 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:
gadget The scrolled gadget.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, and IlvScrolledGadgetWLFHandler.

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:
gadget The scrolled gadget.
dst The destination port.
t The transformer.
clip The 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:
gadget The scrolled gadget.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, and IlvScrolledGadgetWLFHandler.

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:
gadget The scrolled gadget.
dst The destination port.
dir The orientation of the scroll bar.
t The transformer.
clip The 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:
gadget The scrolled gadget.

Implemented in IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, and IlvScrolledGadgetWLFHandler.

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

Is called to handle the events of a scrolled gadget.

Parameters:
gadget The scrolled gadget.
event The 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:
gadget The scrolled gadget.
event The 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:
gadget The scrolled gadget.
rect The returned rectangle of the internal area.
t The transformer.

Implemented in IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, and IlvScrolledGadgetWLFHandler.

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:
gadget The scrolled gadget.
dir The orientation of the scroll bar.
rect The returned bounding box of the specified scroll bar.
t The transformer.

Implemented in IlvScrolledGadgetMLFHandler, IlvScrolledGadgetVXLFHandler, IlvScrolledGadgetW95LFHandler, and IlvScrolledGadgetWLFHandler.

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:
gadget The scrolled gadget.
rect The returned rectangle of the visible area.
t The transformer.

Implemented in IlvDefaultScrolledGadgetLFHandler.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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