CFxWebView Class Reference

#include <FxWebWidgetInterfaces.h>

Public Types
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 Member Functions
	CFxWebView (CFxWebWidgetManager *pManager)
virtual	~CFxWebView ()
virtual QWidget *	GetWidget ()=0
virtual const QWidget *	GetWidget () const =0
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
virtual void	SetDefaultUserAgentString (const QString &userAgentString)=0
virtual void	SetUserAgentString (const QUrl &url, const QString &userAgentString)=0
virtual QString	GetDefaultUserAgentString ()=0
virtual QMap< QUrl, QString >	GetUserAgentStrings ()=0
virtual void	ClearDefaultUserAgentString ()=0
virtual void	ClearUserAgentString (const QUrl &url)=0
virtual void	ClearUserAgentStrings ()=0
virtual void	SetCacheEnabled (bool bEnable)=0
virtual void	DoStop ()=0
virtual void	DoBack ()=0
virtual void	DoForward ()=0
virtual void	DoReload ()=0
virtual void	DoPrint (QPrinter *) const =0
virtual bool	CanGoBack () const =0
virtual bool	CanGoForward () const =0
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
virtual void	OpenExternalLinksInBrowser (std::function< bool(const QUrl &url)> checkIfExternalLink)=0
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 Attributes
CFxWebWidgetManager *	m_pManager

Detailed Description

Description: The special wrapper for QWebView and QWebEngineView widgets. It prevents direct linkage to QWebKit/QWebEngine module and loads required modules on demand. QWebView/QWebEngineView widget can be created using CFxWebWidgetManager::GetManager()->CreateView() method. Library: DDKERNEL

Definition at line 46 of file FxWebWidgetInterfaces.h.

Member Enumeration Documentation

FxFindFlag

enum CFxWebView::FxFindFlag

Wrapper for QWebPage::FindFlag enum

Enumerator
FindBackward
FindCaseSensitively
FindWrapsAroundDocument
HighlightAllOccurrences
FindAtWordBeginningsOnly
TreatMedialCapitalAsWordBeginning
FindBeginsInSelection

Definition at line 103 of file FxWebWidgetInterfaces.h.

FxLinkDelegationPolicy

enum CFxWebView::FxLinkDelegationPolicy

Wrapper for QWebPage::LinkDelegationPolicy enum

Enumerator
DontDelegateLinks
DelegateExternalLinks
DelegateAllLinks

Definition at line 154 of file FxWebWidgetInterfaces.h.

FxPersistentCookiesPolicy

enum CFxWebView::FxPersistentCookiesPolicy

Wrapper for QWebEngineProfile::PersistentCookiesPolicy enum

Enumerator
NoPersistentCookies
AllowPersistentCookies
ForcePersistentCookies

Definition at line 145 of file FxWebWidgetInterfaces.h.

FxWebAction

enum CFxWebView::FxWebAction

Wrapper for QWebPage::WebAction enum

Enumerator
NoWebAction
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

Definition at line 55 of file FxWebWidgetInterfaces.h.

FxWebAttribute

enum CFxWebView::FxWebAttribute

Wrapper for QWebSettings::WebAttribute enum

Enumerator
AutoLoadImages
JavascriptEnabled
JavascriptCanOpenWindows
JavascriptCanAccessClipboard
LinksIncludedInFocusChain
LocalStorageEnabled
LocalContentCanAccessRemoteUrls
XSSAuditingEnabled
SpatialNavigationEnabled
LocalContentCanAccessFileUrls
HyperlinkAuditingEnabled
ScrollAnimatorEnabled
ErrorPageEnabled
PluginsEnabled
FullScreenSupportEnabled
ScreenCaptureEnabled
WebGLEnabled
Accelerated2dCanvasEnabled
AutoLoadIconsForPage
TouchIconsEnabled
FocusOnNavigationEnabled
PrintElementBackgrounds
AllowRunningInsecureContent

Definition at line 116 of file FxWebWidgetInterfaces.h.

Constructor & Destructor Documentation

CFxWebView()

CFxWebView::CFxWebView

(

CFxWebWidgetManager *

pManager

)

~CFxWebView()

virtual CFxWebView::~CFxWebView ( )

virtual

Member Function Documentation

AlsoOpenLinksInBrowser()

virtual void CFxWebView::AlsoOpenLinksInBrowser ( )

pure virtual

CanGoBack()

