FxWebWidgetInterfaces.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 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();

    static CFxWebView* Create();
 
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
    };
 
public:
    virtual QWidget* GetWidget() = 0;
    virtual const QWidget* GetWidget() const = 0;

public:
    
    virtual void Load( 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 CFxString& sURL );
    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 QAction* GetPageAction( FxWebAction eAction ) const = 0;

    virtual void TriggerPageAction( FxWebAction eAction, bool bChecked = false ) = 0;

    virtual double GetZoomFactor() const = 0;

    virtual void SetZoomFactor( double dFactor ) = 0;

    virtual void FindText( const QString& subString, FxFindFlag options = ( FxFindFlag )0, const std::function<void( bool )>& resultCallback = std::function<void( bool )>() ) = 0;

    virtual void SetDefaultUserAgentString( const QString &userAgentString ) = 0;
    virtual QString GetDefaultUserAgentString() = 0;
 
public:
    virtual void DoStop() = 0;
    virtual void DoBack() = 0;
    virtual void DoForward() = 0;
    virtual void DoReload() = 0;
 
public:
    virtual bool CanGoBack() const = 0;
    virtual bool CanGoForward() const = 0;
 
public:
    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 EvaluateJavascript( const QString& script ) = 0;
    virtual void LoadQWebChannel( ) = 0;
    virtual void ClearCookies() = 0;
    virtual bool ConnectToLinkClickedSignal( std::function<void( const QUrl& )> slot ) = 0;
    virtual bool ConnectToGeometryChangeRequestedSignal( std::function<void( const QRect& )> slot ) = 0;
    virtual bool ConnectToLoadFinishedSignal( std::function<void( bool )> slot ) = 0;
    virtual bool ConnectToLoadStartedSignal( std::function<void( void )> slot ) = 0;
    virtual bool ConnectToLoadProgressSignal( std::function<void( int progress )> slot ) = 0;
    virtual bool ConnectToContentsSizeChangedSignal( std::function<void( const QSizeF& )> slot ) = 0;
    virtual bool ConnectToUrlChangedSignal( std::function<void( const QUrl& )> slot ) = 0;
 
protected:
    CFxWebWidgetManager* m_pManager;
};
 
#include "FxPragmaPop.h"