IlvIcon Class Reference

Graphic class. More...

#include <ilviews/graphics/icon.h>

Inheritance diagram for IlvIcon:

Public Member Functions
	IlvIcon (IlvDisplay display, const IlvPoint &position, IlvBitmap bitmap, IlvPalette *palette=0)
	Constructor.
virtual void	applyTransform (const IlvTransformer *t)
	Applies a transformation function to the graphic object.
virtual void	boundingBox (IlvRect &rect, 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 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, const IlvRegion *rect=0) const
	Draws the graphic object.
IlvBitmap *	getBitmap () const
	Gets the bitmap of this icon.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlvDim	height () const
	Gets the icon's height.
virtual IlBoolean	inside (const IlvRegion &trect, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box.
virtual IlBoolean	intersects (const IlvRegion &trect, const IlvTransformer *t=0) const
	Checks whether a region intersects the bounding box with transformation applied.
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	setBitmap (IlvBitmap *bitmap)
	Sets the bitmap of this icon.
IlvDim	width () const
	Gets the icon's width.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
virtual IlBoolean	zoomable () const
	Queries the zoomable capability.
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 IlvIcon object appears as an opaque image.

See also:: IlvBitmap.

Constructor & Destructor Documentation

IlvIcon::IlvIcon	(	IlvDisplay *	display,
		const IlvPoint &	position,
		IlvBitmap *	bitmap,
		IlvPalette *	palette = `0`
	)

Constructor.

The constructor initializes a new IlvIcon at an indicated location. This icon is initialized with the provided bitmap.

Parameters:

	display	A pointer to the display object that will display this icon.
	position	The top-left position of this icon.
	bitmap	The bitmap used by this icon. This bitmap is referenced by the `IlvIcon` object; therefore, if you modify the bitmap object, the visible aspect of the `IlvIcon` takes these changes into account. This bitmap is locked in the constructor and unlocked in the destructor.
	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 IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

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

Reimplemented in IlvZoomableIcon.

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

Reimplemented in IlvZoomableIcon.

const char* IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

virtual IlBoolean IlvIcon::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.

Reimplemented in IlvZoomableIcon.

virtual IlvGraphic* IlvIcon::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 IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

virtual void IlvIcon::draw	(	IlvPort *	dst,
		const IlvTransformer *	t,
		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.

Reimplemented in IlvZoomableIcon.

IlvBitmap* IlvIcon::getBitmap ( ) const

Gets the bitmap of this icon.

Returns:: A pointer to the associated IlvBitmap object.

virtual IlvClassInfo* IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

static IlAny IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

static const IlvClassInfo* IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

IlvDim IlvIcon::height ( ) const

Gets the icon's height.

Returns:: The height of the associated bitmap.

virtual IlBoolean IlvIcon::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.

Reimplemented in IlvZoomableIcon.

virtual IlBoolean IlvIcon::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.

Reimplemented in IlvZoomableIcon.

IlBoolean IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

IlBoolean IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

static IlvGraphic* IlvIcon::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 IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

static IlBoolean IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

static IlBoolean IlvIcon::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 IlvSimpleGraphic.

Reimplemented in IlvTransparentIcon, IlvZoomableIcon, and IlvZoomableTransparentIcon.

virtual void IlvIcon::setBitmap ( IlvBitmap * bitmap ) [virtual]

Sets the bitmap of this icon.

Associates the IlvIcon object with a new bitmap. The previous bitmap is unlocked and the new associated bitmap is locked. Note that if you change the bitmap of the icon with one that doesn't have the same dimensions as the previous bitmap, the bounding box of this icon will change.

Parameters:

bitmap

The new bitmap that this icon will display.

Reimplemented in IlvTransparentIcon, and IlvZoomableTransparentIcon.

IlvDim IlvIcon::width ( ) const

Gets the icon's width.

Returns:: The width of the associated bitmap.

virtual void IlvIcon::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 IlvTransparentIcon, and IlvZoomableIcon.

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

Queries the zoomable capability.

Returns:: Always IlFalse. An IlvIcon is never zoomable.

Reimplemented from IlvGraphic.

Reimplemented in IlvZoomableIcon.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvIcon 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