RMessageWindow Class Reference

#include <mw/clock.h>

Link against: clock.lib

class RMessageWindow : public RAnimWithUtils

Inherits from

RMessageWindow
- RAnimWithUtils
  - RAnim

Public Member Enumerations
enum	anonymous { EMaxTextLength }

Public Member Functions
	RMessageWindow(RAnimDll &, const RWindowBase &)
IMPORT_C void	CancelDisplay()
IMPORT_C void	ConstructL(TInt, TInt, TRgb, TRgb)
IMPORT_C void	ConstructL(TInt, TInt, TRgb, TRgb, TRgb)
IMPORT_C void	GetBorders(TMargins &)
IMPORT_C void	SetBackgroundColor(TRgb)
IMPORT_C void	SetBorderColor(TRgb)
IMPORT_C void	SetPlinthColors(TRgb, TRgb)
IMPORT_C void	SetTextColor(TRgb)
IMPORT_C void	StartDisplay(TBool, TTimeIntervalMicroSeconds32, const TDesC &)
IMPORT_C void	StartDisplay(TBool, TTimeIntervalMicroSeconds32, TTimeIntervalMicroSeconds32, const TDesC &)

Inherited Functions
	RAnim::AsyncCommandReply(TRequestStatus &,TInt,const TIpcArgs &)
	RAnim::Command(TInt)
	RAnim::Command(TInt,const TPtrC8 &)
	RAnim::CommandReply(TInt)
	RAnim::CommandReply(TInt,const TDesC8 &,const TIpcArgs &)
	RAnim::CommandReply(TInt,const TPtrC8 &)
	RAnim::Construct(const RWindowBase &,TInt,const TDesC8 &)
	RAnim::Construct(const RWindowBase &,TInt,const TDesC8 &,const TIpcArgs &)
	RAnim::Construct(const RWsSprite &,TInt,const TDesC8 &)
	RAnim::Construct(const RWsSprite &,TInt,const TDesC8 &,const TIpcArgs &)
	RAnim::Destroy()
	RAnim::RAnim()
	RAnim::RAnim(RAnimDll &)
	RAnim::~RAnim()
	RAnimWithUtils::AppendToConstructorBufL(const TDesC8 &)
	RAnimWithUtils::Close()
	RAnimWithUtils::ConstructorBuf()const
	RAnimWithUtils::ConstructorBufAlreadySent()const
	RAnimWithUtils::ConstructorBufExists()const
	RAnimWithUtils::RAnimWithUtils(RAnimDll &,const RWindowBase &)
	RAnimWithUtils::SendConstructorBufIfCompleteL(TInt)
	RAnimWithUtils::SendConstructorBufL(TInt)
	RAnimWithUtils::SetNumAdditionsStillExpected(TInt)

Detailed Description

A configurable window that appears for a brief time to display a message to the user and then disappears.

This is the basic class that is used by classes such as CEikonEnv and CEikMsgWin to provide information and message windows. Such higher-level classes would normally be used by client applications rather than RMessageWindow. This class can be used though to implement specialist new classes.

Note that this class is in the same library as the Clock API for implementation reasons only.

Member Enumeration Documentation

Enum anonymous

Defines the maximum length of text in the message.

Enumerator	Value	Description
EMaxTextLength	80	Maximum length of text in the message.

Constructor & Destructor Documentation

RMessageWindow ( RAnimDll &, const RWindowBase & )

IMPORT_C	RMessageWindow	(	RAnimDll &	aAnimDll,
			const RWindowBase &	aWindow
		)

Constructor.

Parameters
aAnimDll	This RAnimDll must have been loaded with the server-side message window animation DLL, clocka.dll.
aWindow	Window to which to add the message window.

Member Function Documentation

CancelDisplay ( )

IMPORT_C void

CancelDisplay

(

)

Cancels the display of the window.

ConstructL ( TInt, TInt, TRgb, TRgb )

IMPORT_C void	ConstructL	(	TInt	aBaselineOffset,
			TInt	aFontHandle,
			TRgb	aBackgroundColor,
			TRgb	aTextColor
		)

Performs second-phase construction.

Parameters
aBaselineOffset	Height of window in pixels above the font's baseline.
aFontHandle	Handle to the font to use. This can be obtained with CFbsFont::Handle().
aBackgroundColor	Window's background colour.
aTextColor	Message text colour.

ConstructL ( TInt, TInt, TRgb, TRgb, TRgb )

IMPORT_C void	ConstructL	(	TInt	aBaselineOffset,
			TInt	aFontHandle,
			TRgb	aBackgroundColor,
			TRgb	aTextColor,
			TRgb	aBorderColor
		)

Performs second-phase construction, with a window border colour.

Parameters
aBaselineOffset	Height of window in pixels above the font's baseline.
aFontHandle	Handle to the font to use. This can be obtained with CFbsFont::Handle().
aBackgroundColor	Window's background colour.
aTextColor	Message text colour.
aBorderColor	Window border colour.

GetBorders ( TMargins & )

IMPORT_C void

GetBorders

(

TMargins &

aBorders

)

Gets the widths of the window's borders.

Parameters
aBorders	On return, the widths of the window's borders

SetBackgroundColor ( TRgb )

IMPORT_C void

SetBackgroundColor

(

TRgb

aBackgroundColor

)

Sets the background colour for the window.

Parameters
aBackgroundColor	Background colour.

SetBorderColor ( TRgb )

IMPORT_C void

SetBorderColor

(

TRgb

aBorderColor

)

Sets the window border colour.

Parameters
aBorderColor	Window border colour.

SetPlinthColors ( TRgb, TRgb )

IMPORT_C void	SetPlinthColors	(	TRgb	aTl,
			TRgb	aBr
		)

Sets the plinth colours.

Parameters
aTl	Colour to use around the top and left borders.
aBr	Colour to use around the bottom and right borders.

SetTextColor ( TRgb )

IMPORT_C void

SetTextColor

(

TRgb

aTextColor

)

Sets the message text colour.

Parameters
aTextColor	Message text colour.

StartDisplay ( TBool, TTimeIntervalMicroSeconds32, const TDesC & )

IMPORT_C void	StartDisplay	(	TBool	aFlash,
			TTimeIntervalMicroSeconds32	aInitialDelay,
			const TDesC &	aText
		)

Displays the message window for a specified time.

Parameters
aFlash	Set this to true to make the message window flash.
aInitialDelay	Duration for which to display the message window.
aText	Text to put in the window.

StartDisplay ( TBool, TTimeIntervalMicroSeconds32, TTimeIntervalMicroSeconds32, const TDesC & )

IMPORT_C void	StartDisplay	(	TBool	aFlash,
			TTimeIntervalMicroSeconds32	aInitialDelay,
			TTimeIntervalMicroSeconds32	aDuration,
			const TDesC &	aText
		)

Displays the message window for a specified time with an initial delay.

Parameters
aFlash	Set this to true to make the message window flash.
aInitialDelay	Initial delay before showing the window.
aDuration	Duration for which to display the message window.
aText	Text to put in the window.