Collapse all Symbian^3 Application Developer Library

TAknEditorCaseState Class Reference

class TAknEditorCaseState

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

Public Member Functions
	TAknEditorCaseState ()
IMPORT_C void	ClearFlag ( TCaseStateFlags )
IMPORT_C TUint	CurrentCase ()
IMPORT_C TBool	IsFlagSet ( TCaseStateFlags )
IMPORT_C TUint	PreviousCase ()
IMPORT_C TUint	PreviousCaseUsedToEnterText ()
IMPORT_C void	SetCurrentCase ( TUint )
IMPORT_C void	SetFlag ( TCaseStateFlags )
IMPORT_C void	SetPreviousCase ( TUint )
IMPORT_C void	SetPreviousCaseUsedToEnterText ( TUint )

Public Member Enumerations
enum	TCaseStateFlags { EFlagTextEnteredInCurrentCase = 0x00000001, EFlagInitialiseRequired = 0x00000002, EFlagSupressAutoUpdateCase = 0x00000004 }

Private Attributes
TUint8	iCurrentCase
TUint8	iFlags
TUint8	iPreviousCase
TUint8	iPreviousCaseUsedToEnterText
TInt	iSpare

Constructor & Destructor Documentation

TAknEditorCaseState()

IMPORT_C

TAknEditorCaseState

(

)

C++ default constructor.

TAknEditorCaseState

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

Member Functions Documentation

ClearFlag(TCaseStateFlags)

IMPORT_C void

ClearFlag

(

TCaseStateFlags

aFlag

)

Clear the given flag.

Parameters

TCaseStateFlags aFlag

a Flag to be cleared.

CurrentCase()

IMPORT_C TUint

CurrentCase

(

)

const

Gets current case.

IsFlagSet(TCaseStateFlags)

IMPORT_C TBool

IsFlagSet

(

TCaseStateFlags

aFlag

)

const

Tells whether the given flag is set or not.

Parameters

TCaseStateFlags aFlag

The flag to check.

PreviousCase()

IMPORT_C TUint

PreviousCase

(

)

const

Gets previous case.

PreviousCaseUsedToEnterText()

IMPORT_C TUint

PreviousCaseUsedToEnterText

(

)

const

Gets previous case used to enter text.

SetCurrentCase(TUint)

IMPORT_C void

SetCurrentCase

(

TUint

aCase

)

Sets current case.

Parameters

TUint aCase

A new case.

SetFlag(TCaseStateFlags)

IMPORT_C void

SetFlag

(

TCaseStateFlags

aFlag

)

Sets a flag.

Parameters

TCaseStateFlags aFlag

a Flag to be set.

SetPreviousCase(TUint)

IMPORT_C void

SetPreviousCase

(

TUint

aCase

)

Sets previous case.

Parameters

TUint aCase

a Previously used case.

SetPreviousCaseUsedToEnterText(TUint)

IMPORT_C void

SetPreviousCaseUsedToEnterText

(

TUint

aCase

)

Sets previous case used to enter text.

Parameters

TUint aCase

Previously used case to enter text.

Member Enumerations Documentation

Enum TCaseStateFlags

Flags that indicate states of the case.

Enumerators

EFlagTextEnteredInCurrentCase = 0x00000001	Has text been entered with current case.
EFlagInitialiseRequired = 0x00000002	Initialisation is required.
EFlagSupressAutoUpdateCase = 0x00000004	Supress case's automatic update.