Class RMessageWindow

RMessageWindow

Support

Supported from 5.0

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 such classes 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.

Derivation

RAnim Client-side handle to a server-side animation class RAnimWithUtils Utility class to support clock animation RMessageWindow A configurable window that appears for a brief time to display a message to the user and then disappears

Defined in RMessageWindow:
EMaxTextLength, Anonymous, CancelDisplay(), ConstructL(), GetBorders(), RMessageWindow(), SetBackgroundColor(), SetBorderColor(), SetPlinthColors(), SetTextColor(), StartDisplay()

Inherited from RAnim:
Command(), CommandReply(), Construct(), Destroy()

Inherited from RAnimWithUtils:
Close()

See also:

• CEikMsgWin
• CEikonEnv

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

Description

Constructor.

Parameters

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

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

Description

Second-phase construction.

Parameters

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

See also:

• CFbsFont::Handle()

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

Support

Supported from 5.1

Description

Second-phase construction, with window border colour option.

Parameters

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

See also:

• CFbsFont::Handle()

void CancelDisplay();

Description

Cancels the display of the window.

void GetBorders(TMargins& aBorders);

Description

Gets the widths of the window's borders.

Parameters

TMargins& aBorders On return, widths of the window's borders

void SetBackgroundColor(TRgb aBackgroundColor);

Support

Supported from 5.1

Description

Sets the background colour for the window.

Parameters

TRgb aBackgroundColor Background colour

void SetBorderColor(TRgb aBorderColor);

Support

Supported from 5.1

Description

Sets the window border colour.

Parameters

TRgb aBorderColor Window border colour

void SetPlinthColors(TRgb aTl,TRgb aBr);

Support

Supported from 6.0

Description

Sets the plinth colours.

Parameters

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

void SetTextColor(TRgb aTextColor);

Support

Supported from 5.1

Description

Sets the message text colour.

Parameters

TRgb aTextColor Message text colour

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

Description

Display message window for a specified time.

Parameters

TBool aFlash Set this to true to make the message window flash TTimeIntervalMicroSeconds32 aInitialDelay Duration for which to display the message window const TDesC& aText Text to put in the window

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

Description

Display message window for a specified time with initial delay.

Parameters

TBool aFlash Set this to true to make the message window flash TTimeIntervalMicroSeconds32 aInitialDelay Initial delay before showing the window TTimeIntervalMicroSeconds32 aDuration Duration for which to display the message window const TDesC& aText Text to put in the window

Anonymous

Description

Defines the maximum length of text in the message.

EMaxTextLength Maximum length of text in the message