TAknEditorCaseState Class Reference

#include <mw/aknedsts.h>

class TAknEditorCaseState
Public Member Enumerations
enumTCaseStateFlags { EFlagTextEnteredInCurrentCase, EFlagInitialiseRequired, EFlagSupressAutoUpdateCase }
Public Member Functions
TAknEditorCaseState()
IMPORT_C voidClearFlag(TCaseStateFlags)
IMPORT_C TUintCurrentCase()
IMPORT_C TBoolIsFlagSet(TCaseStateFlags)
IMPORT_C TUintPreviousCase()
IMPORT_C TUintPreviousCaseUsedToEnterText()
IMPORT_C voidSetCurrentCase(TUint)
IMPORT_C voidSetFlag(TCaseStateFlags)
IMPORT_C voidSetPreviousCase(TUint)
IMPORT_C voidSetPreviousCaseUsedToEnterText(TUint)

Detailed Description

Data structure to store current state of case modes.

Data structure to hold the current state of all case state information currently held by the fep and applicable to an editor.

Since
Series 60 0.9

Member Enumeration Documentation

Enum TCaseStateFlags

Flags that indicate states of the case.

EnumeratorValueDescription
EFlagTextEnteredInCurrentCase0x00000001

Has text been entered with current case.

EFlagInitialiseRequired0x00000002

Initialisation is required.

EFlagSupressAutoUpdateCase0x00000004

Supress case's automatic update.

Constructor & Destructor Documentation

TAknEditorCaseState ( )

IMPORT_CTAknEditorCaseState()

C++ default constructor.

Member Function Documentation

ClearFlag ( TCaseStateFlags )

IMPORT_C voidClearFlag(TCaseStateFlagsaFlag)

Clear the given flag.

ParameterDescription
aFlaga Flag to be cleared.

CurrentCase ( )

IMPORT_C TUintCurrentCase()const

Gets current case.

Returns: The current case.

IsFlagSet ( TCaseStateFlags )

IMPORT_C TBoolIsFlagSet(TCaseStateFlagsaFlag)const

Tells whether the given flag is set or not.

ParameterDescription
aFlagThe flag to check.

Returns: ETrue if flag is set, EFalse if not.

PreviousCase ( )

IMPORT_C TUintPreviousCase()const

Gets previous case.

Returns: The previous case.

PreviousCaseUsedToEnterText ( )

IMPORT_C TUintPreviousCaseUsedToEnterText()const

Gets previous case used to enter text.

Returns: The previous case used to enter text.

SetCurrentCase ( TUint )

IMPORT_C voidSetCurrentCase(TUintaCase)

Sets current case.

ParameterDescription
aCaseA new case.

SetFlag ( TCaseStateFlags )

IMPORT_C voidSetFlag(TCaseStateFlagsaFlag)

Sets a flag.

ParameterDescription
aFlaga Flag to be set.

SetPreviousCase ( TUint )

IMPORT_C voidSetPreviousCase(TUintaCase)

Sets previous case.

ParameterDescription
aCasea Previously used case.

SetPreviousCaseUsedToEnterText ( TUint )

IMPORT_C voidSetPreviousCaseUsedToEnterText(TUintaCase)

Sets previous case used to enter text.

ParameterDescription
aCasePreviously used case to enter text.
© Nokia 2011.