1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Mobility Components.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QCONTACTABSTRACTREQUEST_H

    43 #define QCONTACTABSTRACTREQUEST_H

    44 

    45 #include "qcontactmanager.h"

    46 #include <QObject>

    47 

    48 QTM_BEGIN_NAMESPACE

    49 

    50 class QContactManagerEngine;

    51 class QContactAbstractRequestPrivate;

    52 class Q_CONTACTS_EXPORT QContactAbstractRequest : public QObject

    53 {

    54     Q_OBJECT

    55 

    56 public:

    57     ~QContactAbstractRequest();

    58 

    59     enum State {

    60         InactiveState = 0,   // operation not yet started

    61         ActiveState,         // operation started, not yet finished

    62         CanceledState,       // operation is finished due to cancellation

    63         FinishedState        // operation either completed successfully or failed.  No further results will become available.

    64     };

    65 

    66     State state() const; // replaces status()

    67     bool isInactive() const;

    68     bool isActive() const;

    69     bool isFinished() const;

    70     bool isCanceled() const;

    71     QContactManager::Error error() const;

    72 

    73     enum RequestType {

    74         InvalidRequest = 0,

    75         ContactFetchRequest,

    76         ContactLocalIdFetchRequest,

    77         ContactRemoveRequest,

    78         ContactSaveRequest,

    79         DetailDefinitionFetchRequest,

    80         DetailDefinitionRemoveRequest,

    81         DetailDefinitionSaveRequest,

    82         RelationshipFetchRequest,

    83         RelationshipRemoveRequest,

    84         RelationshipSaveRequest

    85     };

    86 

    87     RequestType type() const;

    88 

    89     /* Which manager we want to perform the asynchronous request */

    90     QContactManager* manager() const;

    91     void setManager(QContactManager* manager);

    92 

    93 public Q_SLOTS:

    94     /* Verbs */

    95     bool start();

    96     bool cancel();

    97 

    98     /* waiting for stuff */

    99     bool waitForFinished(int msecs = 0);

   100 

   101 Q_SIGNALS:

   102     void stateChanged(QContactAbstractRequest::State newState);

   103     void resultsAvailable();

   104 

   105 protected:

   106     QContactAbstractRequest(QContactAbstractRequestPrivate* otherd, QObject* parent = 0);

   107     QContactAbstractRequestPrivate* d_ptr;

   108 

   109 private:

   110     QContactAbstractRequest(QObject* parent = 0) : QObject(parent), d_ptr(0) {}

   111     Q_DISABLE_COPY(QContactAbstractRequest)

   112     friend class QContactManagerEngine;

   113     friend class QContactAbstractRequestPrivate;

   114 };

   115 

   116 QTM_END_NAMESPACE

   117 

   118 #endif