IlvGridRectangle Class Reference

Graphic class. More...

#include <ilviews/graphics/gridrect.h>

Inheritance diagram for IlvGridRectangle:

List of all members.

Public Member Functions
	IlvGridRectangle (IlvDisplay *display, const IlvRect &drawrect, IlvDim nbColumns, IlvDim nbRows, 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.
IlvDim	getColumns () const
	Retrieves the number of columns.
IlBoolean	getFixedSize () const
	Queries if all cells have the same size.
IlvDim	getRows () const
	Retrieves the number of rows.
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	setColumns (IlvDim c)
	Sets the number of columns.
void	setFixedSize (IlBoolean s)
	Forces all cells to have exactly the same size.
void	setRows (IlvDim r)
	Sets the number of rows.
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 IlvGridRectangle object appears as a rectangular grid.

- IlvGridRectangle - The number of rows and columns can be specified, as well as whether or not all columns (or rows) should have exactly the same width (or height), as the object size may not be a multiple of the number of rows or columns.

---

Constructor & Destructor Documentation

IlvGridRectangle::IlvGridRectangle	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		IlvDim	nbColumns,
		IlvDim	nbRows,
		IlvPalette *	palette = 0
	)

Constructor.

Parameters:

	display	The display instance.
	size	The initial location and size of this grid rectangle.
	columns	The initial number of columns in this grid rectangle.
	rows	The initial number of rows in this grid rectangle.
	palette	The initial palette that is used to display that object. If it is 0 or left unspecified, the default palette of display is used.

---

Member Function Documentation

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

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

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

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

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

IlvDim IlvGridRectangle::getColumns

(

)

const

Retrieves the number of columns.

Returns:

The number of columns defined for this object.

IlBoolean IlvGridRectangle::getFixedSize

(

)

const

Queries if all cells have the same size.

Returns:

IlTrue if this IlvGridRectangle has a fixed distance, in pixels, between every two consecutive rows or columns. If this value is IlFalse, then the columns and rows of the grid may appear not to have the same size. In this case, we ensure that the grid fits the total bounding box.

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

IlvDim IlvGridRectangle::getRows

(

)

const

Retrieves the number of rows.

Returns:

The number of rows defined for this object.

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

IlBoolean IlvGridRectangle::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.

IlBoolean IlvGridRectangle::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.

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

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

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

void IlvGridRectangle::setColumns

(

IlvDim

c

)

Sets the number of columns.

Parameters:

columns

The number of columns that are displayed by this grid rectangle.

void IlvGridRectangle::setFixedSize

(

IlBoolean

s

)

Forces all cells to have exactly the same size.

Parameters:

fixed

If set to IlTrue, then this grid forces all columns and rows to the same size, which means that the grid may not entirely cover its total bounding box. If fixed is IlFalse, then the grid arranges the column and row sizes to fit its total bounding box (resulting in a variation of at most one pixel in the size of the cells).

void IlvGridRectangle::setRows

(

IlvDim

r

)

Sets the number of rows.

Parameters:

columns

The number of rows that are displayed by this grid rectangle.

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