IlvGraphicSet Class Reference

Graphic class. More...

#include <ilviews/graphics/set.h>

Inheritance diagram for IlvGraphicSet:

Public Member Functions
	IlvGraphicSet (int num...)
	Constructor.
	IlvGraphicSet ()
	Constructor.
	~IlvGraphicSet ()
	Destructor.
virtual void	addObject (IlvGraphic *obj)
	Adds an object.
void	align (IlvPosition align=IlvLeft)
	Aligns the objects.
virtual void	apply (IlvApplyObject function, IlAny arg)
	Applies a function to the objects.
virtual void	applyReferences (IlvApplyObject function, IlAny arg)
	Applies a function to the referenced objects.
virtual void	applyTransform (const IlvTransformer *t)
	Applies a transformation function to the graphic object.
virtual void	boundingBox (IlvRect &r, const IlvTransformer *t=0) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
void	column (IlvDeltaPos spacing=4)
	Force a vertical space between the objects.
virtual IlBoolean	contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Checks whether a point is in the object.
virtual IlvGraphic *	copy () const
	Copies this object.
virtual void	draw (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
IlvGraphic *	firstContains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Gets an object at a given location.
IlvGraphic *	firstIntersects (const IlvRegion &region, const IlvTransformer *t=0) const
	Gets an object in a given region.
virtual IlvIntensity	getAlpha () const
	Retrieves the alpha component.
IlUInt	getCardinal () const
	Gets the number of stored objects.
virtual IlvGraphic *	getChildAt (IlUInt index) const
	Returns the sub-object of the graphic object specified by index.
virtual IlvGraphic *	getChildByName (const char *name) const
	Returns the sub-object of the graphic object specified by name.
virtual IlUInt	getChildCount () const
	Returns the number of children of this graphic object.
virtual IlInt	getChildIndex (const IlvGraphic *object) const
	Returns the index of the specified sub-object in this graphic object.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlInt	getIndex (IlvGraphic *object) const
	Gets the index of an object.
virtual IlUShort	getLineWidth () const
	Retrieves the line width.
IlvGraphic *	getObject (IlUInt index) const
	Gets an object by index.
IlvGraphic const	getObjects (IlUInt &count) const
	Gets an array of all stored objects.
virtual void	insertObject (IlvGraphic *object)
	Inserts an object.
virtual IlBoolean	inside (const IlvRegion &tregion, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box.
virtual IlBoolean	intersects (const IlvRegion &tregion, const IlvTransformer *t=0) const
	Checks whether a region intersects the bounding box with transformation applied.
virtual void	invert (IlBoolean=((IlBoolean) 0))
	Highlights the object.
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 void	print (ILVSTDPREF ostream &, int level=0) const
	Prints for debugging purposes.
virtual void	removeObject (IlvGraphic *object)
	Removes an object.
void	row (IlvDeltaPos spacing=4)
	Force an horizontal space between the objects.
void	sameHeight (IlvDim height)
	Force the height of all the objects.
void	sameWidth (IlvDim width)
	Force the width of all the objects.
virtual void	setAlpha (IlvIntensity)
	Sets the alpha value of the object.
virtual void	setAntialiasingMode (IlvAntialiasingMode)
	Sets the anti-aliasing mode of the object.
virtual void	setArcMode (IlvArcMode)
	Sets the arc mode of the object.
virtual void	setBackground (IlvColor *)
	Sets the background color of the object.
virtual void	setColorPattern (IlvColorPattern *)
	Sets the color pattern of the object.
virtual void	setFillRule (IlvFillRule)
	Sets the fill rule of the object.
virtual void	setFillStyle (IlvFillStyle)
	Sets the fill style of the object.
virtual void	setFont (IlvFont *)
	Sets the font of the object.
virtual void	setForeground (IlvColor *)
	Sets the foreground color of the object.
virtual void	setGradientPattern (IlvGradientPattern *)
	Sets the gradient pattern of the object.
virtual void	setHolder (IlvGraphicHolder *holder)
	Sets the object's holder.
virtual void	setLineStyle (IlvLineStyle *)
	Sets the line style of the object.
virtual void	setLineWidth (IlUShort)
	Sets the line width of the object.
virtual void	setMode (IlvDrawMode)
	Sets the drawing mode of the object temporarily.
void	setObject (IlUInt index, IlvGraphic *object)
	Sets an object.
virtual void	setOverwrite (IlBoolean)
	Sets an overwrite mode that modifies how the drawing member functions operate.
virtual void	setPalette (IlvPalette *)
	Sets the palette of the object.
virtual void	setPattern (IlvPattern *)
	Sets the pattern of the object.
virtual void	symmetry (IlvDirection)
	Flips a graphic object.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
virtual IlBoolean	zoomable () const
	Checks whether this object is zoomable.
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

An IlvGraphicSet object organizes a set of IlvGraphic objects. IlvGraphicSet implements all geometric and graphic member functions by means of calls to the member functions of the objects that it contains. For example, the draw method of IlvGraphicSet calls the draw method of the objects contained in the graphic set.

- IlvGraphicSet -

See also:: IlvManager::group, IlvManager::unGroup.

Constructor & Destructor Documentation

IlvGraphicSet::IlvGraphicSet ( )

Constructor.

Initializes an empty IlvGraphicSet object, which is a skeleton. You can call member functions such as addObject to add IlvGraphic objects to the IlvGraphicSet object.

IlvGraphicSet::IlvGraphicSet ( int num... )

Constructor.

Initializes an IlvGraphicSet object on the basis of the nObjects parameter. IlvGraphic objects are provided as the parameters following num.

Parameters:

num The number of initial objects in this new graphic set. This should also be the number of parameters that follow num, and all must be pointers to valid instances of IlvGraphic.

IlvGraphicSet::~IlvGraphicSet ( )

Destructor.

The destructor destroys all the objects that are stored in this graphic set.

Member Function Documentation

virtual void IlvGraphicSet::addObject ( IlvGraphic * obj ) [virtual]

Adds an object.

Adds an object at the end of the objects list, so it will be the last to be drawn.

Warning:: [note] Although it is possible to add an object twice to the object list, it is not recommended.

static void IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

void IlvGraphicSet::align ( IlvPosition align = IlvLeft )

Aligns the objects.

Applies an alignment to all objects, relatively to the global bounding box of the graphic set.

Parameters:

align The direction of the alignment. This can be either IlvLeft, IlvTop, IlvRight, or IlvBottom to translate all the objects so that they share the indicated side coordinate. This parameter can also be set to IlvHorizontalCenter, IlvVerticalCenter, or IlvCenter to align the indicated positions.

virtual void IlvGraphicSet::apply	(	IlvApplyObject	function,
		IlAny	arg
	)			`[virtual]`

Applies a function to the objects.

Applies a function to all the IlvGraphic objects that are referenced. The function function will be called for each object stored in this set. The function will receive, in turn, a pointer to each of the objects that are stored in the set and a user-defined parameter.

Parameters:

	function	The function to be applied to the objects.
	arg	The user argument that will be provided to function for each object.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::applyReferences	(	IlvApplyObject	function,
		IlAny	arg
	)			`[virtual]`

Applies a function to the referenced objects.

Calls the member function IlvGraphic::applyReferences with the arguments function and argument for each object stored in the set.

Parameters:

	function	The function to be applied to the referenced objects.
	arg	The user argument that will be provided to function for each object.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::applyTransform ( const IlvTransformer * t ) [virtual]

Applies a transformation function to the graphic object.

Applies the transformer t to the shape of the object. Unless the transformation is a scaling operation, the result of applying it to certain objects can be insignificant. For example, applying a non-scaling transformer to an IlvRectangle object is meaningless, since the rectangle remains a rectangle. On the other hand, meaningful transformations can be applied to objects that are instances of types such as IlvLine or IlvPolyPoints.

Warning:: [note] applyTransform is one of the most important method to be rewritten for classes derived from IlvGraphic, since it is called by the resize, move, moveResize, scale, etc., methods.

Parameters:

t

The transformer value. If 0, no transformation is performed.

Implements IlvGraphic.

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

const char* IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

void IlvGraphicSet::column ( IlvDeltaPos spacing = 4 )

Force a vertical space between the objects.

Moves the objects vertically to set a constant vertical space between them. The method does not align the objects.

Parameters:

spacing

The vertical space that is set between two consecutive objects.

virtual IlBoolean IlvGraphicSet::contains	(	const IlvPoint &	p,
		const IlvPoint &	tp,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Checks whether a point is in the object.

Checks whether the coordinates are located in the shape of this object. A transformation parameter allows you to use the view's coordinate system for this test.

Parameters:

	p	The point to be tested.
	tp	The transformed point obtained by applying the transformer t to the point p.
	t	A transformer value, or `0` if there is no transformation.

Returns:: IlTrue when the point p lies inside the outline of the object.

Reimplemented from IlvGraphic.

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

Implements IlvGraphic.

Reimplemented in IlvSelector.

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

Implements IlvGraphic.

IlvGraphic* IlvGraphicSet::firstContains	(	const IlvPoint &	p,
		const IlvPoint &	tp,
		const IlvTransformer *	t = `0`
	)			const

Gets an object at a given location.

Parameters:

	p	The point, in the graphic set coordinates system that is looked at.
	tp	The point, in the coordinates system defined by t that is looked at.
	t	The transformation that is used for the seek.

Returns:: A pointer to the first object located at p, or 0 if there are none. The tp parameter is the transformed point obtained by applying the transformer t to the point p. This allows you to use the view coordinates system for this test.

IlvGraphic* IlvGraphicSet::firstIntersects	(	const IlvRegion &	region,
		const IlvTransformer *	t = `0`
	)			const

Gets an object in a given region.

Parameters:

region

The region where objects are searched. This region is in the coordinates system defined by t.

Returns:: A pointer to the first object that intersects with the region region, or 0 if there are none.

virtual IlvIntensity IlvGraphicSet::getAlpha ( ) const [virtual]

Retrieves the alpha component.

Returns:: The alpha component of the object.

Reimplemented from IlvGraphic.

IlUInt IlvGraphicSet::getCardinal ( ) const

Gets the number of stored objects.

Returns:: The total number of objects stored in this set.

virtual IlvGraphic* IlvGraphicSet::getChildAt ( IlUInt index ) const [virtual]

Returns the sub-object of the graphic object specified by index.

Parameters:

index

The index of the object being searched.

Returns:: The sub-object of the graphic object with index index. If the index is not valid, 0 is returned.

Reimplemented from IlvGraphic.

virtual IlvGraphic* IlvGraphicSet::getChildByName ( const char * name ) const [virtual]

Returns the sub-object of the graphic object specified by name.

Parameters:

name

The name of the object being searched.

Returns:: The sub-object of the graphic object whose name is name. If this graphic object does not contain a sub-object with name as name, 0 is returned.

Reimplemented from IlvGraphic.

virtual IlUInt IlvGraphicSet::getChildCount ( ) const [virtual]

Returns the number of children of this graphic object.

Returns:: The number of children of this graphic object.

Reimplemented from IlvGraphic.

virtual IlInt IlvGraphicSet::getChildIndex ( const IlvGraphic * object ) const [virtual]

Returns the index of the specified sub-object in this graphic object.

Parameters:

object

The sub-object whose index is being searched for.

Returns:: The index of the sub-object in this graphic object, or -1 if object is not a sub-object of this graphic object.

Reimplemented from IlvGraphic.

virtual IlvClassInfo* IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

IlInt IlvGraphicSet::getIndex ( IlvGraphic * object ) const

Gets the index of an object.

Parameters:

object

The object that is seeked.

Returns:: The index of the object in this set. The first object of the set has an index of 0. If the object is not stored in this set, this function returns -1.

virtual IlUShort IlvGraphicSet::getLineWidth ( ) const [virtual]

Retrieves the line width.

Returns:: The line width of the object.

Reimplemented from IlvGraphic.

IlvGraphic* IlvGraphicSet::getObject ( IlUInt index ) const

Gets an object by index.

Parameters:

index

The index of the object that is seeked.

Returns:: The index ^th object. The first object of the set has an index of 0.

IlvGraphic* const* IlvGraphicSet::getObjects ( IlUInt & count ) const

Gets an array of all stored objects.

Parameters:

count

Is set on return to the number of returned objects.

Returns:: An array of graphic objects stored in this GraphicSet. This array will have count elements, and must not be modified or deleted. Other Rogue Wave Views functions can overwrite this array so the caller of this method should consider copying it.

static IlAny IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

static const IlvClassInfo* IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

virtual void IlvGraphicSet::insertObject ( IlvGraphic * object ) [virtual]

Inserts an object.

Inserts an object at the beginning of the maintained list so it will be the first object to be drawn when the IlvGraphicSet object is redrawn.

Parameters:

object

The object to be inserted.

Reimplemented in IlvSelector.

virtual IlBoolean IlvGraphicSet::inside	(	const IlvRegion &	r,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Determines whether an object with transformation applied is inside the bounding box.

Parameters:

	r	The region to be tested.
	t	A transformer value, or `0` if there is no transformation.

Returns:: IlTrue when the object, drawn with the transformer t, covers completely the region r. This virtual member function returns IlFalse when this is not the case. That means that it returns IlTrue if all rectangles that define the region completely lie inside the object.

Reimplemented from IlvGraphic.

virtual IlBoolean IlvGraphicSet::intersects	(	const IlvRegion &	r,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Checks whether a region intersects the bounding box with transformation applied.

Parameters:

	r	The region to be tested.
	t	A transformer value, or `0` if there is no transformation.

Returns:: IlTrue when the region r overlaps the transformed object (if t is not 0) and IlFalse when this is not the case.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::invert ( IlBoolean temp = ((IlBoolean) 0) ) [virtual]

Highlights the object.

Highlights the object. It is implemented as swapping the foreground and background colors of the object, but can have other implementations in derived subclasses. The parameter temp controls the way you toggle between the background and the foreground. If temp is omitted or is IlFalse, then a new palette is computed by calling the IlvDisplay::getPalette() method. If temp is IlTrue, the object palette is inverted, and thus all the objects referencing this palette will be affected.

Parameters:

temp If IlTrue, highlights the object.

Reimplemented from IlvGraphic.

IlBoolean IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

IlBoolean IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

virtual void IlvGraphicSet::print	(	ILVSTDPREF ostream &	out,
		int	level = `0`
	)			const `[virtual]`

Prints for debugging purposes.

Use for debugging purposes. Depending on the debugging level given as the level parameter, basic information about this object is printed to out. Basic implementation prints the object class name, and its bounding box. When this object is defined by another object (that is, if it is a referenced object), this subobject is described only if the level parameter is not zero. When this object is defined by a group of objects, these subobjects are defined themselves if the level parameter is not zero. In general, the higher level is, the more information you get about the object.

Parameters:

	out	The output stream.
	level	The debugging level. If 0, subobjects are not described.

Reimplemented from IlvGraphic.

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

Reimplemented in IlvSelector.

virtual void IlvGraphicSet::removeObject ( IlvGraphic * object ) [virtual]

Removes an object.

Removes an object from the list of referenced objects. If an object is stored more than once in the same IlvGraphicSet, only the first occurrence will be removed. The object is not destroyed.

Parameters:

object

The object to be removed from this graphic set.

Reimplemented in IlvSelector.

static IlBoolean IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

static IlBoolean IlvGraphicSet::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 IlvGraphic.

Reimplemented in IlvSelector.

void IlvGraphicSet::row ( IlvDeltaPos spacing = 4 )

Force an horizontal space between the objects.

Moves the objects horizontally to set a constant horizontal space between them. The method does not align the objects.

Parameters:

spacing

The horizontal space that is set between two consecutive objects.

void IlvGraphicSet::sameHeight ( IlvDim height )

Force the height of all the objects.

Resizes each object according to a given height.

Parameters:

height

The new height of all the stored objects.

void IlvGraphicSet::sameWidth ( IlvDim width )

Force the width of all the objects.

Resizes each object according to a given width.

Parameters:

width

The new width of all the stored objects.

virtual void IlvGraphicSet::setAlpha ( IlvIntensity alpha ) [virtual]

Sets the alpha value of the object.

Parameters:

alpha

The new alpha value.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setAntialiasingMode ( IlvAntialiasingMode mode ) [virtual]

Sets the anti-aliasing mode of the object.

Parameters:

mode

The new anti-aliasing mode.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setArcMode ( IlvArcMode mode ) [virtual]

Sets the arc mode of the object.

Parameters:

mode

The new arc mode.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setBackground ( IlvColor * background ) [virtual]

Sets the background color of the object.

Parameters:

background

The new background color.

Reimplemented from IlvGraphic.

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

Sets the color pattern of the object.

Parameters:

pattern

The new color pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setFillRule ( IlvFillRule rule ) [virtual]

Sets the fill rule of the object.

Parameters:

rule

The new fill rule.

Reimplemented from IlvGraphic.

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

Sets the fill style of the object.

Parameters:

style

The new fill style.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setFont ( IlvFont * font ) [virtual]

Sets the font of the object.

Parameters:

font

The new font.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setForeground ( IlvColor * foreground ) [virtual]

Sets the foreground color of the object.

Parameters:

foreground

The new foreground color.

Reimplemented from IlvGraphic.

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

Sets the gradient pattern of the object.

Parameters:

pattern

The new gradient pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setHolder ( IlvGraphicHolder * holder ) [virtual]

Sets the object's holder.

This default implementation has no real function.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setLineStyle ( IlvLineStyle * style ) [virtual]

Sets the line style of the object.

Parameters:

style

The new line style.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setLineWidth ( IlUShort width ) [virtual]

Sets the line width of the object.

Parameters:

width

The new line width.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setMode ( IlvDrawMode mode ) [virtual]

Sets the drawing mode of the object temporarily.

Changing the IlvDrawMode attribute of an object is considered a temporary operation. You have to set the mode to its default value when you no longer need another mode different from the value IlvModeSet. The drawing mode information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).

Parameters:

mode

The drawing mode to be set.

Reimplemented from IlvGraphic.

void IlvGraphicSet::setObject	(	IlUInt	index,
		IlvGraphic *	object
	)

Sets an object.

Changes the index ^th object of this set so it becomes object. If index is invalid, this function does nothing. The previous object is destroyed.

Parameters:

	index	The index of the object that is replaced.
	object	The new object that is stored.

virtual void IlvGraphicSet::setOverwrite ( IlBoolean over ) [virtual]

Sets an overwrite mode that modifies how the drawing member functions operate.

Modifies the way the drawing member functions operate. The information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).

Parameters:

over If IlFalse, sets selective hidden drawing operations.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setPalette ( IlvPalette * palette ) [virtual]

Sets the palette of the object.

Each of the graphic properties of this object is then taken from this IlvPalette instance.

Parameters:

palette

The palette to be set.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setPattern ( IlvPattern * pattern ) [virtual]

Sets the pattern of the object.

Parameters:

pattern

The new pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::symmetry ( IlvDirection axis ) [virtual]

Flips a graphic object.

Flips the object about one of the horizontal or vertical axis (or a combination of the two). The axis is given by the axis parameter, which you can give the value IlvHorizontal, in

which case the flip takes place around the horizontal axis of the object, or IlvVertical, which flips the object around the

vertical axis. You can also use the IlvCenter value to flip the object around its center. The default implementation calls the member function applyTransform with a transformer corresponding to the required symmetry.

Parameters:

axis

The axis around which flipping occurs.

Reimplemented from IlvGraphic.

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

Implements IlvGraphic.

Reimplemented in IlvSelector.

virtual IlBoolean IlvGraphicSet::zoomable ( ) const [virtual]

Checks whether this object is zoomable.

Returns:: IlTrue if the graphic object can be zoomed, and IlFalse otherwise. See the member functions IsZoomAllowed and AllowZoom below.

Reimplemented from IlvGraphic.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvGraphicSet 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