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 |
View class. More...
#include <ilviews/util/drview.h>
Public Member Functions | |
| IlvDrawingView (IlvAbstractView *parent, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvDrawingView (IlvDisplay *display, IlvSystemView parent, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvDrawingView (IlvDisplay *display, IlvSystemView available) | |
| Constructor. More... | |
| IlvDrawingView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvDrawingView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlUInt properties, IlBoolean visible=IlTrue, IlvSystemView transientFor=0) | |
| Constructor. More... | |
| virtual void | draw (const IlvRegion *clip=0) |
| Draws the view contents. More... | |
| virtual void | handleExpose (IlvEvent &event) |
| Handles a newly exposed region. More... | |
| virtual void | handleInput (IlvEvent &event) |
| Handles an input event. More... | |
| virtual void | reDraw (const IlvRegion *clip=0) |
| Redraws the entire view. More... | |
 Public Member Functions inherited from IlvView | |
| IlvView (IlvAbstractView *parent, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvView (IlvDisplay *display, IlvSystemView available) | |
| Constructor. More... | |
| IlvView (IlvDisplay *display, IlvSystemView parent, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlUInt properties, IlBoolean visible=IlTrue, IlvSystemView transientFor=0) | |
| Constructor. More... | |
| void | addProperty (const IlSymbol *key, IlAny value) |
| Adds a property to the view. More... | |
| virtual IlBoolean | applyValue (const IlvValue &) |
| Applies an accessor. More... | |
| void | ensureInScreen (IlvPos xMargin=0, IlvPos yMargin=0) |
| Ensures that the view remains visible. More... | |
| const char * | getName () const |
| Retrieves the name. More... | |
| IlAny | getProperty (const IlSymbol *key) const |
| Retrieves a property. More... | |
| const char * | getTitle () const |
| Retrieves the title of this view. More... | |
| IlBoolean | hasProperty (const IlSymbol *key) const |
| Checks the existence of a property. More... | |
| virtual void | hide () |
| Hides the view. More... | |
| void | iconBitmap (IlvBitmap *image, IlvBitmap *mask=0) |
| Sets the icon aspect. More... | |
| void | iconify () |
| Requests this window to iconify itself. More... | |
| virtual IlBoolean | isIconified () const |
| Retrieves the iconified state. More... | |
| IlBoolean | isModal () const |
| Queries the modality of this view. More... | |
| IlBoolean | isVisible () const |
| Retrieves the visibility. More... | |
| virtual void | move (const IlvPoint &point) |
| Moves the view. More... | |
| virtual void | moveResize (const IlvRect &rect) |
| Reshapes the view. More... | |
| void | moveToMouse (IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue) |
| Moves the view relative to the location of the mouse. More... | |
| void | moveToScreen (IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue) |
| Moves the view relative to the root window. More... | |
| void | moveToView (const IlvView *view, IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue) |
| Moves the view relative to another view. More... | |
| virtual IlvValue & | queryValue (IlvValue &) const |
| Retrieves the value of an accessor. More... | |
| virtual void | removeDeleteCallback (IlvDestroyCallback del=0, IlAny userArg=0) |
| Removes a Delete callback. More... | |
| virtual void | removeDestroyCallback (IlvDestroyCallback destroy=0, IlAny userArg=0) |
| Removes a Destroy callback. More... | |
| virtual void | removeExposeCallback (IlvExposeCallback expose=0, IlAny userArg=0) |
| Removes an Expose callback. More... | |
| virtual void | removeInputCallback (IlvInputCallback input=0, IlAny userArg=0) |
| Removes an Input callback. More... | |
| IlBoolean | removeProperty (const IlSymbol *key) |
| Removes a property. More... | |
| virtual void | removeResizeCallback (IlvResizeCallback resize=0, IlAny userArg=0) |
| Removes a Resize callback. More... | |
| IlBoolean | replaceProperty (const IlSymbol *key, IlAny value) |
| Replaces a property. More... | |
| virtual void | resize (IlvDim w, IlvDim h) |
| Resizes the view. More... | |
| virtual void | setDeleteCallback (IlvDestroyCallback del, IlAny userArg=0) |
| Sets a callback that watches for destruction. More... | |
| virtual void | setDestroyCallback (IlvDestroyCallback destroy, IlAny userArg=0) |
| Sets a callback for Destroy events. More... | |
| virtual void | setExposeCallback (IlvExposeCallback expose, IlAny userArg=0) |
| Sets a callback for Expose events. More... | |
| void | setIconTitle (const char *title) |
| Sets the iconified title of this view. More... | |
| virtual void | setInputCallback (IlvInputCallback input, IlAny userArg=0) |
| Sets a callback for Input events. More... | |
| void | setMaximumSize (IlvDim w, IlvDim h) |
| Sets the maximum size of this view. More... | |
| void | setMinimumSize (IlvDim w, IlvDim h) |
| Sets the minimum size of this view. More... | |
| virtual void | setName (const char *name) |
| Sets the name. More... | |
| void | setProperty (const IlSymbol *key, IlAny value) |
| Sets or removes a property. More... | |
| virtual void | setResizeCallback (IlvResizeCallback resize, IlAny userArg=0) |
| Sets a callback for Resize events. More... | |
| void | setShapeMask (IlvBitmap *mask, IlBoolean useTitle=IlFalse) |
| Sets a shape mask. More... | |
| virtual void | setTitle (const char *title) |
| Sets the title of the view. More... | |
| virtual void | show () |
| Shows the view. More... | |
| virtual IlBoolean | showModal (IlBoolean doesGrab=IlFalse, IlvCursor *cursor=0) |
| Shows the window in a modal mode. More... | |
| Public Member Functions inherited from IlvAbstractView | |
| virtual void | boundingBox (IlvRect &bbox) const |
| Retrieves the relative dimensions of the view. More... | |
| virtual IlBoolean | changeValue (const IlvValue &val) |
| Changes the value of an accessor. More... | |
| IlBoolean | enableMultitouch (IlBoolean enable) |
| Allows the view to receive multitouch events. More... | |
| void | ensureVisible (const IlvPoint &point) |
| Ensures that a point remains visible. More... | |
| void | ensureVisible (const IlvRect &rect) |
| Ensures that a rectangle remains visible.: More... | |
| virtual void | erase (const IlvRect &rect, IlBoolean reDraw=IlFalse) |
| Erases an area of this view. More... | |
| virtual void | erase (IlBoolean reDraw=IlFalse) |
| Entirely erases the view. More... | |
| virtual void | frameBBox (IlvRect &bbox) const |
| Retrieves the dimension of the view frame. More... | |
| IlvColor * | getBackground () const |
| Retrieves the background color of this view. More... | |
| IlvBitmap * | getBackgroundBitmap () const |
| Gets the background bitmap of this view. More... | |
| IlvCursor * | getCursor () const |
| Retrieves the cursor currently set in this view. More... | |
| IlvIntensity | getOpacity () const |
| Returns the opacity level of the view. More... | |
| IlvAbstractView * | getParent () const |
| Gets the parent of this view. More... | |
| IlvSystemView | getShellSystemView () const |
| Gets the system-dependent identifier of the top shell of this view. More... | |
| IlvSystemView | getSystemView () const |
| Gets the system-dependent identifier of this view. More... | |
| void | getTransparentColorKey (IlvIntensity &r, IlvIntensity &g, IlvIntensity &b) const |
| Returns the color used as a key for transparency. More... | |
| virtual void | globalBBox (IlvRect &bbox) const |
| Retrieves the absolute dimensions of the view. More... | |
| IlBoolean | hasGrab () const |
| Queries if this view has the display grab. More... | |
| IlBoolean | isLayered () const |
| Returns whether the view is layered or not. More... | |
| IlBoolean | isMultitouchEnabled () |
| Queries if the view is set to receive multitouch events. More... | |
| virtual IlBoolean | isScrolled () const |
| Queries for scrolling capabilities. More... | |
| IlBoolean | isSensitive () const |
| Retrieves the sensitivity of this view to input events. More... | |
| virtual void | lower () |
| Pushes this view below the others. More... | |
| virtual void | position (IlvPoint &position) const |
| Retrieves the position of the view. More... | |
| virtual void | raise () |
| Brings this view on top. More... | |
| void | removeWindowProc (IlvWindowProc windowProc, IlAny procArgument=0) |
| Removes a user-defined window procedure. More... | |
| virtual void | setBackground (IlvColor *c) |
| Sets the background color of this view. More... | |
| virtual void | setBackgroundBitmap (IlvBitmap *b) |
| Sets the background bitmap of this view. More... | |
| void | setCursor (IlvCursor *cursor) |
| Sets the cursor for this view. More... | |
| IlBoolean | setFocus () |
| Sets the input focus to this view. More... | |
| void | setLayered (IlBoolean layered) |
| Sets whether the window is layered or not. More... | |
| void | setOpacity (IlvIntensity level) |
| Sets the opacity value of the view. More... | |
| void | setSensitive (IlBoolean sensitivity) |
| Sets the sensitivity of this view to input events. More... | |
| void | setTransparentColorKey (IlvIntensity r, IlvIntensity g, IlvIntensity b) |
| Sets the transparency color key value. More... | |
| void | setWindowProc (IlvWindowProc windowProc, IlAny procArgument=0) |
| Sets a Windows window procedure. More... | |
| virtual void | sizeVisible (IlvRect &rect) const |
| Retrieves the visible part of the view. More... | |
| Public Member Functions inherited from IlvSystemPort | |
| IlvSystemPort (IlvDisplay *display, IlvWindowsHandle HDC, IlvDim width=0, IlvDim height=0) | |
| Windows-specific constructor. More... | |
| virtual void | clearArea (const IlvRect &, IlBoolean=IlFalse) const |
| Clears a rectangular area of the screen. More... | |
| virtual void | clearArea (const IlvRegion &, IlBoolean=IlFalse) const |
| Clears a region of the screen. More... | |
| virtual void | clip (const IlvRect *) const |
| Limits the drawing to the given rectangular area. More... | |
| virtual void | clip (const IlvRegion *) const |
| Limits the drawing to the given region. More... | |
| virtual IlUShort | depth () const |
| Gives the depth of the port. More... | |
| virtual void | drawArc (const IlvPalette *, const IlvRect &, IlFloat, IlFloat) const |
| Draws an arc. More... | |
| virtual void | drawBitmap (const IlvPalette *, const IlvSystemPort *, const IlvRect &, const IlvPoint &) const |
| Draws an image. More... | |
| virtual void | drawBitmap (const IlvPalette *, const IlvBitmap *, const IlvRect &, const IlvRegion *=0, IlvPosition=IlvCenter, IlBoolean=IlFalse) const |
| Draws an image. More... | |
| virtual void | drawIString (const IlvPalette *, const IlvPoint &, const char *, int, IlvPosition=IlvLeft) const |
| Draws a string at the given position. More... | |
| virtual void | drawLine (const IlvPalette *, const IlvPoint &, const IlvPoint &) const |
| Draws a line between 2 points. More... | |
| virtual void | drawPoint (const IlvPalette *, const IlvPoint &) const |
| Draws a point at the given position. More... | |
| virtual void | drawPoints (const IlvPalette *, IlUInt, const IlvPoint *) const |
| Draws a series of points. More... | |
| virtual void | drawPolyLine (const IlvPalette *, IlUInt, const IlvPoint *) const |
| Draws a series of connected lines. More... | |
| virtual void | drawPolyLine (const IlvPalette *, const IlvPoint &, IlUInt, const IlvDeltaPoint *) const |
| Draws a series of connected lines relatively to a reference. More... | |
| virtual void | drawRectangle (const IlvPalette *, const IlvRect &) const |
| Draws the given rectangle. More... | |
| virtual void | drawRoundRectangle (const IlvPalette *, const IlvRect &, IlUShort) const |
| Draws a round rectangle. More... | |
| virtual void | drawSegments (const IlvPalette *, IlUInt, const IlvPoint *, const IlvPoint *) const |
| Draws a set of segments. More... | |
| virtual void | drawString (const IlvPalette *, const IlvPoint &, const char *, int, IlvPosition=IlvLeft) const |
| Draws a string at the given position. More... | |
| virtual void | drawTransformedString (const IlvPalette *, const char *, int, const IlvTransformer &, const IlvRegion *=0) const |
| Draws a transformed string. More... | |
| virtual void | drawTransparentBitmap (const IlvPalette *, const IlvSystemPort *, const IlvRect &, const IlvPoint &) const |
| Draws a transparent bitmap. More... | |
| virtual void | end () |
| Closed the dump device. More... | |
| virtual void | fillArc (const IlvPalette *, const IlvRect &, IlFloat, IlFloat) const |
| Fills the arc. More... | |
| virtual void | fillPaths (const IlvPalette *, IlUInt, const IlvPointArray *) const |
| Fills the shape defined by the given paths. More... | |
| virtual void | fillPolyLine (const IlvPalette *, IlUInt, const IlvPoint *, IlBoolean=IlFalse) const |
| Fills a polygon. More... | |
| virtual void | fillPolyLine (const IlvPalette *, const IlvPoint &, IlUInt, const IlvDeltaPoint *, IlBoolean=IlFalse) const |
| Fills a polygon. More... | |
| virtual void | fillRectangle (const IlvPalette *, const IlvRect &) const |
| Fills the given rectangle. More... | |
| virtual void | fillRoundRectangle (const IlvPalette *, const IlvRect &, IlUShort) const |
| Fills a round rectangle. More... | |
| IlvWindowsHandle | getDC () const |
| Gets the Windows Handle Device Context. More... | |
| virtual IlBoolean | initDevice (const char *, IlvRect *=0) |
| Initializes the dump device. More... | |
| virtual IlBoolean | isABitmap () const |
| Indicates that this port is a bitmap (not a view or a dump device). More... | |
| virtual IlBoolean | isASystemPort () const |
| Indicates that this port is a true system port (not a dump device). More... | |
| virtual IlBoolean | isBad () const |
| Indicates whether this port is valid. More... | |
| virtual IlBoolean | newPage () const |
| Produces an output page and prepares for a new page. More... | |
| void | releaseDC () |
| Releases the Windows Handle Device Context. More... | |
| virtual void | send (const char *) const |
| Sends character strings to an output device. More... | |
| virtual void | setTransformer (const IlvTransformer &) |
| Applies another transformer to the coordinates provided for the drawing functions. More... | |
| virtual void | stretchBitmap (const IlvPalette *, const IlvPoint &, const IlvBitmap *, const IlvTransformer &, const IlvRect *=0) const |
| Stretches a bitmap. More... | |
| virtual void | stretchBitmap (const IlvPalette *, const IlvRect &, const IlvBitmap *, const IlvRect *=0) const |
| Stretches a bitmap. More... | |
| virtual void | stretchBitmapData (const IlvPalette *palette, const IlvBitmapData *src, const IlvRect &from, const IlvRect &to, IlBoolean opaque=IlFalse) const |
| Draws a bitmap data. More... | |
| virtual void | stretchTransparentBitmap (const IlvPalette *, const IlvPoint &, const IlvBitmap *, const IlvTransformer &, const IlvRect *=0) const |
| Stretches a transparent bitmap. More... | |
| virtual void | stretchTransparentBitmap (const IlvPalette *, const IlvRect &, const IlvBitmap *, const IlvRect *=0) const |
| Stretches a transparent bitmap. More... | |
| Public Member Functions inherited from IlvPort | |
| IlvPort (IlvDisplay *display=0) | |
| Constructor. More... | |
| void | composeAlpha (IlvIntensity alpha) |
| Composes the current alpha value of the port. More... | |
| virtual void | drawArrow (const IlvPalette *palette, const IlvPoint &from, const IlvPoint &to, IlFloat position) const |
| Draws an arrow. More... | |
| virtual void | drawBezier (const IlvPalette *palette, IlUInt count, const IlvPoint *points) const |
| Draws a set of Bzier curves. More... | |
| virtual void | drawClosedBezier (const IlvPalette *palette, IlUInt count, const IlvPoint *points) const |
| Appends a closing curve to a set of Bézier curves. More... | |
| virtual void | drawILabel (const IlvPalette *palette, const char *label, int length, const IlvRect &drawRect, const IlvRegion *clip=0, IlvPosition align=IlvCenter) const |
| Draws a label in a rectangle. More... | |
| virtual void | drawLabel (const IlvPalette *palette, const char *label, int length, const IlvRect &drawRect, const IlvRegion *clip=0, IlvPosition align=IlvCenter) const |
| Draws a label in a rectangle. More... | |
| virtual void | drawMarker (const IlvPalette *palette, const IlvPoint &location, IlvMarkerType type=IlvMarkerSquare, IlUShort size=IlvDefaultMarkerSize) const |
| Draws a marker. More... | |
| virtual void | drawMnemonicLabel (const IlvPalette *palette, const char *label, const IlvRect &drawRect, const IlvRegion *clip=0, IlvPosition align=IlvCenter, IlBoolean underline=IlTrue) const |
| Draws an underlined letter in a label. More... | |
| virtual void | drawOutlineRectangle (const IlvPalette *outlinePalette, const IlvPalette *fillPalette, const IlvRect &rect, const IlvRegion *clip=0) const |
| Draws a rectangle with border effects. More... | |
| virtual void | drawPaths (const IlvPalette *palette, IlUInt count, const IlvPointArray *paths) const |
| Draws an array of paths as polylines. More... | |
| virtual void | drawReliefDiamond (const IlvPalette *, const IlvPalette *invertedPalette, const IlvPalette *topShade, const IlvPalette *bottomShade, const IlvRect &bbox, IlUShort thickness, const IlvRegion *clip=0) const |
| Draws a diamond with depth effects. More... | |
| virtual void | drawReliefRectangle (const IlvPalette *palette, const IlvPalette *invertedPalette, const IlvPalette *topShade, const IlvPalette *bottomShade, const IlvRect &bbox, IlUShort thickness, const IlvRegion *clip=0) const |
| Draws a filled rectangle with depth effects. More... | |
| virtual void | drawShadowRectangle (const IlvPalette *palette, const IlvPalette *invertedPalette, const IlvRect &bbox, IlUShort thickness, IlvPosition shadowPosition, const IlvRegion *clip=0) const |
| Draws a filled rectangle with its shadow. More... | |
| virtual void | fillBezier (const IlvPalette *palette, IlUInt count, const IlvPoint *points) const |
| Fills an area specified by a set of Bézier curves. More... | |
| IlvIntensity | getAlpha () const |
| Provides the alpha value of the port. More... | |
| IlvAntialiasingMode | getAntialiasingMode () const |
| Provides the anti-aliasing mode of the port. More... | |
| IlvDisplay * | getDisplay () const |
Returns a pointer to the IlvDisplay of this port. More... | |
| IlvDim | height () const |
| Provides the height of the port. More... | |
| virtual IlBoolean | isADevice () const |
| Indicates that this port is a dump device. More... | |
| void | setAlpha (IlvIntensity alpha) |
| Sets the alpha value of the port. More... | |
| void | setAntialiasingMode (IlvAntialiasingMode mode) |
| Sets the anti-aliasing mode of the port. More... | |
| void | size (IlvDim &w, IlvDim &h) const |
| Gives the dimensions of the port. More... | |
| IlvDim | width () const |
| Provides the width of the port. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from IlvSystemPort | |
| static IlvBitmapData * | GetBitmapData (IlvSystemPort *port, const IlvRect *rect=0) |
Creates an IlvBitmapData from a rectangular area in an IlvSystemPort. More... | |
View class.
Library: display
When using the IlvView class hierarchy, you must specify the callback functions used to handle incoming events. The IlvDrawingView class has predefined member functions for this purpose.
| IlvDrawingView::IlvDrawingView | ( | IlvAbstractView * | parent, |
| const IlvRect & | size, | ||
| IlBoolean | visible = IlTrue |
||
| ) |
Constructor.
This constructor initializes a view object that is a child of the parent view.
| parent | The parent view. |
| size | The initial location and size of the view, in the coordinate system of parent. |
| visible | Can be set to IlFalse to initially hide the window. |
| IlvDrawingView::IlvDrawingView | ( | IlvDisplay * | display, |
| IlvSystemView | parent, | ||
| const IlvRect & | size, | ||
| IlBoolean | visible = IlTrue |
||
| ) |
Constructor.
This constructor creates a view that is a child of the existing system view indicated by parent.
| display | The display instance. |
| parent | The parent system view. |
| size | The initial location and size of the view, in the coordinate system of the existing system view. |
| visible | Can be set to IlFalse to initially hide the window. |
| IlvDrawingView::IlvDrawingView | ( | IlvDisplay * | display, |
| IlvSystemView | available | ||
| ) |
Constructor.
This constructor creates a new view object by actually using the existing system view indicated by available.
| display | The display instance. |
| available | The system view on which this IlvDrawingView is based. |
| IlvDrawingView::IlvDrawingView | ( | IlvDisplay * | display, |
| const char * | name, | ||
| const char * | title, | ||
| const IlvRect & | size, | ||
| IlBoolean | visible = IlTrue |
||
| ) |
Constructor.
This constructor initializes a view object that is a new top window.
| display | The display instance. |
| name | The name of this view (used by the resource association mechanism). |
| title | The title of this top window. |
| size | The initial location and size of the view, relative to the root window of display. |
| visible | Can be set to IlFalse to initially hide the window. |
| IlvDrawingView::IlvDrawingView | ( | IlvDisplay * | display, |
| const char * | name, | ||
| const char * | title, | ||
| const IlvRect & | size, | ||
| IlUInt | properties, | ||
| IlBoolean | visible = IlTrue, |
||
| IlvSystemView | transientFor = 0 |
||
| ) |
Constructor.
This constructor creates a top window, with an optional parameter properties that makes it possible to tune its aspect.
| display | The display instance. |
| name | The name of this view (used by the resource association mechanism). |
| title | The title of this top window. |
| size | The initial location and size of the view, relative to the root window of display. |
| properties | The properties of that view (see above). |
| visible | Can be set to IlFalse to initially hide the window. |
| transientFor | The possible system view for which this view is transient. If unspecified or set to 0, this view will not be transient for any view. |
|
virtual |
Draws the view contents.
This is the member function you will overload to perform the different drawing tasks that are needed by your application.
The default implementation does nothing.
| clip | The clipping region where the drawing must take place. If 0, there is no clipping region to be used. |
Reimplemented in IlvContainer.
|
virtual |
Handles a newly exposed region.
This member function is called when this view reveals new regions that must be updated.
The default implementation calls reDraw with the relevant exposed region.
| event | The event that is received for this expose event. |
Reimplemented in IlvContainer.
|
virtual |
Handles an input event.
This member function is called when an input event (keystrokes or mouse events) is received by this view.
Its default implementation does nothing.
| event | The input event that is received. |
Reimplemented in IlvContainer.
|
virtual |
Redraws the entire view.
The default implementation erases, if necessary, the background of the window then calls draw.
| clip | The clipping region to be refreshed. |
Reimplemented in IlvContainer.
© 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.