Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvGraphicHandle Class Reference

Graphic class. More...

#include <ilviews/graphics/handle.h>

Inheritance diagram for IlvGraphicHandle:
IlvGraphic IlvValueInterface IlvFilteredGraphic IlvFixedSizeGraphic IlvTransformedGraphic IlvGraphicInstance

Public Member Functions

 IlvGraphicHandle (IlvGraphic *object, IlBoolean owner=IlFalse)
 Constructor. More...
 
virtual void apply (IlvApplyObject function, IlAny userArg)
 Applies a function to the referenced object. More...
 
virtual void applyReferences (IlvApplyObject function, IlAny userArg)
 Conditionally applies a function to the referenced object. More...
 
virtual void applyTransform (const IlvTransformer *t)
 Applies a transformation. More...
 
virtual void boundingBox (IlvRect &r, const IlvTransformer *t=0) const
 Retrieves the bounding box of the graphic 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...
 
virtual void draw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws the 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 **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const
 Retrieves the list of available accessors of an object. More...
 
virtual IlvIntensity getAlpha () const
 Retrieves the alpha component. More...
 
IlvAntialiasingMode getAntialiasingMode () const
 Retrieves the anti-aliasing mode. More...
 
virtual IlvGraphicHoldergetHolder () const
 Gets a pointer to an object's holder. More...
 
virtual IlUShort getLineWidth () const
 Retrieves the line width. More...
 
virtual IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look & feel handler used by this object. More...
 
IlvGraphicgetObject () const
 Retrieves the reference object. More...
 
virtual IlBoolean inside (const IlvRegion &tregion, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
virtual IlBoolean intersects (const IlvRegion &tregion, const IlvTransformer *t=0) const
 Checks whether a region intersects the bounding box with transformation applied. More...
 
virtual void invert (IlBoolean temp=IlFalse)
 Highlights the object. More...
 
IlBoolean isOwner () const
 Retrieves the ownership. 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 m)
 Sets the arc mode of the object. More...
 
virtual void setBackground (IlvColor *c)
 Sets the background color of the object. More...
 
virtual void setColorPattern (IlvColorPattern *b)
 Sets the color pattern of the object. More...
 
virtual void setFillRule (IlvFillRule m)
 Sets the fill rule of the object. More...
 
virtual void setFillStyle (IlvFillStyle f)
 Sets the fill style of the object. More...
 
virtual void setFont (IlvFont *f)
 Sets the font of the object. More...
 
virtual void setForeground (IlvColor *c)
 Sets the foreground color of the object. More...
 
virtual void setGradientPattern (IlvGradientPattern *g)
 Sets the gradient pattern of the object. More...
 
virtual void setHolder (IlvGraphicHolder *holder)
 Sets the object's holder. More...
 
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 m)
 Sets the drawing mode of the object temporarily. More...
 
void setObject (IlvGraphic *object)
 Sets the referenced object. More...
 
virtual void setOverwrite (IlBoolean overwrite)
 Sets an overwrite mode that modifies how the drawing member functions operate. More...
 
void setOwner (IlBoolean flag)
 Sets the ownership. More...
 
virtual void setPalette (IlvPalette *pal)
 Sets the palette of the object. More...
 
virtual void setPattern (IlvPattern *p)
 Sets the pattern of the object. More...
 
virtual IlBoolean zoomable () const
 Checks whether this object is zoomable. 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...
 
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 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...
 
IlBoolean contains (const IlvPoint &p) const
 Checks whether a point is in the object. More...
 
virtual IlvGraphiccopy () const =0
 Copies this object. More...
 
void draw (IlvPort *dst, const IlvTransformer *t, const IlvRect *clip) const
 Draws a graphic object. 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...
 
IlSymbolgetCallbackName (const IlSymbol *callbackType) const
 Gets the name of a callback. More...
 
IlSymbolgetCallbackName () 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 IlvGraphicgetChildAt (IlUInt index) const
 Returns the sub-object of the graphic object specified by index. More...
 
