diff options
Diffstat (limited to 'TelepathyQt/contact-search-channel.h')
-rw-r--r-- | TelepathyQt/contact-search-channel.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/TelepathyQt/contact-search-channel.h b/TelepathyQt/contact-search-channel.h new file mode 100644 index 00000000..29c8424c --- /dev/null +++ b/TelepathyQt/contact-search-channel.h @@ -0,0 +1,114 @@ +/** + * This file is part of TelepathyQt + * + * @copyright Copyright (C) 2010 Collabora Ltd. <http://www.collabora.co.uk/> + * @copyright Copyright (C) 2010 Nokia Corporation + * @license LGPL 2.1 + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef _TelepathyQt_contact_search_channel_h_HEADER_GUARD_ +#define _TelepathyQt_contact_search_channel_h_HEADER_GUARD_ + +#ifndef IN_TP_QT_HEADER +#error IN_TP_QT_HEADER +#endif + +#include <TelepathyQt/Channel> +#include <TelepathyQt/Contact> +#include <TelepathyQt/Types> + +namespace Tp +{ + +class TP_QT_EXPORT ContactSearchChannel : public Channel +{ + Q_OBJECT + Q_DISABLE_COPY(ContactSearchChannel) + +public: + static const Feature FeatureCore; + + class SearchStateChangeDetails + { + public: + SearchStateChangeDetails(); + SearchStateChangeDetails(const SearchStateChangeDetails &other); + ~SearchStateChangeDetails(); + + bool isValid() const { return mPriv.constData() != 0; } + + SearchStateChangeDetails &operator=(const SearchStateChangeDetails &other); + + bool hasDebugMessage() const { return allDetails().contains(QLatin1String("debug-message")); } + QString debugMessage() const { return qdbus_cast<QString>(allDetails().value(QLatin1String("debug-message"))); } + + QVariantMap allDetails() const; + + private: + friend class ContactSearchChannel; + + TP_QT_NO_EXPORT SearchStateChangeDetails(const QVariantMap &details); + + struct Private; + friend struct Private; + QSharedDataPointer<Private> mPriv; + }; + + typedef QHash<ContactPtr, Contact::InfoFields> SearchResult; + + static ContactSearchChannelPtr create(const ConnectionPtr &connection, + const QString &objectPath, const QVariantMap &immutableProperties); + + virtual ~ContactSearchChannel(); + + ChannelContactSearchState searchState() const; + uint limit() const; + QStringList availableSearchKeys() const; + QString server() const; + + PendingOperation *search(const QString &searchKey, const QString &searchTerm); + PendingOperation *search(const ContactSearchMap &searchTerms); + void continueSearch(); + void stopSearch(); + +Q_SIGNALS: + void searchStateChanged(Tp::ChannelContactSearchState state, const QString &errorName, + const Tp::ContactSearchChannel::SearchStateChangeDetails &details); + void searchResultReceived(const Tp::ContactSearchChannel::SearchResult &result); + +protected: + ContactSearchChannel(const ConnectionPtr &connection, const QString &objectPath, + const QVariantMap &immutableProperties, const Feature &coreFeature); + +private Q_SLOTS: + TP_QT_NO_EXPORT void gotProperties(QDBusPendingCallWatcher *watcher); + TP_QT_NO_EXPORT void gotSearchState(QDBusPendingCallWatcher *watcher); + TP_QT_NO_EXPORT void onSearchStateChanged(uint state, const QString &error, const QVariantMap &details); + TP_QT_NO_EXPORT void onSearchResultReceived(const Tp::ContactSearchResultMap &result); + TP_QT_NO_EXPORT void gotSearchResultContacts(Tp::PendingOperation *op); + +private: + class PendingSearch; + + struct Private; + friend struct Private; + Private *mPriv; +}; + +} // Tp + +#endif |