 |
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 |
View rectangle class. More...
#include <ilviews/contain/rectangl.h>
Public Member Functions | |
| IlvContainerRectangle (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0) | |
| Constructor. More... | |
| virtual IlvView * | createView (IlvAbstractView *parent, const IlvRect &size) |
| Creates the view. More... | |
| virtual IlvContainer * | getContainer () const |
| Returns a pointer to the encapsulated container object. More... | |
| const char * | getFilename () const |
| Returns the file name associated with this object. More... | |
| virtual void | makeView (IlvPort *dst, const IlvTransformer *t=0) |
| Sets up the view. More... | |
| void | setFilename (const char *name, IlBoolean redraw=IlFalse) |
| Sets the name of the file associated with the container. More... | |
 Public Member Functions inherited from IlvViewRectangle | |
| IlvViewRectangle (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0) | |
| Constructor. More... | |
| virtual void | applyTransform (const IlvTransformer *t) |
| Applies a transformation function to the graphic object. More... | |
| virtual void | draw (IlvPort *, const IlvTransformer *t=0, const IlvRegion *clip=0) const |
| Draws the graphic object. More... | |
| virtual IlvView * | getView () const |
| Retrieves the view of this object. More... | |
| void | hide () |
| Hides the view. | |
| virtual void | setBackground (IlvColor *) |
| Sets the background color of the object. More... | |
| virtual void | setPalette (IlvPalette *) |
| Sets the internal palette. More... | |
| virtual void | setView (IlvView *view) |
| Sets the view of this object. More... | |
| void | show () |
| Shows the view. | |
| Public Member Functions inherited from IlvFilledRectangle | |
| IlvFilledRectangle (IlvDisplay *display, const IlvRect &drawrect, IlvPalette *palette=0) | |
| Constructor. More... | |
| virtual IlBoolean | contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const |
| Checks whether a point is in the object. More... | |
| Public Member Functions inherited from IlvRectangle | |
| IlvRectangle (IlvDisplay *display, const IlvRect &drawrect, IlvPalette *palette=0) | |
| Constructor. More... | |
| virtual void | boundingBox (IlvRect &rect, const IlvTransformer *t=0) const |
| Retrieves the bounding box of the graphic object. More... | |
| Public Member Functions inherited from IlvSimpleGraphic | |
| IlvSimpleGraphic (IlvDisplay *display, IlvPalette *palette=0) | |
Initializes a new IlvSimpleGraphic. More... | |
| virtual | ~IlvSimpleGraphic () |
| Destructor. More... | |
| virtual void | applyResources (const char *, const char *, const char *, const char *, IlvDisplay *=0) |
| Applies resources on a graphic object. More... | |
| IlvIntensity | getAlpha () const |
| Retrieves the alpha value. More... | |
| IlvAntialiasingMode | getAntialiasingMode () const |
| Retrieves the anti-aliasing mode. More... | |
| IlvArcMode | getArcMode () const |
| Retrieves the arc mode. More... | |
| IlvColor * | getBackground () const |
| Retrieves the background color. More... | |
| IlvColorPattern * | getColorPattern () const |
| Retrieves the color pattern. More... | |
| virtual IlvDisplay * | getDisplay () const |
Retrieves the IlvDisplay instance. More... | |
| IlvFillRule | getFillRule () const |
| Retrieves the fill rule. More... | |
| IlvFillStyle | getFillStyle () const |
| Retrieves the fill style. More... | |
| IlvFont * | getFont () const |
| Retrieves the font. More... | |
| IlvColor * | getForeground () const |
| Retrieves the foreground color. More... | |
| IlvGradientPattern * | getGradientPattern () const |
| Retrieves the gradient pattern. More... | |
| IlvLineStyle * | getLineStyle () const |
| Retrieves the line style. More... | |
| IlUShort | getLineWidth () const |
| Retrieves the line width. More... | |
| virtual IlvLookFeelHandler * | getLookFeelHandler () const |
| Returns the look & feel handler used by this object. More... | |
| virtual int | getLookupStringInputMethod (IlvEvent &event, char *bufferReturn, int bytesBuffer, int *statusReturn) |
| Gets the preedit string from an input method. More... | |
| IlvDrawMode | getMode () const |
| Retrieves the draw mode. More... | |
| IlBoolean | getOverwrite () const |
| Retrieves the overwrite mode. More... | |
| IlvPalette * | getPalette () const |
| Retrieves the internal palette value. More... | |
| IlvPattern * | getPattern () const |
| Retrieves the pattern. More... | |
| virtual void | invert (IlBoolean=IlFalse) |
| Highlights the object. More... | |
| virtual void | registerInputMethod () const |
| Controls the connection of a graphic object to an input method. 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 | 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 | setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const |
| Controls the interaction between a simple graphic object and an input method. 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... | |
| virtual void | setOverwrite (IlBoolean) |
| Sets an overwrite mode that modifies how the drawing member functions operate. More... | |
| virtual void | setPattern (IlvPattern *) |
| Sets the pattern of the object. More... | |
| virtual void | setValuesInputMethod (IlUShort count, const IlvImValue *values) const |
| Controls the interaction between a graphic object and an input method. More... | |
| virtual void | unRegisterInputMethod () const |
| Controls the disconnection of a graphic object from an input method. More... | |
| virtual void | unsetFocusInputMethod () const |
| Controls the interaction between a graphic object and an input method. 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 | 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 void | getAccessors (const IlSymbol *const **, const IlvValueTypeClass *const **, IlUInt &) const |
| Retrieves the list of available accessors of an 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 a name. More... | |
| virtual IlUInt | getChildCount () const |
| Returns the number of children of this graphic object. More... | |
| virtual IlInt | getChildIndex (const IlvGraphic *object) const |
| Returns the index of the specified sub-object in this graphic object. More... | |
| virtual IlvGraphic *const * | getChildren (IlUInt &count) const |
| Returns an array containing the sub-objects of this graphic object. More... | |
| virtual IlvClassInfo * | getClassInfo () const |
| Gets class information. More... | |
| IlAny | getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const |
| Retrieves the indicated property value in the class of this object. More... | |
| IlAny | getClientData () const |
| Gets client data. More... | |
| virtual const char * | getDefaultInteractor () const |
| Gets the name of the default interactor for this object. More... | |
| virtual IlvGraphicHolder * | getHolder () const |
| Gets a pointer to an object's holder. More... | |
| IlvInteractor * | getInteractor () const |
| Returns the interactor associated with the current object. More... | |
| 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... | |
| 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 | 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... | |
| virtual IlBoolean | zoomable () const |
| Checks whether this object is zoomable. More... | |
| Public Member Functions inherited from IlvValueInterface | |
| virtual IlBoolean | applyValue (const IlvValue &value) |
| Apply an accessor. More... | |
| virtual IlBoolean | changeValue (const IlvValue &val) |
| Changes the value of an accessor. More... | |
| virtual IlBoolean | changeValues (const IlvValue *values, IlUShort count=0) |
| Changes several accessor values simultaneously. More... | |
| virtual IlvValue & | queryValue (IlvValue &val) const |
| Retrieves an accessor value. More... | |
| virtual void | queryValues (IlvValue *values, IlUShort count) const |
| Retrieves multiple accessor values simultaneously. More... | |
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... | |
View rectangle class.
Library: views
The IlvContainerRectangle class defines a graphic object that encapsulates an instance of IlvContainer. This instance can be associated with a file name. When the container is created, it reads the corresponding file.
IlvContainer. | IlvContainerRectangle::IlvContainerRectangle | ( | IlvDisplay * | display, |
| const IlvRect & | rect, | ||
| IlvPalette * | palette = 0 |
||
| ) |
Constructor.
Initializes a new instance of the IlvContainerRectangle class.
| display | The connection to the display. |
| rect | The size and position of the object. |
| palette | The palette used to draw the object. The palette background color is set to the background color of the encapsulated container. |
|
virtual |
Creates the view.
The new view object is created visible. This virtual member function lets you create graphic objects that store new types of IlvView objects. This member function is called by makeView.
| parent | The parent view of the created view. |
| size | The dimensions of the view that is created. |
makeView. Reimplemented from IlvViewRectangle.
|
virtual |
Returns a pointer to the encapsulated container object.
| const char* IlvContainerRectangle::getFilename | ( | ) | const |
Returns the file name associated with this object.
This file is read by the container upon its creation.
0 if there is none.
|
virtual |
Sets up the view.
Makes the IlvView object, meaning that is creates the view by calling the above createView member function, and sets the current background and the delete callback.
This function is called by draw when the view has not yet been created.
| dst | The destination port where the object is displayed. |
| t | The transformer applied to the object's drawing. |
Reimplemented from IlvViewRectangle.
Sets the name of the file associated with the container.
This file is read by the container upon its creation.
| name | The name of the file to load. |
| redraw | A Boolean value indicating whether to redraw the container or not. |
© 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.