mythuiwebbrowser.h

Go to the documentation of this file.

#ifndef MYTHUI_WEBBROWSER_H_
#define MYTHUI_WEBBROWSER_H_
 
#include <QtGlobal>
#include <QUrl>
#include "mythuitype.h"
#include "mythuiexp.h"
 
#include <QString>
#include <QElapsedTimer>
#include <QColor>
#include <QIcon>
 
#include <QWebView>
#include <QWebPage>
#include <QNetworkReply>
 
class MythUIScrollBar;
class MythUIWebBrowser;
class MythUIBusyDialog;
class MythScreenType;
 
class BrowserApi : public QObject
{
    Q_OBJECT
  public:
    explicit BrowserApi(QObject *parent);
    ~BrowserApi(void) override;
 
    void setWebView(QWebView *view);
 
  public slots:
    static void Play(void);
    static void Stop(void);
    static void Pause(void);
 
    static void SetVolume(int volumn);
    int GetVolume(void);
 
    static void PlayFile(const QString& filename);
    static void PlayTrack(int trackID);
    static void PlayURL(const QString& url);
 
    QString GetMetadata(void);
 
  private slots:
    void attachObject();
 
  private:
    void customEvent(QEvent *e) override; // QObject
 
    QWebFrame *m_frame     { nullptr };
 
    bool       m_gotAnswer { false   };
    QString    m_answer;
};
 
class MythNetworkAccessManager : public QNetworkAccessManager
{
  Q_OBJECT
  public:
    MythNetworkAccessManager() = default;
 
  protected:
    QNetworkReply* createRequest(Operation op, const QNetworkRequest & req,
                                 QIODevice * outgoingData = nullptr) override; // QNetworkAccessManager
};
 
class MythWebPage : public QWebPage
{
  Q_OBJECT
 
  public:
    explicit MythWebPage(QObject *parent = nullptr);
    ~MythWebPage() override;
 
    bool extension (Extension extension, const ExtensionOption *option = nullptr,
                    ExtensionReturn *output = nullptr) override; // QWebPage
    bool supportsExtension (Extension extension) const override; // QWebPage
 
  protected:
    QString userAgentForUrl(const QUrl &url) const override; // QWebPage
 
  private:
    friend class MythWebView;
};
 
class MythWebView : public QWebView
{
  Q_OBJECT
 
  public:
    MythWebView(QWidget *parent, MythUIWebBrowser *parentBrowser);
    ~MythWebView(void) override;
 
    void keyPressEvent(QKeyEvent *event) override; // QWidget
    void customEvent(QEvent *e) override; // QWidget
 
  protected slots:
    void  handleUnsupportedContent(QNetworkReply *reply);
    void  handleDownloadRequested(const QNetworkRequest &request);
    QWebView *createWindow(QWebPage::WebWindowType type) override; // QWebView
 
  private:
    void showDownloadMenu(void);
    void doDownloadRequested(const QNetworkRequest &request);
    void doDownload(const QString &saveFilename);
    void openBusyPopup(const QString &message);
    void closeBusyPopup(void);
 
    static bool isMusicFile(const QString &extension, const QString &mimetype);
    static bool isVideoFile(const QString &extension, const QString &mimetype);
 
    QString getReplyMimetype(void);
    static QString getExtensionForMimetype(const QString &mimetype);
 
    MythWebPage      *m_webpage         {nullptr};
    MythUIWebBrowser *m_parentBrowser   {nullptr};
    BrowserApi       *m_api             {nullptr};
    QNetworkRequest   m_downloadRequest;
    QNetworkReply    *m_downloadReply   {nullptr};
    MythUIBusyDialog *m_busyPopup       {nullptr};
    bool              m_downloadAndPlay {false};
};
 
class MUI_PUBLIC MythUIWebBrowser : public MythUIType
{
  Q_OBJECT
 
  public:
    MythUIWebBrowser(MythUIType *parent, const QString &name);
    ~MythUIWebBrowser() override;
 
