rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvToggleLFHandler Class Reference

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

#include <ilviews/gadgets/toggle.h>

Inheritance diagram for IlvToggleLFHandler:
IlvObjectLFHandler IlvDefaultToggleLFHandler IlvToggleMLFHandler IlvToggleWLFHandler IlvToggleVXLFHandler IlvToggleW95LFHandler

List of all members.

Public Member Functions

 IlvToggleLFHandler (IlvLookFeelHandler *lfh)
 Constructor.
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.
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.
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.
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.
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.
virtual IlUShort getCheckSize () const =0
 Returns the size of the check box of the toggle button.
virtual IlUShort getXMargin () const =0
 Returns the margin between the check box and the label of the toggle button.
virtual IlBoolean handleEvent (IlvToggle *toggle, IlvEvent &event) const =0
 Is called to handle the events of a toggle button.

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.

Creates a new IlvToggleLFHandler 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 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:
toggle The toggle button.
dst The destination port.
t The transformer.
clip The 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:
toggle The toggle button.
dst The destination port.
rect The rectangle where to draw the check box.
clip The clipping region.

Implemented in IlvToggleMLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleWLFHandler.

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

Implemented in IlvToggleMLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleWLFHandler.

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:
toggle The toggle button.
dst The destination port.
t The transformer.
clip The 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:
toggle The toggle button.
dst The destination port.
rect The rectangle where to draw the text and bitmap.
clip The clipping region.

Implemented in IlvToggleMLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleWLFHandler.

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 IlvToggleMLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleWLFHandler.

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 IlvToggleMLFHandler, IlvToggleVXLFHandler, IlvToggleW95LFHandler, and IlvToggleWLFHandler.

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

Is called to handle the events of a toggle button.

Parameters:
toggle The toggle button.
event The event to handle.
Returns:
IlTrue if the event has been consumed.

Implemented in IlvToggleMLFHandler, and IlvToggleWLFHandler.

 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.