CAknEdwinState 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

Stores the (FEP) states of editor controls.


Public Member Functions
virtual	~CAknEdwinState ()
	Destructor.
	CAknEdwinState (MEikCcpuEditor *aCcpuState)
	C++ constructor.
IMPORT_C	CAknEdwinState ()
	C++ default constructor.
IMPORT_C void	SetObserver (MAknEdStateObserver *aObserver)
	Sets an observer for this control.
IMPORT_C void	ReportAknEdStateEventL (MAknEdStateObserver::EAknEdwinStateEvent aEventType)
	From `MAknEdStateObserver`.
IMPORT_C TInt	Flags () const
	Returns control's flags.
IMPORT_C TInt	DefaultInputMode () const
	Get default input mode for the editor.
IMPORT_C TInt	CurrentInputMode () const
	Get current input mode for the editor.
IMPORT_C TInt	PermittedInputModes () const
	Get permitted input modes for the editor.
IMPORT_C TInt	DefaultCase () const
	Get default case for the editor.
IMPORT_C TInt	CurrentCase () const
	Get current character case for the editor.
IMPORT_C TInt	PermittedCases () const
	Get permitted cases for the editor.
IMPORT_C TInt	DefaultLanguage () const
	T9 language codes are not anymore supported, use `LocalLanguage()` instead.
IMPORT_C TInt	SpecialCharacterTableResourceId () const
	Get editor specific special character table resource ID.
IMPORT_C TAknEditorNumericKeymap	NumericKeymap () const
	Get number mode key mapping for '*' and '#' keys.
IMPORT_C TCursorSelection	CurrentInlineEditSpan () const
	Get the cursor or cursor selection within a document.
IMPORT_C SEditorCbaState &	CbaState ()
	Get control's CBA state.
IMPORT_C CEikMenuBar *	MenuBar () const
	Get the control's menu bar.
IMPORT_C MEikCcpuEditor *	CcpuState () const
	Get an interface that provides ccpu (cut, copy, paste and undo) functionalities.
IMPORT_C MObjectProvider *	ObjectProvider () const
	Get control's object provider.
IMPORT_C TLanguage	LocalLanguage () const
	Get the control's input language.
IMPORT_C CAknEdwinFormAccessor *	FormAccessor () const
	Accessor for control's form.
IMPORT_C void	SetFlags (TInt aFlags)
	Set initial editor flags for the editor.
IMPORT_C void	SetDefaultInputMode (TInt aInputMode)
	Set default input mode for the editor.
IMPORT_C void	SetCurrentInputMode (TInt aInputMode)
	Updates editor input mode.
IMPORT_C void	SetPermittedInputModes (TInt aInputModes)
	Set permitted input modes for the editor.
IMPORT_C void	SetDefaultCase (TInt aCase)
	Set default case for the editor.
IMPORT_C void	SetCurrentCase (TInt aCase)
	Updates editor case.
IMPORT_C void	SetPermittedCases (TInt aCases)
	Set permitted cases for the editor.
IMPORT_C void	SetDefaultLanguage (TInt aLanguage)
	T9 language codes are not anymore supported.
IMPORT_C void	SetSpecialCharacterTableResourceId (TInt aResourceId)
	Set editor specific special character table.
IMPORT_C void	SetNumericKeymap (TAknEditorNumericKeymap aKeymap)
	Set number mode key mapping for '*' and '#' keys.
IMPORT_C void	SetInlineEditSpan (TCursorSelection aCurrentInlineEditSpan)
	Set the cursor or cursor selection within a document.
IMPORT_C void	SetCba ()
	Gets the control's button array from object provider and sets the softkey command id's to 0.
IMPORT_C void	SetMenu ()
	Sets the menu bar from the object provider.
IMPORT_C void	SetObjectProvider (MObjectProvider *aObjectProvider)
	Set the object provider for the control.
IMPORT_C void	SetLocalLanguage (TLanguage aLanguage)
	Set new local input language for the editor.
IMPORT_C void	SetFormAccessor (CAknEdwinFormAccessor *aFormAccessor)
	Set form accessor for this control.
IMPORT_C void	SetCcpuState (MEikCcpuEditor *aCcpuEditor)
	Set a control that implements ccpu (cut, copy, paste and undo) interface.
IMPORT_C void	SetMiddleSoftkeyCommandId (TInt aCommandId)
	Set middle sofkey command id.
IMPORT_C TInt	MiddleSoftkeyCommandId () const
	Return middle sofkey command id.
Friends
class	CT9FepControl
class	CT9FepCaseManager
class	CAknFepCaseManager
class	CAknFepManager
Data Structures
struct	SEditorCbaState
	Control's button array and softkey command id's. More...

Constructor & Destructor Documentation

virtual CAknEdwinState::~CAknEdwinState ( ) [virtual]

Destructor.

CAknEdwinState::CAknEdwinState

(

MEikCcpuEditor *

aCcpuState

)

