CEikSecretEditor Class Reference

Enumerator:

EMaxSecEdBufLength	The maximum number of characters in the displayed text buffer.
EMaxSecEdSecArrayLength	Indicates the maximum number of characters which may be entered into the editor. Editors additionally have a maximum length, see SetMaxLength(), which must not exceed this value.

Default constructor.

This constructs a editor with a border type of TGulBorder::ESingleGray.

This function should be used as the first stage in two stage construction, followed by a call to either ConstructFromResourceL() or SetMaxLength().

Destructor.

Sets the alignment of the editor.

Parameters:

aAlign

The editor's alignment.

Sets the font that is used to draw the text in this editor.

Parameters:

aFont

A pointer to a CFont object that is used to draw the text in this editor.

Appends a character to the editor.

Parameters:

aKeyCode

The character to append.

Reimplemented in CAknNumericSecretEditor.

Access method for getting at the buffer without copying out from it.

Returns:

Non-modifiable descriptor reference to the contained buffer.

Second-phase construction from a resource file.

This function reads the number of characters which may be entered by the user into the editor from a SECRETED resource. You should call either this function or SetMaxLength() before drawing the editor and offering key events, otherwise the editor will not accept text input.

Parameters:

aReader

A resource file reader.

Panic:

EIKCTL 13 If the value read from resource is greater than EMaxSecEdLength.

Gets the list of logical colours used to draw the editor.

Overrides CCoeControl::GetColorUseListL().

Parameters:

aColorUseList

On return, the colour list.

Reimplemented from CEikBorderedControl.

Gets the editor's text string.

This may be called from the container class when the model data should be updated according to the text contained in the editor.

Parameters:

aText

On return, the editor's text. This is what is stored in memory, not what is displayed. This descriptor must be capable of holding the maxlength of the internal buffer.

From CCoeControl.

Handles pointer events.

Parameters:

aPointerEvent

The pointer event.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknNumericSecretEditor.

Handles a change to the editor's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts.

Calls CEikBorderedControl::HandleResourceChange().

Parameters:

aType

A message UID value.

Reimplemented from CEikBorderedControl.

Set the initial display of the secret editor.

Calling this routine doesn't affect the actual character buffer.

Parameters:

aNumberOfCharacters

Must be >=0 and <= EMaxSecEdBufLength.

Gets the editor's input capabilities.

Overrides CCoeControl::InputCapabilities().

If this function is overrided in a subclass, the subclass should obtain this class' InputCapabilities' object provider through TCoeInputCapabilities::ObjectProvider() and set that as a part of the subclass' InputCapabilities object provider chain to ensure maximum functionality.

Returns:

The editor's input capabilities. The ESecretText and ENavigation flags are set.

Reimplemented in CAknNumericSecretEditor.

Returns the current maximum length of the internal buffer.

Returns:

the current maximum length of the internal buffer.

Gets the editor's minimum size in pixels.

Overrides CCoeControl::MinimumSize().

Returns:

The editor's minimum size in pixels.

Responds to key presses.

Overrides CCoeControl::OfferKeyEventL().

Parameters:

	aKeyEvent	The key event.
	aType	Not used.

Returns:

Indicates whether or not the key event was consumed.

Clears the editor's text string removing any trace of it from memory.

Method to reveal (or hide) the currently input editor contents.

Parameters:

aReveal

- if ETrue, reveals the contents; if EFalse hides them.

Changes default and current input mode of a secret editor.

By default input mode in the secret editor is alpha input mode (EAknEditorSecretAlphaInputMode). By using this method the default input mode can be changed to numeric input mode (EAknEditorNumericInputMode).

Parameters:

aInputMode

Default input mode in the secret editor. Only EAknEditorNumericInputMode and EAknEditorSecretAlphaInputMode are supported.

Set the maximum length of the editor.

This is the maximum number of characters which may be entered by the user into the editor.

Parameters:

aMaxLength

The maximum number of characters which may be entered.

Panic:

EIKCTL 13 If aMaxLength is greater than EMaxSecEdLength.

Set the skin control context to be used with this secret editor.

If this method is not called, the control context available through MOP (if any) is used. If NULL control context is specified, no control context is used at all.

Parameters:

aContext

The background control context used to draw the background of this editor or NULL. Ownership is not transferred.

Sets the colors for text and background as skin IDs.

Parameters:

	aAknSkinIDForTextColor	ID for text color.
	aAknSkinIDForBgColor	ID for background color.

Set the contents of the character buffer.

Parameters:

aText

The text to be set as the contents of the character buffer.

Responds to changes to the size and position of the contents of this control.

Overrides CCoeControl::SizeChanged().

Updates and redraws the editor.