FxWebWidgetInterfaces.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPragmaPush.h"
 
#include "DDKERNEL.h"
 
#include "FxString.h"
 
#include <QtCore/qurl.h>
#include <QtGui/qicon.h>
#include <QtGui/qpainter.h>
#include <QtNetwork/qnetworkaccessmanager.h>
#include <QtWidgets/qwidget.h>
 
class QWidget;
class QAction;
class QNetworkCookie;
class QNetworkAccessManager;
class QPrinter;
 
class CFxWebWidgetManager;
 
class DDKERNEL_API CFxWebView
{
public:
    CFxWebView( CFxWebWidgetManager* pManager );
    virtual ~CFxWebView();
 
public:
    enum FxWebAction
    {
        NoWebAction = -1,
        Back,
        Forward,
        Stop,
        Reload,
 
        Cut,
        Copy,
        Paste,
 
        Undo,
        Redo,
        SelectAll,
        ReloadAndBypassCache,
 
        PasteAndMatchStyle,
 
        OpenLinkInThisWindow,
        OpenLinkInNewWindow,
        OpenLinkInNewTab,
        CopyLinkToClipboard,
        DownloadLinkToDisk,
 
        CopyImageToClipboard,
        CopyImageUrlToClipboard,
        DownloadImageToDisk,
 
        CopyMediaUrlToClipboard,
        ToggleMediaControls,
        ToggleMediaLoop,
        ToggleMediaPlayPause,
        ToggleMediaMute,
        DownloadMediaToDisk,
 
        InspectElement,
        ExitFullScreen,
        RequestClose,
        Unselect,
        SavePage,
        OpenLinkInNewBackgroundTab,
        ViewSource,
        WebActionCount
    };
 
    enum FxFindFlag
    {
        FindBackward = 1,
        FindCaseSensitively = 2,
        FindWrapsAroundDocument = 4,
        HighlightAllOccurrences = 8,
        FindAtWordBeginningsOnly = 16,
        TreatMedialCapitalAsWordBeginning = 32,
        FindBeginsInSelection = 64
    };
 
    enum FxWebAttribute
    {
        AutoLoadImages,
        JavascriptEnabled,
        JavascriptCanOpenWindows,
        JavascriptCanAccessClipboard,
        LinksIncludedInFocusChain,
        LocalStorageEnabled,
        LocalContentCanAccessRemoteUrls,
        XSSAuditingEnabled,
        SpatialNavigationEnabled,
        LocalContentCanAccessFileUrls,
        HyperlinkAuditingEnabled,
        ScrollAnimatorEnabled,
        ErrorPageEnabled,
        PluginsEnabled,
        FullScreenSupportEnabled,
        ScreenCaptureEnabled,
        WebGLEnabled,
        Accelerated2dCanvasEnabled,
        AutoLoadIconsForPage,
        TouchIconsEnabled,
        FocusOnNavigationEnabled,
        PrintElementBackgrounds,
        AllowRunningInsecureContent
    };
 
    enum FxPersistentCookiesPolicy
    {
        NoPersistentCookies,
        AllowPersistentCookies,
        ForcePersistentCookies
    };
 
    enum FxLinkDelegationPolicy
    {
        DontDelegateLinks,
        DelegateExternalLinks,
        DelegateAllLinks
    };
 
public:
    virtual QWidget* GetWidget() = 0;
    virtual const QWidget* GetWidget() const = 0;
 
public:
 
    virtual void Load( const CFxString& sURL );
    virtual void SetURL( const CFxString& sURL );
 
    virtual void Load( const QString& sURL ) = 0;
    virtual void Load( const QUrl& url ) = 0;
    virtual void Load( const QNetworkRequest& request, QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray &body = QByteArray() ) = 0;
    virtual void SetHtml( const QString& html, const QUrl& baseUrl = QUrl() ) = 0;
    virtual void SetContent( const QByteArray& data, const QString& sMimeType = QString(), const QUrl& baseUrl = QUrl() ) = 0;
 
    virtual QString GetTitle() const = 0;
    virtual void SetURL( const QUrl &url ) = 0;
    virtual void SetURL( const QString& sURL ) = 0;
    virtual QUrl GetURL() const = 0;
    virtual QIcon GetIcon() const = 0;
 
    virtual bool HasSelection() const = 0;
    virtual QString GetSelectedText() const = 0;
    virtual QString GetSelectedHtml() const = 0;
 
    virtual QAction* GetPageAction( FxWebAction eAction ) const = 0;
    virtual void TriggerPageAction( FxWebAction eAction, bool bChecked = false ) = 0;
 
    virtual bool IsModified() const = 0;
 
    virtual double GetZoomFactor() const = 0;
    virtual void SetZoomFactor( double dFactor ) = 0;
 
    virtual void SetTextSizeMultiplier( double dFactor ) = 0;
    virtual double GetTextSizeMultiplier() const = 0;
 
    virtual QSize GetPreferredContentsSize() = 0;
 
