Frame class to adapt any object as an IlvGraphic. More...

#include <ilviews/graphics/adapter.h>

Inheritance diagram for IlvGraphicAdapter< ADAPTEE >:

Public Member Functions
	IlvGraphicAdapter (ADAPTEE *obj, IlBoolean owner=IlFalse)
	Constructor. More...

virtual	~IlvGraphicAdapter ()=0
	Destructor. More...

ADAPTEE *const	getAdaptee () const
	Returns a const pointer to the adaptee. More...

virtual IlBoolean	handleEvent (IlvEvent &event, const IlvTransformer *t=0) const =0
	Handles mouse and keyboard events. More...

IlBoolean	isOwner () const
	Returns the ownership property. More...

void	setAdaptee (ADAPTEE *adaptee, IlBoolean owner)
	Sets the adpatee. More...

virtual void	write (IlvOutputFile &os) const =0
	Writes out the object description. More...

Public Member Functions inherited from IlvGraphic
void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Adds a callback function to a callback list. More...

void	addCallback (const IlSymbol callbackType, const IlSymbol callbackName, const IlSymbol *script=0)
	Adds a callback function to a callback list. More...

void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Adds a callback function to a callback list. More...

void	addClassProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...

void	addProperty (const IlSymbol *key, IlAny value)
	Adds a specific property to the object. More...

void	addTag (const IlSymbol *tag)
	Adds a tag. More...

virtual void	apply (IlvApplyObject function, IlAny arg)
	Applies a function to objects that compose another object. More...

IlBoolean	applyAttribute (const char *attributeClassName, IlInt value, IlAny checkData=0) const
	Applies attributes. More...

IlBoolean	applyAttribute (const char *attributeClassName, IlFloat value, IlAny checkData=0) const
	Applies attributes. More...

IlBoolean	applyAttribute (const char attributeClassName, const char value, IlAny checkData=0) const
	Applies attributes. More...

virtual void	applyReferences (IlvApplyObject function, IlAny arg)
	Applies a function to objects that are referenced by another object. More...

virtual void	applyResources (const char storageName, const char storageClassName, const char objectName, const char objectClassName, IlvDisplay *display=0)
	Applies resources on a graphic object. More...

virtual void	applyTransform (const IlvTransformer *t)=0
	Applies a transformation function to the graphic object. More...

virtual void	boundingBox (IlvRect &bbox, const IlvTransformer *t=0) const =0
	Retrieves the bounding box of the graphic object. More...

virtual void	callCallbacks (const IlSymbol *callbackType)
	Calls every callback of a given type. More...

const char *	className () const
	Returns the class name of an object. More...

virtual void	computeFocusRegion (IlvRegion &r, const IlvTransformer *t=0) const
	Computes the region needed for the drawing of the focus. More...

virtual IlBoolean	contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Checks whether a point is in the object. More...

IlBoolean	contains (const IlvPoint &p) const
	Checks whether a point is in the object. More...

virtual IlvGraphic *	copy () const =0
	Copies this object. More...

virtual void	draw (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const =0
	Draws the graphic object. More...

void	draw (IlvPort dst, const IlvTransformer t, const IlvRect *clip) const
	Draws a graphic object. More...

virtual void	drawFocus (IlvPort dst, const IlvPalette palette, const IlvTransformer t=0, const IlvRegion clip=0) const
	Draws additional drawings for an object that has the keyboard focus. More...

virtual void	getAccessors (const IlSymbol const , const IlvValueTypeClass const **, IlUInt &) const
	Retrieves the list of available accessors of an object. More...

virtual IlvIntensity	getAlpha () const
	Retrieves the alpha component. More...

virtual IlvAntialiasingMode	getAntialiasingMode () const
	Retrieves the anti-aliasing mode. More...

IlvGraphicCallback	getCallback (const IlSymbol *callbackType) const
	Gets a callback. More...

IlvGraphicCallback	getCallback () const
	Gets the main callback function. More...

IlAny	getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Gets a callback user data. More...

IlAny	getCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) const
	Gets a callback user data. More...

IlSymbol *	getCallbackName (const IlSymbol *callbackType) const
	Gets the name of a callback. More...

IlSymbol *	getCallbackName () const
	Gets the symbol that identifies the main callback. More...

virtual IlUInt	getCallbackTypes (const char const names, const IlSymbol const **types) const
	Gets the number of register callback types for the object. More...

