gsprofilesrv_pub/profiles_engine_wrapper_api/inc/ProEngFactory2.h
branchGCC_SURGE
changeset 45 f48d04161a92
parent 27 572294aa6075
parent 43 3341fe7c643a
equal deleted inserted replaced
27:572294aa6075 45:f48d04161a92
     1 /*
       
     2 * Copyright (c) 2009 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: Factory for Profiles Engine Wrapper.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef PROENGFACTORY2_H
       
    21 #define PROENGFACTORY2_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <ProEngFactory.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 
       
    28 class MProEngNotifyHandler2;
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *  Factory for Profiles Engine Wrapper.
       
    34 *  You can create new instances of Profiles Engines, Notification Handlers and
       
    35 *  Alert Tone Seekers by using this factory.<br><br>
       
    36 *  Example:
       
    37 *  @code
       
    38 *  // Create a new instance of Profiles Engine:
       
    39 *  MProEngEngine* engine =
       
    40 *      ProEngFactory2::NewEngineLC();
       
    41 *
       
    42 *  // Create a new instance of Notification Handler:
       
    43 *  MProEngNotifyHandler* notifyHandler =
       
    44 *      ProEngFactory2::NewNotifyHandlerL();
       
    45 *
       
    46 *  // Create a new instance of Alert Tone Seeker:
       
    47 *  MProEngAlertToneSeeker* toneSeeker =
       
    48 *      ProEngFactory2::NewAlertToneSeekerL();
       
    49 *  @endcode
       
    50 *
       
    51 *  @lib ProfileEngine.lib
       
    52 *  @since  10.1
       
    53 */
       
    54 class ProEngFactory2 : public ProEngFactory
       
    55     {
       
    56     public: // New functions
       
    57         /**
       
    58         * Create a new instance of Profiles Notification Handler 2.
       
    59         * @since 10.1
       
    60         * @return New instance of Notification Handler.
       
    61         *         Ownership is transferred to the client application.
       
    62         */
       
    63         IMPORT_C static MProEngNotifyHandler2* NewNotifyHandler2L();
       
    64 
       
    65     private:
       
    66 
       
    67         // Prohibit C++ default constructor.
       
    68         ProEngFactory2();
       
    69         // Prohibit Destructor.
       
    70         ~ProEngFactory2();
       
    71 
       
    72     };
       
    73 
       
    74 #endif      // PROENGFACTORY2_H
       
    75 
       
    76 // End of File
       
    77