rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStringListLFHandler Class Reference

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

#include <ilviews/gadgets/slist.h>

Inheritance diagram for IlvStringListLFHandler:
IlvObjectLFHandler IlvDefaultStringListLFHandler IlvStringListMLFHandler IlvStringListWLFHandler

List of all members.

Public Member Functions

 IlvStringListLFHandler (IlvLookFeelHandler *lfh)
 Constructor.
virtual void drawBackground (const IlvStringList *slist, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the background of a string list.
virtual void drawFrame (const IlvStringList *slist, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the frame of a string list.
virtual void drawGadgetContents (const IlvStringList *slist, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the contents of a string list.
virtual void drawGadgetItem (const IlvStringList *slist, const IlvGadgetItem *item, IlvPort *dst, const IlvRect &bbox, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw a string list item.
virtual IlBoolean focusFollowSelection () const =0
 Indicates whether the focus should follow the selection.
virtual IlvDim getItemHeight (const IlvStringList *slist, IlUShort pos) const =0
 Is called to get the height of the specified item of a string list.
virtual IlBoolean handleGadgetEvent (IlvStringList *slist, IlvEvent &event) const =0
 Is called to handle the events of a string list.

Detailed Description

Object Look-and-Feel class.

Library: ilvadvgdt

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


Constructor & Destructor Documentation

IlvStringListLFHandler::IlvStringListLFHandler ( IlvLookFeelHandler lfh  ) 

Constructor.

Creates a new IlvStringListLFHandler 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 IlvStringListLFHandler::drawBackground ( const IlvStringList slist,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const [pure virtual]

Is called to draw the background of a string list.

Parameters:
slist The string list.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvDefaultStringListLFHandler.

virtual void IlvStringListLFHandler::drawFrame ( const IlvStringList slist,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const [pure virtual]

Is called to draw the frame of a string list.

Parameters:
slist The string list.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvDefaultStringListLFHandler.

virtual void IlvStringListLFHandler::drawGadgetContents ( const IlvStringList slist,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const [pure virtual]

Is called to draw the contents of a string list.

Parameters:
slist The string list.
dst The destination port.
t The transformer.
clip The clipping region.

Implemented in IlvDefaultStringListLFHandler.

virtual void IlvStringListLFHandler::drawGadgetItem ( const IlvStringList slist,
const IlvGadgetItem item,
IlvPort dst,
const IlvRect bbox,
const IlvTransformer t,
const IlvRegion clip 
) const [pure virtual]

Is called to draw a string list item.

Parameters:
slist The string list.
item The string list item to draw.
dst The destination port.
bbox The rectangle where to draw the item.
t The transformer. Not Used.
clip The clipping region.

Implemented in IlvStringListMLFHandler, and IlvDefaultStringListLFHandler.

virtual IlBoolean IlvStringListLFHandler::focusFollowSelection (  )  const [pure virtual]

Indicates whether the focus should follow the selection.

Returns:
IlTrue if the focus should follow the selection.

Implemented in IlvStringListMLFHandler, and IlvStringListWLFHandler.

virtual IlvDim IlvStringListLFHandler::getItemHeight ( const IlvStringList slist,
IlUShort  pos 
) const [pure virtual]

Is called to get the height of the specified item of a string list.

Parameters:
slist The string list.
pos The index of the string list item.
Returns:
The height of the pos item in the string list slist.

Implemented in IlvStringListMLFHandler, and IlvStringListWLFHandler.

virtual IlBoolean IlvStringListLFHandler::handleGadgetEvent ( IlvStringList slist,
IlvEvent event 
) const [pure virtual]

Is called to handle the events of a string list.

Parameters:
slist The string list.
event The event to handle.
Returns:
IlTrue if the event has been consumed.

Implemented in IlvDefaultStringListLFHandler.


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