IlvRectangularGauge Class Reference

Graphic class. More...

#include <ilviews/graphics/gauge.h>

Inheritance diagram for IlvRectangularGauge:

Public Member Functions
	IlvRectangularGauge (IlvDisplay display, const IlvRect &drawrect, IlFloat min=0, IlFloat max=100, IlFloat value=50, IlvDirection direction=IlvVertical, IlBoolean showBox=((IlBoolean) 1), IlvPalette palette=0)
	Constructor.
virtual void	bboxRange (IlFloat v1, IlFloat v2, IlvRect &rect, const IlvTransformer *t=0) const
	Returns the rectangle to update when the value of the gauge changes.
virtual void	boundingBox (IlvRect &, const IlvTransformer *t=0) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
virtual IlvGraphic *	copy () const
	Copies this object.
virtual void	draw (IlvPort , const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
virtual void	drawValue (IlvPort , const IlvTransformer t=0, const IlvRegion *clip=0) const
	Performs the drawing representing the current value of the gauge.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlvDirection	getDirection () const
	Gets the direction of the gauge.
IlBoolean	isBoxShown () const
	Tells you if the gauge's border is shown.
IlBoolean	isSubtypeOf (const IlvClassInfo *c) const
	Checks whether this object's class is a subclass.
IlBoolean	isSubtypeOf (const char *t) const
	Checks whether this object's class is a subclass of a given parent class.
virtual IlFloat	requestValue (const IlvPoint &, const IlvTransformer *, IlBoolean &) const
	Returns the value of the gauge associated with a given point.
virtual void	setColorPattern (IlvColorPattern *pattern)
	Sets the color pattern of the object.
void	setDirection (IlvDirection direction)
	Sets the direction of the gauge.
virtual void	setFillStyle (IlvFillStyle style)
	Sets the fill style of the object.
virtual void	setGradientPattern (IlvGradientPattern *pattern)
	Sets the gradient pattern of the object.
void	showBox (IlBoolean flag)
	Sets the visibility of the gauge's border.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
Static Public Member Functions
static void	AddProperty (const IlSymbol *k, IlAny v)
	Adds a property to this object's class.
static IlAny	GetProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
	Retrieves the property value associated with the key in this object's class.
static const IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
	Checks for the existence of a property for this object's class hierarchy.
static IlvGraphic *	read (IlvInputFile &, IlvPalette *pal)
	Reads an object description from a file.
static IlBoolean	RemoveProperty (const IlSymbol *key)
	Removes a property from this object's class.
static IlBoolean	ReplaceProperty (const IlSymbol *k, IlAny v)
	Replaces a property in this object's class.

Detailed Description

Graphic class.

Library: views

A rectangular gauge appears as a rectangle containing another rectangle as in the figure below. This second rectangle is the moving part of the gauge, and is displayed as a flat area. It is attached to three of the four borders of the outer rectangle, and the free end indicates the value.

- IlvRectangularGauge -

See also:: IlvCircularGauge, IlvReliefGauge, IlvSliderGauge.

Constructor & Destructor Documentation

IlvRectangularGauge::IlvRectangularGauge	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		IlFloat	min = `0`,
		IlFloat	max = `100`,
		IlFloat	value = `50`,
		IlvDirection	direction = `IlvVertical`,
		IlBoolean	showBox = `((IlBoolean)1)`,
		IlvPalette *	palette = `0`
	)

Constructor.

The drawrect parameter indicates the size of the object. The direction parameter indicates the direction of the gauge: it can be set to any of the four directions (IlvBottom, IlvTop, IlvLeft, IlvRight), indicating the position of the minimum value representation, or to IlvVertical (equivalent to IlvBottom) or IlvHorizontal (equivalent to IlvLeft).

Parameters:

	display	The display instance.
	drawrect	Specifies the geometry of the rectangle.
	min	The minimum value of the gauge.
	max	The maximum value of the gauge.
	value	The current value of the gauge.
	direction	The direction of the gauge.
	showBox	A Boolean value indicating whether to show the gauge's border rectangle or not.
	palette	The palette used to draw the graphic object.

Member Function Documentation

static void IlvRectangularGauge::AddProperty	(	const IlSymbol *	key,
		IlAny	value
	)			`[static]`

Adds a property to this object's class.

This static function associates the given value with the given key for the class of this object only.

