1 /*

     2 * Copyright (c) 2004-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:  Access interface to different list localization data sets.

    15 *

    16 */

    17 

    18 #ifndef MPIMLOCALIZATIONMANAGER_H

    19 #define MPIMLOCALIZATIONMANAGER_H

    20 

    21 // INCLUDES

    22 #include "pimtypes.h"

    23 #include <badesca.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class MPIMLocalizationData;

    27 class MPIMConfirmationDialogue;

    28 

    29 /**

    30  * PIM Item and category operations

    31  */

    32 enum TPIMOperationType

    33 {

    34     EPIMOperationItemDeletion = 1,

    35     EPIMOperationItemCommit,

    36     EPIMOperationCategoryDeletion,

    37     EPIMOperationContactListRead,

    38     EPIMOperationContactListWrite,

    39     EPIMOperationEventListRead,

    40     EPIMOperationEventListWrite,

    41     EPIMOperationToDoListRead,

    42     EPIMOperationToDoListWrite

    43 };

    44 

    45 // CLASS DECLARATION

    46 /**

    47  * A Factory class for MPIMLocalizationData objects

    48  */

    49 class MPIMLocalizationManager

    50 {

    51 public: // destructor

    52     /**

    53      * Destructor is public virtual in order to allow deletion through

    54      * M-class

    55      */

    56     virtual ~MPIMLocalizationManager() { }

    57 

    58 public:

    59     /**

    60      * Creates an instance of MPIMLocalizationData.

    61      * Caller takes ownership of the returned object.

    62      *

    63      * @param aType Type of the list, which of data to localize.

    64      *              This can be KPIMLocalizationIdContact,

    65      *              KPIMLocalizationIdSIM, KPIMLocalizationIdEvent or

    66      *              KPIMLocalizationidToDo

    67      *

    68      * @return MPIMLocalizationData object for the requested list type.

    69      * @par Leaving:

    70      * The method leaves on error. Error codes should be interpreted as

    71      * follows:

    72      * @li \c KErrArgument - \a aType is not valid

    73      * @li \c KErrNotFound - The resource file cannot be read

    74      */

    75     virtual MPIMLocalizationData* GetPIMLocalizationDataL(

    76         TPIMLocalizationDataID aType) = 0;

    77 

    78     /**

    79      * Creates an instance of MPIMLocalizationData.

    80      * Caller takes ownership of the returned object.

    81      *

    82      * @param aType Type of the list, which of data to localize.

    83      *              This can be KPIMLocalizationIdContact,

    84      *              KPIMLocalizationIdSIM, KPIMLocalizationIdEvent or

    85      *              KPIMLocalizationidToDo

    86      *

    87      * @param aSubType List name identifier. Currently only Event lists

    88      *              can have list name identifiers (all other list should

    89      *              use zero).

    90      *

    91      * @return MPIMLocalizationData object for the requested list type.

    92      * @par Leaving:

    93      * The method leaves on error. Error codes should be interpreted as

    94      * follows:

    95      * @li \c KErrArgument - \a aType is not valid, or \a aSubType is not

    96      * valid for \a aType.

    97      * @li \c KErrNotFound - The resource file cannot be read

    98      */

    99     virtual MPIMLocalizationData* GetPIMLocalizationDataL(

   100         TPIMLocalizationDataID aType,

   101         TPIMLocalizationDataID aSubType) = 0;

   102 

   103 

   104 

   105 };

   106 

   107 

   108 

   109 #endif // MPIMLOCALIZATIONMANAGER_H

   110 

   111 // End of file