virtual IlvGraphic *	getChildAt (IlUInt index) const
	Returns the sub-object of the graphic object specified by index. More...

virtual IlvGraphic *	getChildByName (const char *name) const
	Returns the sub-object of the graphic object specified by a name. More...

virtual IlUInt	getChildCount () const
	Returns the number of children of this graphic object. More...

virtual IlInt	getChildIndex (const IlvGraphic *object) const
	Returns the index of the specified sub-object in this graphic object. More...

virtual IlvGraphic const	getChildren (IlUInt &count) const
	Returns an array containing the sub-objects of this graphic object. More...

virtual IlvClassInfo *	getClassInfo () const
	Gets class information. More...

IlAny	getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const
	Retrieves the indicated property value in the class of this object. More...

IlAny	getClientData () const
	Gets client data. More...

virtual const char *	getDefaultInteractor () const
	Gets the name of the default interactor for this object. More...

virtual IlvGraphicHolder *	getHolder () const
	Gets a pointer to an object's holder. More...

IlvInteractor *	getInteractor () const
	Returns the interactor associated with the current object. More...

virtual IlUShort	getLineWidth () const
	Retrieves the line width. More...

virtual IlvLookFeelHandler *	getLookFeelHandler () const
	Returns the look & feel handler used by this object. More...

const char *	getName () const
	Gets the name of the object. More...

IlvNamedProperty *	getNamedProperty (const IlSymbol *name) const
	Gets a named property. More...

IlSymbol *	getNextFocusGraphic () const
	Gets the next object in the focus chain. More...

IlSymbol *	getPreviousFocusGraphic () const
	Gets the previous object in the focus chain. More...

IlAny	getProperty (const IlSymbol *key) const
	Gets a property. More...

IlvSmartSet *	getSmartSet () const
	Gets the smart set object containing this graphic object. More...

const IlSymbol const	getTags (IlUInt &count) const
	Returns all the tags applied to this object. More...

IlvDim	h () const
	Gets the height value of the object. More...

void	h (IlvDim h)
	Sets the height value of the object. More...

IlBoolean	hasCallback (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallback (const IlSymbol callbackType, const IlSymbol callbackName) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function has user data. More...

IlBoolean	hasCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) const
	Checks whether a callback function has user data. More...

const IlvClassInfo *	hasClassProperty (const IlSymbol *key, IlBoolean s=IlFalse) const
	Checks for a class where the keyed property exists. More...

IlBoolean	hasProperty (const IlSymbol *key) const
	Checks whether the object has a particular property. More...

IlBoolean	hasTag (const IlSymbol *tag) const
	Checks whether the object has a specific tag. More...

