stateproviders/ftustateprovider/inc/ftustateprovider.h
changeset 0 c464cd7e2753
equal deleted inserted replaced
-1:000000000000 0:c464cd7e2753
       
     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:  Declaration of the FTU state provider
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef FTU_STATEPROVIDERS_STATEPROVIDER_H
       
    20 #define FTU_STATEPROVIDERS_STATEPROVIDER_H
       
    21 
       
    22 #include "ftutest_global.h"
       
    23 #include "ftustateprovider_global.h"
       
    24 
       
    25 FTU_TEST_CLASS(FtuStateProviderTest)
       
    26 
       
    27 class QState;
       
    28 class FtuStateProviderPrivate;
       
    29 
       
    30 
       
    31     
       
    32 /**
       
    33  * @ingroup group_ftustateprovider
       
    34  * @brief Provides a default implementation for each FTU state.
       
    35  *
       
    36  * This provider includes a default implementation for each FTU state
       
    37  * States are described in the ftustateprovider.manifest file.
       
    38  *
       
    39  * @lib ftustateprovider
       
    40  * @since S60 ?S60_version.
       
    41  */
       
    42 class FTUSTATEPROVIDER_EXPORT FtuStateProvider : public QObject
       
    43 {
       
    44 
       
    45     Q_OBJECT
       
    46 public:
       
    47 
       
    48     FtuStateProvider(QObject *parent=NULL);
       
    49 
       
    50 public:
       
    51 
       
    52     /**
       
    53      * Creates a state based on the given uri.
       
    54      *
       
    55      * @param uri Identifies the state to be created.
       
    56      * @since S60 ?S60_version.
       
    57      * @return Constructed QState, ownership transferred.
       
    58      */
       
    59     QState* createState(const QString& uri);
       
    60 
       
    61 private:
       
    62 
       
    63     FtuStateProviderPrivate* mPrivate;
       
    64     friend class FtuStateProviderPrivate; 
       
    65     
       
    66         
       
    67 
       
    68     FTU_TEST_FRIEND_CLASS(FtuStateProviderTest)
       
    69 };
       
    70 
       
    71 
       
    72 #endif //FTU_STATEPROVIDERS_STATEPROVIDER_H