profilesservices/ProfileEngine/EngInc/MProfileUtilitySingleton.h
branchRCL_3
changeset 8 f62c3a3d66b8
parent 4 3f8368f032cf
child 10 c8b9b0986973
equal deleted inserted replaced
4:3f8368f032cf 8:f62c3a3d66b8
     1 /*
       
     2 * Copyright (c) 2002 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:  Profile Utility interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MPROFILEUTILITYSINGLETON_H__
       
    21 #define __MPROFILEUTILITYSINGLETON_H__
       
    22 
       
    23 //  INCLUDES
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class MProfileUtilitySingleton;
       
    27 class MProfilesLocalFeatures;
       
    28 
       
    29 // FUNCTION PROTOTYPES
       
    30 /**
       
    31 * Return reference to MProfileUtilitySingleton instance. Create it if
       
    32 * necessary. For each succesful InstanceL() call there must be a corres-
       
    33 * ponding Release() call, so that the internal reference counting works.
       
    34 * @since 3.2
       
    35 * @return Reference to the only MProfileUtilitySingleton instance.
       
    36 */
       
    37 IMPORT_C MProfileUtilitySingleton& ProfileUtilityInstanceL();
       
    38 
       
    39 /**
       
    40 * Release the resources of MProfileUtilitySingleton (when there are no
       
    41 * references to it anymore). For each succesful InstanceL() call there
       
    42 * must be a corresponding Release() call, so that the internal
       
    43 * reference counting works.
       
    44 * @since 3.2
       
    45 */
       
    46 IMPORT_C void ReleaseProfileUtility();
       
    47 
       
    48 
       
    49 // CLASS DECLARATION
       
    50 /**
       
    51 *  Profile utility class.
       
    52 *
       
    53 *  @lib profileeng.lib
       
    54 *  @since 3.2
       
    55 */
       
    56 class MProfileUtilitySingleton
       
    57     {
       
    58     protected:  // Destructor
       
    59 
       
    60         virtual ~MProfileUtilitySingleton() {};
       
    61 
       
    62     public: // New functions
       
    63 
       
    64         /**
       
    65         * Returns a reference to MProfilesLocalFeatures instance owned by
       
    66         * this MProfileUtility instance.
       
    67         * @since 3.2
       
    68         */
       
    69         virtual MProfilesLocalFeatures& ProfilesLocalFeatures() = 0;
       
    70 
       
    71     };
       
    72 
       
    73 #endif      // __MPROFILEUTILITYSINGLETON_H__
       
    74 
       
    75 // End of File
       
    76