 |
Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Graphic class. More...
#include <ilviews/graphics/selector.h>
Public Member Functions | |
| IlvSelector () | |
| Constructor. More... | |
| virtual void | computeFocusRegion (IlvRegion &, const IlvTransformer *t=0) const |
| Computes the region needed for the drawing of the focus. More... | |
| virtual void | drawFocus (IlvPort *, const IlvPalette *, const IlvTransformer *t=0, const IlvRegion *clip=0) const |
| Draws additional drawings for an object that has the keyboard focus. More... | |
| virtual void | insertObject (IlvGraphic *obj) |
| Inserts an object. More... | |
| IlBoolean | isSelected (IlvGraphic *object) const |
| Returns a Boolean value indicating whether the specified graphic is selected or not. More... | |
| virtual void | removeObject (IlvGraphic *obj) |
| Removes an object. More... | |
| void | setSelected (IlvGraphic *object) |
| Sets the specified graphic object as the selected object for this selector. More... | |
| void | setSelected (IlShort index) |
| Sets the graphic object specified by its index as the selected object for this selector. More... | |
| IlvGraphic * | whichGraphicSelected () const |
| Returns a pointer to the selected object of this selector. More... | |
| IlShort | whichSelected () const |
| Returns the index of the selected object of this selector. More... | |
 Public Member Functions inherited from IlvGraphicSet | |
