RMessageWindow Class Reference

class RMessageWindow : public RAnimWithUtils

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.

CEikMsgWin CEikonEnv

Inherits from

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)
Public Member Enumerations
enum anonymous { EMaxTextLength  = 80 }

Constructor & Destructor Documentation

RMessageWindow(RAnimDll &, const RWindowBase &)

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

Parameters

RAnimDll & aAnimDll
const RWindowBase & aWindow

Member Functions Documentation

CancelDisplay()

IMPORT_C void CancelDisplay ( )

ConstructL(TInt, TInt, TRgb, TRgb)

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

Parameters

TInt aBaselineOffset
TInt aFontHandle
TRgb aBackgroundColor
TRgb aTextColor

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

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

Parameters

TInt aBaselineOffset
TInt aFontHandle
TRgb aBackgroundColor
TRgb aTextColor
TRgb aBorderColor

GetBorders(TMargins &)

IMPORT_C void GetBorders ( TMargins & aBorders )

Parameters

TMargins & aBorders

SetBackgroundColor(TRgb)

IMPORT_C void SetBackgroundColor ( TRgb aBackgroundColor )

Parameters

TRgb aBackgroundColor

SetBorderColor(TRgb)

IMPORT_C void SetBorderColor ( TRgb aBorderColor )

Parameters

TRgb aBorderColor

SetPlinthColors(TRgb, TRgb)

IMPORT_C void SetPlinthColors ( TRgb aTl,
TRgb aBr
)

Parameters

TRgb aTl
TRgb aBr

SetTextColor(TRgb)

IMPORT_C void SetTextColor ( TRgb aTextColor )

Parameters

TRgb aTextColor

StartDisplay(TBool, TTimeIntervalMicroSeconds32, const TDesC &)

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

Parameters

TBool aFlash
TTimeIntervalMicroSeconds32 aInitialDelay
const TDesC & aText

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

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

Parameters

TBool aFlash
TTimeIntervalMicroSeconds32 aInitialDelay
TTimeIntervalMicroSeconds32 aDuration
const TDesC & aText

Member Enumerations Documentation

Enum anonymous

Defines the maximum length of text in the message.

Enumerators

EMaxTextLength = 80

Maximum length of text in the message.