rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvATLModuleInitialization Class Reference

This class initializes the ATL library. More...

#include <ilviews/windows/atl.h>

Inheritance diagram for IlvATLModuleInitialization:
IlvAbstractLibraryInitialization

List of all members.

Public Member Functions

virtual HWND createControl (char const *identifier, IlvRect const &bbox, REFIID rIID, void **interf, IlvView *parent=0) const
 Create an ATL control.
HINSTANCE getHInstance () const
 Returns the handle to the application instance.

Static Public Member Functions

static IlvRefCountPtr
< IlvAbstractLibraryInitialization
GetInstance ()
 Returns an unique instance of this class.

Protected Member Functions

 IlvATLModuleInitialization (IlvDisplay *display)
 Constructor.
virtual ~IlvATLModuleInitialization ()
 Destructor.

Detailed Description

This class initializes the ATL library.

Library: ilvcom

It uses a mechanism of counting reference. When the counter is decreased to 0, the object is deleted and the ATL library is released.


Constructor & Destructor Documentation

IlvATLModuleInitialization::IlvATLModuleInitialization ( IlvDisplay display  )  [protected]

Constructor.

It is protected and is just intended to be called as part of the initialization of a derived class.
It initializes the ATL library.

Parameters:
display A pointer to an IlvDisplay.
virtual IlvATLModuleInitialization::~IlvATLModuleInitialization (  )  [protected, virtual]

Destructor.

It is protected and must not be called directly. It releases the ATL library.


Member Function Documentation

virtual HWND IlvATLModuleInitialization::createControl ( char const *  identifier,
IlvRect const &  bbox,
REFIID  rIID,
void **  interf,
IlvView parent = 0 
) const [virtual]

Create an ATL control.

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.
bbox The size of the control.
rIID The REFIID of the requested interface.
interf The variable where the returned interface is stored.
HINSTANCE IlvATLModuleInitialization::getHInstance (  )  const

Returns the handle to the application instance.

Returns:
The handle to the application instance.
static IlvRefCountPtr<IlvAbstractLibraryInitialization> IlvATLModuleInitialization::GetInstance (  )  [static]

Returns an unique instance of this class.

The instance is automatically locked through a reference counter. Once you don't need it anymore, just unlock it.

This function may throw an IlvATLLibraryInitializationError or an IlvATLInterfaceError exception.

Parameters:
display A pointer to an IlvDisplay.
Returns:
A pointer to an instance of this class.
See also:
IlvATLLibraryInitializationError, IlvATLInterfaceError.

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