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 

    43 #ifndef QCONTACTPRESENCE_H

    44 #define QCONTACTPRESENCE_H

    45 

    46 #include <QString>

    47 #include <QUrl>

    48 

    49 #include "qtcontactsglobal.h"

    50 #include "qcontactdetail.h"

    51 #include "qcontact.h"

    52 

    53 QTM_BEGIN_NAMESPACE

    54 

    55 /* Leaf class */

    56 class Q_CONTACTS_EXPORT QContactPresence : public QContactDetail

    57 {

    58 public:

    59 #ifdef Q_QDOC

    60     static const QLatin1Constant DefinitionName;

    61     static const QLatin1Constant FieldTimestamp;

    62     static const QLatin1Constant FieldNickname;

    63     static const QLatin1Constant FieldPresenceState;

    64     static const QLatin1Constant FieldPresenceStateText;

    65     static const QLatin1Constant FieldPresenceStateImageUrl;

    66     static const QLatin1Constant FieldCustomMessage;

    67 #else

    68     Q_DECLARE_CUSTOM_CONTACT_DETAIL(QContactPresence, "Presence")

    69     Q_DECLARE_LATIN1_CONSTANT(FieldTimestamp, "Timestamp");

    70     Q_DECLARE_LATIN1_CONSTANT(FieldNickname, "Nickname");

    71     Q_DECLARE_LATIN1_CONSTANT(FieldPresenceState, "PresenceState");

    72     Q_DECLARE_LATIN1_CONSTANT(FieldPresenceStateText, "PresenceStateText");

    73     Q_DECLARE_LATIN1_CONSTANT(FieldPresenceStateImageUrl, "PresenceStateImageUrl");

    74     Q_DECLARE_LATIN1_CONSTANT(FieldCustomMessage, "CustomMessage");

    75 #endif

    76 

    77     enum PresenceState {

    78         PresenceUnknown = 0,

    79         PresenceAvailable,

    80         PresenceHidden,

    81         PresenceBusy,

    82         PresenceAway,

    83         PresenceExtendedAway,

    84         PresenceOffline,

    85     };

    86 

    87     void setTimestamp(const QDateTime& timestamp) {setValue(FieldTimestamp, timestamp);}

    88     QDateTime timestamp() const {return value<QDateTime>(FieldTimestamp);}

    89     void setNickname(const QString& nickname) {setValue(FieldNickname, nickname);}

    90     QString nickname() const {return value(FieldNickname);}

    91     void setPresenceState(PresenceState presence) {setValue(FieldPresenceState, static_cast<int>(presence));}

    92     PresenceState presenceState() const {return static_cast<PresenceState>(value<int>(FieldPresenceState));}

    93     void setPresenceStateText(const QString& presenceStateText) {setValue(FieldPresenceStateText, presenceStateText);}

    94     QString presenceStateText() const {return value(FieldPresenceStateText);}

    95     void setPresenceStateImageUrl(const QUrl& presenceStateImageUrl) {setValue(FieldPresenceStateImageUrl, presenceStateImageUrl);}

    96     QUrl presenceStateImageUrl() const {return value(FieldPresenceStateImageUrl);}

    97     void setCustomMessage(const QString& customMessage) {setValue(FieldCustomMessage, customMessage);}

    98     QString customMessage() const {return value(FieldCustomMessage);}

    99 };

   100 

   101 QTM_END_NAMESPACE

   102 

   103 #endif

   104