AknEditUtils Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikcore.lib

Capability Information

Required Capabilities

None


#include <aknutils.h>

Detailed Description

Utility class to initialize editor control.

Use this in conjunction with AknLayoutUtils::LayoutEdwin(). The class is not fully implemented yet.


Static Public Member Functions

static IMPORT_C void  ConstructEditingL (CEikEdwin *aEdwin, TInt aResourceId)
static IMPORT_C void  ConstructEditingL (CEikEdwin *aEdwin, TResourceReader &aReader)
static IMPORT_C void  ConstructEditingL (CEikEdwin *aEdwin, const SAknEditorParameters &aParams)
static IMPORT_C void  ConstructEditingL (CEikEdwin *aEdwin, TInt aEditingSpace, TInt aEditingWindow, TInt aCharacterCase, TInt aJustification, TBool aAllowedToMoveInsertionPoint, TBool aCursorYesNo, TBool aOverflowYesNo)
  Configures edwin editor.
static IMPORT_C void  ConstructEditingL (CEikEdwin *aEdwin, TInt aEditingSpace, TInt aEditingWindow, TInt aCharacterCase, TInt aJustification, TBool aAllowedToMoveInsertionPoint, TBool aCursorYesNo, TBool aOverflowYesNo, TBool aIsResizable)
  Configures edwin editor.

Data Structures

struct   SAknEditorParameters
  Basic elements that are needed for the basic editing functions. More...

Member Function Documentation

static IMPORT_C void AknEditUtils::ConstructEditingL CEikEdwin aEdwin,
TInt  aEditingSpace,
TInt  aEditingWindow,
TInt  aCharacterCase,
TInt  aJustification,
TBool  aAllowedToMoveInsertionPoint,
TBool  aCursorYesNo,
TBool  aOverflowYesNo,
TBool  aIsResizable
[static]
 

Configures edwin editor.

Use AknLayoutUtils::LayoutEdwin() with this method.

Parameters:
aEdwin  Edwins created with new.
aEditingSpace  maximum number of characters for the editor
aEditingWindow  maximum number of lines in the editor
aCharacterCase  initial character case: EAknEditorCharactersUpperCase = EAknEditorUpperCase, EAknEditorCharactersLowerCase = EAknEditorLowerCase, EAknEditorCharactersTextCase = EAknEditorTextCase, EAknEditorCharactersTitleCase = EAknEditorTitleCase
aJustification  alignment for the editor text ( EAknEditorAlignCenter, EAknEditorAlignLeft, EAknEditorAlignRight)
aAllowedToMoveInsertionPoint  user can move cursor
aCursorYesNo  is cursor visible or not.
aOverflowYesNo 
aIsResizeable  is edwin resizeable (one line editor should use EFalse, in order to have proper scrolling)
static IMPORT_C void AknEditUtils::ConstructEditingL CEikEdwin aEdwin,
TInt  aEditingSpace,
TInt  aEditingWindow,
TInt  aCharacterCase,
TInt  aJustification,
TBool  aAllowedToMoveInsertionPoint,
TBool  aCursorYesNo,
TBool  aOverflowYesNo
[static]
 

Configures edwin editor.

Use AknLayoutUtils::LayoutEdwin() with this method.

Parameters:
aEdwin  Edwins created with new.
aEditingSpace  maximum number of characters for the editor
aEditingWindow  maximum number of lines in the editor
aCharacterCase  initial character case: EAknEditorCharactersUpperCase = EAknEditorUpperCase, EAknEditorCharactersLowerCase = EAknEditorLowerCase, EAknEditorCharactersTextCase = EAknEditorTextCase, EAknEditorCharactersTitleCase = EAknEditorTitleCase
aJustification  alignment for the editor text ( EAknEditorAlignCenter, EAknEditorAlignLeft, EAknEditorAlignRight)
aAllowedToMoveInsertionPoint  user can move cursor
aCursorYesNo  is cursor visible or not.
aOverflowYesNo 
static IMPORT_C void AknEditUtils::ConstructEditingL CEikEdwin aEdwin,
const SAknEditorParameters aParams
[static]
 
static IMPORT_C void AknEditUtils::ConstructEditingL CEikEdwin aEdwin,
TResourceReader &  aReader
[static]
 
static IMPORT_C void AknEditUtils::ConstructEditingL CEikEdwin aEdwin,
TInt  aResourceId
[static]
 

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

Copyright © Nokia Corporation 2001-2008
Back to top