MythMediaNotification Class Reference

#include <libmythui/mythnotification.h>

Inheritance diagram for MythMediaNotification:

Collaboration diagram for MythMediaNotification:

Public Member Functions
	MythMediaNotification (Type nType, const QImage &Image, const DMAP &Metadata, float Progress, const QString &DurationText)
	MythMediaNotification (Type nType, const QImage &Image, const DMAP &Metadata, std::chrono::seconds Duration, int Position)
	MythMediaNotification (Type nType, const QString &Image, const DMAP &Metadata, float Progress, const QString &DurationText)
	MythMediaNotification (Type nType, const QString &Image, const DMAP &Metadata, std::chrono::seconds Duration, int Position)
MythEvent *	clone () const override
Public Member Functions inherited from MythImageNotification
	MythImageNotification (Type nType, QImage Image)
	MythImageNotification (Type nType, QString ImagePath)
	MythImageNotification (Type nType, QImage Image, const DMAP &Metadata)
	MythImageNotification (Type nType, QString ImagePath, const DMAP &Metadata)
MythEvent *	clone () const override
void	SetImage (const QImage &Image)
void	SetImagePath (const QString &Image)
QImage	GetImage () const
QString	GetImagePath () const
Public Member Functions inherited from MythNotification
	MythNotification (Type nType, void *Parent=nullptr)
	MythNotification (int Id, void *Parent)
	MythNotification (const QString &Title, const QString &Author, const QString &Details=QString())
	MythNotification (Type nType, const QString &Title, const QString &Author, const QString &Details=QString(), const QString &Extra=QString())
	MythNotification (Type nType, DMAP Metadata)
	MythNotification (const MythEvent &Event)
	~MythNotification () override=default
MythEvent *	clone () const override
	MythNotification (MythNotification &&)=delete
MythNotification &	operator= (MythNotification &&)=delete
void	SetId (int Id)
	Contains the application registration id. More...
void	SetParent (void *Parent)
	Contains the parent address. Required if id is set Id provided must match the parent address as provided during the MythNotificationCenter registration, otherwise the id value will be ignored. More...
void	SetFullScreen (bool FullScreen)
	A notification may request to be displayed in full screen, this request may not be fullfilled should the theme not handle full screen notification. More...
void	SetDescription (const QString &Description)
	Contains a short description of the notification. More...
void	SetMetaData (const DMAP &MetaData)
	metadata of the notification. In DMAP format. DMAP can contains various information such as artist, album name, author name, genre etc.. More...
void	SetDuration (std::chrono::seconds Duration)
	Contains a duration during which the notification will be displayed for. The duration is informative only as the MythNotificationCenter will determine automatically how long a notification can be displayed for and will depend on priority, visibility and other factors. More...
void	SetStyle (const QString &sStyle)
	Contains an alternative notification style. Should a style be defined, the Notification Center will attempt to load an alternative theme and fall back to the default one if unsuccessful. More...
void	SetVisibility (VNMask nVisibility)
	Define a bitmask of Visibility. More...
void	SetPriority (Priority nPriority)
	Reserved for future use, not implemented at this stage. More...
void	ToStringList ()
bool	FromStringList ()
int	GetId () const
void *	GetParent () const
bool	GetFullScreen () const
QString	GetDescription () const
DMAP	GetMetaData () const
std::chrono::seconds	GetDuration () const
QString	GetStyle () const
VNMask	GetVisibility () const
Priority	GetPriority () const
Public Member Functions inherited from MythEvent
	MythEvent (int type)
	MythEvent (int type, QString lmessage)
	MythEvent (int type, QString lmessage, QStringList lextradata)
	MythEvent (QString lmessage)
	MythEvent (QString lmessage, QStringList lextradata)
	MythEvent (QString lmessage, const QString &lextradata)
	~MythEvent () override
const QString &	Message () const
const QString &	ExtraData (int idx=0) const
const QStringList &	ExtraDataList () const
int	ExtraDataCount () const
void	log (const QString &prefix)
MythEvent *	clone () const override
	MythEvent (MythEvent &&)=delete
MythEvent &	operator= (MythEvent &&)=delete
Public Member Functions inherited from MythPlaybackNotification
	MythPlaybackNotification (Type nType, float Progress, QString ProgressText)
	MythPlaybackNotification (Type nType, float Progress, QString ProgressText, const DMAP &Metadata)
	MythPlaybackNotification (Type nType, std::chrono::seconds Duration, int Position)
MythEvent *	clone () const override
void	SetProgress (float progress)
	Set the current playback position to be displayed with the notification. Value to be between 0 <= x <= 1. Note: x < 0 means no progress bar to be displayed. More...
void	SetProgressText (const QString &text)
float	GetProgress () const
QString	GetProgressText () const

