CPbkAddressSelect::TBaseParams Class Reference

API published in: S60 1st Ed
API deprecated in: S60 5th Ed

Link against: pbkview.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <cpbkaddressselect.h>

Inherited by CPbkEmailAddressSelect::TParams, CPbkEmailOverSmsAddressSelect::TParams, CPbkMmsAddressSelect::TParams, CPbkPhoneNumberSelect::TParams, CPbkPocAddressSelect::TParams, CPbkSmsAddressSelect::TParams, CPbkVideoNumberSelect::TParams, and CPbkVoipAddressSelect::TParams.

Detailed Description

Parameters for ExecuteLD(TBaseParams&).
See also:
ExecuteLD(TBaseParams&)

Public Member Functions
IMPORT_C const CPbkContactItem &  ContactItem ()
  Returns the contact supplied to constructor.
IMPORT_C void  SetFocusedField (const TPbkContactItemField *aFocusedField)
  Sets the focused field of the contact item.
IMPORT_C void  SetUseDefaultDirectly (TBool aUseDefaultDirectly)
  Set to ETrue to use default address of the contact directly.
IMPORT_C const TPbkContactItemField *  SelectedField () const
  Returns the selected field or NULL if no selection was made.
IMPORT_C const TPbkContactItemField *  FocusedField () const
  Returns the focused field or NULL if there was no field level focus.

Protected Member Functions
IMPORT_C  TBaseParams (const CPbkContactItem &aContact, const TPbkContactItemField *aDefaultField)
  Constructor.

Friends
class  CPbkAddressSelect

Constructor & Destructor Documentation

IMPORT_C CPbkAddressSelect::TBaseParams::TBaseParams (  const CPbkContactItem &  aContact,
const TPbkContactItemField *  aDefaultField
)  [protected]
 

Constructor.

Parameters:
aContact  Contact from which to select an address.
aDefaultField  The field to use as the default. NULL if no default is set for aContact.

Member Function Documentation

IMPORT_C const CPbkContactItem& CPbkAddressSelect::TBaseParams::ContactItem (   ) 
 

Returns the contact supplied to constructor.

Returns:
Contact item.
IMPORT_C const TPbkContactItemField* CPbkAddressSelect::TBaseParams::FocusedField (   )  const
 

Returns the focused field or NULL if there was no field level focus.

Returns:
Focused contact item field.
IMPORT_C const TPbkContactItemField* CPbkAddressSelect::TBaseParams::SelectedField (   )  const
 

Returns the selected field or NULL if no selection was made.

Returns:
Selected contact item field.
IMPORT_C void CPbkAddressSelect::TBaseParams::SetFocusedField (  const TPbkContactItemField *  aFocusedField  ) 
 

Sets the focused field of the contact item.

If focused field is a non-empty address field it is returned directly by ExecuteLD. The default value is NULL.

Parameters:
aFocusedField  The focused field to set
IMPORT_C void CPbkAddressSelect::TBaseParams::SetUseDefaultDirectly (  TBool  aUseDefaultDirectly  ) 
 

Set to ETrue to use default address of the contact directly.

Focused field overrides default address if both are available. The default value is EFalse.

Parameters:
aUseDefaultDirectly  Defines whether the default address should be used directly

Friends And Related Function Documentation

friend class CPbkAddressSelect [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top