CPbkIconInfoContainer Class Reference

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

Link against: pbkview.lib

Capability Information

Required Capabilities

None

#include <pbkiconinfo.h>

Detailed Description

Collection of phonebook icon info objects.
See also:
TPbkIconInfo
Deprecated:

Public Member Functions
  ~CPbkIconInfoContainer ()
  Destructor.
IMPORT_C const TPbkIconInfo *  Find (TPbkIconId aIconId) const
  Finds a particular TPbkIconInfo in the container.
IMPORT_C CGulIcon *  LoadBitmapL (TPbkIconId aIconId) const
  Creates and returns a CGulIcon object corresponding to the aIconId.
IMPORT_C void  AppendIconsFromResourceL (TInt aResourceId)
  Appends new icon info elements from aResourceId.

Static Public Member Functions
static IMPORT_C CPbkIconInfoContainer *  NewL (CCoeEnv *aCoeEnv=NULL)
  Creates a new instance of this class intialized with Phonebook default icon info from PbkView.rsc.
static IMPORT_C CPbkIconInfoContainer *  NewL (TResourceReader &aReader)
  Creates a new instance of this class.
static IMPORT_C CPbkIconInfoContainer *  NewL (TInt aResourceId, CCoeEnv *aCoeEnv=NULL)
  Creates a new instance of this class.

Constructor & Destructor Documentation

CPbkIconInfoContainer::~CPbkIconInfoContainer (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CPbkIconInfoContainer::AppendIconsFromResourceL (  TInt  aResourceId  ) 
 

Appends new icon info elements from aResourceId.

The resource must be of PBK_ICON_INFO type.

Parameters:
aResourceId  Resource id for icon infos to be added.
IMPORT_C const TPbkIconInfo* CPbkIconInfoContainer::Find (  TPbkIconId  aIconId  )  const
 

Finds a particular TPbkIconInfo in the container.

Parameters:
aIconId  Id of the icon info to search.
Returns:
Matching icon info or NULL if not found.
IMPORT_C CGulIcon* CPbkIconInfoContainer::LoadBitmapL (  TPbkIconId  aIconId  )  const
 

Creates and returns a CGulIcon object corresponding to the aIconId.

ownership of the returned object is transferred to the client. Returns NULL if icon id is not in the array.

Parameters:
aIconId  Phonebook icon id.
Returns:
Icon object corresponding to the icon id. NULL if not found.
static IMPORT_C CPbkIconInfoContainer* CPbkIconInfoContainer::NewL (  TInt  aResourceId,
CCoeEnv *  aCoeEnv = NULL
)  [static]
 

Creates a new instance of this class.

Parameters:
aResourceId  Resource id of an array of PBK_ICON_INFO resources. Phonebook default icon info array's resource id is R_PBK_ICON_INFO_ARRAY in PbkView.rsc.
aCoeEnv  Optional CCoeEnv instance. This function performs faster if this parameter is provided.
Returns:
A new instance of this class.
static IMPORT_C CPbkIconInfoContainer* CPbkIconInfoContainer::NewL (  TResourceReader &  aReader  )  [static]
 

Creates a new instance of this class.

Parameters:
aReader  Resource reader initialized to point to an array of PBK_ICON_INFO resources.
Returns:
A new instance of this class.
static IMPORT_C CPbkIconInfoContainer* CPbkIconInfoContainer::NewL (  CCoeEnv *  aCoeEnv = NULL  )  [static]
 

Creates a new instance of this class intialized with Phonebook default icon info from PbkView.rsc.

Note that PbkView.rsc has to be loaded, see RPbkViewResourceFile.

Parameters:
aCoeEnv  Optional CCoeEnv instance. This function performs faster if this parameter is provided.
Returns:
A new instance of this class.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top