notificationlistmodel.h

/***************************************************************************
**
** Copyright (c) 2012 Jolla Ltd.
**
** This file is part of lipstick.
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation
** and appearing in the file LICENSE.LGPL included in the packaging
** of this file.
**
****************************************************************************/

#ifndef NOTIFICATIONLISTMODEL_H
#define NOTIFICATIONLISTMODEL_H

#include "qobjectlistmodel.h"
#include "lipstickglobal.h"

class LipstickNotification;

class LIPSTICK_EXPORT NotificationListModel : public QObjectListModel
{
    Q_OBJECT
    Q_PROPERTY(bool populated READ populated NOTIFY populatedChanged)

public:
    explicit NotificationListModel(QObject *parent = 0);
    virtual ~NotificationListModel();

    bool populated() const;

signals:
    void populatedChanged(bool populated);
    void clearRequested();

private slots:
    void init();
    void updateNotifications(const QList<uint> &ids);
    void removeNotification(uint id);
    void removeNotifications(const QList<uint> &ids);

protected:
    /*!
     * Checks whether the given notification should be shown. A notification
     * should be shown when it's class is not system and it has a body and a
     * summary.
     *
     * \param notification the notification to check
     * \return \c true if the notification should be shown, \c false otherwise
     */
    virtual bool notificationShouldBeShown(LipstickNotification *notification);

    /*!
     * Checks where the notification should be placed so that the
     * notifications in the model are ordered by timestamp.
     *
     * \param notification the notification for which to get the position
     * \return index in which the notification shoud be placed
     */
    virtual int indexFor(LipstickNotification *notification);

    void refreshModel();

    void markAsDisplayed(uint id);

private:
    Q_DISABLE_COPY(NotificationListModel)

    void updateNotification(uint id);
    bool m_populated;

#ifdef UNIT_TEST
    friend class Ut_NotificationListModel;
#endif
};

#endif // NOTIFICATIONLISTMODEL_H