wxwidgets/interface/wx/webview_chromium.h
Vadim Zeitlin 08d6fe059b Update CEF requirements for the current version
Also don't use "CEF3" any more as "CEF1" doesn't really exist by now any
longer and there is only a single version of CEF.
2023-09-06 03:50:05 +02:00

190 lines
7.8 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: webview_chromium.h
// Purpose: interface of wxWebViewChromium
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxWebViewChromium
wxWebViewChromium is a Chromium-based backend for wxWebView using the
Chromium Embedded Framework (CEF).
This backend is only available for Windows, Linux and macOS and currently
requires CEF version 116.
Using CEF also requires a compiler with C++14 support.
@section requirements Building CEF
If you are compiling your own copy of CEF then your compile flags must
match those you are using to compile wxWidgets. Specifically on Windows
it is likely you will need to adjust the following properties in the CEF
provided build files:
- C/C++ - Code Generation - Runtime Library - Multithreaded [Debug] DLL
- C/C++ - Code Generation - Enable C++ Exceptions - Yes
- C/C++ - Language - Enable Run-Time Type Information - Yes
@section instructions Build Instructions
__General__
The wxWebViewChromium backend is built into a separate webview_chromium
library which depends on the webview library.
When building with CMake enable wxUSE_WEBVIEW_CHROMIUM and CEF will be
automatically downloaded during configuration based on your platform.
For other build systems please follow the following instructions:
Once you have a copy of CEF, either from compiling it yourself or using
prebuilt binaries, you should copy it into `wx_root/3rdparty/cef`. To run the
webview_chromium sample you need to copy the CEF resources into the
sample directory. The following files need to be copied:
- The shared objects in the wx_root/3rdparty/cef/Debug or
wx_root/3rdparty/cef/Release folder, depending on your build type.
- The contents of the wx_root/3rdparty/cef/Resources folder.
When building wxWidgets you need to ensure wxWebViewChromium is enabled,
either by passing --enable-webviewchromium for autoconf based builds or
setting wxUSE_WEBVIEW_CHROMIUM equal to 1 in setup.h for Visual Studio
based builds.
When running applications using wxWebViewChromium, the command line option
`--type=xxx` is interpreted specially as it is used by CEF to launch helper
applications, so your program must not use this option for anything else.
__Microsoft Windows Platform__
Windows 7 or newer is required to run applications using wxWebViewChromium.
Such applications should also have an application manifest declaring compatibility
with supported Windows versions.
Only Microsoft Visual C++ 2015 or newer can be used to build wxWebViewChromium.
__Linux with GTK__
wxWebviewChromium currently only supports X11 and not Wayland, i.e. you
need to either ensure that `GDK_BACKEND` environment variable is set to
"x11" before running your program using it or call
@code
gdk_set_allowed_backends("x11")
@endcode
in your application code.
Moreover, the actual browser is only created once the window is shown, and
can't be used until then. You can bind an event handler for wxEVT_CREATE to
know when it is usable.
__Mac OS X Platform__
OS X 10.9 or above is required.
Due to the application bundle structure on OS X, wxWebviewChromium is a
little more complicated than on Windows/Linux platforms. An extra helper
application for executing separate Chromium processes(renderer, plugin,
etc) is required.
For applications using wxWebviewChromium, below are the steps to make
it work, based off the webview_chromium sample bakefile.
1. Build the webview_chromium library.
- Use system tool `install_name_tool -change` to correct `Chromium
Embedded Framework.framework/Chromium Embedded Framework` location.
2. Compile/link/package the `helper` app:
- Require `process_helper_mac.cpp`
- Require link frameworks: Chromium Embedded Framework.framework,
AppKit.frameworks.
- Require app bundle configuration: Info.plist
- Use system tool `install_name_tool -change` to correct `Chromium
Embedded Framework.framework/Chromium Embedded Framework` location.
3. Compile/link/package the `webviewchromium` app:
- Require `webview.cpp`
- Require link frameworks: Chromium Embedded Framework.framework,
AppKit.frameworks.
- Require app bundle configuration: Info.plist
- Use system tool `install_name_tool -change` to correct `Chromium
Embedded Framework.framework/Chromium Embedded Framework` location.
4. Create a `Contents/Frameworks` directory in `webviewchromium.app` bundle
and copy `helper.app`, `webviewchromium.dylib`, 'webview.dylib'
and `Chromium Embedded Framework` into it.
5. Use `samples/webview_chromium/mac/tools/make_more_helper.sh` to make
sub-process helper app bundles based on the `helper` app.
Below is the wxWebviewChromium sample app bundle directory structure:
webview_chromium.app
`-- Contents
|-- Frameworks
| |-- Chromium Embedded Framework.framework <= CEF framework
| | |-- Chromium Embedded Framework
| | |-- Libraries
| | | `-- ffmpegsumo.so
| | `-- Resources\
| |-- libwx_osx_cocoau_webviewchromium-3.1.dylib <= wxWebviewChromium library supports webviewChromium backend.
| |-- libwx_osx_cocoau_webview-3.1.dylib <= wxWebview library supports other backends.
| `-- webview_chromium Helper.app <= helper app
| `-- Contents
| |-- Info.plist
| |-- MacOS
| | `-- webview_chromium Helper
| |-- PkgInfo
| `-- Resources
| `-- wxmac.icns
|-- Info.plist
|-- MacOS
| `-- webview_chromium <= webviewchromium sample executable
|-- PkgInfo
`-- Resources
`-- wxmac.icns <= resources.
@section differences API Differences
wxWebViewChromium aims to support the full wxWebView API, but there are
some features which are currently unsupported:
- GetSelectedSource/GetSelectedText: Always returns "".
- HasSelection: Always returns false.
- IsEditable: Always returns false.
- CanUndo/CanRedo/CanCut/CanCopy/CanPaste: Always returns true.
- Find: Always returns -1.
- RunScript: Retrieving the result of JavaScript execution is not supported and
if the @a output parameter is non-null, the function will always return false.
@since 3.3.0
@library{wxwebview_chromium}
@category{webview}
**/
class wxWebViewChromium : public wxWebView
{
public:
/**
wxWebViewChromium constructor, arguments as per wxWebView::New.
*/
wxWebViewChromium(wxWindow* parent,
wxWindowID id,
const wxString& url = wxWebViewDefaultURLStr,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxWebViewNameStr);
/**
Creation function for two-step creation.
*/
virtual bool Create(wxWindow* parent,
wxWindowID id,
const wxString& url = wxWebViewDefaultURLStr,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxWebViewNameStr);
};