    void Init(void);
 
    void LoadPage(const QUrl& url);
    void SetHtml(const QString &html, const QUrl &baseUrl = QUrl());
 
    void LoadUserStyleSheet(const QUrl& url);
 
    bool keyPressEvent(QKeyEvent *event) override; // MythUIType
    void Pulse(void) override; // MythUIType
    void Scroll(int dx, int dy);
 
    QIcon GetIcon(void);
    QUrl  GetUrl(void);
    QString GetTitle(void);
 
    void SetActive(bool active);
    bool IsActive(void) const { return m_active; }
 
    bool IsInputToggled(void) const { return m_inputToggled; }
    void SetInputToggled(bool inputToggled) { m_inputToggled = inputToggled; }
 
    void  SetZoom(float zoom);
    float GetZoom(void) const;
 
    bool CanGoForward(void);
    bool CanGoBack(void);
 
    QVariant evaluateJavaScript(const QString& scriptSource);
 
    void SetDefaultSaveDirectory(const QString &saveDir);
    QString GetDefaultSaveDirectory(void) { return m_defaultSaveDir; }
 
    void SetDefaultSaveFilename(const QString &filename);
    QString GetDefaultSaveFilename(void) { return m_defaultSaveFilename; }
 
  public slots:
    void Back(void);
    void Forward(void);
    void ZoomIn(void);
    void ZoomOut(void);
 
  signals:
    void loadStarted(void);                    
    void loadFinished(bool ok);                
    void loadProgress(int progress);           
    void titleChanged(const QString &title);   
    void statusBarMessage(const QString &text);
    void iconChanged(void);                    
    void fileDownloaded(QString filename);     
 
  protected slots:
    void slotLoadStarted(void);
    void slotLoadFinished(bool Ok);
    void slotLoadProgress(int progress);
    void slotTitleChanged(const QString &title);
    void slotStatusBarMessage(const QString &text);
    void slotIconChanged(void);
    void slotLinkClicked(const QUrl &url);
    void slotTopScreenChanged(MythScreenType *screen);
    void slotScrollBarShowing(void);
    void slotScrollBarHiding(void);
 
  protected:
    void Finalize(void) override; // MythUIType
    void UpdateBuffer(void);
    void HandleMouseAction(const QString &action);
    void SetBackgroundColor(QColor color);
    void ResetScrollBars(void);
    void UpdateScrollBars(void);
    bool IsOnTopScreen(void);
 
    void DrawSelf(MythPainter *p, int xoffset, int yoffset,
                          int alphaMod, QRect clipRect) override; // MythUIType
 
    bool ParseElement(const QString &filename, QDomElement &element,
                      bool showWarnings) override; // MythUIType
    void CopyFrom(MythUIType *base) override; // MythUIType
    void CreateCopy(MythUIType *parent) override; // MythUIType
 
    MythScreenType *m_parentScreen         { nullptr };
 
    MythWebView *m_browser                 { nullptr };
    MythRect     m_browserArea;
    MythRect     m_actualBrowserArea;
 
    MythImage   *m_image                   { nullptr };
 
    bool         m_active                  { false   };
    bool         m_wasActive               { false   };
    bool         m_initialized             { false   };
    QElapsedTimer m_lastUpdateTime;
    int          m_updateInterval          { 0       };
 
    float        m_zoom                    { 1.0     };
    QColor       m_bgColor;
    QUrl         m_widgetUrl;
    QString      m_userCssFile;
    QString      m_defaultSaveDir;
    QString      m_defaultSaveFilename;
 
    bool         m_inputToggled            { false   };
    QString      m_lastMouseAction;
    int          m_mouseKeyCount           { 0       };
    QElapsedTimer m_lastMouseActionTime;
 
    MythUIScrollBar *m_horizontalScrollbar { nullptr };
    MythUIScrollBar *m_verticalScrollbar   { nullptr };
    MythUIAnimation  m_scrollAnimation;
    QPoint           m_destinationScrollPos;
};
 
#endif