Class CEikMsgWin

class CEikMsgWin : public CBase;

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.

Members

Defined in CEikMsgWin:

• CEikMsgWin(CEikonEnv &)Protected constructor.
• CEikMsgWin_Reserved1()
• CEikMsgWin_Reserved2()
• CancelDisplay()Stops displaying the message window.
• ConstructL(RWindowGroup &)Completes construction.
• DoStartDisplay(const TDesC &)
• StartDisplay(const TDesC &,TGulAlignment)Displays the message window with the specified text and alignment.
• iBlankWindowThe window in which the message will be drawn.
• iDummyAn empty control required for construction of a blank window. This defines a han...
• iEikonEnv_A CEikonEnv*, which all applications have. This is required for construction of ...
• iMessageWindowAn RAnim derived class, which is responsible for interacting with server side cl...
• ~CEikMsgWin()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

protected: IMPORT_C CEikMsgWin(CEikonEnv &aEikonEnv);

Description

Protected constructor.

Parameters

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

IMPORT_C void ConstructL(RWindowGroup &aWindowGroup);

Description

Completes construction.

Parameters

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

IMPORT_C virtual ~CEikMsgWin();

Description

Destructor.

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

Description

Displays the message window with the specified text and alignment.

Parameters

const TDesC16 &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.

IMPORT_C void CancelDisplay();

Description

Stops displaying the message window.

private: IMPORT_C virtual void CEikMsgWin_Reserved1();

Description

private: IMPORT_C virtual void CEikMsgWin_Reserved2();

Description

private: virtual void DoStartDisplay(const TDesC &aText)=0;

Description

Parameters

const TDesC16 &aText

protected: 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.

protected: 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.

protected: RBlankWindow * iBlankWindow;

Description

The window in which the message will be drawn.

protected: 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.