epoc32/include/app/Pbk2FieldPropertiesFactory.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  Phonebook 2 field properties factory.
    15 *
    16 */
    17 
    18 
    19 #ifndef PBK2FIELDPROPERTIESFACTORY_H
    20 #define PBK2FIELDPROPERTIESFACTORY_H
    21 
    22 // INCLUDE FILES
    23 #include <e32def.h>
    24 
    25 // FORWARD DECLARATIONS
    26 class MVPbkFieldTypeList;
    27 class MPbk2FieldPropertyArray;
    28 class RFs;
    29 
    30 /**
    31  * Phonebook 2 field properties factory.
    32  * Pbk2FieldPropertiesFactory is responsible for creating field
    33  * property arrays.
    34  *
    35  * @see MPbk2FieldPropertyArray
    36  */
    37 class Pbk2FieldPropertiesFactory
    38     {
    39     public: // Interface
    40 
    41         /**
    42          * Creates a new field property array.
    43          *
    44          * @param aSupportedFieldTypeList   A list of Virtual Phonebook
    45          *                                  field types. Pass the master
    46          *                                  field type list to have all
    47          *                                  the properties loaded.
    48          * @param aRFs                      A file system session reference
    49          *                                  for reading resources.
    50          *                                  If NULL then own session
    51          *                                  is created.
    52          * @return  Field property array.
    53          */
    54         IMPORT_C static MPbk2FieldPropertyArray* CreateL(
    55                 const MVPbkFieldTypeList& aSupportedFieldTypeList,
    56                 RFs* aRFs = NULL );
    57     
    58         /**
    59          * Creates a new field property array.
    60          *
    61          * @param aSupportedFieldTypeList   A list of Virtual Phonebook
    62          *                                  field types. Pass the master
    63          *                                  field type list to have all
    64          *                                  the properties loaded.
    65          * @param aRFs                      A file system session reference
    66          *                                  for reading resources.
    67          *                                  If NULL then own session
    68          *                                  is created.
    69          * @return  Field property array.
    70          */
    71         IMPORT_C static MPbk2FieldPropertyArray* CreateLC(
    72                 const MVPbkFieldTypeList& aSupportedFieldTypeList,
    73                 RFs* aRFs = NULL );
    74     };
    75 
    76 #endif // PBK2FIELDPROPERTIESFACTORY_H
    77 
    78 // End of File