mythnotificationcenter.h

Go to the documentation of this file.

//
//  mythnotificationcenter.h
//  MythTV
//
//  Created by Jean-Yves Avenard on 25/06/13.
//  Copyright (c) 2013 Bubblestuff Pty Ltd. All rights reserved.
//
 
#ifndef MYTHTV_MYTHNOTIFICATIONCENTER_H
#define MYTHTV_MYTHNOTIFICATIONCENTER_H
 
#include <QList>
#include <QDateTime>
#include <QMutex>
 
#include "mythuiexp.h"
 
#include "mythnotification.h"
 
// .h
 
class MythScreenType;
class NCPrivate;
 
class MUI_PUBLIC MythNotificationCenterEvent : public MythEvent
{
public:
    MythNotificationCenterEvent() : MythEvent(kEventType) { }
 
    static const Type kEventType;
 
    // No implicit copying.
    MythNotificationCenterEvent(MythNotificationCenterEvent &&) = delete;
    MythNotificationCenterEvent &operator=(MythNotificationCenterEvent &&) = delete;
protected:
    MythNotificationCenterEvent(const MythNotificationCenterEvent &other) = default;
    MythNotificationCenterEvent &operator=(const MythNotificationCenterEvent &other) = default;
};
 
class MUI_PUBLIC MythNotificationCenter
{
public:
    MythNotificationCenter(void);
    virtual ~MythNotificationCenter();
 
    bool Queue(const MythNotification &notification);
 
    static MythNotificationCenter *GetInstance(void);
 
    int  Register(void *from);
    void UnRegister(void *from, int id, bool closeimemdiately = false);
 
    /*
     * OSD drawing utilities
     */
 
    static QDateTime ScreenExpiryTime(const MythScreenType *screen);
    static bool ScreenCreated(const MythScreenType *screen);
    void GetNotificationScreens(QList<MythScreenType*> &screens);
    static void UpdateScreen(MythScreenType *screen);
    int DisplayedNotifications(void) const;
    int QueuedNotifications(void) const;
    bool RemoveFirst(void);
    void ProcessQueue(void);
 
private:
    NCPrivate *d {nullptr}; // NOLINT(readability-identifier-naming)
};
 
MUI_PUBLIC void ShowNotificationError(const QString &msg,
                                      const QString &from = QString(),
                                      const QString &detail = QString(),
                                      VNMask visibility = MythNotification::kAll,
                                      MythNotification::Priority priority = MythNotification::kDefault);
 
MUI_PUBLIC void ShowNotification(const QString &msg,
                                 const QString &from = QString(),
                                 const QString &detail = QString(),
                                 VNMask visibility = MythNotification::kAll,
                                 MythNotification::Priority priority = MythNotification::kDefault);
 
MUI_PUBLIC void ShowNotification(bool  error,
                                 const QString &msg,
                                 const QString &origin = QString(),
                                 const QString &detail = QString(),
                                 const QString &image = QString(),
                                 const QString &extra = QString(),
                                 const QString &progress_text = QString(),
                                 float progress = -1.0F,
                                 std::chrono::seconds duration = -1s,
                                 bool  fullscreen = false,
                                 VNMask visibility = MythNotification::kAll,
                                 MythNotification::Priority priority = MythNotification::kDefault,
                                 const QString &style = QString());
 
MUI_PUBLIC void ShowNotification(MythNotification::Type type,
                                 const QString &msg,
                                 const QString &origin = QString(),
                                 const QString &detail = QString(),
                                 const QString &image = QString(),
                                 const QString &extra = QString(),
                                 const QString &progress_text = QString(),
                                 float progress = -1.0F,
                                 std::chrono::seconds duration = -1s,
                                 bool  fullscreen = false,
                                 VNMask visibility = MythNotification::kAll,
                                 MythNotification::Priority priority = MythNotification::kDefault,
                                 const QString &style = QString());
 
#endif /* defined(MYTHTV_MYTHNOTIFICATIONCENTER_H) */