S60 3rd Edition API Reference: TAknEditorCaseState Class Reference

TAknEditorCaseState Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib uiklaf.lib form.lib

Capability Information

Required Capabilities

None

#include <aknedsts.h>

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.


Public Types

enum  TCaseStateFlags { EFlagTextEnteredInCurrentCase = 0x00000001, EFlagInitialiseRequired = 0x00000002, EFlagSupressAutoUpdateCase = 0x00000004 }
 Flags that indicate states of the case. More...

Public Member Functions

IMPORT_C TAknEditorCaseState ()
 C++ default constructor.
IMPORT_C void SetCurrentCase (TUint aCase)
 Sets current case.
IMPORT_C void SetPreviousCase (TUint aCase)
 Sets previous case.
IMPORT_C void SetPreviousCaseUsedToEnterText (TUint aCase)
 Sets previous case used to enter text.
IMPORT_C TUint CurrentCase () const
 Gets current case.
IMPORT_C TUint PreviousCase () const
 Gets previous case.
IMPORT_C TUint PreviousCaseUsedToEnterText () const
 Gets previous case used to enter text.
IMPORT_C void SetFlag (TCaseStateFlags aFlag)
 Sets a flag.
IMPORT_C void ClearFlag (TCaseStateFlags aFlag)
 Clear the given flag.
IMPORT_C TBool IsFlagSet (TCaseStateFlags aFlag) const
 Tells whether the given flag is set or not.

Member Enumeration Documentation

enum TAknEditorCaseState::TCaseStateFlags
 

Flags that indicate states of the case.

Enumerator:
EFlagTextEnteredInCurrentCase  Has text been entered with current case.
EFlagInitialiseRequired  Initialisation is required.
EFlagSupressAutoUpdateCase  Supress case's automatic update.

Constructor & Destructor Documentation

IMPORT_C TAknEditorCaseState::TAknEditorCaseState (   ) 
 

C++ default constructor.

Member Function Documentation

IMPORT_C void TAknEditorCaseState::ClearFlag ( TCaseStateFlags  aFlag  ) 
 

Clear the given flag.

Parameters:
aFlag a Flag to be cleared.
IMPORT_C TUint TAknEditorCaseState::CurrentCase (   )  const
 

Gets current case.

Returns:
The current case.
IMPORT_C TBool TAknEditorCaseState::IsFlagSet ( TCaseStateFlags  aFlag  )  const
 

Tells whether the given flag is set or not.

Parameters:
aFlag The flag to check.
Returns:
ETrue if flag is set, EFalse if not.
IMPORT_C TUint TAknEditorCaseState::PreviousCase (   )  const
 

Gets previous case.

Returns:
The previous case.
IMPORT_C TUint TAknEditorCaseState::PreviousCaseUsedToEnterText (   )  const
 

Gets previous case used to enter text.

Returns:
The previous case used to enter text.
IMPORT_C void TAknEditorCaseState::SetCurrentCase ( TUint  aCase  ) 
 

Sets current case.

Parameters:
aCase A new case.
IMPORT_C void TAknEditorCaseState::SetFlag ( TCaseStateFlags  aFlag  ) 
 

Sets a flag.

Parameters:
aFlag a Flag to be set.
IMPORT_C void TAknEditorCaseState::SetPreviousCase ( TUint  aCase  ) 
 

Sets previous case.

Parameters:
aCase a Previously used case.
IMPORT_C void TAknEditorCaseState::SetPreviousCaseUsedToEnterText ( TUint  aCase  ) 
 

Sets previous case used to enter text.

Parameters:
aCase Previously used case to enter text.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top