virtual IlBoolean	inside (const IlvRegion &r, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...

IlBoolean	inside (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...

IlBoolean	inside (const IlvRect &r) const
	Determines whether a rectangle is inside the bounding box. More...

virtual IlBoolean	intersects (const IlvRegion &r, const IlvTransformer *t=0) const
	Checks whether a region intersects the bounding box with transformation applied. More...

IlBoolean	intersects (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Checks whether a rectangle intersects the bounding box with transformation applied. More...

IlBoolean	intersects (const IlvRect &r) const
	Checks whether a rectangle intersects the bounding box. More...

virtual void	invert (IlBoolean temp=IlFalse)
	Highlights the object. More...

IlBoolean	isFirstFocusGraphic () const
	Checks whether the object is first in the focus chain. More...

IlBoolean	isFocusable () const
	Checks whether the object can receive the keyboard focus. More...

IlBoolean	isInSmartSet () const
	Checks whether a graphic object belongs to a smart set. More...

IlBoolean	isLastFocusGraphic () const
	Checks whether the object is last in the focus chain. More...

IlBoolean	isSensitive () const
	Checks whether the object is sensitive. More...

IlBoolean	isSubtypeOf (const char *parentClass) const
	Checks whether this object's class is a subclass of a given parent class. More...

IlBoolean	isSubtypeOf (const IlvClassInfo *classInfo) const
	Checks whether this object's class is a subclass. More...

virtual void	move (IlvPos x, IlvPos y)
	Moves the graphic object. More...

void	move (const IlvPoint &p)
	Moves the graphic object. More...

void	moveResize (const IlvRect &size)
	Moves and resizes a graphic object. More...

virtual IlBoolean	needsInputContext () const
	Indicates whether the graphic instance can connect to an input method for locale dependent input. More...

virtual void	print (std::ostream &out, int level=0) const
	Prints for debugging purposes. More...

void	removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Removes a callback function from a callback list. More...

void	removeCallback (const IlSymbol callbackType, const IlSymbol callbackName)
	Removes a callback function from a callback list. More...

IlBoolean	removeClassProperty (const IlSymbol *key)
	Removes a property from this object's class. More...

void	removeInteractor ()
	Removes the interactor from the current object. More...

IlvNamedProperty *	removeNamedProperty (IlSymbol *name)
	Removes a named property from the object. More...

IlBoolean	removeProperty (const IlSymbol *key)
	Removes a property from the object. More...

void	removeTag (const IlSymbol *tag)
	Removes a tag. More...

IlBoolean	replaceClassProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...

IlBoolean	replaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property. More...

virtual void	resize (IlvDim newW, IlvDim newH)
	Resizes a graphic object. More...

virtual void	rotate (const IlvPoint &center, IlFloat angle)
	Rotates a graphic object. More...

virtual void	scale (IlFloat zoomX, IlFloat zoomY)
	Scales the graphic object. More...

virtual void	setAlpha (IlvIntensity alpha)
	Sets the alpha value of the object. More...

virtual void	setAntialiasingMode (IlvAntialiasingMode mode)
	Sets the anti-aliasing mode of the object. More...

virtual void	setArcMode (IlvArcMode mode)
	Sets the arc mode of the object. More...

virtual void	setBackground (IlvColor *background)
	Sets the background color of the object. More...

void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Sets a new callback. More...

void	setCallback (const IlSymbol callbackType, const IlSymbol callbackName, const IlSymbol *script=0)
	Removes all previously set callbacks. More...

void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Removes all previously set callbacks. More...

void	setCallback (IlvGraphicCallback callback, IlAny data)
	Sets the main callback function. More...

void	setCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
	Sets the callback user data for a callback function. More...

void	setCallbackData (const IlSymbol callbackType, const IlSymbol callbackName, IlAny data)
	Sets the callback user data for a callback function. More...

void	setCallbackName (const IlSymbol *callbackName)
	Sets the symbol that identifies the main callback. More...

void	setClientData (IlAny clientData)
	Sets client data. More...

virtual void	setColorPattern (IlvColorPattern *pattern)
	Sets the color pattern of the object. More...

virtual void	setFillRule (IlvFillRule rule)
	Sets the fill rule of the object. More...

virtual void	setFillStyle (IlvFillStyle style)
	Sets the fill style of the object. More...

void	setFirstFocusGraphic ()
	Sets the object to be first in the focus chain.

void	setFocusable (IlBoolean value)
	Set the focusable state of the object. More...

virtual void	setFont (IlvFont *font)
	Sets the font of the object. More...

virtual void	setForeground (IlvColor *foreground)
	Sets the foreground color of the object. More...

virtual void	setGradientPattern (IlvGradientPattern *pattern)
	Sets the gradient pattern of the object. More...

virtual void	setHolder (IlvGraphicHolder *)
	Sets the object's holder. More...

IlBoolean	setInteractor (IlvInteractor *inter)
	Attaches an interactor to the current object. More...

IlBoolean	setInteractor (const char *name)
	Attaches an interactor to this graphic object. More...

void	setLastFocusGraphic ()
	Sets the object to be last in the focus chain.

virtual void	setLineStyle (IlvLineStyle *style)
	Sets the line style of the object. More...

virtual void	setLineWidth (IlUShort width)
	Sets the line width of the object. More...

virtual void	setMode (IlvDrawMode mode)
	Sets the drawing mode of the object temporarily. More...

virtual void	setName (const char *name)
	Sets the name of the object. More...

IlvNamedProperty *	setNamedProperty (IlvNamedProperty *property)
	Sets a named property on the object. More...

virtual void	setNeedsInputContext (IlBoolean val)
	Specifies whether the graphic object should have locale dependent input. More...

void	setNextFocusGraphic (IlSymbol *name)
	Sets the object to be next in the focus chain. More...

virtual void	setOverwrite (IlBoolean over)
	Sets an overwrite mode that modifies how the drawing member functions operate. More...

virtual void	setPalette (IlvPalette *palette)
	Sets the palette of the object. More...

virtual void	setPattern (IlvPattern *pattern)
	Sets the pattern of the object. More...

void	setPreviousFocusGraphic (IlSymbol *name)
	Sets an object as previous in the focus chain. More...

void	setProperty (const IlSymbol *key, IlAny value)
	Sets a property of the object to a value. More...

virtual void	setSensitive (IlBoolean value)
	Sets the sensitivity of the object. More...

virtual void	symmetry (IlvDirection axis)
	Flips a graphic object. More...

virtual void	translate (IlvPos dx, IlvPos dy)
	Applies a transformation function on a graphic object. More...

IlvDim	w () const
	Gets the width value of the object. More...

void	w (IlvDim w)
	Sets the width value of the object. More...

IlvPos	x () const
	Gets the `x` coordinate value of the object. More...

void	x (IlvPos x)
	Sets the `x` coordinate value of the object. More...

IlvPos	y () const
	Gets the `y` coordinate value of the object. More...

void	y (IlvPos y)
	Sets the `y` coordinate value of the object. More...

virtual IlBoolean	zoomable () const
	Checks whether this object is zoomable. More...

Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...

virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...

virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...

virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...

virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Protected Member Functions
	IlvGraphicAdapter ()
	Constructor. More...

virtual void	afterSetAdaptee ()
	This virtual member function is called after the adaptee is set.

virtual void	beforeSetAdaptee ()
	Is called before the adaptee is set.

virtual IlvReferenceStreamer *	factory () const =0
	Creates an `IlvReferenceStreamer`. More...

virtual void	writeAdaptee (IlvOutputFile &os) const =0
	Saves the data specific to the adaptee. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvGraphic
static void	AddProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...

static void	AddToCallbackTypeList (IlUInt &count, const char const names, const IlSymbol const *types, const char newName, const IlSymbol *newType)
	Adds a callback to a list. More...

static void	AllowZoom (IlBoolean az)
	Sets or inhibits zooming. More...

static IlvClassInfo *	ClassInfo () const
	Gets class information. More...

static IlAny	GetProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Retrieves the property value associated with the key in this object's class. More...

static const IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Checks for the existence of a property for this object's class hierarchy. More...

static IlBoolean	IsZoomAllowed ()
	Checks whether zoomable objects can display themselves when zooming out. More...

static IlvGraphic *	read (IlvInputFile &file, IlvPalette *palette)
	Reads an object description from a file. More...

static IlBoolean	RemoveProperty (const IlSymbol *key)
	Removes a property from this object's class. More...

static IlBoolean	ReplaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...

Detailed Description

template<class ADAPTEE>
class IlvGraphicAdapter< ADAPTEE >

Frame class to adapt any object as an IlvGraphic.

Library: views

This template class is intended to be used as a base class (it is a pure abstract class). The parameter of the template ADAPTEE specifies the type of the adpatee object.

Among the member functions inherited from IlvGraphic, the following ones have to be defined:

virtual void boundingBox(IlvRect&          rect,
                         const IlvTransformer* t = 0) const
virtual IlBoolean contains(const IlvPoint&   p,
                            const IlvPoint&   tp,
                            const IlvTransformer* t = 0) const;
virtual void draw(IlvPort*           dst,
                  const IlvTransformer*      t = 0,
                  const IlvRegion*   clip = 0) const;
virtual void applyTransform(const IlvTransformer* t);

The following member functions are likely to be redefined:

virtual void drawPalette(const IlvPalette*   pal,
                         IlvPort*            dst,
                         const IlvTransformer*       t = 0,
                         const IlvRegion*    clip = 0) const;
virtual void setBackground(IlvColor* c);
virtual void setForeground(IlvColor* c);
virtual void setFont(IlvFont* f);
virtual void setColorPattern(IlvColorPattern* b);
virtual void setGradientPattern(IlvGradientPattern* g);
virtual void setPattern(IlvPattern* p);
virtual void setMode(IlvDrawMode m);
virtual void setArcMode(IlvArcMode m);
virtual void setFillRule(IlvFillRule m);
virtual void setFillStyle(IlvFillStyle f);
virtual void setLineStyle(IlvLineStyle* style);
virtual void setLineWidth(IlUShort width);
virtual void setOverwrite(IlBoolean overwrite);
virtual void setAlpha(IlvIntensity alpha);
virtual void setAntialiasingMode(IlvAntialiasingMode mode);
virtual IlBoolean zoomable() const;
virtual void setPalette(IlvPalette* pal);
virtual void print(ILVSTDPREF ostream&, int level = 0) const;

Constructor & Destructor Documentation

template<class ADAPTEE>

IlvGraphicAdapter< ADAPTEE >::IlvGraphicAdapter	(	ADAPTEE *	obj,
		IlBoolean	owner = `IlFalse`
	)

Constructor.

Initializes the data members specific to the class.

Parameters

obj	A pointer to an ADAPTEE (type given as parameter of the template) `IlvGraphic`. The type of the object is given as parameter to the template.
owner	An IlBoolean. The default value is IlFalse, that means that the adaptee is not owned.

See also: IlvGraphicAdapter::~IlvGraphicAdapter(); IlvGraphicAdapter::isOwner(); IlvGraphicAdapter::getAdaptee(); IlvGraphicAdapter::setAdaptee()

template<class ADAPTEE >

IlvGraphicAdapter< ADAPTEE >::~IlvGraphicAdapter ( )

pure virtual

Destructor.

The adaptee is unlocked. If the reference counter is null and has the property owner set to true - that means at least one of the adapters that share this adaptee is owner - then the adaptee is deleted.

See also: IlvGraphicAdapter::IlvGraphicAdapter()

template<class ADAPTEE>

IlvGraphicAdapter< ADAPTEE >::IlvGraphicAdapter ( )

protected

Constructor.

This protected constructor may only be used by a derived class.

Member Function Documentation

template<class ADAPTEE>

virtual IlvReferenceStreamer* IlvGraphicAdapter< ADAPTEE >::factory ( ) const

protectedpure virtual

Creates an IlvReferenceStreamer.

The object returned by this function must be deleted.

Returns: The reference streamer for the adaptee.

Implemented in IlvGraphicCOMAdapter.

template<class ADAPTEE>

ADAPTEE* const IlvGraphicAdapter< ADAPTEE >::getAdaptee ( ) const

Returns a const pointer to the adaptee.

The type is given by the parameter of the template.

Returns: A const pointer to an ADAPTEE (type given as parameter of the template).

See also: IlvGraphicAdapter::setAdapter()

template<class ADAPTEE>

virtual IlBoolean IlvGraphicAdapter< ADAPTEE >::handleEvent	(	IlvEvent &	event,
		const IlvTransformer *	t = `0`
	)		const

pure virtual

Handles mouse and keyboard events.

The function returns IlFalse if the event has not been dealt with.

Parameters

event	The event to be handled.
t	The transformer.

Returns: IlTrue if the event is handled, IlFalse otherwise.

template<class ADAPTEE>

IlBoolean IlvGraphicAdapter< ADAPTEE >::isOwner ( ) const

Returns the ownership property.

Returns: IlTrue when the object has the ownership of the adaptee, IlFalse otherwise.

See also: IlvGraphicAdapter::setAdaptee()

template<class ADAPTEE>

void IlvGraphicAdapter< ADAPTEE >::setAdaptee	(	ADAPTEE *	adaptee,
		IlBoolean	owner
	)

Sets the adpatee.

First, this function calls the virtual member function beforeSetAdaptee().

Second it calls the factory of IlvOwnership in order to get an owner object. The previous object, if any, is automatically unlocked through a reference counter mechanism.

Third, it calls the virtual member function afterSetAdaptee().

Parameters

adaptee	A pointer to an ADAPTEE (type given as parameter of the template).
owner	An `IlBoolean` that specifies the ownership of the adaptee.

See also: IlvGraphicAdapter::getAdaptee()

template<class ADAPTEE >

void IlvGraphicAdapter< ADAPTEE >::write ( IlvOutputFile & os ) const

pure virtual

Writes out the object description.

This member function uses a IlvReferenceStreamer to save the adaptee through a call to template<class OBJECT> void IlvWrite(IlvOwnership<OBJECT>&, IlvOutputFile&, IlvReferenceStreamer&).

The derived classes must save their data after having called this function.

Parameters

os	The `IlvOutputFile` that is written to.

See also: IlvGraphicAdapter::writeAdaptee(); IlvWrite()

Implements IlvGraphic.

template<class ADAPTEE>

virtual void IlvGraphicAdapter< ADAPTEE >::writeAdaptee ( IlvOutputFile & os ) const

protectedpure virtual

Saves the data specific to the adaptee.

Parameters

os	The `IlvOutputFile` that is written to.

Implemented in IlvGraphicCOMAdapter.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class ADAPTEE> class IlvGraphicAdapter< ADAPTEE >

Constructor & Destructor Documentation

Member Function Documentation

template<class ADAPTEE>
class IlvGraphicAdapter< ADAPTEE >