Parameters:

	key	The key to be associated.
	value	The value to be associated.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual void IlvRectangularGauge::bboxRange	(	IlFloat	v1,
		IlFloat	v2,
		IlvRect &	rect,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Returns the rectangle to update when the value of the gauge changes.

Returns:: The rectangular region to be updated if the value of the gauge was changing from v1 to v2.

Parameters:

	v1	Initial value of the gauge.
	v2	Future value of the gauge.
	rect	Used to return the rectangle to update.
	t	The transformer. If it is specified, the graphic object is considered to be drawn through a transformation and the returned rectangle is expressed in the transformed coordinate system.

Implements IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual void IlvRectangularGauge::boundingBox	(	IlvRect &	bbox,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Retrieves the bounding box of the graphic object.

Sets bbox, the rectangle reference parameter, to be the bounding box of the object. Since the object can appear within a transformed environment (for example, in a multiview editor), an IlvTransformer object occurs as an optional parameter in order to compute the bounding box in the coordinate system of the transformed environment. When there is no transformation, t is set to 0.

Parameters:

	bbox	The bounding box to be set.
	t	A transformer value or `0` if there is no transformation.

Implements IlvGauge.

const char* IlvRectangularGauge::className ( ) const

Returns the class name of an object.

This method is equivalent to getClassInfo()->getClassName().

Returns:: The class name of the object. For example, for an IlvRectangle object, the className function returns "IlvRectangle".

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual IlvGraphic* IlvRectangularGauge::copy ( ) const [virtual]

Copies this object.

Allocates and returns a copy of this object. If the object is composite, the implementation of this member function makes a copy of the object's components.

Returns:: A copy of the object.

See also:: IlvPredefinedIOMembers.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual void IlvRectangularGauge::draw	(	IlvPort *	dst,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)			const `[virtual]`

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t which might have the value 0. The clip parameter, which can also be 0, represents the clipping region relative to the transformed object.

Parameters:

	dst	The destination port.
	t	The transformer value. If 0, no transformation is performed.
	clip	The clipping region, or 0 if none.

Reimplemented from IlvGauge.

virtual void IlvRectangularGauge::drawValue	(	IlvPort *	,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)			const `[virtual]`

Performs the drawing representing the current value of the gauge.

Called by the member function draw and interactors that connect to it. Draws the part of the gauge that indicates its value (such as the hand of a watch).

Parameters:

	dst	The destination port.
	t	The transformer to apply to the drawing.
	clip	The clipping region.

Implements IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual IlvClassInfo* IlvRectangularGauge::getClassInfo ( ) const [virtual]

Gets class information.

Returns a pointer to the IlvClassInfo object associated with this object's class.

Returns:: A pointer to the class information object of the class of this object.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

IlvDirection IlvRectangularGauge::getDirection ( ) const

Gets the direction of the gauge.

Returns:: The direction of this gauge.

static IlAny IlvRectangularGauge::GetProperty	(	const IlSymbol *	key,
		IlBoolean	checkSuperClass = `((IlBoolean) 0)`
	)			`[static]`

Retrieves the property value associated with the key in this object's class.

Retrieves the property value associated with the property name key. If the property cannot be found in the class of this object, and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until the property is found. If the property cannot be found, then 0 is returned.

Parameters:

	key	The key with which the property value is associated.
	checkSuperClass	`IlTrue` specifies iterative search on superclasses.

Returns:: The property value associated with the proper name key, or 0.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

static const IlvClassInfo* IlvRectangularGauge::HasProperty	(	const IlSymbol *	key,
		IlBoolean	checkSuperClass = `((IlBoolean) 0)`
	)			`[static]`

Checks for the existence of a property for this object's class hierarchy.

Retrieves a pointer to the IlvClassInfo that indicates a class where the key property exists. If the returned value is non-0, then this property actually exists for this class. If this is not the case and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until a match is found. If the property cannot be found, then 0 is returned.

Parameters:

	key	The key with which the property value is associated.
	checkSuperClass	`IlTrue` specifies iterative search on superclasses.

Returns:: A pointer to the ClassInfo that indicates a class where the key property exists, or 0.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

IlBoolean IlvRectangularGauge::isBoxShown ( ) const

Tells you if the gauge's border is shown.

Returns:: An IlBoolean value indicating whether the border rectangle is to be displayed or not.

IlBoolean IlvRectangularGauge::isSubtypeOf ( const IlvClassInfo * classInfo ) const

Checks whether this object's class is a subclass.

This method is equivalent to getClassInfo()->isSubtypeOf(classInfo).

Parameters:

classInfo

The name of a class on which the object's class is tested.

Returns:: Either IlTrue or IlFalse, depending on whether or not this object's class is a subclass of the class indicated by classInfo.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

IlBoolean IlvRectangularGauge::isSubtypeOf ( const char * parentClass ) const

Checks whether this object's class is a subclass of a given parent class.

This method is equivalent to getClassInfo()->isSubtypeOf(parentClass).

Parameters:

parentClass

A string representing the parent class.

Returns:: Either IlTrue or IlFalse, depending on whether or not this object's class inherits parentClass attributes. The parentClass parameter should be a string representing the class name of an IlvGraphic subclass. A call to this member function for a given class instance returns IlTrue if given the name of its class.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

static IlvGraphic* IlvRectangularGauge::read	(	IlvInputFile &	file,
		IlvPalette *	palette
	)			`[static]`

Reads an object description from a file.

Reads an object description from the file input, given the palette graphic attributes. It reads the information that was saved by the member function write to be able to create a new instance of this object. Usually, because of the availability of the constructor that expects an IlvInputFile, read should be equivalent to:

 IlvGraphic*
 MyClass::read(IlvInputFile& file, IlvPalette* palette)
 {
     return new MyClass(file, palette);
 }

In the following example, the static member function read of the IlvLabel class could have the following form:

 IlvGraphic*
 IlvLabel::read(IlvInputFile& file, IlvPalette* pal)
 {
     IlvPoint pos;
     file.getStream() >> pos;     // Read the position field
     return new IlvLabel(pal->getDisplay(), pos,
     IlvReadString(file.getStream()), pal);
 }

Parameters:

	file	The name of the file to be read from.
	palette	The name of the palette for the object.

See also:: DeclareTypeInfoRO, DeclareTypeInfo, IlvPredefinedIOMembers.

Warning:: [note] The read method is not capitalized like other static methods so that it is consistent with the write method.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

static IlBoolean IlvRectangularGauge::RemoveProperty ( const IlSymbol * key ) [static]

Removes a property from this object's class.

This static function removes the indicated property to the class of this object.

Parameters:

key

The key property to be removed.

Returns:: IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

static IlBoolean IlvRectangularGauge::ReplaceProperty	(	const IlSymbol *	key,
		IlAny	value
	)			`[static]`

Replaces a property in this object's class.

This static function replaces the indicated property value to the class of this object.

Parameters:

	key	The key to be replaced.
	value	The value to be replaced.

Returns:: IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

virtual IlFloat IlvRectangularGauge::requestValue	(	const IlvPoint &	point,
		const IlvTransformer *	t,
		IlBoolean &	connect
	)			const `[virtual]`

Returns the value of the gauge associated with a given point.

Returns:: the value stored in this gauge if its moving part was at the specified location. If the point is outside the object bounding box, the function returns a reasonable value (the closest point on the object bounding box is considered).

Parameters:

	point	The point. If a transformer is specified, the point is considered to be transformed, i.e. expressed in the transformed coordinate system.
	t	The transformer.
	connect	If `IlTrue`, the provided point indicates a connection to the gauge. Mostly, this means that the point is located on the moving part of the gauge.

Implements IlvGauge.

Reimplemented in IlvSliderGauge.

virtual void IlvRectangularGauge::setColorPattern ( IlvColorPattern * pattern ) [virtual]

Sets the color pattern of the object.

Parameters:

pattern

The new color pattern.

Reimplemented from IlvSimpleGraphic.

void IlvRectangularGauge::setDirection ( IlvDirection direction )

Sets the direction of the gauge.

Sets the direction of this gauge to direction.

Parameters:

direction

The direction of the gauge.

virtual void IlvRectangularGauge::setFillStyle ( IlvFillStyle style ) [virtual]

Sets the fill style of the object.

Parameters:

style

The new fill style.

Reimplemented from IlvSimpleGraphic.

virtual void IlvRectangularGauge::setGradientPattern ( IlvGradientPattern * pattern ) [virtual]

Sets the gradient pattern of the object.

Parameters:

pattern

The new gradient pattern.

Reimplemented from IlvSimpleGraphic.

void IlvRectangularGauge::showBox ( IlBoolean flag )

Sets the visibility of the gauge's border.

Sets the visibility of the border of the rectangle to show.

Parameters:

show

A Boolean value indicating whether to show the gauge's border rectangle or not.

virtual void IlvRectangularGauge::write ( IlvOutputFile & output ) const [virtual]

Writes an object description to a file.

Writes out, in a file, the object description. This description contains all the information necessary to create an exact copy of this object by means of the member function read. Information concerning any IlvPalette object attached to this object is written out by the object containers. All other information, such as the position and size of the object, is written out by this virtual member function.
For example, suppose we have an IlvLabel class that implements a graphic object drawn as a text string at a given position. It maintains its position in an internal IlvPoint field called _position and its textual content in an internal character array field called _text. The only information we need to save is the contents of those fields. So, the member function write of such an object should have the following form:

 void
 IlvLabel::write(IlvOutputFile& file) const
 {
     // Save the position field
     file.getStream() << IlvSpc() << _position;
     // Save the text field
     IlvWriteString(file.getStream(), _text);
 }

Parameters:

output

The the output file to be written to.

See also:: DeclareTypeInfo.

Reimplemented from IlvGauge.

Reimplemented in IlvSliderGauge, and IlvReliefGauge.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvRectangularGauge Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Foundation Package API Reference Guide