1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxWebView
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 Zoom levels available in wxWebView
15 wxWEB_VIEW_ZOOM_SMALL
,
16 wxWEB_VIEW_ZOOM_MEDIUM
, //!< default size
17 wxWEB_VIEW_ZOOM_LARGE
,
18 wxWEB_VIEW_ZOOM_LARGEST
22 The type of zooming that the web view control can perform
24 enum wxWebViewZoomType
27 The entire layout scales when zooming, including images
29 wxWEB_VIEW_ZOOM_TYPE_LAYOUT
,
31 Only the text changes in size when zooming, images and other layout
32 elements retain their initial size
34 wxWEB_VIEW_ZOOM_TYPE_TEXT
38 Types of errors that can cause navigation to fail
40 enum wxWebViewNavigationError
42 /** Connection error (timeout, etc.) */
43 wxWEB_NAV_ERR_CONNECTION
,
44 /** Invalid certificate */
45 wxWEB_NAV_ERR_CERTIFICATE
,
46 /** Authentication required */
48 /** Other security error */
49 wxWEB_NAV_ERR_SECURITY
,
50 /** Requested resource not found */
51 wxWEB_NAV_ERR_NOT_FOUND
,
52 /** Invalid request/parameters (e.g. bad URL, bad protocol,
53 unsupported resource type) */
54 wxWEB_NAV_ERR_REQUEST
,
55 /** The user cancelled (e.g. in a dialog) */
56 wxWEB_NAV_ERR_USER_CANCELLED
,
57 /** Another (exotic) type of error that didn't fit in other categories*/
64 enum wxWebViewReloadFlags
66 /** Default reload, will access cache */
67 wxWEB_VIEW_RELOAD_DEFAULT
,
68 /** Reload the current view without accessing the cache */
69 wxWEB_VIEW_RELOAD_NO_CACHE
73 * List of available backends for wxWebView
77 /** Value that may be passed to wxWebView to let it pick an appropriate
78 * engine for the current platform*/
79 wxWEB_VIEW_BACKEND_DEFAULT
,
81 /** The WebKit web engine */
82 wxWEB_VIEW_BACKEND_WEBKIT
,
84 /** Use Microsoft Internet Explorer as web engine */
89 @class wxWebViewHistoryItem
91 A simple class that contains the URL and title of an element of the history
100 class wxWebViewHistoryItem
106 wxWebViewHistoryItem(const wxString
& url
, const wxString
& title
);
109 @return The url of the page.
114 @return The title of the page.
120 @class wxWebViewHandler
122 The base class for handling custom schemes in wxWebView, for example to
123 allow virtual file system support.
131 class wxWebViewHandler
135 Constructor. Takes the name of the scheme that will be handled by this
136 class for example @c file or @c zip.
138 wxWebViewHandler(const wxString
& scheme
);
141 @return A pointer to the file represented by @c uri.
143 virtual wxFSFile
* GetFile(const wxString
&uri
) = 0;
146 @return The name of the scheme, as passed to the constructor.
148 virtual wxString
GetName() const;
154 This control may be used to render web (HTML / CSS / javascript) documents.
155 It is designed to allow the creation of multiple backends for each port,
156 although currently just one is available. It differs from wxHtmlWindow in
157 that each backend is actually a full rendering engine, Trident on MSW and
158 Webkit on OSX and GTK. This allows the correct viewing complex pages with
161 @section descriptions Backend Descriptions
163 @par wxWEB_VIEW_BACKEND_IE (MSW)
165 The IE backend uses Microsoft's Trident rendering engine, specifically the
166 version used by the locally installed copy of Internet Explorer. As such it
167 is only available for the MSW port. By default recent versions of the
168 <a href="http://msdn.microsoft.com/en-us/library/aa752085%28v=VS.85%29.aspx">WebBrowser</a>
169 control, which this backend uses, emulate Internet Explorer 7. This can be
170 changed with a registry setting, see
171 <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
172 this</a> article for more information. This backend has full support for
173 custom schemes and virtual file systems.
175 @par wxWEB_VIEW_WEBKIT (GTK)
177 Under GTK the WebKit backend uses
178 <a href="http://webkitgtk.org/">WebKitGTK+</a>. The current minimum version
179 required is 1.3.1 which ships by default with Ubuntu Natty and Debian
180 Wheezy and has the package name libwebkitgtk-dev. Custom schemes and
181 virtual files systems are supported under this backend, however embedded
182 resources such as images and stylesheets are currently loaded using the
185 @par wxWEB_VIEW_WEBKIT (OSX)
187 The OSX WebKit backend uses Apple's
188 <a href="http://developer.apple.com/library/mac/#documentation/Cocoa/Reference/WebKit/Classes/WebView_Class/Reference/Reference.html#//apple_ref/doc/uid/20001903">WebView</a>
189 class. This backend has full support for custom schemes and virtual file
192 @section async Asynchronous Notifications
194 Many of the methods in wxWebView are asynchronous, i.e. they return
195 immediately and perform their work in the background. This includes
196 functions such as LoadUrl() and Reload(). To receive notification of the
197 progress and completion of these functions you need to handle the events
198 that are provided. Specifically @c wxEVT_COMMAND_WEB_VIEW_LOADED notifies
199 when the page or a sub-frame has finished loading and
200 @c wxEVT_COMMAND_WEB_VIEW_ERROR notifies that an error has occurred.
202 @section vfs Virtual File Systems and Custom Schemes
204 wxWebView supports the registering of custom scheme handlers, for example
205 @c file or @c http. To do this create a new class which inherits from
206 wxWebViewHandler, where wxWebHandler::GetFile() returns a pointer to a
207 wxFSFile which represents the given url. You can then register your handler
208 with RegisterHandler() it will be called for all pages and resources.
210 wxWebFileHandler is provided to allow the navigation of pages inside a zip
211 archive. It overrides the @c file scheme and provides support for the
212 standard @c file syntax as well as paths to archives of the form
213 @c file:///C:/example/docs.zip;protocol=zip/main.htm
215 @beginEventEmissionTable{wxWebViewEvent}
216 @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
217 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
218 to get a resource. This event may be vetoed to prevent navigating to this
219 resource. Note that if the displayed HTML document has several frames, one
220 such event will be generated per frame.
221 @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
222 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
223 confirmed that a resource would be requested. This event may not be vetoed.
224 Note that if the displayed HTML document has several frames, one such event
225 will be generated per frame.
226 @event{EVT_WEB_VIEW_LOADED(id, func)}
227 Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
228 is fully loaded and displayed. Note that if the displayed HTML document has
229 several frames, one such event will be generated per frame.
230 @event{EVT_WEB_VIEW_ERROR(id, func)}
231 Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
233 The integer associated with this event will be a wxWebNavigationError item.
234 The string associated with this event may contain a backend-specific more
235 precise error message/code.
236 @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
237 Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
238 window is created. You must handle this event if you want anything to
239 happen, for example to load the page in a new window or tab.
240 @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
241 Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
242 the page title changes. Use GetString to get the title.
247 @category{ctrl,webview}
248 @see wxWebViewHandler, wxWebViewEvent
250 class wxWebView
: public wxControl
255 Creation function for two-step creation.
257 virtual bool Create(wxWindow
* parent
,
259 const wxString
& url
= wxWebViewDefaultURLStr
,
260 const wxPoint
& pos
= wxDefaultPosition
,
261 const wxSize
& size
= wxDefaultSize
,
263 const wxString
& name
= wxWebViewNameStr
) = 0;
266 Factory function to create a new wxWebView for two-step creation
267 (you need to call wxWebView::Create on the returned object)
268 @param backend which web engine to use as backend for wxWebView
269 @return the created wxWebView, or NULL if the requested backend is
272 static wxWebView
* New(wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
);
275 Factory function to create a new wxWebView
276 @param parent parent window to create this view in
277 @param id ID of this control
278 @param url URL to load by default in the web view
279 @param pos position to create this control at
280 (you may use wxDefaultPosition if you use sizers)
281 @param size size to create this control with
282 (you may use wxDefaultSize if you use sizers)
283 @param backend which web engine to use as backend for wxWebView
284 @return the created wxWebView, or NULL if the requested backend
287 static wxWebView
* New(wxWindow
* parent
,
289 const wxString
& url
= wxWebViewDefaultURLStr
,
290 const wxPoint
& pos
= wxDefaultPosition
,
291 const wxSize
& size
= wxDefaultSize
,
292 wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
,
294 const wxString
& name
= wxWebViewNameStr
);
297 Get the title of the current web page, or its URL/path if title is not
300 virtual wxString
GetCurrentTitle() const = 0;
303 Get the URL of the currently displayed document.
305 virtual wxString
GetCurrentURL() const = 0;
308 Return the pointer to the native backend used by this control.
310 This method can be used to retrieve the pointer to the native rendering
311 engine used by this control. The return value needs to be down-casted
312 to the appropriate type depending on the platform: under Windows, it's
313 a pointer to IWebBrowser2 interface, under OS X it's a WebView pointer
314 and under GTK it's a WebKitWebView.
316 For example, you could set the WebKit options using this method:
318 #include <webkit/webkit.h>
322 wv = static_cast<WebKitWebView*>(m_window->GetNativeBackend());
324 WebKitWebSettings* settings = webkit_web_view_get_settings(wv);
325 g_object_set(G_OBJECT(settings),
326 "enable-frame-flattening", TRUE,
333 virtual void* GetNativeBackend() const = 0;
336 Get the HTML source code of the currently displayed document.
337 @return The HTML source code, or an empty string if no page is currently
340 virtual wxString
GetPageSource() const = 0;
343 Get the text of the current page.
345 virtual wxString
GetPageText() const = 0;
348 Returns whether the web control is currently busy (e.g. loading a page).
350 virtual bool IsBusy() const = 0;
353 Returns whether the web control is currently editable
355 virtual bool IsEditable() const = 0;
358 Load a web page from a URL
359 @param url The URL of the page to be loaded.
360 @note Web engines generally report errors asynchronously, so if you wish
361 to know whether loading the URL was successful, register to receive
362 navigation error events.
364 virtual void LoadURL(const wxString
& url
) = 0;
367 Opens a print dialog so that the user may print the currently
370 virtual void Print() = 0;
373 Registers a custom scheme handler.
374 @param handler A shared pointer to a wxWebHandler.
376 virtual void RegisterHandler(wxSharedPtr
<wxWebViewHandler
> handler
) = 0;
379 Reload the currently displayed URL.
380 @param flags A bit array that may optionally contain reload options.
382 virtual void Reload(wxWebViewReloadFlags flags
= wxWEB_VIEW_RELOAD_DEFAULT
) = 0;
385 Runs the given javascript code.
387 virtual void RunScript(const wxString
& javascript
) = 0;
390 Set the editable property of the web control. Enabling allows the user
391 to edit the page even if the @c contenteditable attribute is not set.
392 The exact capabilities vary with the backend being used.
394 virtual void SetEditable(bool enable
= true) = 0;
397 Set the displayed page source to the contents of the given string.
398 @param html The string that contains the HTML data to display.
399 @param baseUrl URL assigned to the HTML data, to be used to resolve
400 relative paths, for instance.
402 virtual void SetPage(const wxString
& html
, const wxString
& baseUrl
) = 0;
405 Set the displayed page source to the contents of the given stream.
406 @param html The stream to read HTML data from.
407 @param baseUrl URL assigned to the HTML data, to be used to resolve
408 relative paths, for instance.
410 virtual void SetPage(wxInputStream
& html
, wxString baseUrl
);
413 Stop the current page loading process, if any.
414 May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
415 TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
417 virtual void Stop() = 0;
424 Returns @true if the current selection can be copied.
426 @note This always returns @c true on the OSX WebKit backend.
428 virtual bool CanCopy() const = 0;
431 Returns @true if the current selection can be cut.
433 @note This always returns @c true on the OSX WebKit backend.
435 virtual bool CanCut() const = 0;
438 Returns @true if data can be pasted.
440 @note This always returns @c true on the OSX WebKit backend.
442 virtual bool CanPaste() const = 0;
445 Copies the current selection.
447 virtual void Copy() = 0;
450 Cuts the current selection.
452 virtual void Cut() = 0;
455 Pastes the current data.
457 virtual void Paste() = 0;
464 Returns @true if it is possible to navigate backward in the history of
467 virtual bool CanGoBack() const = 0;
470 Returns @true if it is possible to navigate forward in the history of
473 virtual bool CanGoForward() const = 0;
476 Clear the history, this will also remove the visible page.
478 virtual void ClearHistory() = 0;
481 Enable or disable the history. This will also clear the history.
483 virtual void EnableHistory(bool enable
= true) = 0;
486 Returns a list of items in the back history. The first item in the
487 vector is the first page that was loaded by the control.
489 virtual wxVector
<wxSharedPtr
<wxWebViewHistoryItem
> > GetBackwardHistory() = 0;
492 Returns a list of items in the forward history. The first item in the
493 vector is the next item in the history with respect to the curently
496 virtual wxVector
<wxSharedPtr
<wxWebViewHistoryItem
> > GetForwardHistory() = 0;
499 Navigate back in the history of visited pages.
500 Only valid if CanGoBack() returns true.
502 virtual void GoBack() = 0;
505 Navigate forward in the history of visited pages.
506 Only valid if CanGoForward() returns true.
508 virtual void GoForward() = 0;
511 Loads a history item.
513 virtual void LoadHistoryItem(wxSharedPtr
<wxWebViewHistoryItem
> item
) = 0;
520 Clears the current selection.
522 virtual void ClearSelection() = 0;
525 Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
526 the selection must be editable, either through SetEditable or the
527 correct HTML attribute.
529 virtual void DeleteSelection() = 0;
532 Returns the currently selected source, if any.
534 virtual wxString
GetSelectedSource() const = 0;
537 Returns the currently selected text, if any.
539 virtual wxString
GetSelectedText() const = 0;
542 Returns @true if there is a current selection.
544 virtual bool HasSelection() const = 0;
547 Selects the entire page.
549 virtual void SelectAll() = 0;
556 Returns @true if there is an action to redo.
558 virtual bool CanRedo() const = 0;
561 Returns @true if there is an action to undo.
563 virtual bool CanUndo() const = 0;
566 Redos the last action.
568 virtual void Redo() = 0;
571 Undos the last action.
573 virtual void Undo() = 0;
580 Retrieve whether the current HTML engine supports a zoom type.
581 @param type The zoom type to test.
582 @return Whether this type of zoom is supported by this HTML engine
583 (and thus can be set through SetZoomType()).
585 virtual bool CanSetZoomType(wxWebViewZoomType type
) const = 0;
588 Get the zoom factor of the page.
589 @return The current level of zoom.
591 virtual wxWebViewZoom
GetZoom() const = 0;
594 Get how the zoom factor is currently interpreted.
595 @return How the zoom factor is currently interpreted by the HTML engine.
597 virtual wxWebViewZoomType
GetZoomType() const = 0;
600 Set the zoom factor of the page.
601 @param zoom How much to zoom (scale) the HTML document.
603 virtual void SetZoom(wxWebViewZoom zoom
) = 0;
606 Set how to interpret the zoom factor.
607 @param zoomType How the zoom factor should be interpreted by the
609 @note invoke CanSetZoomType() first, some HTML renderers may not
610 support all zoom types.
612 virtual void SetZoomType(wxWebViewZoomType zoomType
) = 0;
619 @class wxWebViewEvent
621 A navigation event holds information about events associated with
624 @beginEventEmissionTable{wxWebViewEvent}
625 @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
626 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
627 to get a resource. This event may be vetoed to prevent navigating to this
628 resource. Note that if the displayed HTML document has several frames, one
629 such event will be generated per frame.
630 @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
631 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
632 confirmed that a resource would be requested. This event may not be vetoed.
633 Note that if the displayed HTML document has several frames, one such event
634 will be generated per frame.
635 @event{EVT_WEB_VIEW_LOADED(id, func)}
636 Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
637 is fully loaded and displayed. Note that if the displayed HTML document has
638 several frames, one such event will be generated per frame.
639 @event{EVT_WEB_VIEW_ERROR(id, func)}
640 Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
642 The integer associated with this event will be a wxWebNavigationError item.
643 The string associated with this event may contain a backend-specific more
644 precise error message/code.
645 @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
646 Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
647 window is created. You must handle this event if you want anything to
648 happen, for example to load the page in a new window or tab.
649 @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
650 Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
651 the page title changes. Use GetString to get the title.
656 @category{events,webview}
660 class wxWebViewEvent
: public wxNotifyEvent
664 wxWebViewEvent(wxEventType type
, int id
, const wxString href
,
665 const wxString target
);
668 Get the name of the target frame which the url of this event
669 has been or will be loaded into. This may return an emptry string
670 if the frame is not available.
672 const wxString
& GetTarget() const;
675 Get the URL being visited
677 const wxString
& GetURL() const;
681 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATING
;
682 wxEventType wxEVT_COMMAND_WEB_VIEW_NAVIGATED
;
683 wxEventType wxEVT_COMMAND_WEB_VIEW_LOADED
;
684 wxEventType wxEVT_COMMAND_WEB_VIEW_ERROR
;
685 wxEventType wxEVT_COMMAND_WEB_VIEW_NEWWINDOW
;
686 wxEventType wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED
;