virtual bool CFxWebView::CanGoBack ( ) const

pure virtual

CanGoForward()

virtual bool CFxWebView::CanGoForward ( ) const

pure virtual

ClearCookies()

virtual void CFxWebView::ClearCookies ( )

pure virtual

ClearDefaultUserAgentString()

virtual void CFxWebView::ClearDefaultUserAgentString ( )

pure virtual

ClearUserAgentString()

virtual void CFxWebView::ClearUserAgentString ( const QUrl &  url )

pure virtual

ClearUserAgentStrings()

virtual void CFxWebView::ClearUserAgentStrings ( )

pure virtual

ConnectToContentChangedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToContentChangedSignal ( std::function< void(void)>  slot )

pure virtual

ConnectToContentsSizeChangedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToContentsSizeChangedSignal ( std::function< void(const QSizeF &)>  slot )

pure virtual

ConnectToGeometryChangeRequestedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToGeometryChangeRequestedSignal ( std::function< void(const QRect &)>  slot )

pure virtual

ConnectToHttpResponseFinished()

virtual QMetaObject::Connection CFxWebView::ConnectToHttpResponseFinished ( std::function< void(QNetworkReply *)>  slot )

pure virtual

ConnectToLinkClickedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToLinkClickedSignal ( std::function< void(const QUrl &)>  slot )

pure virtual

ConnectToLoadFinishedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToLoadFinishedSignal ( std::function< void(bool)>  slot )

pure virtual

ConnectToLoadProgressSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToLoadProgressSignal ( std::function< void(int progress)>  slot )

pure virtual

ConnectToLoadStartedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToLoadStartedSignal ( std::function< void(void)>  slot )

pure virtual

ConnectToRepaintRequestedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToRepaintRequestedSignal ( std::function< void(const QRect &)>  slot )

pure virtual

ConnectToRepaintRequestedSignalWebEngine()

virtual QMetaObject::Connection CFxWebView::ConnectToRepaintRequestedSignalWebEngine ( std::function< void(bool)>  slot )

pure virtual

ConnectToUrlChangedSignal()

virtual QMetaObject::Connection CFxWebView::ConnectToUrlChangedSignal ( std::function< void(const QUrl &)>  slot )

pure virtual

DoBack()

virtual void CFxWebView::DoBack ( )

pure virtual

DoForward()

virtual void CFxWebView::DoForward ( )

pure virtual

DoPrint()

virtual void CFxWebView::DoPrint ( QPrinter *  ) const

pure virtual

DoReload()

virtual void CFxWebView::DoReload ( )

pure virtual

DoStop()

virtual void CFxWebView::DoStop ( )

pure virtual

EvaluateJavascript()

virtual void CFxWebView::EvaluateJavascript ( const QString &  script )

pure virtual

FindText()

virtual bool CFxWebView::FindText ( const QString &  subString, FxFindFlag  options = (FxFindFlag) 0  )

pure virtual

GetCookieStoreForDefaultProfile()

virtual QObject* CFxWebView::GetCookieStoreForDefaultProfile ( )

pure virtual

GetDefaultUserAgentString()

virtual QString CFxWebView::GetDefaultUserAgentString ( )

pure virtual

GetIcon()

virtual QIcon CFxWebView::GetIcon ( ) const

pure virtual

GetLinkDelegationPolicy()

virtual FxLinkDelegationPolicy CFxWebView::GetLinkDelegationPolicy ( )

pure virtual

GetPageAction()

virtual QAction* CFxWebView::GetPageAction ( FxWebAction  eAction ) const

pure virtual

GetPreferredContentsSize()

virtual QSize CFxWebView::GetPreferredContentsSize ( )

pure virtual

GetRenderHints()

virtual QPainter::RenderHints CFxWebView::GetRenderHints ( ) const

pure virtual

GetSelectedHtml()

virtual QString CFxWebView::GetSelectedHtml ( ) const

pure virtual

GetSelectedText()

virtual QString CFxWebView::GetSelectedText ( ) const

pure virtual

GetTextSizeMultiplier()

virtual double CFxWebView::GetTextSizeMultiplier ( ) const

pure virtual

GetTitle()

virtual QString CFxWebView::GetTitle ( ) const

pure virtual

GetURL()

virtual QUrl CFxWebView::GetURL ( ) const

pure virtual

GetUserAgentStrings()

