rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvViewCOMAdapter Class Reference

Class that encapsulate an ActiveX so that it may be used as an IlvView. More...

#include <ilviews/windows/comvadap.h>

Inheritance diagram for IlvViewCOMAdapter:
IlvView IlvAbstractView IlvSystemPort IlvPort

Public Member Functions

 IlvViewCOMAdapter (char const *identifier, IlvAbstractView *parent, IlvRect const &dims, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvViewCOMAdapter (char const *identifier, IlvDisplay *display, char const *name, char const *title, IlvRect const &dims, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvViewCOMAdapter (char const *identifier, IlvDisplay *display, char const *name, char const *title, IlvRect const &dims, IlUInt properties, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
IOleObject * getOleInterface () const
 Returns a pointer to an IOleObject interface. More...
 
HRESULT queryInterface (REFIID iid, void **ppvObject)
 Encapsulates the IUnknown::QueryInterface COM API for the ActiveX associated with this 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 IlvValuequeryValue (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...
 
IlvColorgetBackground () const
 Retrieves the background color of this view. More...
 
IlvBitmapgetBackgroundBitmap () const
 Gets the background bitmap of this view. More...
 
IlvCursorgetCursor () const
 Retrieves the cursor currently set in this view. More...
 
IlvIntensity getOpacity () const
 Returns the opacity level of the view. More...
 
IlvAbstractViewgetParent () 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...
 
IlvDisplaygetDisplay () 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 IlvBitmapDataGetBitmapData (IlvSystemPort *port, const IlvRect *rect=0)
 Creates an IlvBitmapData from a rectangular area in an IlvSystemPort. More...
 

Detailed Description

Class that encapsulate an ActiveX so that it may be used as an IlvView.

Library: ilvcom

See Also
IlvView.

Constructor & Destructor Documentation

IlvViewCOMAdapter::IlvViewCOMAdapter ( char const *  identifier,
IlvAbstractView parent,
IlvRect const &  dims,
IlBoolean  visible = IlTrue 
)

Constructor.

This constructor initializes a view adapter object of an ActiveX, specified by an identifier. The view is a child of the parent view.

Parameters
identifierThe identifier the control. This string can be a CLSID (with braces), a ProgID, a URL, or raw HTML (prefixed with MSHTML:). If either a URL or raw HTML is supplied, the Web browser will be loaded with this information.
parentThe parent view.
sizeThe initial location and size of the view, in the coordinate system of parent.
visibleCan be set to IlFalse to initially hide the window.
IlvViewCOMAdapter::IlvViewCOMAdapter ( char const *  identifier,
IlvDisplay display,
char const *  name,
char const *  title,
IlvRect const &  dims,
IlBoolean  visible = IlTrue 
)

Constructor.

This constructor initializes a view adapter object of an ActiveX, specified by an identifier. This view is a new top window.

Parameters
identifierThe identifier the control. This string can be a CLSID (with braces), a ProgID, a URL, or raw HTML (prefixed with MSHTML:). If either a URL or raw HTML is supplied, the Web browser will be loaded with this information.
displayThe display instance.
nameThe name of this view (used by the resource association mechanism).
titleThe title of this top window.
sizeThe initial location and size of the view, relative to the root window of display.
visibleCan be set to IlFalse to initially hide the window.
IlvViewCOMAdapter::IlvViewCOMAdapter ( char const *  identifier,
IlvDisplay display,
char const *  name,
char const *  title,
IlvRect const &  dims,
IlUInt  properties,
IlBoolean  visible = IlTrue,
IlvSystemView  transientFor = 0 
)

Constructor.

This constructor initializes an view adapter object of an ActiveX, specified by an identifier. This view is a new top window. This constructor has an optional parameter properties that makes it possible to tune its aspect. This parameter is an OR combination of these flags:

  • IlvStandardBorder: the new top window has regular window borders, banner and resize handles.
  • IlvNoBorder: the new top window has no border. Note that on X Window, setting the property IlvNoBorder is more than a decoration issue. The view creates an override-redirect window; thus, the window manager will ignore it. The application then acts as temporary window manager, which very few applications are prepared to do. The main purpose of IlvNoBorder is to create pop-up windows, like menus.
  • IlvNoResizeBorder: the new top window has no resize handle; thus, the user cannot resize this window.

The parameter transientFor specifies the system view for which the IlvView is transient. It may be any top-level system view and not necessarily encapsulated by a IlvView. Saying that a view v1 is transient for view v2 means that:

  • v1 cannot be iconified.
  • v1 is automatically unmapped when v2 is iconified.
  • v1 is always on top of v2 (in the windows stacking order).

This notion is applicable to views built as top-level windows ("shells" in Motif). Note that on Windows platforms, if v1 is transient for v2, then the destruction of v2 will automatically destroy v1 as well. You may have to protect your application against this by setting a delete callback on v1 (see setDeleteCallback).

Parameters
identifierThe identifier the control. This string can be a CLSID (with braces), a ProgID, a URL, or raw HTML (prefixed with MSHTML:). If either a URL or raw HTML is supplied, the Web browser will be loaded with this information.
displayThe display instance.
nameThe name of this view (used by the resource association mechanism).
titleThe title of this top window.
sizeThe initial location and size of the view, relative to the root window of display.
propertiesThe properties of that view (see above).
visibleCan be set to IlFalse to initially hide the window.
transientForThe possible system view for which this view is transient. If unspecified or set to 0, this view will not be transient for any view.

Member Function Documentation

IOleObject * IlvViewCOMAdapter::getOleInterface ( ) const

Returns a pointer to an IOleObject interface.

Returns
A pointer to the IOleObject interface used to create this object.
HRESULT IlvViewCOMAdapter::queryInterface ( REFIID  iid,
void **  ppvObject 
)

Encapsulates the IUnknown::QueryInterface COM API for the ActiveX associated with this view.

See the COM API documentation for more information.

Parameters
Identifierof the interface being requested.
Addressof pointer variable that receives the interface pointer requested in riid. Upon successful return, *ppvObject contains the requested interface pointer to the object. If the object does not support the interface specified in iid, *ppvObject is set to NULL.
Returns
S_OK if the interface is supported, E_NOINTERFACE if not.

© 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.