searchui/stateproviders/searchstateprovider/inc/searchstateprovider.h
changeset 2 208a4ba3894c
parent 0 ccd0fd43f247
equal deleted inserted replaced
0:ccd0fd43f247 2:208a4ba3894c
    16  */
    16  */
    17 
    17 
    18 #ifndef SEARCH_STATEPROVIDERS_STATEPROVIDER_H
    18 #ifndef SEARCH_STATEPROVIDERS_STATEPROVIDER_H
    19 #define SEARCH_STATEPROVIDERS_STATEPROVIDER_H
    19 #define SEARCH_STATEPROVIDERS_STATEPROVIDER_H
    20 
    20 
    21 #include "Search_global.h"
    21 #include "search_global.h"
    22 
    22 
    23 #include "hsistateprovider.h"
    23 SEARCH_CLASS( SearchStateProviderTest)
    24 
    24 
    25 class SearchStateProviderTest;
    25 #ifdef BUILD_SEARCHSTATEPROVIDER
       
    26 #define SEARCH_STATEPROVIDER Q_DECL_EXPORT
       
    27 #else
       
    28 #define SEARCH_STATEPROVIDER Q_DECL_IMPORT
       
    29 #endif
    26 
    30 
    27 class QState;
    31 class QState;
    28 
    32 
    29 /**
    33 /**
    30  * @ingroup group_Searchstateprovider
    34  * @ingroup group_Searchstateprovider
    34  * States are described in the Searchstateprovider.manifest file.
    38  * States are described in the Searchstateprovider.manifest file.
    35  *
    39  *
    36  * @lib Searchstateprovider
    40  * @lib Searchstateprovider
    37  * @since S60 ?S60_version.
    41  * @since S60 ?S60_version.
    38  */
    42  */
    39 class SearchStateProvider : public QObject, public IHsStateProvider
    43 class SEARCH_STATEPROVIDER SearchStateProvider : public QObject
    40     {
    44     {
    41 
    45 
    42 Q_OBJECT
    46 Q_OBJECT
    43 Q_INTERFACES(IHsStateProvider)
       
    44 
    47 
    45 public:
    48 public:
    46 
    49 
    47     /**
    50     /**
    48      * Default constructor.
    51      * Default constructor.
    49      *
    52      *
    50      * @since S60 ?S60_version.
    53      * @since S60 ?S60_version.
    51      */
    54      */
    52     SearchStateProvider();
    55     SearchStateProvider(QObject *parent=NULL);    
       
    56     
    53 
    57 
    54     /**
    58 public:   
    55      * Destructor.
       
    56      *
       
    57      * @since S60 ?S60_version.
       
    58      */
       
    59     virtual ~SearchStateProvider();
       
    60 
       
    61 public:
       
    62 
       
    63     /**
       
    64      * Returns contained states as a list of tokens.
       
    65      *
       
    66      * @return Contained states as a list of tokens.
       
    67      * @since S60 ?S60_version.
       
    68      */
       
    69     QList<HsStateToken> states();
       
    70 
    59 
    71     /**
    60     /**
    72      * Creates a state based on the given token.
    61      * Creates a state based on the given token.
    73      *
    62      *
    74      * @param aToken Identifies the state to be created.
    63      * @param aToken Identifies the state to be created.
    75      * @since S60 ?S60_version.
    64      * @since S60 ?S60_version.
    76      */
    65      */
    77     QState* createState(const HsStateToken& aToken);
    66     QState* createState(const QString& uri);
    78 
    67 
    79 private:
    68 private:   
    80 
    69 
    81     /**
    70     SEARCH_FRIEND_CLASS    ( SearchStateProviderTest)
    82      * Token that describes the wizard menu state.
       
    83      */
       
    84     HsStateToken mInitStateToken;
       
    85 
       
    86     HsStateToken mWizardMenuStateToken;
       
    87 
       
    88     HsStateToken mWizardActivatedStateToken;
       
    89 
       
    90     friend class SearchStateProviderTest;
       
    91     };
    71     };
    92 
    72 
    93 #endif //SEARCH_STATEPROVIDERS_STATEPROVIDER_H
    73 #endif //SEARCH_STATEPROVIDERS_STATEPROVIDER_H