satui/satapp/inc/satappaction.h
author hgs
Tue, 10 Aug 2010 13:19:41 +0300
changeset 38 bc103bfb69cf
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 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
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef SATAPPACTION_H
hgs
parents:
diff changeset
    20
#define SATAPPACTION_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <QObject>
hgs
parents:
diff changeset
    23
#include <QString>
hgs
parents:
diff changeset
    24
#include <QVariant>
hgs
parents:
diff changeset
    25
#include <QMap>
hgs
parents:
diff changeset
    26
#include <e32base.h> // for symbian-to-qt conversions
hgs
parents:
diff changeset
    27
#include "MSatUiObserver.h" // for the param type definitions
hgs
parents:
diff changeset
    28
#include "satappconstant.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// class declaration
hgs
parents:
diff changeset
    31
class SatAppAction : public QObject
hgs
parents:
diff changeset
    32
{
hgs
parents:
diff changeset
    33
    Q_OBJECT
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
public:
hgs
parents:
diff changeset
    36
    /** creates an action with given identity (TSatAction) */
hgs
parents:
diff changeset
    37
    SatAppAction(int action, QObject *parent = 0);
hgs
parents:
diff changeset
    38
    ~SatAppAction();
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
    /** synchronous wait until the action has been completed */
hgs
parents:
diff changeset
    41
    void waitUntilCompleted();
hgs
parents:
diff changeset
    42
    /** completes the action with guiven response */
hgs
parents:
diff changeset
    43
    void complete(TSatUiResponse resp);
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
public slots:
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
    /** completes the action */
hgs
parents:
diff changeset
    48
    void complete() {complete(response());}
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
    // comfy methods for completing with certain response
hgs
parents:
diff changeset
    51
    void completeWithSuccess() {complete(ESatSuccess);}
hgs
parents:
diff changeset
    52
    void completeWithFailure() {complete(ESatFailure);}
hgs
parents:
diff changeset
    53
    void completeWithNoResponse() {complete(ESatNoResponseFromUser);}
hgs
parents:
diff changeset
    54
    void completeWithBackRequested() {complete(ESatBackwardModeRequestedByUser);}
hgs
parents:
diff changeset
    55
    void completeWithSessionTerminated() {complete(ESatSessionTerminatedByUser);}
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
signals:
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
    /** signalled when the action has been completed */
hgs
parents:
diff changeset
    60
    void actionCompleted(SatAppAction *action);
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
public: // param access
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    /** returns the identity of the action (TSatAction) */
hgs
parents:
diff changeset
    65
    int action() {return mAction;}
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
    /** sets the action response */
hgs
parents:
diff changeset
    68
    void setResponse(TSatUiResponse resp) {mResponse=resp;}
hgs
parents:
diff changeset
    69
    /** the action response (TSatUiResponse) */
hgs
parents:
diff changeset
    70
    TSatUiResponse response() {return mResponse;}
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    /** sets a value (arbitary type) */
hgs
parents:
diff changeset
    73
    void set(const QString& key, QVariant value);
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    /** sets QString value after doing symbian-to-qt conversion */
hgs
parents:
diff changeset
    76
    void set(const QString& key, const TDesC& value);
hgs
parents:
diff changeset
    77
    /** sets QStringList value after doing symbian-to-qt conversion */
hgs
parents:
diff changeset
    78
    void set(const QString& key, const MDesCArray& value);
hgs
parents:
diff changeset
    79
    /** sets QList<int> value after doing symbian-to-qt conversion */
hgs
parents:
diff changeset
    80
    void set(const QString& key, CArrayFixFlat<TInt>& value);
hgs
parents:
diff changeset
    81
    /** sets int(millisec) value after doing symbian-to-qt conversion */
hgs
parents:
diff changeset
    82
    void set(const QString& key, TTimeIntervalSeconds& value);
hgs
parents:
diff changeset
    83
    /** sets int(millisec) value after doing symbian-to-qt conversion */
hgs
parents:
diff changeset
    84
    void set(const QString& key, TTimeIntervalMicroSeconds& value);
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
    /** returns a value (arbitary type) */
hgs
parents:
diff changeset
    87
    QVariant value(const QString &key);
hgs
parents:
diff changeset
    88
    /** whether a value is present */
hgs
parents:
diff changeset
    89
    bool hasValue(const QString &key);
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
private: // data
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
    // identity of this action
hgs
parents:
diff changeset
    94
    int mAction;
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    // response
hgs
parents:
diff changeset
    97
    TSatUiResponse mResponse;
hgs
parents:
diff changeset
    98
    
hgs
parents:
diff changeset
    99
    // parameter map
hgs
parents:
diff changeset
   100
    QMap<QString, QVariant> mParams;
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    // internal action state
hgs
parents:
diff changeset
   103
    enum State {Active,Waiting,Completed};
hgs
parents:
diff changeset
   104
    State mState;
hgs
parents:
diff changeset
   105
};
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
#endif // SATAPPACTION_H
hgs
parents:
diff changeset
   108