qgswebenginepage.h

Go to the documentation of this file.

/***************************************************************************
                          qgswebenginepage.h
                             -------------------
    begin                : December 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSWEBENGINEPAGE_H
#define QGSWEBENGINEPAGE_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QPageLayout>
#include <QSize>
#include <QUrl>
 
SIP_IF_MODULE( HAVE_WEBENGINE_SIP )
 
class QWebEnginePage;
class QPainter;

class CORE_EXPORT QgsWebEnginePage : public QObject
{
    Q_OBJECT
 
  public:
    QgsWebEnginePage( QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsWebEnginePage() override;

    QWebEnginePage *page() SIP_SKIP;

    bool setContent( const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl(), bool blocking = false );

    bool setHtml( const QString &html, const QUrl &baseUrl = QUrl(), bool blocking = false );

    bool setUrl( const QUrl &url, bool blocking = false );

    QSize documentSize() const;

    bool render( QPainter *painter, const QRectF &painterRect ) SIP_THROW( QgsNotSupportedException );
 
  signals:

    void loadStarted();

    void loadProgress( int progress );

    void loadFinished( bool ok );
 
  private:
    void handlePostBlockingLoadOperations();
 
    std::unique_ptr< QWebEnginePage > mPage;
    mutable QSize mCachedSize;
};
 
#endif // QGSWEBENGINEPAGE_H