contacts-model.h

Go to the documentation of this file.

/*
 * Model of all accounts with inbuilt grouping and filtering
 *
 * Copyright (C) 2013 David Edmundson <kde@davidedmundson.co.uk>
 *
 * 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 KTP_CONTACTS_MODEL_H
#define KTP_CONTACTS_MODEL_H

#include <KTp/Models/contacts-filter-model.h>
#include <KTp/types.h>
#include <KTp/ktp-export.h>

namespace KTp
{

class KTP_EXPORT ContactsModel : public KTp::ContactsFilterModel
{
    Q_OBJECT
    Q_PROPERTY(GroupMode groupMode READ groupMode WRITE setGroupMode NOTIFY groupModeChanged)
    Q_PROPERTY(bool trackUnreadMessages READ trackUnreadMessages WRITE setTrackUnreadMessages NOTIFY trackUnreadMessagesChanged)

    Q_PROPERTY(Tp::AccountManagerPtr accountManager READ accountManager WRITE setAccountManager)

    Q_ENUMS(GroupMode)

public:
    enum GroupMode {
        NoGrouping,
        AccountGrouping,
        GroupGrouping
    };

    ContactsModel(QObject *parent);

    virtual ~ContactsModel();

    void setAccountManager(const Tp::AccountManagerPtr &accountManager);

    Tp::AccountManagerPtr accountManager() const;

    void setGroupMode(GroupMode mode);

    GroupMode groupMode() const;

    void setTrackUnreadMessages(bool trackUnread);
    bool trackUnreadMessages() const;

protected:
    //prevent previously public setSourceModel being called externally
    virtual void setSourceModel(QAbstractItemModel *sourceModel);

Q_SIGNALS:
    void groupModeChanged();
    void trackUnreadMessagesChanged();

private:
    class Private;
    Private *d;

    void updateGroupProxyModels();
};

}

#endif // KTP_CONTACTS_MODEL_H