virtual QMap< QUrl, QString > CFxWebView::GetUserAgentStrings ( )

pure virtual

GetWidget() [1/2]

virtual const QWidget* CFxWebView::GetWidget ( ) const

pure virtual

GetWidget() [2/2]

virtual QWidget* CFxWebView::GetWidget ( )

pure virtual

Returns a pointer to QWebView/QWebEngine widget

GetZoomFactor()

virtual double CFxWebView::GetZoomFactor ( ) const

pure virtual

HasSelection()

virtual bool CFxWebView::HasSelection ( ) const

pure virtual

IsModified()

virtual bool CFxWebView::IsModified ( ) const

pure virtual

Load() [1/4]

virtual void CFxWebView::Load ( const CFxString &  sURL )

virtual

Methods of QWebView/QWebEngine interface:

Load() [2/4]

virtual void CFxWebView::Load ( const QNetworkRequest &  request, QNetworkAccessManager::Operation  operation = QNetworkAccessManager::GetOperation, const QByteArray &  body = QByteArray()  )

pure virtual

Load() [3/4]

virtual void CFxWebView::Load ( const QString &  sURL )

pure virtual

Load() [4/4]

virtual void CFxWebView::Load ( const QUrl &  url )

pure virtual

OpenExternalLinksInBrowser()

virtual void CFxWebView::OpenExternalLinksInBrowser ( std::function< bool(const QUrl &url)>  checkIfExternalLink )

pure virtual

SetCacheEnabled()

virtual void CFxWebView::SetCacheEnabled ( bool  bEnable )

pure virtual

SetContent()

virtual void CFxWebView::SetContent ( const QByteArray &  data, const QString &  sMimeType = QString(), const QUrl &  baseUrl = QUrl()  )

pure virtual

SetCookieForDefaultProfile()

virtual void CFxWebView::SetCookieForDefaultProfile ( QNetworkCookie *  pCookie )

pure virtual

SetDefaultUserAgentString()

virtual void CFxWebView::SetDefaultUserAgentString ( const QString &  userAgentString )

pure virtual

SetHtml()

virtual void CFxWebView::SetHtml ( const QString &  html, const QUrl &  baseUrl = QUrl()  )

pure virtual

SetLinkDelegationPolicy()

virtual void CFxWebView::SetLinkDelegationPolicy ( FxLinkDelegationPolicy  linkDelegationPolicy )

pure virtual

SetNetworkAccessManager()

virtual void CFxWebView::SetNetworkAccessManager ( QNetworkAccessManager *  manager )

pure virtual

SetPersistCookies()

virtual void CFxWebView::SetPersistCookies ( bool  bEnable )

pure virtual

SetPersistentCookiesPolicyForDefaultProfile()

virtual void CFxWebView::SetPersistentCookiesPolicyForDefaultProfile ( FxPersistentCookiesPolicy  ePolicy )

pure virtual

SetRenderHint()

virtual void CFxWebView::SetRenderHint ( QPainter::RenderHint  hint, bool  bEnabled = true  )

pure virtual

SetRenderHints()

virtual void CFxWebView::SetRenderHints ( QPainter::RenderHints  hints )

pure virtual

SetSettingsAttribute()

virtual void CFxWebView::SetSettingsAttribute ( FxWebAttribute  eAttribute, bool  bEnable  )

pure virtual

SetTextSizeMultiplier()

virtual void CFxWebView::SetTextSizeMultiplier ( double  dFactor )

pure virtual

SetURL() [1/3]

virtual void CFxWebView::SetURL ( const CFxString &  sURL )

virtual

SetURL() [2/3]

virtual void CFxWebView::SetURL ( const QString &  sURL )

pure virtual

SetURL() [3/3]

virtual void CFxWebView::SetURL ( const QUrl &  url )

pure virtual

SetUserAgentString()

virtual void CFxWebView::SetUserAgentString ( const QUrl &  url, const QString &  userAgentString  )

pure virtual

SetZoomFactor()

virtual void CFxWebView::SetZoomFactor ( double  dFactor )

pure virtual

TriggerPageAction()

virtual void CFxWebView::TriggerPageAction ( FxWebAction  eAction, bool  bChecked = false  )

pure virtual

Member Data Documentation

m_pManager

CFxWebWidgetManager* CFxWebView::m_pManager

protected

Definition at line 271 of file FxWebWidgetInterfaces.h.

---

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

• FxWebWidgetInterfaces.h