Protected Member Functions
	MythMediaNotification (const MythMediaNotification &Notification)
Protected Member Functions inherited from MythImageNotification
	MythImageNotification (const MythImageNotification &)=default
Protected Member Functions inherited from MythNotification
	MythNotification (const MythNotification &Notification)
MythNotification &	operator= (const MythNotification &)
Protected Member Functions inherited from MythEvent
	MythEvent (const MythEvent &other)=default
MythEvent &	operator= (const MythEvent &other)=default
Protected Member Functions inherited from MythPlaybackNotification
	MythPlaybackNotification (const MythPlaybackNotification &)=default

Additional Inherited Members
Public Types inherited from MythNotification
enum	Priority : std::uint8_t {   kDefault = 0 , kLow , kMedium , kHigh ,   kHigher , kHighest }
enum	Visibility : std::uint8_t {   kNone = 0 , kAll = 0xFF , kPlayback = (1 << 0) , kSettings = (1 << 1) ,   kWizard = (1 << 2) , kVideos = (1 << 3) , kMusic = (1 << 4) , kRecordings = (1 << 5) }
Static Public Member Functions inherited from MythNotification
static Type	TypeFromString (const QString &Type)
Static Public Member Functions inherited from MythPlaybackNotification
static QString	StringFromSeconds (std::chrono::seconds Time)
	Create a string in the format HH:mm:ss from a duration in seconds. More...
Static Public Attributes inherited from MythNotification
static const Type	kNew = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kUpdate = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kInfo = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kError = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kWarning = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kCheck = static_cast<QEvent::Type>(QEvent::registerEventType())
static const Type	kBusy = static_cast<QEvent::Type>(QEvent::registerEventType())
Static Public Attributes inherited from MythEvent
static const Type	kMythEventMessage
static const Type	kMythUserMessage
static const Type	kUpdateTvProgressEventType
static const Type	kExitToMainMenuEventType
static const Type	kMythPostShowEventType
static const Type	kPushDisableDrawingEventType
static const Type	kPopDisableDrawingEventType
static const Type	kLockInputDevicesEventType
static const Type	kUnlockInputDevicesEventType
static const Type	kUpdateBrowseInfoEventType
static const Type	kDisableUDPListenerEventType
static const Type	kEnableUDPListenerEventType
Protected Attributes inherited from MythImageNotification
QImage	m_image
QString	m_imagePath
Protected Attributes inherited from MythNotification
int	m_id { -1 }
void *	m_parent { nullptr }
bool	m_fullScreen { false }
QString	m_description
std::chrono::seconds	m_duration { 0s }
DMAP	m_metadata
QString	m_style
VNMask	m_visibility { static_cast<VNMask>(kAll) }
Priority	m_priority { kDefault }
Protected Attributes inherited from MythEvent
QString	m_message
QStringList	m_extradata
Protected Attributes inherited from MythPlaybackNotification
float	m_progress { -1.0F }
QString	m_progressText

Detailed Description

Definition at line 180 of file mythnotification.h.

Constructor & Destructor Documentation

MythMediaNotification() [1/5]

MythMediaNotification::MythMediaNotification	(	Type	nType,
		const QImage &	Image,
		const DMAP &	Metadata,
		float	Progress,
		const QString &	DurationText
	)

Definition at line 305 of file mythnotification.cpp.

Referenced by clone().

MythMediaNotification() [2/5]

MythMediaNotification::MythMediaNotification	(	Type	nType,
		const QImage &	Image,
		const DMAP &	Metadata,
		std::chrono::seconds	Duration,
		int	Position
	)

Definition at line 313 of file mythnotification.cpp.

MythMediaNotification() [3/5]

MythMediaNotification::MythMediaNotification	(	Type	nType,
		const QString &	Image,
		const DMAP &	Metadata,
		float	Progress,
		const QString &	DurationText
	)

Definition at line 321 of file mythnotification.cpp.

MythMediaNotification() [4/5]

MythMediaNotification::MythMediaNotification	(	Type	nType,
		const QString &	Image,
		const DMAP &	Metadata,
		std::chrono::seconds	Duration,
		int	Position
	)

Definition at line 329 of file mythnotification.cpp.

MythMediaNotification() [5/5]

MythMediaNotification::MythMediaNotification ( const MythMediaNotification &  Notification )

protected

Definition at line 337 of file mythnotification.cpp.

Member Function Documentation

clone()

MythEvent * MythMediaNotification::clone ( void  ) const

override

Definition at line 344 of file mythnotification.cpp.

---

The documentation for this class was generated from the following files:

• mythtv/libs/libmythui/mythnotification.h
• mythtv/libs/libmythui/mythnotification.cpp