C++ constructor.

Parameters:

aCcpuState Pointer to a control that implements MEikCcpuEditor interface.

IMPORT_C CAknEdwinState::CAknEdwinState

(

)

C++ default constructor.

Member Function Documentation

IMPORT_C SEditorCbaState& CAknEdwinState::CbaState

(

)

Get control's CBA state.

Returns:: Reference to SEditorCbaState struct.

IMPORT_C MEikCcpuEditor* CAknEdwinState::CcpuState

(

)

const

Get an interface that provides ccpu (cut, copy, paste and undo) functionalities.

Returns:: A pointer to a ccpu interface for this control.

IMPORT_C TInt CAknEdwinState::CurrentCase

(

)

const

Get current character case for the editor.

Returns:: Current character case.

IMPORT_C TCursorSelection CAknEdwinState::CurrentInlineEditSpan

(

)

const

Get the cursor or cursor selection within a document.

Returns:: The cursor or cursor selection within a document.

IMPORT_C TInt CAknEdwinState::CurrentInputMode

(

)

const

Get current input mode for the editor.

Returns:: Current input mode used in the editor.

IMPORT_C TInt CAknEdwinState::DefaultCase

(

)

const

Get default case for the editor.

The case is used when the editor is focused first time.

Returns:: Default character case.

IMPORT_C TInt CAknEdwinState::DefaultInputMode

(

)

const

Get default input mode for the editor.

The input mode is used when the editor is focused first time.

Returns:: Initial input mode to be used in the editor.

IMPORT_C TInt CAknEdwinState::DefaultLanguage

(

)

const

T9 language codes are not anymore supported, use LocalLanguage() instead.

Returns:: 0

IMPORT_C TInt CAknEdwinState::Flags

(

)

const

Returns control's flags.

Returns:: Flags.

IMPORT_C CAknEdwinFormAccessor* CAknEdwinState::FormAccessor

(

)

const

Accessor for control's form.

Returns:: A pointer to to the form accessor of this control.

IMPORT_C TLanguage CAknEdwinState::LocalLanguage

(

)

const

Get the control's input language.

Returns:: Language identity.

IMPORT_C CEikMenuBar* CAknEdwinState::MenuBar

(

)

const

Get the control's menu bar.

Returns:: A pointer to the control's menu bar.

IMPORT_C TInt CAknEdwinState::MiddleSoftkeyCommandId

(

)

const

Return middle sofkey command id.

Returns:: Current middle softkey command id.

IMPORT_C TAknEditorNumericKeymap CAknEdwinState::NumericKeymap

(

)

const

Get number mode key mapping for '*' and '#' keys.

The key mapping is used in editors when numeric input mode is used. Key mapping characters for '*' key are shown on special character table if also text input modes are allowed in the editor but the current input mode is numeric mode.

Returns:: Key mapping used in an editor with number input mode.

IMPORT_C MObjectProvider* CAknEdwinState::ObjectProvider

(

)

const

Get control's object provider.

Returns:: A pointer to control's object provider.

IMPORT_C TInt CAknEdwinState::PermittedCases

(

)

const

Get permitted cases for the editor.

Returns:: Case modes that are permitted in the editor.

IMPORT_C TInt CAknEdwinState::PermittedInputModes

(

)

const

Get permitted input modes for the editor.

Returns:: Input modes that are allowed in the editor.

IMPORT_C void CAknEdwinState::ReportAknEdStateEventL

(

MAknEdStateObserver::EAknEdwinStateEvent

aEventType

)

From MAknEdStateObserver.

Sends an state event to control's observer.

Parameters:

aEventType

Event type.

IMPORT_C void CAknEdwinState::SetCba

(

)

Gets the control's button array from object provider and sets the softkey command id's to 0.

IMPORT_C void CAknEdwinState::SetCcpuState

(

MEikCcpuEditor *

aCcpuEditor

)

Set a control that implements ccpu (cut, copy, paste and undo) interface.

Parameters:

aCcpuEditor Pointer to a control that implements MEikCcpuEditor interface.

IMPORT_C void CAknEdwinState::SetCurrentCase

(

TInt

aCase

)

Updates editor case.

FEP is automatically notified of the case change in editor state and FEP takes new case to use immediately. Available case flags from uikon.hrh are EAknEditorUpperCase, EAknEditorLowerCase and EAknEditorTextCase. This method should not be used to set initial case for the editor. Use SetDefaultCase() method instead for setting the initial case.

Parameters:

aCase

New case for the editor.

IMPORT_C void CAknEdwinState::SetCurrentInputMode

(

TInt

aInputMode

)

Updates editor input mode.

FEP is automatically notified of the new input mode in editor state and FEP takes new input mode to use immediatelly. Current inline editing is reset. This method should not be used for setting initial input mode for the editor. Use SetDefaultInputMode() method instead for setting initial input mode.

Parameters:

aInputMode

New input mode for the editor.

