CAknEdwinState Class Reference

#include <mw/aknedsts.h>

class CAknEdwinState : public MCoeFepAwareTextEditor_Extension1::CState

Inherits from

CAknEdwinState

Nested Classes and Structures

CAknEdwinState::SEditorCbaState

Public Member Functions
	CAknEdwinState(MEikCcpuEditor *)
	CAknEdwinState()
virtual	~CAknEdwinState()
IMPORT_C SEditorCbaState &	CbaState()
IMPORT_C MEikCcpuEditor *	CcpuState()
IMPORT_C TInt	CurrentCase()
IMPORT_C TCursorSelection	CurrentInlineEditSpan()
IMPORT_C TInt	CurrentInputMode()
IMPORT_C TInt	DefaultCase()
IMPORT_C TInt	DefaultInputMode()
IMPORT_C TInt	DefaultLanguage()
IMPORT_C TInt	Flags()
IMPORT_C CAknEdwinFormAccessor *	FormAccessor()
IMPORT_C TLanguage	LocalLanguage()
IMPORT_C CEikMenuBar *	MenuBar()
IMPORT_C TInt	MiddleSoftkeyCommandId()
IMPORT_C TAknEditorNumericKeymap	NumericKeymap()
IMPORT_C MObjectProvider *	ObjectProvider()
IMPORT_C TInt	PermittedCases()
IMPORT_C TInt	PermittedInputModes()
IMPORT_C void	ReportAknEdStateEventL(MAknEdStateObserver::EAknEdwinStateEvent)
IMPORT_C void	SetCba()
IMPORT_C void	SetCcpuState(MEikCcpuEditor *)
IMPORT_C void	SetCurrentCase(TInt)
IMPORT_C void	SetCurrentInputMode(TInt)
IMPORT_C void	SetDefaultCase(TInt)
IMPORT_C void	SetDefaultInputMode(TInt)
IMPORT_C void	SetDefaultLanguage(TInt)
IMPORT_C void	SetFlags(TInt)
IMPORT_C void	SetFormAccessor(CAknEdwinFormAccessor *)
IMPORT_C void	SetInlineEditSpan(TCursorSelection)
IMPORT_C void	SetLocalLanguage(TLanguage)
IMPORT_C void	SetMenu()
IMPORT_C void	SetMiddleSoftkeyCommandId(TInt)
IMPORT_C void	SetNumericKeymap(TAknEditorNumericKeymap)
IMPORT_C void	SetObjectProvider(MObjectProvider *)
IMPORT_C void	SetObserver(MAknEdStateObserver *)
IMPORT_C void	SetPermittedCases(TInt)
IMPORT_C void	SetPermittedInputModes(TInt)
IMPORT_C void	SetSpecialCharacterTableResourceId(TInt)
IMPORT_C TInt	SpecialCharacterTableResourceId()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	MCoeFepAwareTextEditor_Extension1::CState::BaseConstructL()
	MCoeFepAwareTextEditor_Extension1::CState::CState()
	MCoeFepAwareTextEditor_Extension1::CState::~CState()

Detailed Description

Stores the (FEP) states of editor controls.

Since: Series 60 0.9

Constructor & Destructor Documentation

CAknEdwinState ( MEikCcpuEditor * )

CAknEdwinState

(

MEikCcpuEditor *

aCcpuState

)

C++ constructor.

Parameter	Description
aCcpuState	Pointer to a control that implements MEikCcpuEditor interface.

CAknEdwinState ( )

IMPORT_C

CAknEdwinState

(

)

C++ default constructor.

~CAknEdwinState ( )

~CAknEdwinState

(

)

[virtual]

Destructor

Member Function Documentation

CbaState ( )

IMPORT_C SEditorCbaState &

CbaState

(

)

Get control's CBA state.

Returns: Reference to SEditorCbaState struct.

CcpuState ( )

IMPORT_C MEikCcpuEditor *

CcpuState

(

)

const

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

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

CurrentCase ( )

IMPORT_C TInt

CurrentCase

(

)

const

Get current character case for the editor.

Returns: Current character case.

CurrentInlineEditSpan ( )

IMPORT_C TCursorSelection

CurrentInlineEditSpan

(

)

const

Get the cursor or cursor selection within a document.

Returns: The cursor or cursor selection within a document.

CurrentInputMode ( )

IMPORT_C TInt

CurrentInputMode

(

)

const

Get current input mode for the editor.

Returns: Current input mode used in the editor.

DefaultCase ( )

IMPORT_C TInt

DefaultCase

(

)

const

Get default case for the editor. The case is used when the editor is focused first time.

Returns: Default character case.

DefaultInputMode ( )

IMPORT_C TInt

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.

DefaultLanguage ( )

IMPORT_C TInt

DefaultLanguage

(

)

const

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

Returns: 0

Flags ( )

IMPORT_C TInt

Flags

(

)

const

Returns control's flags.

Returns: Flags.

FormAccessor ( )

IMPORT_C CAknEdwinFormAccessor *

FormAccessor

(

)

const

Accessor for control's form.

Since: Series 60 2.0

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

LocalLanguage ( )

