searchui/stateproviders/searchstateprovider/inc/searchonlinestate.h
author hgs
Mon, 12 Jul 2010 00:27:06 +0530
changeset 13 0a2ec6860a93
parent 9 4a2987baf8f7
child 15 df6898e696c6
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description:  
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
#ifndef SEARCH_STATES_ONLINE_H
hgs
parents:
diff changeset
    18
#define SEARCH_STATES_ONLINE_H
hgs
parents:
diff changeset
    19
#include <qstate.h>
hgs
parents:
diff changeset
    20
#include "search_global.h"
hgs
parents:
diff changeset
    21
#include <hbicon.h>
hgs
parents:
diff changeset
    22
SEARCH_CLASS( SearchStateProviderTest)
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
class HbDocumentLoader;
hgs
parents:
diff changeset
    25
class HbView;
hgs
parents:
diff changeset
    26
class HbSearchPanel;
hgs
parents:
diff changeset
    27
class HbMainWindow;
hgs
parents:
diff changeset
    28
class OnlineHandler;
hgs
parents:
diff changeset
    29
/** @ingroup group_searchonlinestate
hgs
parents:
diff changeset
    30
 * @brief The state handles wizard activation and interaction.
hgs
parents:
diff changeset
    31
 *
hgs
parents:
diff changeset
    32
 * @see StateMachine
hgs
parents:
diff changeset
    33
 *
hgs
parents:
diff changeset
    34
 * @lib ?library
hgs
parents:
diff changeset
    35
 * @since S60 ?S60_version
hgs
parents:
diff changeset
    36
 */
hgs
parents:
diff changeset
    37
