Rogue Wave Views 5.6
Rogue Wave Views
Foundation Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
Graphic class. More...
#include <ilviews/graphics/handle.h>
Public Member Functions | |
| IlvFixedSizeGraphic (IlvGraphic *obj, IlBoolean owner=IlFalse, IlvPosition position=IlvBadPosition, const IlvPoint *point=0) | |
| Constructor. 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... | |
| IlBoolean | contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const |
| Checks whether a point is in the object. More... | |
| 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... | |
| const IlvPoint & | getPoint () const |
| Gets the fixed point. More... | |
| IlvPosition | getPosition () const |
| Gets a fixed point position. More... | |
| IlBoolean | inside (const IlvRegion &tregion, const IlvTransformer *t=0) const |
| Determines whether an object with transformation applied is inside the bounding box. More... | |
| IlBoolean | intersects (const IlvRegion &tregion, const IlvTransformer *t=0) const |
| Checks whether a region intersects the bounding box with transformation applied. More... | |
| void | setPoint (const IlvPoint &p) |
| Sets the fixed point. More... | |
| void | setPosition (IlvPosition position) |
| Sets the fixed point position. More... | |
| virtual IlBoolean | zoomable () const |
| Queries the zoomable capability. More... | |
 Public Member Functions inherited from IlvGraphicHandle | |
| 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 IlBoolean | applyValue (const IlvValue &) |
| Apply an accessor. 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 IlvGraphicHolder * | getHolder () const |
| Gets a pointer to an object's holder. More... | |
| virtual IlUShort | getLineWidth () const |
| Retrieves the line width. More... | |
| virtual IlvLookFeelHandler * | getLookFeelHandler () const |
| Returns the look & feel handler used by this object. More... | |
| IlvGraphic * | getObject () const |
| Retrieves the reference object. More... | |
| virtual void | invert (IlBoolean temp=IlFalse) |
| Highlights the object. More... | |
| IlBoolean | isOwner () const |
| Retrieves the ownership. More... | |
| virtual void | print (ILVSTDPREF ostream &, int level=0) const |
| Prints for debugging purposes. More... | |
| virtual IlvValue & | queryValue (IlvValue &) const |
| Retrieves the value of an accessor. 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... | |
| 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 callback, 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... | |
| virtual IlBoolean | changeValue (const IlvValue &val) |
| Changes the value of an accessor. More... | |
| virtual IlBoolean | changeValues (const IlvValue *values, IlUShort count) |
| Changes several accessor values simultaneously. 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 IlvGraphic * | copy () 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... | |
| 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 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... | |
| IlvInteractor * | getInteractor () const |
| Returns the interactor associated with the current 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 a specified graphic 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... | |
| 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 or not. 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 | queryValues (IlvValue *values, IlUShort count) const |
| Retrieves multiple accessor values simultaneously. 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 ¢er, 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 callback, 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 the current 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... | |
| 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... | |
| 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... | |
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... | |
Graphic class.
Library: views
The IlvFixedSizeGraphic class is derived from the basic handle class IlvGraphicHandle. Thus, an IlvFixedSizeGraphic object is a kind of handle, which is associated with a certain referenced object of the IlvGraphic class. An IlvFixedSizeGraphic instance is drawn by applying to its referenced object a graphic transformation so that the referenced object can never change its visible size. The appropriate transformation is internally computed to achieve this result.
| IlvFixedSizeGraphic::IlvFixedSizeGraphic | ( | IlvGraphic * | obj, |
| IlBoolean | owner = IlFalse, |
||
| IlvPosition | position = IlvBadPosition, |
||
| const IlvPoint * | point = 0 |
||
| ) |
Constructor.
The constructor initializes an instance of IlvFixedSizeGraphic. The position argument indicates the point in the referenced object (for example, its center or the top-left corner of its bounding box) that must remain at the same position when the object is redrawn. This parameter defaults to a value that leaves the center of the drawn shape at the same location, regardless of any transformer that might be applied when redrawing the graphic object or when locating events that are redirected to these objects. The last parameter, point, can be used to specify the position of a fixed point when this object is transformed (then position is not taken into account). In the case of a transformation that is applied to the object, the transformation is actually applied to this point, and the object is then translated so that the distance between the object and this transformed point is kept constant.
| object | The graphic object to be fixed. |
| owner | A Boolean value indicating if it is the owner. |
| position | The position of the point to remain fixed. |
| point | A fixed point in transformation. |
|
virtual |
Applies a transformation.
| t | The transformer that is applied to the referenced graphic object by calling its IlvGraphic::applyTransform member function. |
Reimplemented from IlvGraphicHandle.
|
virtual |
Retrieves the bounding box of the graphic object.
Sets bbox, the rectangle reference parameter, to be the bounding box of the object. Since the object can appear within a transformed environment (for example, in a multiview editor), an IlvTransformer object occurs as an optional parameter in order to compute the bounding box in the coordinate system of the transformed environment. When there is no transformation, t is set to 0.
| bbox | The bounding box to be set. |
| t | A transformer value or 0 if there is no transformation. |
Reimplemented from IlvGraphicHandle.
|
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).
| r | The region that is updated. |
| t | The transformer value. If 0, no transformation is performed. |
Reimplemented from IlvGraphicHandle.
|
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.
| 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. |
IlTrue when the point p lies inside the outline of the object. Reimplemented from IlvGraphicHandle.
|
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.
| dst | The destination port. |
| t | The transformer value. If 0, no transformation is performed. |
| clip | The clipping region, or 0 if none. |
Reimplemented from IlvGraphicHandle.
|
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.
| dst | The destination port. |
| palette | The palette of the object. |
| t | The transformer value. If 0, no transformation is performed. |
| clip | The clipping region. |
Reimplemented from IlvGraphicHandle.
| const IlvPoint& IlvFixedSizeGraphic::getPoint | ( | ) | const |
Gets the fixed point.
| IlvPosition IlvFixedSizeGraphic::getPosition | ( | ) | const |
Gets a fixed point position.
|
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.
| r | The region to be tested. |
| t | A transformer value, or 0 if there is no transformation. |
IlTrue when the object, drawn with the transformer t, covers completely the region r. This virtual member function returns IlFalse when this is not the case. That means that it returns IlTrue if all rectangles that define the region completely lie inside the object. Reimplemented from IlvGraphicHandle.
|
virtual |
Checks whether a region intersects the bounding box with transformation applied.
Checks whether a region intersects the bounding box with transformation applied.
| r | The region to be tested. |
| t | A transformer value, or 0 if there is no transformation. |
IlTrue when the region r overlaps the transformed object (if t is not 0) and IlFalse when this is not the case. Reimplemented from IlvGraphicHandle.
| void IlvFixedSizeGraphic::setPoint | ( | const IlvPoint & | p | ) |
Sets the fixed point.
| p | The new reference point. |
| void IlvFixedSizeGraphic::setPosition | ( | IlvPosition | position | ) |
Sets the fixed point position.
Changes the fixed point position by locating the fixed point at the indicated direction relative to the object's bounding box.
| position | The new relative position. |
|
virtual |
Queries the zoomable capability.
IlFalse. An IlvFixedSizeGraphic is never zoomable. Reimplemented from IlvGraphicHandle.
© Copyright 2012, 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.