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:

List of all members.

Public Member Functions
	IlvViewCOMAdapter (char const *identifier, IlvDisplay *display, char const *name, char const *title, IlvRect const &dims, IlUInt properties, IlBoolean visible=((IlBoolean) 1), IlvSystemView transientFor=0)
	Constructor.
	IlvViewCOMAdapter (char const *identifier, IlvDisplay *display, char const *name, char const *title, IlvRect const &dims, IlBoolean visible=((IlBoolean) 1))
	Constructor.
	IlvViewCOMAdapter (char const *identifier, IlvAbstractView *parent, IlvRect const &dims, IlBoolean visible=((IlBoolean) 1))
	Constructor.
IOleObject *	getOleInterface () const
	Returns a pointer to an IOleObject interface.
HRESULT	queryInterface (REFIID iid, void **ppvObject)
	Encapsulates the IUnknown::QueryInterface COM API for the ActiveX associated with this view.

---

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 = ((IlBoolean) 1)
	)

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:

	identifier	The 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.
	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.

IlvViewCOMAdapter::IlvViewCOMAdapter	(	char const *	identifier,
		IlvDisplay *	display,
		char const *	name,
		char const *	title,
		IlvRect const &	dims,
		IlBoolean	visible = ((IlBoolean) 1)
	)

Constructor.

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

Parameters:

	identifier	The 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.
	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.

IlvViewCOMAdapter::IlvViewCOMAdapter	(	char const *	identifier,
		IlvDisplay *	display,
		char const *	name,
		char const *	title,
		IlvRect const &	dims,
		IlUInt	properties,
		IlBoolean	visible = ((IlBoolean) 1),
		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:

	identifier	The 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.
	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.

---

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:

	Identifier	of the interface being requested.
	Address	of 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.