MythTV  master
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MythPlaybackNotification Class Reference

#include <mythnotification.h>

Inheritance diagram for MythPlaybackNotification:
Inheritance graph
[legend]
Collaboration diagram for MythPlaybackNotification:
Collaboration graph
[legend]

Public Member Functions

 MythPlaybackNotification (Type type, float progress, const QString &progressText)
 
 MythPlaybackNotification (Type type, float progress, const QString &progressText, const DMAP &metadata)
 
 MythPlaybackNotification (Type type, int duration, int position)
 
MythEventclone (void) const override
 
void SetProgress (float progress)
 current playback position to be displayed with the notification. More...
 
void SetProgressText (const QString &text)
 text to be displayed with the notification as duration or progress. More...
 
float GetProgress (void) const
 
QString GetProgressText (void) const
 
- Public Member Functions inherited from MythNotification
 MythNotification (Type type, void *parent=nullptr)
 
 MythNotification (int id, void *parent)
 
 MythNotification (const QString &title, const QString &author, const QString &details=QString())
 
 MythNotification (Type type, const QString &title, const QString &author, const QString &details=QString(), const QString &extra=QString())
 
 MythNotification (Type type, const DMAP &metadata)
 
 MythNotification (const MythEvent &me)
 
virtual ~MythNotification ()
 
void SetId (int id)
 Optional MythNotification elements. More...
 
void SetParent (void *parent)
 contains the parent address. More...
 
void SetFullScreen (bool f)
 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 &desc)
 contains a short description of the notification More...
 
void SetMetaData (const DMAP &data)
 metadata of the notification. More...
 
void SetDuration (int duration)
 contains a duration during which the notification will be displayed for. More...
 
void SetStyle (const QString &style)
 contains an alternative notification style. More...
 
void SetVisibility (VNMask n)
 define a bitmask of Visibility More...
 
void SetPriority (Priority n)
 For future use, not implemented at this stage. More...
 
void ToStringList (void)
 
bool FromStringList (void)
 
int GetId (void) const
 
void * GetParent (void) const
 
bool GetFullScreen (void) const
 
QString GetDescription (void) const
 
DMAP GetMetaData (void) const
 
int GetDuration (void) const
 
QString GetStyle (void) const
 
VNMask GetVisibility (void) const
 
Priority GetPriority (void) const
 
- Public Member Functions inherited from MythEvent
 MythEvent (int type)
 
 MythEvent (int type, QString lmessage)
 
 MythEvent (int type, QString lmessage, const QStringList &lextradata)
 
 MythEvent (QString lmessage)
 
 MythEvent (QString lmessage, const QStringList &lextradata)
 
 MythEvent (QString lmessage, const QString lextradata)
 
virtual ~MythEvent ()=default
 
const QString & Message () const
 
const QString & ExtraData (int idx=0) const
 
const QStringList & ExtraDataList () const
 
int ExtraDataCount () const
 

Static Public Member Functions

static QString stringFromSeconds (int time)
 stringFromSeconds: More...
 
- Static Public Member Functions inherited from MythNotification
static Type TypeFromString (const QString &type)
 return Type object from type name More...
 

Protected Member Functions

 MythPlaybackNotification (const MythPlaybackNotification &o)
 
- Protected Member Functions inherited from MythNotification
 MythNotification (const MythNotification &o)
 
MythNotificationoperator= (const MythNotification &)
 

Protected Attributes

float m_progress
 
QString m_progressText
 
- Protected Attributes inherited from MythNotification
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}
 
- Protected Attributes inherited from MythEvent
QString m_message
 
QStringList m_extradata
 

Additional Inherited Members

- Public Types inherited from MythNotification
enum  Priority {
  kDefault = 0, kLow, kMedium, kHigh,
  kHigher, kHighest
}
 Priority enum A notification can be given a priority. More...
 
enum  Visibility {
  kNone = 0, kAll = ~0, kPlayback = (1 << 0), kSettings = (1 << 1),
  kWizard = (1 << 2), kVideos = (1 << 3), kMusic = (1 << 4), kRecordings = (1 << 5)
}
 Visibility enum A notification can be given visibility mask allowing to not be visible under some circumstances, like the screen currently being displayed. More...
 
- Static Public Attributes inherited from MythNotification
static Type New
 
static Type Update
 
static Type Info
 
static Type Error
 
static Type Warning
 
static Type Check
 
static Type Busy
 
- Static Public Attributes inherited from MythEvent
static Type MythEventMessage
 
static Type MythUserMessage
 
static Type kUpdateTvProgressEventType
 
static Type kExitToMainMenuEventType
 
static Type kMythPostShowEventType
 
static Type kPushDisableDrawingEventType
 
static Type kPopDisableDrawingEventType
 
static Type kLockInputDevicesEventType
 
static Type kUnlockInputDevicesEventType
 
static Type kUpdateBrowseInfoEventType
 
static Type kDisableUDPListenerEventType
 
static Type kEnableUDPListenerEventType
 

Detailed Description

Definition at line 268 of file mythnotification.h.

Constructor & Destructor Documentation

◆ MythPlaybackNotification() [1/4]

MythPlaybackNotification::MythPlaybackNotification ( Type  type,
float  progress,
const QString &  progressText 
)
inline

Definition at line 271 of file mythnotification.h.

◆ MythPlaybackNotification() [2/4]

MythPlaybackNotification::MythPlaybackNotification ( Type  type,
float  progress,
const QString &  progressText,
const DMAP metadata 
)
inline

Definition at line 276 of file mythnotification.h.

◆ MythPlaybackNotification() [3/4]

MythPlaybackNotification::MythPlaybackNotification ( Type  type,
int  duration,
int  position 
)
inline

Definition at line 283 of file mythnotification.h.

◆ MythPlaybackNotification() [4/4]

MythPlaybackNotification::MythPlaybackNotification ( const MythPlaybackNotification o)
inlineprotected

Definition at line 313 of file mythnotification.h.

Member Function Documentation

◆ clone()

MythEvent* MythPlaybackNotification::clone ( void  ) const
inlineoverridevirtual

Reimplemented from MythNotification.

Reimplemented in MythMediaNotification.

Definition at line 290 of file mythnotification.h.

◆ SetProgress()

void MythPlaybackNotification::SetProgress ( float  progress)
inline

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.

Definition at line 299 of file mythnotification.h.

◆ SetProgressText()

void MythPlaybackNotification::SetProgressText ( const QString &  text)
inline

text to be displayed with the notification as duration or progress.

Definition at line 303 of file mythnotification.h.

◆ GetProgress()

float MythPlaybackNotification::GetProgress ( void  ) const
inline

Definition at line 306 of file mythnotification.h.

Referenced by MythNotificationScreen::SetNotification().

◆ GetProgressText()

QString MythPlaybackNotification::GetProgressText ( void  ) const
inline

Definition at line 307 of file mythnotification.h.

Referenced by MythNotificationScreen::SetNotification().

◆ stringFromSeconds()

QString MythPlaybackNotification::stringFromSeconds ( int  time)
static

stringFromSeconds:

Usage: stringFromSeconds(seconds). Description: create a string in the format HH:mm:ss from a duration in seconds. HH: will not be displayed if there's less than one hour.

Definition at line 101 of file mythnotification.cpp.

Member Data Documentation

◆ m_progress

float MythPlaybackNotification::m_progress
protected

Definition at line 320 of file mythnotification.h.

◆ m_progressText

QString MythPlaybackNotification::m_progressText
protected

Definition at line 321 of file mythnotification.h.


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