RMessageWindow Class Reference

#include <mw/clock.h>

Link against: eikcore.lib

class RMessageWindow : public RAnimWithUtils

Inherits from

Public Member Enumerations
enumanonymous { EMaxTextLength }
Public Member Functions
RMessageWindow(RAnimDll &, const RWindowBase &)
IMPORT_C voidCancelDisplay()
IMPORT_C voidConstructL(TInt, TInt, TRgb, TRgb)
IMPORT_C voidConstructL(TInt, TInt, TRgb, TRgb, TRgb)
IMPORT_C voidGetBorders(TMargins &)
IMPORT_C voidSetBackgroundColor(TRgb)
IMPORT_C voidSetBorderColor(TRgb)
IMPORT_C voidSetPlinthColors(TRgb, TRgb)
IMPORT_C voidSetTextColor(TRgb)
IMPORT_C voidStartDisplay(TBool, TTimeIntervalMicroSeconds32, const TDesC &)
IMPORT_C voidStartDisplay(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.

See also: CEikMsgWin CEikonEnv

Member Enumeration Documentation

Enum anonymous

Defines the maximum length of text in the message.

EnumeratorValueDescription
EMaxTextLength80

Maximum length of text in the message.

Constructor & Destructor Documentation

RMessageWindow ( RAnimDll &, const RWindowBase & )

IMPORT_CRMessageWindow(RAnimDll &aAnimDll,
const RWindowBase &aWindow
)

Member Function Documentation

CancelDisplay ( )

IMPORT_C voidCancelDisplay()

ConstructL ( TInt, TInt, TRgb, TRgb )

IMPORT_C voidConstructL(TIntaBaselineOffset,
TIntaFontHandle,
TRgbaBackgroundColor,
TRgbaTextColor
)

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

IMPORT_C voidConstructL(TIntaBaselineOffset,
TIntaFontHandle,
TRgbaBackgroundColor,
TRgbaTextColor,
TRgbaBorderColor
)

GetBorders ( TMargins & )

IMPORT_C voidGetBorders(TMargins &aBorders)

SetBackgroundColor ( TRgb )

IMPORT_C voidSetBackgroundColor(TRgbaBackgroundColor)

SetBorderColor ( TRgb )

IMPORT_C voidSetBorderColor(TRgbaBorderColor)

SetPlinthColors ( TRgb, TRgb )

IMPORT_C voidSetPlinthColors(TRgbaTl,
TRgbaBr
)

SetTextColor ( TRgb )

IMPORT_C voidSetTextColor(TRgbaTextColor)

StartDisplay ( TBool, TTimeIntervalMicroSeconds32, const TDesC & )

IMPORT_C voidStartDisplay(TBoolaFlash,
TTimeIntervalMicroSeconds32aInitialDelay,
const TDesC &aText
)

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

IMPORT_C voidStartDisplay(TBoolaFlash,
TTimeIntervalMicroSeconds32aInitialDelay,
TTimeIntervalMicroSeconds32aDuration,
const TDesC &aText
)