Version: 3.3.0
wxWebViewFactory Class Referenceabstract

#include <wx/webview.h>

+ Inheritance diagram for wxWebViewFactory:

Detailed Description

An abstract factory class for creating wxWebView backends.

Each implementation of wxWebView should have its own factory.

Since
2.9.5

Library:  wxWebView
Category:  WebView
See also
wxWebView

Public Member Functions

virtual wxWebViewCreate ()=0
 Function to create a new wxWebView with two-step creation, wxWebView::Create should be called on the returned object. More...
 
virtual wxWebViewCreateWithConfig (const wxWebViewConfiguration &config)
 Function to create a new wxWebView with two-step creation with a wxWebViewConfiguration, wxWebView::Create should be called on the returned object. More...
 
virtual wxWebViewCreate (wxWindow *parent, wxWindowID id, const wxString &url=wxWebViewDefaultURLStr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxWebViewNameStr)=0
 Function to create a new wxWebView with parameters. More...
 
virtual bool IsAvailable ()
 Function to check if the backend is available at runtime. More...
 
virtual wxVersionInfo GetVersionInfo (wxVersionContext context=wxVersionContext::RunTime)
 Retrieve the version information about this backend implementation. More...
 
virtual wxWebViewConfiguration CreateConfiguration ()
 Create a wxWebViewConfiguration object for wxWebView instances created by this factory. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to nullptr the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
 
void * operator new (size_t size, const wxString &filename=nullptr, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Member Function Documentation

◆ Create() [1/2]

virtual wxWebView* wxWebViewFactory::Create ( )
pure virtual

Function to create a new wxWebView with two-step creation, wxWebView::Create should be called on the returned object.

Returns
The created wxWebView.

◆ Create() [2/2]

virtual wxWebView* wxWebViewFactory::Create ( wxWindow parent,
wxWindowID  id,
const wxString url = wxWebViewDefaultURLStr,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = 0,
const wxString name = wxWebViewNameStr 
)
pure virtual

Function to create a new wxWebView with parameters.

Parameters
parentParent window for the control
idID of this control
urlInitial URL to load
posPosition of the control
sizeSize of the control
styleWindow style. For generic window styles, please see wxWindow.
nameWindow name
Returns
The created wxWebView

◆ CreateConfiguration()

virtual wxWebViewConfiguration wxWebViewFactory::CreateConfiguration ( )
virtual

Create a wxWebViewConfiguration object for wxWebView instances created by this factory.

Since
3.3.0

◆ CreateWithConfig()

virtual wxWebView* wxWebViewFactory::CreateWithConfig ( const wxWebViewConfiguration config)
virtual

Function to create a new wxWebView with two-step creation with a wxWebViewConfiguration, wxWebView::Create should be called on the returned object.

Returns
The created wxWebView.
Since
3.3.0
See also
CreateConfiguration()

◆ GetVersionInfo()

virtual wxVersionInfo wxWebViewFactory::GetVersionInfo ( wxVersionContext  context = wxVersionContext::RunTime)
virtual

Retrieve the version information about this backend implementation.

Parameters
contextThe context in which the version information is requested, by default it is the run-time version. Currently only GTK WebKit and CEF backends support returning compile-time version information, all the other backends return an empty wxVersionInfo object in this case.
Since
3.1.5 (context parameter was added in 3.3.0)

◆ IsAvailable()

virtual bool wxWebViewFactory::IsAvailable ( )
virtual

Function to check if the backend is available at runtime.

The wxWebView implementation can use this function to check all runtime requirements without trying to create a wxWebView.

Returns
true if the backend can be used or false if it is not available during runtime.
Since
3.1.5