IlvShadowRectangle Class Reference

Graphic class. More...

#include <ilviews/graphics/shadrect.h>

Inheritance diagram for IlvShadowRectangle:

Public Member Functions
	IlvShadowRectangle (IlvDisplay display, const IlvRect &rect, IlUShort shadowThickness=4, IlvPosition shadowPosition=IlvBottomRight, IlvPalette palette=0)
	Constructor.
const char *	className () const
	Returns the class name of an object.
virtual IlvGraphic *	copy () const
	Copies this object.
void	draw (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlvPosition	getShadowPosition () const
	Returns the shadow position.
IlUShort	getThickness () const
	Returns the shadow thickness.
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.
void	setAlpha (IlvIntensity)
	Sets the alpha value of the object.
void	setAntialiasingMode (IlvAntialiasingMode)
	Sets the anti-aliasing mode of the object.
void	setBackground (IlvColor *c)
	Sets the background color of the object.
void	setForeground (IlvColor *c)
	Sets the foreground color of the object.
void	setLineStyle (IlvLineStyle *style)
	Sets the line style of the object.
void	setLineWidth (IlUShort style)
	Sets the line width of the object.
void	setMode (IlvDrawMode m)
	Sets the drawing mode of the object temporarily.
void	setOverwrite (IlBoolean)
	Sets an overwrite mode that modifies how the drawing member functions operate.
void	setPalette (IlvPalette *palette)
	Sets the internal palette to the given `palette` value.
void	setShadowPosition (IlvPosition shadowPosition)
	Sets the shadow position.
void	setThickness (IlUShort thickness)
	Sets the shadow thickness.
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

An IlvShadowRectangle object appears as a shadowed IlvFilledRectangle object.

- IlvShadowRectangle -

Constructor & Destructor Documentation

IlvShadowRectangle::IlvShadowRectangle	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUShort	shadowThickness = `4`,
		IlvPosition	shadowPosition = `IlvBottomRight`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters:

	display	The display instance.
	rect	Specifies the geometry of the graphic object.
	shadowThickness	The shadow thickness.
	shadowPosition	Specifies the position of the shadow. It can have one of the following `IlvPosition` values: `IlvTop`, `IlvBottom`, `IlvLeft`, `IlvRight`, `IlvTopLeft`, `IlvTopRight`, `IlvBottomLeft`, `IlvBottomRight`, `IlvCenter`. The value `IlvCenter` indicates that there is no shadow.
	palette	A pointer to the palette that will be used by this object. If left unspecified or set to `0`, the default palette of the display (see `IlvDisplay::defaultPalette`) will be used.

Member Function Documentation

static void IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

const char* IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

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

Reimplemented in IlvShadowLabel.

void IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

virtual IlvClassInfo* IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

static IlAny IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

IlvPosition IlvShadowRectangle::getShadowPosition ( ) const

Returns the shadow position.

Returns:: The shadow position.

IlUShort IlvShadowRectangle::getThickness ( ) const

Returns the shadow thickness.

Returns:: The shadow thickness.

static const IlvClassInfo* IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

IlBoolean IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

IlBoolean IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

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

Reimplemented in IlvShadowLabel.

static IlBoolean IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

static IlBoolean IlvShadowRectangle::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 IlvFilledRectangle.

Reimplemented in IlvShadowLabel.

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

Sets the alpha value of the object.

Parameters:

alpha

The new alpha value.

Reimplemented from IlvSimpleGraphic.

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

Sets the anti-aliasing mode of the object.

Parameters:

mode

The new anti-aliasing mode.

Reimplemented from IlvSimpleGraphic.

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

Sets the background color of the object.

Parameters:

background

The new background color.

Reimplemented from IlvSimpleGraphic.

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

Sets the foreground color of the object.

Parameters:

foreground

The new foreground color.

Reimplemented from IlvSimpleGraphic.

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

Sets the line style of the object.

Parameters:

style

The new line style.

Reimplemented from IlvSimpleGraphic.

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

Sets the line width of the object.

Parameters:

width

The new line width.

Reimplemented from IlvSimpleGraphic.

void IlvShadowRectangle::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 IlvSimpleGraphic.

void IlvShadowRectangle::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 IlvSimpleGraphic.

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

Sets the internal palette to the given palette value.

Sets the internal palette to the given palette value. The previous palette is unlocked, and palette is locked.

Parameters:

palette

The new palette of this object.

Reimplemented from IlvSimpleGraphic.

void IlvShadowRectangle::setShadowPosition ( IlvPosition shadowPosition )

Sets the shadow position.

Sets the shadow position of the object.

Parameters:

shadowPosition

The new shadow position.

void IlvShadowRectangle::setThickness ( IlUShort thickness )

Sets the shadow thickness.

Sets the shadow thickness of the object.

Parameters:

thickness

The new value of the shadow thickness.

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

Reimplemented in IlvShadowLabel.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvShadowRectangle 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