CEikMfneSymbol 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 <eikmfne.h>

Inherits CEikMfneField.


Detailed Description

A symbol field for a multi-field numeric editor.

For instance, the AM / PM text in a time editor. In this case, the field contains 2 symbolic items one each for the AM and PM text strings.


Public Member Functions

virtual IMPORT_C  ~CEikMfneSymbol ()
  Destructor.
IMPORT_C void  AddSymbolicItem (CItem *aSymbolicItem, TBool aMakeCurrent)
  Adds the specified symbolic item at the first available position in the array.
IMPORT_C void  SetCurrentSymbolicItemToId (TInt aId)
  Sets the current item to the one specified.
IMPORT_C TInt  IdOfCurrentSymbolicItem () const
  Gets the current symbol's ID.
IMPORT_C void  SetUninitialised (TBool aUninitialised)
  Sets the uninitialized status of the field.
IMPORT_C TBool  IsUninitialised () const
  Gets the uninitialized status of the field.

Static Public Member Functions

static IMPORT_C CEikMfneSymbol NewL (TResourceReader &aResourceReader)
  Allocates and constructs a CEikMfneSymbol from resource.
static IMPORT_C CEikMfneSymbol NewL (TInt aNumSymbolicItems)
  Allocates and constructs a CEikMfneSymbol.

Data Structures

class   CItem
  An item within a symbol field in an MFNE. More...

Constructor & Destructor Documentation

virtual IMPORT_C CEikMfneSymbol::~CEikMfneSymbol  )  [virtual]
 

Destructor.

Deletes the array of symbolic items owned by the object.


Member Function Documentation

IMPORT_C void CEikMfneSymbol::AddSymbolicItem CItem aSymbolicItem,
TBool  aMakeCurrent
 

Adds the specified symbolic item at the first available position in the array.

This should be called by the container only if construction was not made from resource.

Parameters:
aSymbolicItem  The symbol to add. Ownership of aSymbolicItem is transferred to this.
aMakeCurrent  ETrue to make the added symbol current.
Panic:
16 In debug build if the symbolic item array has not yet been created.
Panic:
17 If the array is full.
IMPORT_C TInt CEikMfneSymbol::IdOfCurrentSymbolicItem  )  const
 

Gets the current symbol's ID.

Returns:
The current symbol's ID.
IMPORT_C TBool CEikMfneSymbol::IsUninitialised  )  const
 

Gets the uninitialized status of the field.

Returns:
ETrue, if the field is set as uninitialized.
static IMPORT_C CEikMfneSymbol* CEikMfneSymbol::NewL TInt  aNumSymbolicItems  )  [static]
 

Allocates and constructs a CEikMfneSymbol.

The first item is set as current.

Parameters:
aNumSymbolicItems  The number of symbolic items. Must be greater than one. All items are set to NULL.
Returns:
A newly constructed symbol.
Panic:
15 If there is not more than one symbol.
static IMPORT_C CEikMfneSymbol* CEikMfneSymbol::NewL TResourceReader &  aResourceReader  )  [static]
 

Allocates and constructs a CEikMfneSymbol from resource.

Uses a MFNE_SYMBOL resource. The first item is set as current.

Parameters:
aResourceReader  The resource reader to use.
Returns:
A newly constructed symbol.
Panic:
15 If there is not more than one symbol.
IMPORT_C void CEikMfneSymbol::SetCurrentSymbolicItemToId TInt  aId  ) 
 

Sets the current item to the one specified.

Parameters:
aId  The id of the new current item.
Panic:
18 If the specified item does not exist.
IMPORT_C void CEikMfneSymbol::SetUninitialised TBool  aUninitialised  ) 
 

Sets the uninitialized status of the field.

Parameters:
aUninitialised  If ETrue, sets the field as uninitialized, i.e. doesn't display anything.

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

Copyright © Nokia Corporation 2001-2008
Back to top