rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvFilledCircularGauge Class Reference

Graphic class. More...

#include <ilviews/graphics/cirgauge.h>

Inheritance diagram for IlvFilledCircularGauge:
IlvCircularGauge IlvGauge IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvFilledCircularGauge (IlvDisplay *display, const IlvRect &drawrect, IlFloat min=0, IlFloat max=100, IlFloat value=50, IlFloat start=0, IlFloat range=180, IlvPalette *palette=0)
 Constructor.
const char * className () const
 Returns the class name of an object.
virtual IlvGraphiccopy () const
 Copies this 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 IlvClassInfogetClassInfo () const
 Gets class information.
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.

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 IlvClassInfoHasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
 Checks for the existence of a property for this object's class hierarchy.
static IlvGraphicread (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 filled circular gauge displays the value it holds by means of a filled arc that fits in an ellipse as in the following figure.

fldcrgge.gif


- IlvFilledCircularGauge -

See also:
IlvRectangularGauge, IlvReliefGauge, IlvSliderGauge.

Constructor & Destructor Documentation

IlvFilledCircularGauge::IlvFilledCircularGauge ( IlvDisplay display,
const IlvRect drawrect,
IlFloat  min = 0,
IlFloat  max = 100,
IlFloat  value = 50,
IlFloat  start = 0,
IlFloat  range = 180,
IlvPalette palette = 0 
)

Constructor.

Parameters:
display The display instance.
drawrect Specifies the size of the ellipse, which is the size of the graphic object.
min The minimum value of the gauge.
max The maximum value of the gauge.
value The current value of the gauge.
start The starting angle of the arc.
range The angle range of the arc.
palette The palette used to draw the graphic object.

Member Function Documentation

static void IlvFilledCircularGauge::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 IlvCircularGauge.

const char* IlvFilledCircularGauge::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 IlvCircularGauge.

virtual IlvGraphic* IlvFilledCircularGauge::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 IlvCircularGauge.

virtual void IlvFilledCircularGauge::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.

Reimplemented from IlvCircularGauge.

virtual IlvClassInfo* IlvFilledCircularGauge::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 IlvCircularGauge.

static IlAny IlvFilledCircularGauge::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 IlvCircularGauge.

static const IlvClassInfo* IlvFilledCircularGauge::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 IlvCircularGauge.

IlBoolean IlvFilledCircularGauge::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 IlvCircularGauge.

IlBoolean IlvFilledCircularGauge::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 IlvCircularGauge.

static IlvGraphic* IlvFilledCircularGauge::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 IlvCircularGauge.

static IlBoolean IlvFilledCircularGauge::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 IlvCircularGauge.

static IlBoolean IlvFilledCircularGauge::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 IlvCircularGauge.

virtual IlFloat IlvFilledCircularGauge::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.

Reimplemented from IlvCircularGauge.


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