    virtual QPainter::RenderHints GetRenderHints() const = 0;
    virtual void SetRenderHints( QPainter::RenderHints hints ) = 0;
    virtual void SetRenderHint( QPainter::RenderHint hint, bool bEnabled = true ) = 0;
 
    virtual bool FindText( const QString& subString, FxFindFlag options = ( FxFindFlag )0 ) = 0;
 
    // Set default user agent string. If the passed user agent string is empty,
    // the default user agent string is cleared and the sent string depends on the
    // underlying implementation.
    virtual void SetDefaultUserAgentString( const QString &userAgentString ) = 0;
    // Set user agent string for a specific URL. Scheme and authority are used for matching.
    // If the passed user agent string is empty, the entry is removed.
    virtual void SetUserAgentString( const QUrl &url, const QString &userAgentString ) = 0;
    // Get default user agent string.
    virtual QString GetDefaultUserAgentString() = 0;
    // Get URL-specific user agent strings.
    virtual QMap< QUrl, QString > GetUserAgentStrings() = 0;
    // Clear default user agent string.
    virtual void ClearDefaultUserAgentString() = 0;
    // Clear URL-specific user agent string.
    virtual void ClearUserAgentString( const QUrl &url ) = 0;
    // Clear all URL-specifc user agent strings.
    virtual void ClearUserAgentStrings() = 0;
    // Sets whether the cache is enabled or disabled.
    virtual void SetCacheEnabled( bool bEnable ) = 0;
 
public:
    virtual void DoStop() = 0;
    virtual void DoBack() = 0;
    virtual void DoForward() = 0;
    virtual void DoReload() = 0;
 
    virtual void DoPrint( QPrinter* ) const = 0;
 
public:
    virtual bool CanGoBack() const = 0;
    virtual bool CanGoForward() const = 0;
 
public:
    virtual void SetLinkDelegationPolicy( FxLinkDelegationPolicy linkDelegationPolicy ) = 0;
    virtual FxLinkDelegationPolicy GetLinkDelegationPolicy() = 0;
    virtual void SetSettingsAttribute( FxWebAttribute eAttribute, bool bEnable ) = 0;
    virtual void SetPersistentCookiesPolicyForDefaultProfile( FxPersistentCookiesPolicy ePolicy ) = 0;
    virtual void SetPersistCookies( bool bEnable ) = 0;
    virtual QObject* GetCookieStoreForDefaultProfile() = 0;
    virtual void SetCookieForDefaultProfile( QNetworkCookie* pCookie ) = 0;
    virtual void SetNetworkAccessManager( QNetworkAccessManager * manager ) = 0;
    virtual void EvaluateJavascript( const QString& script ) = 0;
 
    //Opens External Link in browser
    virtual void OpenExternalLinksInBrowser( std::function< bool( const QUrl& url )> checkIfExternalLink ) = 0;
    //Opens the clicked Link both in Browser and Widget.
    virtual void AlsoOpenLinksInBrowser() = 0;
    virtual void ClearCookies() = 0;
 
    virtual QMetaObject::Connection ConnectToLinkClickedSignal( std::function<void( const QUrl& )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToContentChangedSignal( std::function<void( void )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToGeometryChangeRequestedSignal( std::function<void( const QRect& )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToRepaintRequestedSignal( std::function<void( const QRect& )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToLoadFinishedSignal( std::function<void( bool )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToLoadStartedSignal( std::function<void( void )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToLoadProgressSignal( std::function<void( int progress )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToHttpResponseFinished( std::function<void( QNetworkReply * )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToRepaintRequestedSignalWebEngine( std::function<void( bool )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToContentsSizeChangedSignal( std::function<void( const QSizeF& )> slot ) = 0;
    virtual QMetaObject::Connection ConnectToUrlChangedSignal( std::function<void( const QUrl& )> slot ) = 0;
 
protected:
    CFxWebWidgetManager* m_pManager;
};
 
 
class DDKERNEL_API CFxWebWidgetFactory
{
public:
    CFxWebWidgetFactory();
    virtual ~CFxWebWidgetFactory();
 
protected:
    friend class CFxWebWidgetManager;
    virtual CFxWebView* CreateView( CFxWebWidgetManager* pManager ) = 0;
 
};
 
 
class CFxWebWidgetManagerImpl;
 
class DDKERNEL_API CFxWebWidgetManager : public QObject
{
    Q_OBJECT
public:
    virtual ~CFxWebWidgetManager();
 
    static CFxWebWidgetManager* GetManager();
 
    void SetFactory( CFxWebWidgetFactory* pFactory );
 
    CFxWebView* CreateView();
 
public slots:
    bool UnloadModule();
 
protected:
    friend class CFxWebView;
    void OnViewDeleted( CFxWebView* pView );
 
protected:
    CFxWebWidgetManager();
 
    bool CheckModule();
    bool LoadModule();
 
protected:
    CFxWebWidgetManagerImpl* m_pImpl;
 
};
 
#include "FxPragmaPop.h"