mythnotification.h

Go to the documentation of this file.

//
//  mythnotification.h
//  MythTV
//
//  Created by Jean-Yves Avenard on 25/06/13.
//  Copyright (c) 2013 Bubblestuff Pty Ltd. All rights reserved.
//

#ifndef __MythTV__mythnotification__
#define __MythTV__mythnotification__

#include <utility>

// Qt headers
#include <QImage>
#include <QMap>
#include <QMutex>

// MythTV headers
#include "mythevent.h"
#include "mythuiexp.h"

using DMAP = QMap<QString,QString>;
using VNMask = unsigned int;

class MUI_PUBLIC MythNotification : public MythEvent
{
  public:

    static Type New;
    static Type Update;
    static Type Info;
    static Type Error;
    static Type Warning;
    static Type Check;
    static Type Busy;

    explicit MythNotification(Type type, void *parent = nullptr)
        : MythEvent(type, "NOTIFICATION"), m_parent(parent) {}

    MythNotification(int id, void *parent)
        : MythEvent(Update, "NOTIFICATION"), m_id(id), m_parent(parent) {}

    MythNotification(const QString &title, const QString &author,
                     const QString &details = QString())
        : MythEvent(New, "NOTIFICATION"), m_description(title)
    {
        DMAP map;
        map["minm"] = title;
        map["asar"] = author;
        map["asal"] = details;
        m_metadata = map;
        ToStringList();
    }

    MythNotification(Type type, const QString &title, const QString &author,
                     const QString &details = QString(),
                     const QString &extra   = QString())
        : MythEvent(type, "NOTIFICATION"), m_description(title)
    {
        DMAP map;
        map["minm"] = title;
        map["asar"] = author;
        map["asal"] = details;
        map["asfm"] = extra;
        m_metadata = map;
        ToStringList();
    }

    MythNotification(Type type, DMAP metadata)
        : MythEvent(type, "NOTIFICATION"), m_metadata(std::move(metadata))
    {
        ToStringList();
    }

    explicit MythNotification(const MythEvent &me)
        : MythEvent(me)
    {
        FromStringList();
    }

    ~MythNotification() override = default;

    MythEvent *clone(void) const override // MythEvent
        { return new MythNotification(*this); }

    enum Priority {
        kDefault    = 0,
        kLow,
        kMedium,
        kHigh,
        kHigher,
        kHighest,
    };

    enum Visibility {
        kNone       = 0,
        kAll        = ~0,
        kPlayback   = (1 << 0),
        kSettings   = (1 << 1),
        kWizard     = (1 << 2),
        kVideos     = (1 << 3),
        kMusic      = (1 << 4),
        kRecordings = (1 << 5),
    };

    // Setter
    void SetId(int id);
    void SetParent(void *parent)            { m_parent = parent; }
    void SetFullScreen(bool f)             { m_fullScreen = f; ToStringList(); }
    void SetDescription(const QString &desc)
                                      { m_description = desc; ToStringList();  }
    void SetMetaData(const DMAP &data)   { m_metadata = data; ToStringList(); }
    void SetDuration(int duration)     { m_duration = duration; ToStringList(); }
    void SetStyle(const QString &style)     { m_style = style; ToStringList(); }
    void SetVisibility(VNMask n)            { m_visibility = n; ToStringList(); }
    void SetPriority(Priority n)             { m_priority = n; ToStringList(); }

    static Type TypeFromString(const QString &type);

    void ToStringList(void);
    bool FromStringList(void);

    // Getter
    int         GetId(void) const           { return m_id; }
    void       *GetParent(void) const       { return m_parent; }
    bool        GetFullScreen(void) const   { return m_fullScreen; }
    QString     GetDescription(void) const  { return m_description; }
    DMAP        GetMetaData(void) const     { return m_metadata; }
    int         GetDuration(void) const     { return m_duration; };
    QString     GetStyle(void) const        { return m_style; }
    VNMask      GetVisibility(void) const   { return m_visibility; }
    Priority    GetPriority(void) const     { return m_priority; }

  protected:
    MythNotification(const MythNotification &o)
        : MythEvent(o),
        m_id(o.m_id),      m_parent(o.m_parent),   m_fullScreen(o.m_fullScreen),
        m_description(o.m_description),
        m_duration(o.m_duration),                  m_metadata(o.m_metadata),
        m_style(o.m_style),
        m_visibility(o.m_visibility),              m_priority(o.m_priority)
    {
        ToStringList();
    }

#ifndef _MSC_VER
    MythNotification &operator=(const MythNotification&);
#endif

  protected:
    int         m_id          {-1};
    void       *m_parent      {nullptr};
    bool        m_fullScreen  {false};
    QString     m_description;
    int         m_duration    {0};
    DMAP        m_metadata;
    QString     m_style;
    VNMask      m_visibility  {(VNMask)kAll};
    Priority    m_priority    {kDefault};
};

