/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef DESKTOP_NOTIFICATION_CONTROLLER_H
#define DESKTOP_NOTIFICATION_CONTROLLER_H

#include "qtwebenginecoreglobal.h"

#include <QtCore/QSharedPointer>
#include <QtCore/QUrl>
#include <QtGui/QImage>

class GURL;

namespace blink {
    struct NotificationResources;
    struct PlatformNotificationData;
}

namespace QtWebEngineCore {

class UserNotificationControllerPrivate;

// Works as an accessor and owner of chromium objects related to showing desktop notifications.
class Q_WEBENGINECORE_EXPORT UserNotificationController : public QEnableSharedFromThis<UserNotificationController> {
public:
    struct Delegate {
        virtual ~Delegate() { }
        virtual void shown() = 0;
        virtual void clicked() = 0;
        virtual void closed(bool byUser) = 0;
    };

    UserNotificationController(const blink::PlatformNotificationData &params,
                                  const blink::NotificationResources &resources,
                                  const GURL &origin,
                                  Delegate *delegate);
    ~UserNotificationController();

    // The notification was shown.
    void notificationDisplayed();

    // The notification was closed.
    void notificationClosed();

    // The user clicked on the notification.
    void notificationClicked();

    // Chromium requests to close the notification.
    void closeNotification();

    QUrl origin() const;
    QImage icon() const;
    QImage image() const;
    QImage badge() const;
    QString title() const;
    QString body() const;
    QString tag() const;
    QString language() const;
    Qt::LayoutDirection direction() const;

    bool isShown() const;

    class Client {
    public:
        virtual ~Client() { }
        virtual void notificationClosed(const UserNotificationController *) = 0;
    };
    void setClient(Client *client);
    Client* client();

private:
    UserNotificationControllerPrivate *d;
};

} // namespace QtWebEngineCore

#endif // DESKTOP_NOTIFICATION_CONTROLLER_H
