Class CEikMsgWin

CEikMsgWin

Support

Supported from 6.0

Description

Base class providing functions to construct and display an information message.

Derivation

CBase Base class for all classes to be instantiated on the heap CEikMsgWin Base class providing functions to construct and display an information message

Defined in CEikMsgWin:
CEikMsgWin(), CancelDisplay(), ConstructL(), StartDisplay(), iBlankWindow, iDummy, iEikonEnv_, iMessageWindow, ~CEikMsgWin()

Inherited from CBase:
operator new()

protected: CEikMsgWin(CEikonEnv& aEikonEnv);

Description

Protected constructor.

Parameters

CEikonEnv& aEikonEnv The Uikon environment for which the information message is constructed.

void ConstructL(RWindowGroup& aWindowGroup);

Description

Completes construction.

Parameters

RWindowGroup& aWindowGroup The window group for which the information message is constructed.

virtual ~CEikMsgWin();

Description

Destructor.

void StartDisplay(const TDesC& aText, TGulAlignment aCorner);

Description

Displays the message window with the specified text and alignment.

Parameters

const TDesC& aText The text to display in the message. TGulAlignment aCorner The position in which the message window will appear. There are 9 options for this, each square of a 3 by 3 matrix on the screen.

void CancelDisplay();

Description

Stops displaying the message window.

RBlankWindow* iBlankWindow;

Description

The window in which the message will be drawn.

CCoeControl* iDummy;

Description

An empty control required for construction of a blank window. This defines a handle back to the client side object, which is only required if you need to later initiate client side drawing.

CEikonEnv& iEikonEnv_;

Description

A CEikonEnv*, which all applications have. This is required for construction of a CEikMsgWin as it provides access to services which the message window needs, the window server session for example.

RMessageWindow* iMessageWindow;

Description

An RAnim derived class, which is responsible for interacting with server side classes to provide the message window's animation on the screen. It is constructed by passing in the RwindowBase which it will use to draw its contents to, and also a handle to an animation DLL, which provides the animation functionality.