class MUI_PUBLIC MythImageNotification : public virtual MythNotification
{
  public:
    MythImageNotification(Type type, QImage image)
        : MythNotification(type), m_image(std::move(image))
    {
    }

    MythImageNotification(Type type, QString imagePath)
        : MythNotification(type), m_imagePath(std::move(imagePath))
    {
    }

    MythImageNotification(Type type, QImage image, const DMAP &metadata)
        : MythNotification(type, metadata), m_image(std::move(image))
    {
    }

    MythImageNotification(Type type, QString imagePath, const DMAP &metadata)
        : MythNotification(type, metadata), m_imagePath(std::move(imagePath))
    {
    }

    MythEvent *clone(void) const override // MythNotification
        { return new MythImageNotification(*this); }

    // Setter
    void SetImage(const QImage &image)      { m_image = image; }
    void SetImagePath(const QString &image) { m_imagePath = image; }

    //Getter
    QImage GetImage(void) const             { return m_image; }
    QString GetImagePath(void) const        { return m_imagePath; }

  protected:
    MythImageNotification(const MythImageNotification&) = default;

  protected:
    QImage      m_image;
    QString     m_imagePath;
};

class MUI_PUBLIC MythPlaybackNotification : public virtual MythNotification
{
  public:
    MythPlaybackNotification(Type type, float progress, QString progressText)
        : MythNotification(type), m_progress(progress), m_progressText(std::move(progressText))
    {
    }

    MythPlaybackNotification(Type type, float progress, QString progressText,
                             const DMAP &metadata)
        : MythNotification(type, metadata),
        m_progress(progress), m_progressText(std::move(progressText))
    {
    }

    MythPlaybackNotification(Type type, int duration, int position)
        : MythNotification(type)
    {
        m_progress      = (float)position / (float)duration;
        m_progressText  = stringFromSeconds(duration);
    }

    MythEvent *clone(void) const override // MythNotification
        { return new MythPlaybackNotification(*this); }

    // Setter
    void SetProgress(float progress)        { m_progress = progress; }
    void SetProgressText(const QString &text) { m_progressText = text; }

    //Getter
    float GetProgress(void) const           { return m_progress; }
    QString GetProgressText(void) const     { return m_progressText; }

    // utility methods
    static QString stringFromSeconds(int time);

  protected:
    MythPlaybackNotification(const MythPlaybackNotification&) = default;

  protected:
    float       m_progress;
    QString     m_progressText;
};

class MUI_PUBLIC MythMediaNotification : public MythImageNotification,
                                         public MythPlaybackNotification
{
  public:
    MythMediaNotification(Type type, const QImage &image, const DMAP &metadata,
                          float progress, const QString &durationText)
        : MythNotification(type, metadata), MythImageNotification(type, image),
        MythPlaybackNotification(type, progress, durationText)
    {
    }

    MythMediaNotification(Type type, const QImage &image, const DMAP &metadata,
                          int duration, int position)
        : MythNotification(type, metadata), MythImageNotification(type, image),
        MythPlaybackNotification(type, duration, position)
    {
    }

    MythMediaNotification(Type type, const QString &imagePath, const DMAP &metadata,
                          float progress, const QString &durationText)
        : MythNotification(type, metadata), MythImageNotification(type, imagePath),
        MythPlaybackNotification(type, progress, durationText)
    {
    }

    MythMediaNotification(Type type, const QString &imagePath, const DMAP &metadata,
                          int duration, int position)
        : MythNotification(type, metadata), MythImageNotification(type, imagePath),
        MythPlaybackNotification(type, duration, position)
    {
    }

    MythEvent *clone(void) const override // MythImageNotification
        { return new MythMediaNotification(*this); }

  protected:
    MythMediaNotification(const MythMediaNotification &o)
        : MythNotification(o), MythImageNotification(o), MythPlaybackNotification(o)
    {
    }
};

class MUI_PUBLIC MythErrorNotification : public MythNotification
{
  public:
    MythErrorNotification(const QString &title, const QString &author,
                          const QString &details = QString())
        : MythNotification(Error, title, author, details)
    {
        SetDuration(10);
    }
};

class MUI_PUBLIC MythWarningNotification : public MythNotification
{
  public:
    MythWarningNotification(const QString &title, const QString &author,
                            const QString &details = QString())
    : MythNotification(Warning, title, author, details)
    {
        SetDuration(10);
    }
};

class MUI_PUBLIC MythCheckNotification : public MythNotification
{
  public:
    MythCheckNotification(const QString &title, const QString &author,
                          const QString &details = QString())
    : MythNotification(Check, title, author, details)
    {
        SetDuration(5);
    }
};

class MUI_PUBLIC MythBusyNotification : public MythNotification
{
  public:
    MythBusyNotification(const QString &title, const QString &author,
                         const QString &details = QString())
    : MythNotification(Busy, title, author, details) { }
};

#endif /* defined(__MythTV__mythnotification__) */