Collapse all Symbian^3 Product Developer Library

CEikMsgWin Class Reference

class CEikMsgWin : public CBase

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

Inherits from

CEikMsgWin
- CBase

Public Member Functions
	~CEikMsgWin()
IMPORT_C void	CancelDisplay()
IMPORT_C void	ConstructL(RWindowGroup &)
IMPORT_C void	StartDisplay(const TDesC &, TGulAlignment)

Protected Member Functions
	CEikMsgWin(CEikonEnv &)
TDes &	PrepareDisplay(TDes &, TGulAlignment)

Private Member Functions
IMPORT_C void	CEikMsgWin_Reserved1()
IMPORT_C void	CEikMsgWin_Reserved2()
void	DoStartDisplay(const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
RBlankWindow *	iBlankWindow
CCoeControl *	iDummy
CEikonEnv &	iEikonEnv_
RMessageWindow *	iMessageWindow

Private Attributes
TInt	iCEikMsgWin_Spare1
CEikResourceChange *	iResourceChange

Constructor & Destructor Documentation

CEikMsgWin(CEikonEnv &)

IMPORT_C

CEikMsgWin

(

CEikonEnv &

aEikonEnv

)

[protected]

Protected constructor.

Parameters

CEikonEnv & aEikonEnv

The Uikon environment for which the information message is constructed.

~CEikMsgWin()

IMPORT_C

~CEikMsgWin

(

)

[virtual]

Destructor.

Member Functions Documentation

CEikMsgWin_Reserved1()

IMPORT_C void

CEikMsgWin_Reserved1

(

)

[private, virtual]

CEikMsgWin_Reserved2()

IMPORT_C void

CEikMsgWin_Reserved2

(

)

[private, virtual]

CancelDisplay()

IMPORT_C void

CancelDisplay

(

)

Stops displaying the message window.

ConstructL(RWindowGroup &)

IMPORT_C void

ConstructL

(

RWindowGroup &

aWindowGroup

)

Completes construction.

Parameters

RWindowGroup & aWindowGroup

The window group for which the information message is constructed.

DoStartDisplay(const TDesC &)

void

DoStartDisplay

(

const TDesC &

aText

)

[private, pure virtual]

Parameters

const TDesC & aText

PrepareDisplay(TDes &, TGulAlignment)

TDes &	PrepareDisplay	(	TDes &	aText,
			TGulAlignment	aCorner
		)	[protected]

Configures the message window, blank window and display text for specified alignment and display area.

Parameters

TDes & aText	The text to be displayed
TGulAlignment aCorner	Description of message window position.

StartDisplay(const TDesC &, TGulAlignment)

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

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.

Member Data Documentation

RBlankWindow * iBlankWindow

RBlankWindow *

iBlankWindow

[protected]

The window in which the message will be drawn.

TInt iCEikMsgWin_Spare1

TInt

iCEikMsgWin_Spare1

[private]

CCoeControl * iDummy

CCoeControl *

iDummy

[protected]

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_

CEikonEnv &

iEikonEnv_

[protected]

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

RMessageWindow *

iMessageWindow

[protected]

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.

CEikResourceChange * iResourceChange

CEikResourceChange *

iResourceChange

[private]