IMPORT_C TLanguage

LocalLanguage

(

)

const

Get the control's input language.

Returns: Language identity.

MenuBar ( )

IMPORT_C CEikMenuBar *

MenuBar

(

)

const

Get the control's menu bar.

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

MiddleSoftkeyCommandId ( )

IMPORT_C TInt

MiddleSoftkeyCommandId

(

)

const

Return middle sofkey command id.

Since: S60 V3.2

Returns: Current middle softkey command id.

NumericKeymap ( )

IMPORT_C TAknEditorNumericKeymap

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.

ObjectProvider ( )

IMPORT_C MObjectProvider *

ObjectProvider

(

)

const

Get control's object provider.

Returns: A pointer to control's object provider.

PermittedCases ( )

IMPORT_C TInt

PermittedCases

(

)

const

Get permitted cases for the editor.

Returns: Case modes that are permitted in the editor.

PermittedInputModes ( )

IMPORT_C TInt

PermittedInputModes

(

)

const

Get permitted input modes for the editor.

Returns: Input modes that are allowed in the editor.

ReportAknEdStateEventL ( MAknEdStateObserver::EAknEdwinStateEvent )

IMPORT_C void

ReportAknEdStateEventL

(

MAknEdStateObserver::EAknEdwinStateEvent

aEventType

)

From MAknEdStateObserver. Sends an state event to control's observer.

Parameter	Description
aEventType	Event type.

SetCba ( )

IMPORT_C void

SetCba

(

)

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

SetCcpuState ( MEikCcpuEditor * )

IMPORT_C void

SetCcpuState

(

MEikCcpuEditor *

aCcpuEditor

)

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

Parameter	Description
aCcpuEditor	Pointer to a control that implements MEikCcpuEditor interface.

SetCurrentCase ( TInt )

IMPORT_C void

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.

Parameter	Description
aCase	New case for the editor.

SetCurrentInputMode ( TInt )

IMPORT_C void

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.

Parameter	Description
aInputMode	New input mode for the editor.

SetDefaultCase ( TInt )

IMPORT_C void

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.

Parameter	Description
aCase	Initial case to be used in the editor.

SetDefaultInputMode ( TInt )

IMPORT_C void

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.

Parameter	Description
aInputMode	Initial input mode to be used in the editor.

SetDefaultLanguage ( TInt )

IMPORT_C void

SetDefaultLanguage

(

TInt

aLanguage

)

T9 language codes are not anymore supported. Use SetLocalLanguage() instead.

SetFlags ( TInt )

IMPORT_C void

SetFlags

(

TInt

aFlags

)

Set initial editor flags for the editor.

Parameter	Description
aFlags	Avkon editor flags for the editor.

SetFormAccessor ( CAknEdwinFormAccessor * )

IMPORT_C void

SetFormAccessor

(

CAknEdwinFormAccessor *

aFormAccessor

)

Set form accessor for this control.

Since: Series 60 2.0

Parameter	Description
aFormAccessor	Pointer to a form accessor.

SetInlineEditSpan ( TCursorSelection )

IMPORT_C void

SetInlineEditSpan

(

TCursorSelection

aCurrentInlineEditSpan

)

Set the cursor or cursor selection within a document.

Parameter	Description
aCurrentInlineEditSpan	New cursor or cursor selection within a document.

SetLocalLanguage ( TLanguage )

IMPORT_C void

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.

Parameter	Description
aLanguage	Editor local input language.

SetMenu ( )

IMPORT_C void

SetMenu

(

)

Sets the menu bar from the object provider.

SetMiddleSoftkeyCommandId ( TInt )

IMPORT_C void

SetMiddleSoftkeyCommandId

(

TInt

aCommandId

)

Set middle sofkey command id.

Since: S60 V3.2

SetNumericKeymap ( TAknEditorNumericKeymap )

IMPORT_C void

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.

Parameter	Description
aKeymap	Key mapping used in an editor with number input mode.

SetObjectProvider ( MObjectProvider * )

IMPORT_C void

SetObjectProvider

(

MObjectProvider *

aObjectProvider

)

Set the object provider for the control.

Parameter	Description
aObjectProvider	A pointer to a class that implements an object provider.

SetObserver ( MAknEdStateObserver * )

IMPORT_C void

SetObserver

(

MAknEdStateObserver *

aObserver

)

Sets an observer for this control.

Parameter	Description
aObserver	Pointer to an observer.

SetPermittedCases ( TInt )

IMPORT_C void

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.

Parameter	Description
aCases	Case modes that are available in the editor.

SetPermittedInputModes ( TInt )

IMPORT_C void

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.

Parameter	Description
aInputModes	Input modes that are allowed in the editor.

SetSpecialCharacterTableResourceId ( TInt )

IMPORT_C void

SetSpecialCharacterTableResourceId

(

TInt

aResourceId

)

Set editor specific special character table.

Parameter	Description
aResourceId	Special character table dialog resource ID.

SpecialCharacterTableResourceId ( )

IMPORT_C TInt

SpecialCharacterTableResourceId

(

)

const

Get editor specific special character table resource ID.

Returns: Special character table dialog resource ID.