Class that encapsulates an ActiveX so that it may be used as an IlvGraphic object. More...

#include <ilviews/windows/comgadap.h>

Inheritance diagram for IlvGraphicCOMAdapter:

Public Member Functions
	IlvGraphicCOMAdapter (IlvRect const &bbox, char const identifier, IlvDisplay display)
	Constructor. More...

	IlvGraphicCOMAdapter (IlvCOMGraphicFacade *facade, IlvRect const &bbox, IlBoolean owner=IlTrue)
	Constructor. More...

virtual	~IlvGraphicCOMAdapter ()
	Destructor. More...

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

virtual IlBoolean	applyValue (const IlvValue &val)
	Apply an accessor. More...

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

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

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

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

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

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

HRESULT	queryInterface (REFIID iid, void **ppvObject) const
	Encapsulates `IUnknown::QueryInterface` More...

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

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

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

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

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

Public Member Functions inherited from IlvGraphicAdapter< IlvCOMGraphicFacade >
	IlvGraphicAdapter (IlvCOMGraphicFacade *obj, IlBoolean owner=IlFalse)
	Constructor. More...

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

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

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

void	setAdaptee (IlvCOMGraphicFacade *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	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...

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

virtual IlvGraphic *	copy () const =0
	Copies this 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 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 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	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	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	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 void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Protected Member Functions
virtual IlvReferenceStreamer *	factory () const
	Creates an `IlvReferenceStreamer`. More...

Protected Member Functions inherited from IlvGraphicAdapter< IlvCOMGraphicFacade >
	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.

Friends
class	IlvCOMGraphicFacade

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

Class that encapsulates an ActiveX so that it may be used as an IlvGraphic object.

Library: ilvcom

See also: IlvCOMGraphicFacade.; IlvGraphicAdapter.

Constructor & Destructor Documentation

§ IlvGraphicCOMAdapter() [1/2]

IlvGraphicCOMAdapter::IlvGraphicCOMAdapter	(	IlvRect const &	bbox,
		char const *	identifier,
		IlvDisplay *	display
	)

Constructor.

This constructor initializes a graphic adapter object of an ActiveX, specified by an identifier.

Parameters

bbox	The bounding box of the graphic object.
identifier	The identifier of the control. This string can be a CLSID (with braces), a ProgID, a URL, or raw HTML (prefixed with `MSHTML:`). If either a URL or raw HTML is supplied, a Web browser will be loaded with this information.
display	The display instance.

§ IlvGraphicCOMAdapter() [2/2]

IlvGraphicCOMAdapter::IlvGraphicCOMAdapter	(	IlvCOMGraphicFacade *	facade,
		IlvRect const &	bbox,
		IlBoolean	owner = `IlTrue`
	)

Constructor.

This constructor initializes a graphic adapter object from an IlvCOMGraphicFacade.

Parameters

facade	An `IlvCOMGraphicFacade` that encapsulates an ActiveX.
bbox	The bounding box of the graphic object.
owner	Specifies whether the current object must release the ActiveX (by the mean of a reference counter managed by the `IlvCOMGraphicFacade`) or not.

§ ~IlvGraphicCOMAdapter()

virtual IlvGraphicCOMAdapter::~IlvGraphicCOMAdapter ( )

virtual

Destructor.

The destructor releases the resources used by this object. In particular, if the owner flag of the constructor was IlTrue, it decrements the reference counter associated to the ActiveX.

Member Function Documentation

§ applyTransform()

virtual void IlvGraphicCOMAdapter::applyTransform ( IlvTransformer const * 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.

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.

§ applyValue()

virtual IlBoolean IlvGraphicCOMAdapter::applyValue ( const IlvValue & value )

virtual

Apply an accessor.

This member function is called by changeValue() and changeValues() methods.

It must not be called directly.

This method must be overriden by subclasses wishing to add a new accessor modifiable by changeValue().

Parameters

value The new value of the accessor.

Returns: IlTrue on success, otherwise IlFalse.

Reimplemented from IlvValueInterface.

§ boundingBox()

virtual void IlvGraphicCOMAdapter::boundingBox	(	IlvRect &	bbox,
		IlvTransformer const *	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.

Parameters

bbox	The bounding box to be set.
t	A transformer value or `0` if there is no transformation.

Implements IlvGraphic.

§ contains()

IlBoolean IlvGraphicCOMAdapter::contains	(	IlvPoint const &	p,
		IlvPoint const &	tp,
		IlvTransformer const *	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.

§ draw()

virtual void IlvGraphicCOMAdapter::draw	(	IlvPort *	dst,
		IlvTransformer const *	t = `0`,
		IlvRegion const *	clip = `0`
	)		const

virtual

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t.

Parameters

dst	The destination port this object is drawn onto.
t	The transformer value. If `0`, no transformation is performed.
clip	The clipping region, relative to the transformed object, or `0` if none.

Implements IlvGraphic.

§ factory()

virtual IlvReferenceStreamer* IlvGraphicCOMAdapter::factory ( ) const

protectedvirtual

Creates an IlvReferenceStreamer.

The object returned by this function must be deleted.

Returns: The reference streamer for the adaptee.

Implements IlvGraphicAdapter< IlvCOMGraphicFacade >.

§ getAccessors()

virtual void IlvGraphicCOMAdapter::getAccessors	(	const IlSymbol const *	names,
		const IlvValueTypeClass const *	types,
		IlUInt &	count
	)		const

virtual

Retrieves the list of available accessors of an object.

Retrieves the list of accessors of an object. names is the resulting array of symbols. Each symbol is the name of an accessor. types is the array of the types of accessors, count is the number of accessors. The existing types for accessors are the following:

IlvValueBooleanType
IlvValueIntType
IlvValueUIntType
IlvValueFloatType
IlvValueDoubleType
IlvValueStringType
IlvValueDirectionType
IlvValueColorType
IlvValueFontType
IlvValuePatternType
IlvValueColorPatternType
IlvValueGradientPatternType
IlvValueLineStyleType
IlvValueFillStyleType
IlvValueFillRuleType
IlvValueArcModeType
IlvValueBitmapType
IlvValueStringArrayType
IlvValueUIntArrayType
IlvValueMenuItemArrayType
IlvValueMatrixItemArrayType
IlvValueNotebookPageArrayType

The possible accessors for an object are described in the corresponding class.

Parameters

names	The array of symbols returned by the method. Each symbol is the name of an accessor.
types	The array of types returned by the method. Each value is the type of an accessor.
count	The number of items in the arrays names and types.

Reimplemented from IlvGraphic.

§ getDefaultInteractor()

char const* IlvGraphicCOMAdapter::getDefaultInteractor ( ) const

virtual

Gets the name of the default interactor for this object.

Returns: A string that identifies the object interactor that is likely to be associated with this graphic class. If it returns 0, then there is no default interactor for this graphic class.

Reimplemented from IlvGraphic.

§ handleEvent()

virtual IlBoolean IlvGraphicCOMAdapter::handleEvent	(	IlvEvent &	event,
		IlvTransformer const *	t = `0`
	)		const

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.

Implements IlvGraphicAdapter< IlvCOMGraphicFacade >.

§ queryInterface()

HRESULT IlvGraphicCOMAdapter::queryInterface	(	REFIID	iid,
		void **	ppvObject
	)		const

Encapsulates IUnknown::QueryInterface

This method is a C++ replacement of the IUnknown::QueryInterface COM API, for the ActiveX associated with this view. See the COM API documentation for more information.

Parameters

iid	Identifier of the interface being requested.
ppvObject	The address of a pointer variable that receives the interface pointer requested in iid. Upon successful return, `ppvObject` contains the requested interface pointer to the object. If the object does not support the interface specified in iid, `ppvObject` is set to `NULL`.

Returns: S_OK if the interface is supported, and E_NOINTERFACE if it is not.

§ queryValue()

virtual IlvValue& IlvGraphicCOMAdapter::queryValue ( IlvValue & val ) const

virtual

Retrieves an accessor value.

The queryValue() method can be used in the following way:

IlvValue arg("label");

char* label = (char*)labelObject->queryValue(arg);

This method must be overriden by subclasses wishing to add a new readable accessor.

Parameters

val	The `IlvValue` used both to identify the accessor and to store the return value.

Returns: A reference to val, which contains the resulting value.

See also: IlvValue.

Reimplemented from IlvValueInterface.

§ setMode()

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

§ setOverwrite()

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

§ setPalette()

virtual void IlvGraphicCOMAdapter::setPalette ( IlvPalette * palette )

virtual

Sets the palette of the object.

Each of the graphic properties of this object is then taken from this IlvPalette instance.

Parameters

palette The palette to be set.

Reimplemented from IlvGraphic.

§ writeAdaptee()

virtual void IlvGraphicCOMAdapter::writeAdaptee ( IlvOutputFile & os ) const

virtual

Saves the data specific to the adaptee.

Parameters

os	The `IlvOutputFile` that is written to.

Implements IlvGraphicAdapter< IlvCOMGraphicFacade >.

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ IlvGraphicCOMAdapter() [1/2]

§ IlvGraphicCOMAdapter() [2/2]

§ ~IlvGraphicCOMAdapter()

Member Function Documentation

§ applyTransform()

§ applyValue()

§ boundingBox()

§ contains()

§ draw()

§ factory()

§ getAccessors()

§ getDefaultInteractor()

§ handleEvent()

§ queryInterface()

§ queryValue()

§ setMode()

§ setOverwrite()

§ setPalette()

§ writeAdaptee()