IlvColoredToggle Class Reference

Gadget class. More...

#include <ilviews/gadgets/ctoggle.h>

Inheritance diagram for IlvColoredToggle:

List of all members.

Public Member Functions
	IlvColoredToggle (IlvDisplay *display, const IlvPoint &point, IlvBitmap *bitmap, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor.
	IlvColoredToggle (IlvDisplay *display, IlvBitmap *bitmap, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor.
	IlvColoredToggle (IlvDisplay *display, const IlvPoint &point, const char *label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor.
	IlvColoredToggle (IlvDisplay *display, const char *label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor.
IlvColor *	getCheckColor () const
	Returns The color used to draw the toggle button when checked.
void	setCheckColor (IlvColor *color)
	Sets the color to use when the toggle button is checked.

---

Detailed Description

Gadget class.

Library: ilvgadgt

The IlvColoredToggle class defines a toggle button that appears in color when it is checked.

A Colored toggle button

See also:

IlvManagerToggleInteractor, IlvViewToggleInteractor.

---

Constructor & Destructor Documentation

IlvColoredToggle::IlvColoredToggle	(	IlvDisplay *	display,
		const char *	label,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvColoredToggle class using a label. The label is copied.

Parameters:

	display	The connection to the display.
	label	The label of the toggle button
	rect	The size and position of the toggle button.
	thickness	The thickness of the toggle button.
	palette	The palette used by the toggle button.

IlvColoredToggle::IlvColoredToggle	(	IlvDisplay *	display,
		const IlvPoint &	point,
		const char *	label,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvColoredToggle class using a label. The label is copied.

Parameters:

	display	The connection to the display.
	point	The position of the toggle button.
	label	The label of the toggle button
	thickness	The thickness of the toggle button.
	palette	The palette used by the toggle button.

IlvColoredToggle::IlvColoredToggle	(	IlvDisplay *	display,
		IlvBitmap *	bitmap,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvColoredToggle class using a bitmap. The bitmap is locked.

Parameters:

	display	The connection to the display.
	bitmap	The bitmap of the toggle button
	rect	The size and position of the toggle button.
	thickness	The thickness of the toggle button.
	palette	The palette used by the toggle button.

IlvColoredToggle::IlvColoredToggle	(	IlvDisplay *	display,
		const IlvPoint &	point,
		IlvBitmap *	bitmap,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvColoredToggle class using a bitmap. The bitmap is locked.

Parameters:

	display	The connection to the display.
	point	The position of the toggle button.
	bitmap	The bitmap of the toggle button
	thickness	The thickness of the toggle button.
	palette	The palette used by the toggle button.

---

Member Function Documentation

IlvColor* IlvColoredToggle::getCheckColor

(

)

const

Returns The color used to draw the toggle button when checked.

Returns:

The color used to draw the toggle button when checked.

See also:

setCheckColor

void IlvColoredToggle::setCheckColor

(

IlvColor *

color

)

Sets the color to use when the toggle button is checked.

Parameters:

color

The new check color. The previous check color is unlocked, and the new one is locked.

See also:

getCheckColor