| IlvGraphicSet () | |
Initializes an empty IlvGraphicSet object. More... | |
| IlvGraphicSet (int num,...) | |
Initializes an IlvGraphicSet object that groups a set of IlvGraphic objects. More... | |
| ~IlvGraphicSet () | |
| Destructor. More... | |
| virtual void | addObject (IlvGraphic *obj) |
| Adds an object. More... | |
| void | align (IlvPosition align=IlvLeft) |
| Aligns the objects. More... | |
| virtual void | apply (IlvApplyObject function, IlAny arg) |
| Applies a function to the objects. More... | |
| virtual void | applyReferences (IlvApplyObject function, IlAny arg) |
| Applies a function to the referenced objects. More... | |
| virtual void | applyTransform (const IlvTransformer *) |
| Applies a transformation function to the graphic object. More... | |
| virtual void | boundingBox (IlvRect &, const IlvTransformer *=0) const |
| Retrieves the bounding box of the graphic object. More... | |
| void | column (IlvDeltaPos spacing=4) |
| Force a vertical space between the objects. More... | |
| virtual IlBoolean | contains (const IlvPoint &, const IlvPoint &, const IlvTransformer *=0) const |
| Checks whether a point is in the object. More... | |
| virtual void | draw (IlvPort *, const IlvTransformer *=0, const IlvRegion *=0) const |
| Draws the graphic object. More... | |
| IlvGraphic * | firstContains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const |
| Gets an object at a given location. More... | |
| IlvGraphic * | firstIntersects (const IlvRegion ®ion, const IlvTransformer *t=0) const |
| Gets an object in a given region. More... | |
| virtual IlvIntensity | getAlpha () const |
| Retrieves the alpha component. More... | |
| IlUInt | getCardinal () const |
| Gets the number of stored objects. More... | |
| virtual IlvGraphic * | getChildAt (IlUInt) const |
| Returns the sub-object of the graphic object specified by index. More... | |
| virtual IlvGraphic * | getChildByName (const char *) 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 *) const |
| Returns the index of the specified sub-object in this graphic object. More... | |
| IlInt | getIndex (IlvGraphic *object) const |
| Gets the index of an object. More... | |
| virtual IlUShort | getLineWidth () const |
| Retrieves the line width. More... | |
| IlvGraphic * | getObject (IlUInt index) const |
| Gets an object by index. More... | |
| IlvGraphic *const * | getObjects (IlUInt &count) const |
| Gets an array of all stored objects. More... | |
| virtual IlBoolean | inside (const IlvRegion &, const IlvTransformer *=0) const |
| Determines whether an object with transformation applied is inside the bounding box. More... | |
| virtual IlBoolean | intersects (const IlvRegion &, const IlvTransformer *=0) const |
| Checks whether a region intersects the bounding box with transformation applied. More... | |
| virtual void | invert (IlBoolean=IlFalse) |
| Highlights the object. More... | |
| void | row (IlvDeltaPos spacing=4) |
| Force an horizontal space between the objects. More... | |
| void | sameHeight (IlvDim height) |
| Force the height of all the objects. More... | |
| void | sameWidth (IlvDim width) |
| Force the width of all the objects. More... | |
| virtual void | setAlpha (IlvIntensity) |
| Sets the alpha value of the object. More... | |
| virtual void | setAntialiasingMode (IlvAntialiasingMode) |
| Sets the anti-aliasing mode of the object. More... | |
| virtual void | setArcMode (IlvArcMode) |
| Sets the arc mode of the object. More... | |
| virtual void | setBackground (IlvColor *) |
| Sets the background color of the object. More... | |
| virtual void | setColorPattern (IlvColorPattern *) |
| Sets the color pattern of the object. More... | |
| virtual void | setFillRule (IlvFillRule) |
| Sets the fill rule of the object. More... | |
| virtual void | setFillStyle (IlvFillStyle) |
| Sets the fill style of the object. More... | |
| virtual void | setFont (IlvFont *) |
| Sets the font of the object. More... | |
| virtual void | setForeground (IlvColor *) |
| Sets the foreground color of the object. More... | |
| virtual void | setGradientPattern (IlvGradientPattern *) |
| Sets the gradient pattern of the object. More... | |
| virtual void | setHolder (IlvGraphicHolder *) |
| Sets the object's holder. More... | |
| virtual void | setLineStyle (IlvLineStyle *) |
| Sets the line style of the object. More... | |
| virtual void | setLineWidth (IlUShort) |
| Sets the line width of the object. More... | |
| virtual void | setMode (IlvDrawMode) |
| Sets the drawing mode of the object temporarily. More... | |
| void | setObject (IlUInt index, IlvGraphic *object) |
| Sets an object. More... | |
| virtual void | setOverwrite (IlBoolean) |
| Sets an overwrite mode that modifies how the drawing member functions operate. More... | |
| virtual void | setPalette (IlvPalette *) |
| Sets the palette of the object. More... | |
| virtual void | setPattern (IlvPattern *) |
| Sets the pattern of the object. More... | |
| virtual void | symmetry (IlvDirection) |
| Flips a graphic 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 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 | getAccessors (const IlSymbol *const **, const IlvValueTypeClass *const **, IlUInt &) const |
| Retrieves the list of available accessors of an object. 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 *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 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... | |
| 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... | |
| 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 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... | |
| 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 | 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 IlvValue & | queryValue (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 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 IlvSelector class is a special kind of graphic set that handles a unique selection among the objects it holds. This class is a subtype of the IlvGraphicSet class. You must explicitly specify the interactor if you want an interactive behavior. The default interactor name for this object is "Selector".
IlvSelectorInteractor.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 IlvGraphicSet and adds the following ones:
| Name | Type | Equivalent methods |
|---|---|---|
selection | UInt | whichSelected(), setSelected() |
| IlvSelector::IlvSelector | ( | ) |
Constructor.
Initializes an empty IlvSelector object. You can call member functions such as insertObject to add IlvGraphic objects to this instance.
|
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 IlvGraphic.
|
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 IlvGraphic.
|
virtual |
Inserts an object.
Inserts an object at the beginning of the maintained list so it will be the first object to be drawn when the IlvGraphicSet object is redrawn.
| object | The object to be inserted. |
Reimplemented from IlvGraphicSet.
| IlBoolean IlvSelector::isSelected | ( | IlvGraphic * | object | ) | const |
Returns a Boolean value indicating whether the specified graphic is selected or not.
| object | The graphic object. |
setSelected, whichSelected, whichGraphicSelected.
|
virtual |
Removes an object.
Removes an object from the list of referenced objects. If an object is stored more than once in the same IlvGraphicSet, only the first occurrence will be removed. The object is not destroyed.
| object | The object to be removed from this graphic set. |
Reimplemented from IlvGraphicSet.
| void IlvSelector::setSelected | ( | IlvGraphic * | object | ) |
Sets the specified graphic object as the selected object for this selector.
If object is not located in the selector, this method does nothing.
| object | The new selected object. |
whichSelected. | void IlvSelector::setSelected | ( | IlShort | index | ) |
Sets the graphic object specified by its index as the selected object for this selector.
If index is not a valid index, this method deselects the selected graphic object of the selector.
| index | The index of the new selected object. |
whichSelected. | IlvGraphic* IlvSelector::whichGraphicSelected | ( | ) | const |
Returns a pointer to the selected object of this selector.
setSelected, whichSelected. | IlShort IlvSelector::whichSelected | ( | ) | const |
Returns the index of the selected object of this selector.
setSelected, whichGraphicSelected. © 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.