virtual IlvGraphicgetChildByName (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 IlvClassInfogetClassInfo () 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...
 
IlvInteractorgetInteractor () const
 Returns the interactor associated with the current object. More...
 
const char * getName () const
 Gets the name of the object. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Gets a named property. More...
 
IlSymbolgetNextFocusGraphic () const
 Gets the next object in the focus chain. More...
 
IlSymbolgetPreviousFocusGraphic () const
 Gets the previous object in the focus chain. More...
 
IlAny getProperty (const IlSymbol *key) const
 Gets a property. More...
 
IlvSmartSetgetSmartSet () 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 IlvClassInfohasClassProperty (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...
 
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...
 
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...
 
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...
 
IlvNamedPropertyremoveNamedProperty (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...
 
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...
 
void setFirstFocusGraphic ()
 Sets the object to be first in the focus chain.
 
void setFocusable (IlBoolean value)
 Set the focusable state of the object. 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 setName (const char *name)
 Sets the name of the object. More...
 
IlvNamedPropertysetNamedProperty (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...
 
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...
 
virtual void write (IlvOutputFile &output) const =0
 Writes an object description to a file. 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...
 
- 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 IlvValuequeryValue (IlvValue &val) const
 Retrieves an accessor value. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. 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 IlvClassInfoClassInfo () 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 IlvClassInfoHasProperty (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 IlvGraphicread (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

Graphic class.

Library: views

This section explains the concept of handle objects. An IlvGraphicHandle object is used to reference an IlvGraphic object. The IlvGraphicHandle object is thus called the handle object, and the other object the referenced object.

Note
These handle objects have nothing to do with the square handles mentioned in the documentation of the IlvDrawSelection class.

This relationship enables you to use a handle object to indirectly access the referenced object. Also, the same referenced object can be shared among several handles. You can thus "duplicate" a complex graphic object as many times as you like by simply creating new handle objects, which all reference the same original graphic object. By referencing a complex object, instead of copying it, you save computing resources.

Another concept is that of ownership. You can make a handle object the owner of the unique referenced object with which it is associated. In this case, you no longer access the referenced object directly, but only through its handle.
When a handle owns its referenced object, deleting the handle removes both the handle and the referenced object. When the handle does not own the referenced object, a delete operation removes only the handle, leaving the referenced object intact.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvGraphic and adds the following ones:

Name Type Equivalent methods
graphic IlvGraphic getObject(), setObject()
owner Boolean isOwner(), setOwner()

Constructor & Destructor Documentation

§ IlvGraphicHandle()

IlvGraphicHandle::IlvGraphicHandle ( IlvGraphic object,
IlBoolean  owner = IlFalse 
)

Constructor.

Parameters
objectThe referenced object.
ownerMust be set to IlTrue to make the handle object the owner of the referenced object.

Member Function Documentation

§ apply()

virtual void IlvGraphicHandle::apply ( IlvApplyObject  function,
IlAny  userArg 
)
virtual

Applies a function to the referenced object.

Parameters
functionThe function that is applied.
userArgThe user argument that is passed to function.

Reimplemented from IlvGraphic.

§ applyReferences()

virtual void IlvGraphicHandle::applyReferences ( IlvApplyObject  function,
IlAny  userArg 
)
virtual

Conditionally applies a function to the referenced object.

The function is applied only if the handle is not the owner of the referenced object. Otherwise, this member function does nothing.

Parameters
functionThe function that is applied.
userArgThe user argument that is passed to function.

Reimplemented from IlvGraphic.

§ applyTransform()

virtual void IlvGraphicHandle::applyTransform ( const IlvTransformer t)
virtual

Applies a transformation.

Parameters
tThe transformer that is applied to the referenced graphic object by calling its IlvGraphic::applyTransform() member function.

Implements IlvGraphic.

Reimplemented in IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ boundingBox()

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

Parameters
bboxThe bounding box to be set.
tA transformer value or 0 if there is no transformation.

Implements IlvGraphic.

Reimplemented in IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ computeFocusRegion()

virtual void IlvGraphicHandle::computeFocusRegion ( IlvRegion r,
const IlvTransformer t = 0 
) const
virtual

Computes the region needed for the drawing of the focus.

This method is called to compute the region needed for the drawing of the focus (see the method drawFocus()).

Parameters
rThe region that is updated.
tThe transformer value. If 0, no transformation is performed.
Returns
The computed region.

Reimplemented from IlvGraphic.

Reimplemented in IlvFixedSizeGraphic, and IlvTransformedGraphic.

§ contains()

virtual IlBoolean IlvGraphicHandle::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
pThe point to be tested.
tpThe transformed point obtained by applying the transformer t to the point p.
tA 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 IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ draw()

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

Parameters
dstThe destination port this object is drawn onto.
tThe transformer value. If 0, no transformation is performed.
clipThe clipping region, relative to the transformed object, or 0 if none.

Implements IlvGraphic.

Reimplemented in IlvGraphicInstance, IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ drawFocus()

virtual void IlvGraphicHandle::drawFocus ( IlvPort dst,
const IlvPalette palette,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
virtual

Draws additional drawings for an object that has the keyboard focus.

This method is called to draw additional drawings when the graphic object has the keyboard focus. The default implementation draws a rectangle around the object. The drawing will be done inside the region returned by computeFocusRegion().

Parameters
dstThe destination port.
paletteThe palette of the object.
tThe transformer value. If 0, no transformation is performed.
clipThe clipping region.

Reimplemented from IlvGraphic.

Reimplemented in IlvFixedSizeGraphic, and IlvTransformedGraphic.

§ getAccessors()

virtual void IlvGraphicHandle::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
namesThe array of symbols returned by the method. Each symbol is the name of an accessor.
typesThe array of types returned by the method. Each value is the type of an accessor.
countThe number of items in the arrays names and types.

Reimplemented from IlvGraphic.

§ getAlpha()

virtual IlvIntensity IlvGraphicHandle::getAlpha ( ) const
virtual

Retrieves the alpha component.

Returns
The alpha component of the object.

Reimplemented from IlvGraphic.

§ getAntialiasingMode()

IlvAntialiasingMode IlvGraphicHandle::getAntialiasingMode ( ) const
virtual

Retrieves the anti-aliasing mode.

Returns
The anti-aliasing mode of the object.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance.

§ getHolder()

virtual IlvGraphicHolder* IlvGraphicHandle::getHolder ( ) const
virtual

Gets a pointer to an object's holder.

Returns
A pointer to the IlvGraphicHolder object in which the graphic is located.

Reimplemented from IlvGraphic.

§ getLineWidth()

virtual IlUShort IlvGraphicHandle::getLineWidth ( ) const
virtual

Retrieves the line width.

Returns
The line width of the object.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance.

§ getLookFeelHandler()

virtual IlvLookFeelHandler* IlvGraphicHandle::getLookFeelHandler ( ) const
virtual

Returns the look & feel handler used by this object.

The default implementation returns 0.

Returns
The look & feel handler used by this object.

Reimplemented from IlvGraphic.

§ getObject()

IlvGraphic* IlvGraphicHandle::getObject ( ) const

Retrieves the reference object.

Returns
The referenced IlvGraphic object.

§ inside()

virtual IlBoolean IlvGraphicHandle::inside ( const IlvRegion r,
const IlvTransformer t = 0 
) const
virtual

Determines whether an object with transformation applied is inside the bounding box.

Determines whether an object with transformation applied is inside the bounding box.

Parameters
rThe region to be tested.
tA 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 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 IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ intersects()

virtual IlBoolean IlvGraphicHandle::intersects ( const IlvRegion r,
const IlvTransformer t = 0 
) const
virtual

Checks whether a region intersects the bounding box with transformation applied.

Checks whether a region intersects the bounding box with transformation applied.

Parameters
rThe region to be tested.
tA 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 IlvFixedSizeGraphic, IlvTransformedGraphic, and IlvFilteredGraphic.

§ invert()

virtual void IlvGraphicHandle::invert ( IlBoolean  temp = IlFalse)
virtual

Highlights the object.

Highlights the object. It is implemented as swapping the foreground and background colors of the object, but can have other implementations in derived subclasses. The parameter temp controls the way you toggle between the background and the foreground. If temp is omitted or is IlFalse, then a new palette is computed by calling the IlvDisplay::getPalette() method. If temp is IlTrue, the object palette is inverted, and thus all the objects referencing this palette will be affected.

Parameters
tempIf IlTrue, highlights the object.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ isOwner()

IlBoolean IlvGraphicHandle::isOwner ( ) const

Retrieves the ownership.

Returns
IlTrue if the handle owns its referenced object.

§ setAlpha()

virtual void IlvGraphicHandle::setAlpha ( IlvIntensity  alpha)
virtual

Sets the alpha value of the object.

Parameters
alphaThe new alpha value.

Reimplemented from IlvGraphic.

§ setAntialiasingMode()

virtual void IlvGraphicHandle::setAntialiasingMode ( IlvAntialiasingMode  mode)
virtual

Sets the anti-aliasing mode of the object.

Parameters
modeThe new anti-aliasing mode.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setArcMode()

virtual void IlvGraphicHandle::setArcMode ( IlvArcMode  mode)
virtual

Sets the arc mode of the object.

Parameters
modeThe new arc mode.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setBackground()

virtual void IlvGraphicHandle::setBackground ( IlvColor background)
virtual

Sets the background color of the object.

Sets the background color of the object.

Parameters
backgroundThe new background color.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setColorPattern()

virtual void IlvGraphicHandle::setColorPattern ( IlvColorPattern pattern)
virtual

Sets the color pattern of the object.

Sets the color pattern of the object.

Parameters
patternThe new color pattern.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setFillRule()

virtual void IlvGraphicHandle::setFillRule ( IlvFillRule  rule)
virtual

Sets the fill rule of the object.

Parameters
ruleThe new fill rule.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setFillStyle()

virtual void IlvGraphicHandle::setFillStyle ( IlvFillStyle  style)
virtual

Sets the fill style of the object.

Parameters
styleThe new fill style.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setFont()

virtual void IlvGraphicHandle::setFont ( IlvFont font)
virtual

Sets the font of the object.

Parameters
fontThe new font.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setForeground()

virtual void IlvGraphicHandle::setForeground ( IlvColor foreground)
virtual

Sets the foreground color of the object.

Sets the foreground color of the object.

Parameters
foregroundThe new foreground color.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setGradientPattern()

virtual void IlvGraphicHandle::setGradientPattern ( IlvGradientPattern pattern)
virtual

Sets the gradient pattern of the object.

Sets the gradient pattern of the object.

Parameters
patternThe new gradient pattern.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setHolder()

virtual void IlvGraphicHandle::setHolder ( IlvGraphicHolder )
virtual

Sets the object's holder.

This default implementation has no real function.

Reimplemented from IlvGraphic.

Reimplemented in IlvTransformedGraphic.

§ setLineStyle()

virtual void IlvGraphicHandle::setLineStyle ( IlvLineStyle style)
virtual

Sets the line style of the object.

Parameters
styleThe new line style.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setLineWidth()

virtual void IlvGraphicHandle::setLineWidth ( IlUShort  width)
virtual

Sets the line width of the object.

Parameters
widthThe new line width.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setMode()

virtual void IlvGraphicHandle::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
modeThe drawing mode to be set.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setObject()

void IlvGraphicHandle::setObject ( IlvGraphic object)

Sets the referenced object.

The ownership is not changed, and the previous object is not deleted, whatever the ownership of this handle.

Parameters
objectThe new referenced object.

§ setOverwrite()

virtual void IlvGraphicHandle::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
overIf IlFalse, sets selective hidden drawing operations.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setOwner()

void IlvGraphicHandle::setOwner ( IlBoolean  flag)

Sets the ownership.

Parameters
flagThe new ownership flag. If this value is IlTrue, then the handle is the owner of the referenced object with which it is associated and you should no longer access the referenced object directly.

§ setPalette()

virtual void IlvGraphicHandle::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
paletteThe palette to be set.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ setPattern()

virtual void IlvGraphicHandle::setPattern ( IlvPattern pattern)
virtual

Sets the pattern of the object.

Sets the pattern of the object.

Parameters
patternThe new pattern.

Reimplemented from IlvGraphic.

Reimplemented in IlvGraphicInstance, and IlvFilteredGraphic.

§ zoomable()

virtual IlBoolean IlvGraphicHandle::zoomable ( ) const
virtual

Checks whether this object is zoomable.

Returns
IlTrue if the graphic object can be zoomed, and IlFalse otherwise.
See also
IsZoomAllowed(), AllowZoom().

Reimplemented from IlvGraphic.

Reimplemented in IlvFixedSizeGraphic, and IlvFilteredGraphic.


© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.