IlvDisplayConfig Class Reference

Display configuration base class. More...

#include <ilviews/base/config.h>

Inheritance diagram for IlvDisplayConfig:

Public Member Functions
IlvDisplay *	getDisplay () const
	Gets the display instance. More...
IlAny	getUserArg () const
	Gets the user argument. More...
void	setDefaultBackground (const char *bgName, IlBoolean isMutable=IlFalse)
	Sets the default background color. More...
void	setDefaultBackground (IlvIntensity r, IlvIntensity g, IlvIntensity b, IlBoolean isMutable)
	Sets the default background color. More...
void	setDefaultForeground (const char *fgName, IlBoolean isMutable=IlFalse)
	Sets the default foreground color. More...
void	setDefaultForeground (IlvIntensity r, IlvIntensity g, IlvIntensity b, IlBoolean isMutable)
	Sets the default foreground color. More...

Friends
class	IlvDisplay

Detailed Description

Display configuration base class.

Library: xviews or winviews or mviews (mutually exclusive)

The class IlvDisplayConfig handles the display system-independent aspects of the configuration of a Rogue Wave Views application. It is the class type that is used in the display configuration callbacks (see IlvDisplay constructors for details).
The current version of this library does not yet implement any general functions. However it will be extended in future versions.

See Also

IlvDisplay.

Member Function Documentation

IlvDisplay* IlvDisplayConfig::getDisplay

(

)

const

Gets the display instance.

Returns

A pointer to the IlvDisplay instance that created this object.

IlAny IlvDisplayConfig::getUserArg

(

)

const

Gets the user argument.

Returns

The user parameter provided in the IlvDisplay constructor.

void IlvDisplayConfig::setDefaultBackground	(	const char *	bgName,
		IlBoolean	isMutable = IlFalse
	)

Sets the default background color.

This member function enables you to force the default background color of the display to the color named bgName. If isMutable is set to IlTrue, and if the display system allows it, the allocated color will be mutable.

Parameters

bgName	The name of color to set to background.
isMutable	Sets whether the color is a mutable color or not.

void IlvDisplayConfig::setDefaultBackground	(	IlvIntensity	r,
		IlvIntensity	g,
		IlvIntensity	b,
		IlBoolean	isMutable
	)

Sets the default background color.

This member function enables you to force the default background color of the display to the color defined by the r, g, and b parameters. If isMutable is set to IlTrue, and if the display system allows it, the allocated color will be mutable.

Parameters

r	The red component of the color.
g	The green component of the color.
b	The blue component of the color.
isMutable	Sets whether the color is a mutable color or not.

void IlvDisplayConfig::setDefaultForeground	(	const char *	fgName,
		IlBoolean	isMutable = IlFalse
	)

Sets the default foreground color.

This member function enables you to force the default foreground color of the display to the color named fgName. If isMutable is set to IlTrue, and if the display system allows it, the allocated color will be mutable.

Parameters

fgName	The name of color to set to foreground.
isMutable	Sets whether the color is a mutable color or not.

void IlvDisplayConfig::setDefaultForeground	(	IlvIntensity	r,
		IlvIntensity	g,
		IlvIntensity	b,
		IlBoolean	isMutable
	)

Sets the default foreground color.

This member function enables you to force the default foreground color of the display to the color defined by the r, g, and b parameters. If isMutable is set to IlTrue, and if the display system allows it, the allocated color will be mutable.

Parameters

r	The red component of the color.
g	The green component of the color.
b	The blue component of the color.
isMutable	Sets whether the color is a mutable color or not.