class SearchOnlineState : public QState
hgs
parents:
diff changeset
    38
    {
hgs
parents:
diff changeset
    39
Q_OBJECT
hgs
parents:
diff changeset
    40
public:
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
public:
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
     * Constructor.
hgs
parents:
diff changeset
    46
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
    47
     * @param aParent Owner.
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    SearchOnlineState(QState *aParent = 0);
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
    /**
hgs
parents:
diff changeset
    52
     * Destructor.
hgs
parents:
diff changeset
    53
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
    54
     */
hgs
parents:
diff changeset
    55
    virtual ~SearchOnlineState();
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
protected:
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
    /**
hgs
parents:
diff changeset
    60
     * @copydoc QState::onEntry()
hgs
parents:
diff changeset
    61
     */
hgs
parents:
diff changeset
    62
    void onEntry(QEvent *event);
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * @copydoc QState::onExit()
hgs
parents:
diff changeset
    66
     */
hgs
parents:
diff changeset
    67
    void onExit(QEvent *event);
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
private:
hgs
parents:
diff changeset
    70
    /**
hgs
parents:
diff changeset
    71
     * deactivates the signals .
hgs
parents:
diff changeset
    72
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
    73
     */
hgs
parents:
diff changeset
    74
    void deActivateSignals();
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * activates the signals .
hgs
parents:
diff changeset
    78
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
    79
     */
hgs
parents:
diff changeset
    80
    void activateSignals();
hgs
parents:
diff changeset
    81
    
hgs
parents:
diff changeset
    82
    void createui();
hgs
parents:
diff changeset
    83
public slots:
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
    /**
hgs
parents:
diff changeset
    86
     * slot connects to search panel to initiate the online search
hgs
parents:
diff changeset
    87
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
    88
     * @param aKeyword search keyword.
hgs
parents:
diff changeset
    89
     */
hgs
parents:
diff changeset
    90
    void startOnlineSearch(const QString &aKeyword);
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
     * slot connects to search panel to launch the settings delimiter
hgs
parents:
diff changeset
    94
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
    95
     */
hgs
parents:
diff changeset
    96
    void setSettings();
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
     * slot connects to search panel to cancel the outstanding search
hgs
parents:
diff changeset
   100
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
   101
     */
hgs
parents:
diff changeset
   102
    void cancelSearch();
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
    /**
hgs
parents:
diff changeset
   105
     * slot connects to online handler to get notified when plugin is intialized 
hgs
parents:
diff changeset
   106
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
   107
     */
hgs
parents:
diff changeset
   108
    void slotpluginIntialized(bool);
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
    /**
hgs
parents:
diff changeset
   111
     * slot connects to online handler to get notified when plugin is shutdown 
hgs
parents:
diff changeset
   112
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
   113
     */
hgs
parents:
diff changeset
   114
    void slotpluginShutdown(bool);
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
    /**
hgs
parents:
diff changeset
   117
     * slot connects to online handler to get notified when view changed  
hgs
parents:
diff changeset
   118
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
   119
     */
hgs
parents:
diff changeset
   120
    void slotbackEventTriggered();
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
    /**
hgs
parents:
diff changeset
   123
     * slot connects to progressive search state to get notified criteria in search panel  
hgs
parents:
diff changeset
   124
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
   125
     * @param aKeyword search keyword.     
hgs
parents:
diff changeset
   126
     */
hgs
parents:
diff changeset
   127
    void slotIndeviceQuery(QString);
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
    /**
hgs
parents:
diff changeset
   130
     * slot connects to progressive search state to launch the suggestion links  
hgs
parents:
diff changeset
   131
     * @since S60 ?S60_version.
hgs
parents:
diff changeset
   132
     * @param aKeyword search keyword.
hgs
parents:
diff changeset
   133
     * @param id search provider id.     
hgs
parents:
diff changeset
   134
     */
hgs
parents:
diff changeset
   135
    void slotlaunchLink(int, QString);
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
    /**
hgs
parents:
diff changeset
   138
     * slot connects to main window to get notify when view is ready  
hgs
parents:
diff changeset
   139
     * @since S60 ?S60_version.     
hgs
parents:
diff changeset
   140
     */
hgs
parents:
diff changeset
   141
    void slotviewReady();
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
signals:
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
    /**
hgs
parents:
diff changeset
   146
     * Signalled when user selects an to switch the settings state
hgs
parents:
diff changeset
   147
     * setting state will be  activated.
hgs
parents:
diff changeset
   148
     */
hgs
parents:
diff changeset
   149
    void switchOnlineToSettingsState();
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
    /**
hgs
parents:
diff changeset
   152
     * Signalled when user change the state to progressive state
hgs
parents:
diff changeset
   153
     * setting state will be  activated.
hgs
parents:
diff changeset
   154
     */
hgs
parents:
diff changeset
   155
    void onlineSearchQuery(QString);
hgs
parents:
diff changeset
   156
13
hgs
parents: 9
diff changeset
   157
    /**
hgs
parents: 9
diff changeset
   158
     * Signalled when UI is ready on online state        
hgs
parents: 9
diff changeset
   159
     */
hgs
parents: 9
diff changeset
   160
    void applicationReady();
hgs
parents: 9
diff changeset
   161
9
hgs
parents:
diff changeset
   162
private:
hgs
parents:
diff changeset
   163
    HbMainWindow* mMainWindow;
hgs
parents:
diff changeset
   164
    /**
hgs
parents:
diff changeset
   165
     * main view.
hgs
parents:
diff changeset
   166
     * Own.
hgs
parents:
diff changeset
   167
     */
hgs
parents:
diff changeset
   168
    HbView* mView;
hgs
parents:
diff changeset
   169
hgs
parents:
diff changeset
   170
    /**
hgs
parents:
diff changeset
   171
     * The searchpanel widget.
hgs
parents:
diff changeset
   172
     * Own.
hgs
parents:
diff changeset
   173
     */
hgs
parents:
diff changeset
   174
    HbSearchPanel* mSearchPanel;
hgs
parents:
diff changeset
   175
hgs
parents:
diff changeset
   176
    /**
hgs
parents:
diff changeset
   177
     * HbDocumentLoader instance.
hgs
parents:
diff changeset
   178
     */
hgs
parents:
diff changeset
   179
    HbDocumentLoader* mDocumentLoader;
hgs
parents:
diff changeset
   180
hgs
parents:
diff changeset
   181
    /**
hgs
parents:
diff changeset
   182
     * OnlineHandler instance.
hgs
parents:
diff changeset
   183
     */
hgs
parents:
diff changeset
   184
    OnlineHandler* mInternetHandler;
hgs
parents:
diff changeset
   185
hgs
parents:
diff changeset
   186
    /**
hgs
parents:
diff changeset
   187
     * search keyword.
hgs
parents:
diff changeset
   188
     */
hgs
parents:
diff changeset
   189
    QString mSearchQuery;
hgs
parents:
diff changeset
   190
    bool mSearchReady;
hgs
parents:
diff changeset
   191
    bool mIndeviceQueryAvailable;
hgs
parents:
diff changeset
   192
    bool mIsUICreated;
hgs
parents:
diff changeset
   193
    /**
hgs
parents:
diff changeset
   194
     * friend class for unit testing
hgs
parents:
diff changeset
   195
     */
hgs
parents:
diff changeset
   196
    SEARCH_FRIEND_CLASS (SearchStateProviderTest)
hgs
parents:
diff changeset
   197
    };
hgs
parents:
diff changeset
   198
hgs
parents:
diff changeset
   199
#endif //SEARCH_STATES_ONLINE_H