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

#include <backendcontext.h>

Collaboration diagram for Frontend:
Collaboration graph
[legend]

Public Member Functions

 Frontend ()=default
 
 ~Frontend ()=default
 
Q_INVOKABLE Frontend (QObject *parent=nullptr)
 
DTC::FrontendStatusGetStatus (void) override
 
bool SendMessage (const QString &Message, uint TimeoutInt) override
 
bool SendNotification (bool Error, const QString &Type, const QString &Message, const QString &Origin, const QString &Description, const QString &Image, const QString &Extra, const QString &ProgressText, float Progress, int Timeout, bool Fullscreen, uint Visibility, uint Priority) override
 
bool SendAction (const QString &Action, const QString &Value, uint Width, uint Height) override
 
bool PlayRecording (int RecordedId, int ChanId, const QDateTime &StartTime) override
 
bool PlayVideo (const QString &Id, bool UseBookmark) override
 
QStringList GetContextList (void) override
 
DTC::FrontendActionListGetActionList (const QString &Context) override
 
bool SendKey (const QString &Key) override
 

Static Public Member Functions

static bool IsValidAction (const QString &action)
 
static void InitialiseActions (void)
 

Public Attributes

QString m_name
 
QHostAddress m_ip
 The user friendly name of the frontend. More...
 
int m_connectionCount {0}
 The frontend IP address. More...
 

Static Protected Attributes

static QStringList gActionList = QStringList()
 
static QHash< QString, QStringList > gActionDescriptions = QHash<QString,QStringList>()
 

Friends

class MythFEXML
 

Detailed Description

Definition at line 19 of file backendcontext.h.

Constructor & Destructor Documentation

◆ Frontend() [1/2]

Frontend::Frontend ( )
default

◆ ~Frontend()

Frontend::~Frontend ( )
default

◆ Frontend() [2/2]

Q_INVOKABLE Frontend::Frontend ( QObject *  parent = nullptr)
inlineexplicit

Definition at line 18 of file programs/mythfrontend/services/frontend.h.

Member Function Documentation

◆ GetStatus()

DTC::FrontendStatus * Frontend::GetStatus ( void  )
override

Definition at line 35 of file frontend.cpp.

◆ SendMessage()

bool Frontend::SendMessage ( const QString &  Message,
uint  TimeoutInt 
)
override

Definition at line 47 of file frontend.cpp.

◆ SendNotification()

bool Frontend::SendNotification ( bool  Error,
const QString &  Type,
const QString &  Message,
const QString &  Origin,
const QString &  Description,
const QString &  Image,
const QString &  Extra,
const QString &  ProgressText,
float  Progress,
int  Timeout,
bool  Fullscreen,
uint  Visibility,
uint  Priority 
)
override

Definition at line 62 of file frontend.cpp.

◆ SendAction()

bool Frontend::SendAction ( const QString &  Action,
const QString &  Value,
uint  Width,
uint  Height 
)
override

Definition at line 91 of file frontend.cpp.

◆ PlayRecording()

bool Frontend::PlayRecording ( int  RecordedId,
int  ChanId,
const QDateTime &  StartTime 
)
override

Definition at line 134 of file frontend.cpp.

◆ PlayVideo()

bool Frontend::PlayVideo ( const QString &  Id,
bool  UseBookmark 
)
override

Definition at line 197 of file frontend.cpp.

◆ GetContextList()

QStringList Frontend::GetContextList ( void  )
override

Definition at line 253 of file frontend.cpp.

◆ GetActionList()

DTC::FrontendActionList * Frontend::GetActionList ( const QString &  Context)
override

Definition at line 259 of file frontend.cpp.

◆ IsValidAction()

bool Frontend::IsValidAction ( const QString &  action)
static

Definition at line 284 of file frontend.cpp.

Referenced by SendAction().

◆ InitialiseActions()

void Frontend::InitialiseActions ( void  )
static

◆ SendKey()

bool Frontend::SendKey ( const QString &  Key)
override

Definition at line 340 of file frontend.cpp.

Friends And Related Function Documentation

◆ MythFEXML

friend class MythFEXML
friend

Definition at line 13 of file programs/mythfrontend/services/frontend.h.

Member Data Documentation

◆ m_name

QString Frontend::m_name

◆ m_ip

QHostAddress Frontend::m_ip

The user friendly name of the frontend.

Definition at line 26 of file backendcontext.h.

Referenced by BackendContext::SetFrontendConnected().

◆ m_connectionCount

int Frontend::m_connectionCount {0}

The frontend IP address.

Definition at line 28 of file backendcontext.h.

Referenced by BackendContext::SetFrontendConnected(), and BackendContext::SetFrontendDisconnected().

◆ gActionList

QStringList Frontend::gActionList = QStringList()
staticprotected

Definition at line 52 of file programs/mythfrontend/services/frontend.h.

Referenced by InitialiseActions(), and IsValidAction().

◆ gActionDescriptions

QHash< QString, QStringList > Frontend::gActionDescriptions = QHash<QString,QStringList>()
staticprotected

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