locationsystemui/locationsysui/locpsysettings/locpsysettingseng/inc/locpsyeng.h
branchRCL_3
changeset 44 2b4ea9893b66
parent 42 02ba3f1733c6
child 45 6b6920c56e2f
equal deleted inserted replaced
42:02ba3f1733c6 44:2b4ea9893b66
     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: This  is a header file for engine class of Location position settings
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CLOCPSYENG_H_
       
    20 #define CLOCPSYENG_H_
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 
       
    25 // FORWARD DECLARATION
       
    26 
       
    27 class CLocPsySettings;
       
    28 class MLocPsySettings;
       
    29 
       
    30 /**
       
    31 * Enumerations for model creation
       
    32 */
       
    33 enum TLocModelType
       
    34     {
       
    35     ELocPsySettings, 
       
    36     };
       
    37 
       
    38 // CLASS DECLARATION
       
    39 /**
       
    40  *  Implements entry point class to LocEng.dll
       
    41  *
       
    42  *  @lib locpsysettingseng.dll
       
    43  *  @since 3.1
       
    44  */
       
    45 class CLocPsyEng : public CBase
       
    46     {
       
    47     private:
       
    48        /**
       
    49         * C++ default constructor.
       
    50         */
       
    51         CLocPsyEng();
       
    52         
       
    53     public:
       
    54        /**
       
    55         * Two-phased constructor.
       
    56         *
       
    57         * @return CLocPsyEng object.
       
    58         */
       
    59         IMPORT_C static CLocPsyEng* NewL();
       
    60         
       
    61        /**
       
    62         * Destructor.
       
    63         */
       
    64         IMPORT_C virtual ~CLocPsyEng();
       
    65     
       
    66     public: 
       
    67        /**
       
    68         * Settings model getter.
       
    69         * Model is NOT created if it does not exist.
       
    70         * Ownership not transferred.
       
    71         * @return pointer to the settings model
       
    72         */
       
    73         IMPORT_C MLocPsySettings* SettingsModel();
       
    74         /**
       
    75         * Model creator.
       
    76         * This method creates and initializes models.
       
    77         * Model creation method is used if no separate 
       
    78         * handle to model needed. 
       
    79         * @param aModel model identificator.
       
    80         */
       
    81         IMPORT_C void CreateModelL( TLocModelType aModel );
       
    82 
       
    83         /**
       
    84         * Engine can contain multiple models.
       
    85         * With help of this function certain model can be deleted.
       
    86         * @param aModelType Model type to be deleted
       
    87         */
       
    88         IMPORT_C void RemoveModel(TLocModelType aModelType );
       
    89                        
       
    90     private:    // data
       
    91         // OWn: Settings model
       
    92         CLocPsySettings* iSettings; 
       
    93     };
       
    94 
       
    95 #endif // CLOCPSYENG_H_
       
    96 
       
    97 // End of File