Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

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

#include <ilviews/gadgets/toggle.h>

Inheritance diagram for IlvToggleLFHandler:
IlvObjectLFHandler IlvDefaultToggleLFHandler IlvToggleMLFHandler IlvToggleWLFHandler IlvToggleVXLFHandler IlvToggleW95LFHandler

Public Member Functions

 IlvToggleLFHandler (IlvLookFeelHandler *lfh)
 Constructor. More...
 
virtual void drawBackground (const IlvToggle *toggle, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the background of a toggle button. More...
 
virtual void drawCheckBox (const IlvToggle *toggle, IlvPort *dst, const IlvRect &rect, const IlvRegion *clip) const =0
 Is called to draw the check box of a toggle button. More...
 
virtual void drawContents (const IlvToggle *toggle, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the contents of a toggle button. More...
 
virtual void drawFrame (const IlvToggle *toggle, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the frame of a toggle button. More...
 
virtual void drawText (const IlvToggle *toggle, IlvPort *dst, const IlvRect &rect, const IlvRegion *clip) const =0
 Is called to draw the text and bitmap of a toggle button. More...
 
virtual IlUShort getCheckSize () const =0
 Returns the size of the check box of the toggle button. More...
 
virtual IlUShort getXMargin () const =0
 Returns the margin between the check box and the label of the toggle button. More...
 
virtual IlBoolean handleEvent (IlvToggle *toggle, IlvEvent &event) const =0
 Is called to handle the events of a toggle button. More...
 

Detailed Description

Object Look-and-Feel class.

Library: ilvgadgt

The base class for the object look-and-feel handlers of the toggle button.

Constructor & Destructor Documentation

IlvToggleLFHandler::IlvToggleLFHandler ( IlvLookFeelHandler lfh)

Constructor.

Initializes a new IlvToggleLFHandler instance.

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

Member Function Documentation

virtual void IlvToggleLFHandler::drawBackground ( const IlvToggle toggle,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the background of a toggle button.

Parameters
toggleThe toggle button.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultToggleLFHandler.

virtual void IlvToggleLFHandler::drawCheckBox ( const IlvToggle toggle,
IlvPort dst,
const IlvRect rect,
const IlvRegion clip 
) const
pure virtual

Is called to draw the check box of a toggle button.

Parameters
toggleThe toggle button.
dstThe destination port.
rectThe rectangle where to draw the check box.
clipThe clipping region.

Implemented in IlvToggleWLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleMLFHandler.

virtual void IlvToggleLFHandler::drawContents ( const IlvToggle toggle,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the contents of a toggle button.

Parameters
toggleThe toggle button.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvToggleVXLFHandler, IlvToggleW95LFHandler, IlvToggleWLFHandler, and IlvToggleMLFHandler.

virtual void IlvToggleLFHandler::drawFrame ( const IlvToggle toggle,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the frame of a toggle button.

Parameters
toggleThe toggle button.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultToggleLFHandler.

virtual void IlvToggleLFHandler::drawText ( const IlvToggle toggle,
IlvPort dst,
const IlvRect rect,
const IlvRegion clip 
) const
pure virtual

Is called to draw the text and bitmap of a toggle button.

Parameters
toggleThe toggle button.
dstThe destination port.
rectThe rectangle where to draw the text and bitmap.
clipThe clipping region.

Implemented in IlvToggleWLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleMLFHandler.

virtual IlUShort IlvToggleLFHandler::getCheckSize ( ) const
pure virtual

Returns the size of the check box of the toggle button.

Returns
The size of the check box of the toggle button.

Implemented in IlvToggleVXLFHandler, IlvToggleW95LFHandler, IlvToggleWLFHandler, and IlvToggleMLFHandler.

virtual IlUShort IlvToggleLFHandler::getXMargin ( ) const
pure virtual

Returns the margin between the check box and the label of the toggle button.

Returns
The margin between the check box and the label of the toggle button.

Implemented in IlvToggleVXLFHandler, IlvToggleW95LFHandler, IlvToggleWLFHandler, and IlvToggleMLFHandler.

virtual IlBoolean IlvToggleLFHandler::handleEvent ( IlvToggle toggle,
IlvEvent event 
) const
pure virtual

Is called to handle the events of a toggle button.

Parameters
toggleThe toggle button.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvToggleWLFHandler, and IlvToggleMLFHandler.


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