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 | Static Public Member Functions | Protected Member Functions
IlvATLModuleInitialization Class Reference

This class initializes the ATL library. More...

#include <ilviews/windows/atl.h>

Inheritance diagram for IlvATLModuleInitialization:
IlvAbstractLibraryInitialization

Public Member Functions

virtual HWND createControl (char const *identifier, IlvRect const &bbox, REFIID rIID, void **interf, IlvView *parent=0) const
 Create an ATL control. More...
 
HINSTANCE getHInstance () const
 Returns the handle to the application instance. More...
 
- Public Member Functions inherited from IlvAbstractLibraryInitialization
virtual ~IlvAbstractLibraryInitialization ()=0
 The destructor. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

- Protected Types inherited from IlvAbstractLibraryInitialization
typedef IlvRefCountPtr
< IlvAbstractLibraryInitialization
CntPtr
 This typedef is a synonym for the type used to declare a reference counter on the inherited classes of this class.
 

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
displayA pointer to an IlvDisplay.
virtual IlvATLModuleInitialization::~IlvATLModuleInitialization ( )
protectedvirtual

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
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.
bboxThe size of the control.
rIIDThe REFIID of the requested interface.
interfThe 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
displayA 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.