IlvShadowLabel Class Reference

Graphic class. More...

#include <ilviews/graphics/shadlab.h>

Inheritance diagram for IlvShadowLabel:

Public Member Functions
	IlvShadowLabel (IlvDisplay display, const IlvPoint &at, const char label, IlUShort thickness=IlvDefaultShadowThickness, IlvPosition shadowPosition=IlvBottomRight, IlvPalette *palette=0)
	Constructor.
	IlvShadowLabel (IlvDisplay display, const char label, const IlvRect &rect, IlUShort thickness=IlvDefaultShadowThickness, 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.
virtual void	draw (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
const char *	getLabel () const
	Returns the string drawn by the graphic 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 detail=0) const
	Prints for debugging purposes.
virtual void	setFont (IlvFont *fnt)
	Sets the font of the object.
void	setLabel (const char *s)
	Sets the string drawn by the graphic object.
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 IlvShadowLabel object appears as an IlvShadowRectangle containing a text string that is clipped by the containing rectangle.

- IlvShadowLabel -

Constructor & Destructor Documentation

IlvShadowLabel::IlvShadowLabel	(	IlvDisplay *	display,
		const char *	label,
		const IlvRect &	rect,
		IlUShort	thickness = `IlvDefaultShadowThickness`,
		IlvPosition	shadowPosition = `IlvBottomRight`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters:

	display	The display instance.
	label	The character string drawn by the graphic object.
	rect	Specifies the size of the filled rectangle around the string. This does not include the shadow of the object.
	shadowThickness	The shadow thickness.
	shadowPosition	The shadow position.
	palette	The palette used to draw the graphic object.

IlvShadowLabel::IlvShadowLabel	(	IlvDisplay *	display,
		const IlvPoint &	at,
		const char *	label,
		IlUShort	thickness = `IlvDefaultShadowThickness`,
		IlvPosition	shadowPosition = `IlvBottomRight`,
		IlvPalette *	palette = `0`
	)

Constructor.

This constructor allows you to specify the position of the center of the string label. The object computes its size to hold the label string.

Member Function Documentation

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

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

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

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

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

const char* IlvShadowLabel::getLabel ( ) const

Returns the string drawn by the graphic object.

Returns:: the string displayed by this object. You must not modify or delete the returned string.

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

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

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

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

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

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

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

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

Sets the font of the object.

Parameters:

font

The new font.

Reimplemented from IlvSimpleGraphic.

void IlvShadowLabel::setLabel ( const char * s )

Sets the string drawn by the graphic object.

Sets the string drawn by the graphic object. The previous string is deleted.

Parameters:

label

The new string. This string is copied.

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

Rogue Wave ViewsFoundation Package API Reference Guide

IlvShadowLabel 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