IMPORT_C void CAknEdwinState::SetDefaultCase

(

TInt

aCase

)

Set default case for the editor.

The case is used when the editor is focused first time. Available case flags from uikon.hrh are EAknEditorUpperCase, EAknEditorLowerCase and . EAknEditorTextCase is used if the initial case is not set from EDWIN resource DEFAULT_CASE or with this API.

Parameters:

aCase

Initial case to be used in the editor.

IMPORT_C void CAknEdwinState::SetDefaultInputMode

(

TInt

aInputMode

)

Set default input mode for the editor.

The input mode is used when the editor is focused first time. EAknEditorTextInputMode is used if the initial input mode is not set from EDWIN resource DEFAULT_INPUT_MODE or with this API.

Parameters:

aInputMode

Initial input mode to be used in the editor.

IMPORT_C void CAknEdwinState::SetDefaultLanguage

(

TInt

aLanguage

)

T9 language codes are not anymore supported.

Use SetLocalLanguage() instead.

IMPORT_C void CAknEdwinState::SetFlags

(

TInt

aFlags

)

Set initial editor flags for the editor.

Parameters:

aFlags

Avkon editor flags for the editor.

IMPORT_C void CAknEdwinState::SetFormAccessor

(

CAknEdwinFormAccessor *

aFormAccessor

)

Set form accessor for this control.

Parameters:

aFormAccessor

Pointer to a form accessor.

IMPORT_C void CAknEdwinState::SetInlineEditSpan

(

TCursorSelection

aCurrentInlineEditSpan

)

Set the cursor or cursor selection within a document.

Parameters:

aCurrentInlineEditSpan

New cursor or cursor selection within a document.

IMPORT_C void CAknEdwinState::SetLocalLanguage

(

TLanguage

aLanguage

)

Set new local input language for the editor.

Global input language changes have not effect for the input language but the user can still change the input language from the edit menu.

Parameters:

aLanguage

Editor local input language.

IMPORT_C void CAknEdwinState::SetMenu

(

)

Sets the menu bar from the object provider.

IMPORT_C void CAknEdwinState::SetMiddleSoftkeyCommandId

(

TInt

aCommandId

)

Set middle sofkey command id.

Parameters:

aId

New middle softkey command id.

IMPORT_C void CAknEdwinState::SetNumericKeymap

(

TAknEditorNumericKeymap

aKeymap

)

Set number mode key mapping for '*' and '#' keys.

The key mapping is used in editors when numeric input mode is used. Key mapping characters for '*' key are shown on special character table if also the text input modes are allowed in the editor but the current input mode is numeric mode. EAknEditorStandardNumberModeKeymap is used in editors that allow only numeric input if the mapping is not set from EDWIN resource NUMERIC_KEYMAP or with this API. EAknEditorAlphanumericNumberModeKeymap is used as default if the editor allows also text input mode.

Parameters:

aKeymap

Key mapping used in an editor with number input mode.

IMPORT_C void CAknEdwinState::SetObjectProvider

(

MObjectProvider *

aObjectProvider

)

Set the object provider for the control.

Parameters:

aObjectProvider

A pointer to a class that implements an object provider.

IMPORT_C void CAknEdwinState::SetObserver

(

MAknEdStateObserver *

aObserver

)

Sets an observer for this control.

Parameters:

aObserver

Pointer to an observer.

IMPORT_C void CAknEdwinState::SetPermittedCases

(

TInt

aCases

)

Set permitted cases for the editor.

Possible flags from uikon.hrh are EAknEditorAllCaseModes, EAknEditorUpperCase,EAknEditorLowerCase and EAknEditorTextCase. EAknEditorAllCaseModes is used if the value is not set from EDWIN resource ALLOWED_CASE_MODES or with this API.

Parameters:

aCases

Case modes that are available in the editor.

IMPORT_C void CAknEdwinState::SetPermittedInputModes

(

TInt

aInputModes

)

Set permitted input modes for the editor.

All input modes are allowed ( EAknEditorAllInputModes ) if the value is not set from EDWIN resource ALLOWED_INPUT_MODES or with this API.

Parameters:

aInputModes

Input modes that are allowed in the editor.

IMPORT_C void CAknEdwinState::SetSpecialCharacterTableResourceId

(

TInt

aResourceId

)

Set editor specific special character table.

Parameters:

aResourceId

Special character table dialog resource ID.

IMPORT_C TInt CAknEdwinState::SpecialCharacterTableResourceId

(

)

const

Get editor specific special character table resource ID.

Returns:: Special character table dialog resource ID.

Friends And Related Function Documentation

friend class CAknFepCaseManager [friend]

friend class CAknFepManager [friend]

friend class CT9FepCaseManager [friend]

friend class CT9FepControl [friend]

The documentation for this class was generated from the following file:

aknedsts.h

CAknEdwinState Class Reference

Capability Information

Detailed Description

Public Member Functions

Friends

Data Structures

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation