1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxWebView
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 Zoom levels availiable 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 wxWebNavigationError
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
74 * List of available backends for wxWebView
78 /** Value that may be passed to wxWebView to let it pick an appropriate
79 * engine for the current platform*/
80 wxWEB_VIEW_BACKEND_DEFAULT
,
82 /** The WebKit web engine */
83 wxWEB_VIEW_BACKEND_WEBKIT
,
85 /** Use Microsoft Internet Explorer as web engine */
90 @class wxWebHistoryItem
92 A simple class that contains the URL and title of an element of the history
100 class wxWebHistoryItem
106 wxWebHistoryItem(const wxString
& url
, const wxString
& title
);
109 @return The url of the page.
114 @return The title of the page.
122 This control may be used to render web (HTML / CSS / javascript) documents.
123 Capabilities of the HTML renderer will depend upon the backed.
125 @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which
126 is also used by Internet Explorer. It is important to note that by default
127 it emulates Internet Explorer 7, this can be chaged with a registry
129 <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
130 this</a> article for more information.
132 Note that errors are generally reported asynchronously though the
133 @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
135 @beginEventEmissionTable{wxWebNavigationEvent}
136 @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
137 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
138 to get a resource. This event may be vetoed to prevent navigating to this
139 resource. Note that if the displayed HTML document has several frames, one
140 such event will be generated per frame.
141 @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
142 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
143 confirmed that a resource would be requested. This event may not be vetoed.
144 Note that if the displayed HTML document has several frames, one such event
145 will be generated per frame.
146 @event{EVT_WEB_VIEW_LOADED(id, func)}
147 Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
148 is fully loaded and displayed. Note that if the displayed HTML document has
149 several frames, one such event will be generated per frame.
150 @event{EVT_WEB_VIEW_ERRROR(id, func)}
151 Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
153 The integer associated with this event will be a wxWebNavigationError item.
154 The string associated with this event may contain a backend-specific more
155 precise error message/code.
156 @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
157 Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
158 window is created. This event may be vetoed to prevent a new window showing,
159 for example if you want to open the url in the existing window or a new tab.
165 class wxWebView
: public wxControl
170 Creation function for two-step creation.
172 virtual bool Create(wxWindow
* parent
,
178 const wxString
& name
) = 0;
181 Factory function to create a new wxWebView for two-step creation
182 (you need to call wxWebView::Create on the returned object)
183 @param backend which web engine to use as backend for wxWebView
184 @return the created wxWebView, or NULL if the requested backend is
187 static wxWebView
* New(wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
);
190 Factory function to create a new wxWebView
191 @param parent parent window to create this view in
192 @param id ID of this control
193 @param url URL to load by default in the web view
194 @param pos position to create this control at
195 (you may use wxDefaultPosition if you use sizers)
196 @param size size to create this control with
197 (you may use wxDefaultSize if you use sizers)
198 @param backend which web engine to use as backend for wxWebView
199 @return the created wxWebView, or NULL if the requested backend
202 static wxWebView
* New(wxWindow
* parent
,
204 const wxString
& url
= wxWebViewDefaultURLStr
,
205 const wxPoint
& pos
= wxDefaultPosition
,
206 const wxSize
& size
= wxDefaultSize
,
207 wxWebViewBackend backend
= wxWEB_VIEW_BACKEND_DEFAULT
,
209 const wxString
& name
= wxWebViewNameStr
);
212 Get the title of the current web page, or its URL/path if title is not
215 virtual wxString
GetCurrentTitle() = 0;
218 Get the URL of the currently displayed document.
220 virtual wxString
GetCurrentURL() = 0;
223 Get the HTML source code of the currently displayed document.
224 @return The HTML source code, or an empty string if no page is currently
227 virtual wxString
GetPageSource() = 0;
230 Get the text of the current page.
232 virtual wxString
GetPageText() = 0;
235 Returns whether the web control is currently busy (e.g. loading a page).
237 virtual bool IsBusy() = 0;
240 Returns whether the web control is currently editable
242 virtual bool IsEditable() = 0;
245 Load a web page from a URL
246 @param url The URL of the page to be loaded.
247 @note Web engines generally report errors asynchronously, so if you wish
248 to know whether loading the URL was successful, register to receive
249 navigation error events.
251 virtual void LoadUrl(const wxString
& url
) = 0;
254 Opens a print dialog so that the user may print the currently
257 virtual void Print() = 0;
260 Reload the currently displayed URL.
261 @param flags A bit array that may optionally contain reload options.
263 virtual void Reload(wxWebViewReloadFlags flags
= wxWEB_VIEW_RELOAD_DEFAULT
) = 0;
266 Runs the given javascript code.
268 virtual void RunScript(const wxString
& javascript
) = 0;
271 Set the editable property of the web control. Enabling allows the user
272 to edit the page even if the @c contenteditable attribute is not set.
273 The exact capabilities vary with the backend being used.
275 virtual void SetEditable(bool enable
= true) = 0;
278 Set the displayed page source to the contents of the given string.
279 @param html The string that contains the HTML data to display.
280 @param baseUrl URL assigned to the HTML data, to be used to resolve
281 relative paths, for instance.
283 virtual void SetPage(const wxString
& html
, const wxString
& baseUrl
) = 0;
286 Set the displayed page source to the contents of the given stream.
287 @param html The stream to read HTML data from.
288 @param baseUrl URL assigned to the HTML data, to be used to resolve
289 relative paths, for instance.
291 virtual void SetPage(wxInputStream
& html
, wxString baseUrl
)
293 wxStringOutputStream stream
;
295 SetPage(stream
.GetString(), baseUrl
);
299 Stop the current page loading process, if any.
300 May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
301 TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
303 virtual void Stop() = 0;
310 Returns @true if the current selection can be copied.
312 virtual bool CanCopy() = 0;
315 Returns @true if the current selection can be cut.
317 virtual bool CanCut() = 0;
320 Returns @true if data can be pasted.
322 virtual bool CanPaste() = 0;
325 Copies the current selection.
327 virtual void Copy() = 0;
330 Cuts the current selection.
332 virtual void Cut() = 0;
335 Pastes the current data.
337 virtual void Paste() = 0;
344 Returns @true if it is possible to navigate backward in the history of
347 virtual bool CanGoBack() = 0;
350 Returns @true if it is possible to navigate forward in the history of
353 virtual bool CanGoForward() = 0;
356 Clear the history, this will also remove the visible page.
358 virtual void ClearHistory() = 0;
361 Enable or disable the history. This will also clear the history.
363 virtual void EnableHistory(bool enable
= true) = 0;
366 Returns a list of items in the back history. The first item in the
367 vector is the first page that was loaded by the control.
369 virtual wxVector
<wxSharedPtr
<wxWebHistoryItem
> > GetBackwardHistory() = 0;
372 Returns a list of items in the forward history. The first item in the
373 vector is the next item in the history with respect to the curently
376 virtual wxVector
<wxSharedPtr
<wxWebHistoryItem
> > GetForwardHistory() = 0;
379 Navigate back in the history of visited pages.
380 Only valid if CanGoBack() returns true.
382 virtual void GoBack() = 0;
385 Navigate forward in the history of visited pages.
386 Only valid if CanGoForward() returns true.
388 virtual void GoForward() = 0;
391 Loads a history item.
393 virtual void LoadHistoryItem(wxSharedPtr
<wxWebHistoryItem
> item
) = 0;
400 Clears the current selection.
402 virtual void ClearSelection() = 0;
405 Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
406 the selection must be editable, either through SetEditable or the
407 correct HTML attribute.
409 virtual void DeleteSelection() = 0;
412 Returns the currently selected source, if any.
414 virtual wxString
GetSelectedSource() = 0;
417 Returns the currently selected text, if any.
419 virtual wxString
GetSelectedText() = 0;
422 Returns @true if there is a current selection.
424 virtual bool HasSelection() = 0;
427 Selects the entire page.
429 virtual void SelectAll() = 0;
436 Returns @true if there is an action to redo.
438 virtual bool CanRedo() = 0;
441 Returns @true if there is an action to undo.
443 virtual bool CanUndo() = 0;
446 Redos the last action.
448 virtual void Redo() = 0;
451 Undos the last action.
453 virtual void Undo() = 0;
460 Retrieve whether the current HTML engine supports a zoom type.
461 @param type The zoom type to test.
462 @return Whether this type of zoom is supported by this HTML engine
463 (and thus can be set through SetZoomType()).
465 virtual bool CanSetZoomType(wxWebViewZoomType type
) const = 0;
468 Get the zoom factor of the page.
469 @return The current level of zoom.
471 virtual wxWebViewZoom
GetZoom() = 0;
474 Get how the zoom factor is currently interpreted.
475 @return How the zoom factor is currently interpreted by the HTML engine.
477 virtual wxWebViewZoomType
GetZoomType() const = 0;
480 Set the zoom factor of the page.
481 @param zoom How much to zoom (scale) the HTML document.
483 virtual void SetZoom(wxWebViewZoom zoom
) = 0;
486 Set how to interpret the zoom factor.
487 @param zoomType How the zoom factor should be interpreted by the
489 @note invoke CanSetZoomType() first, some HTML renderers may not
490 support all zoom types.
492 virtual void SetZoomType(wxWebViewZoomType zoomType
) = 0;
499 @class wxWebNavigationEvent
501 A navigation event holds information about events associated with
504 @beginEventEmissionTable{wxWebNavigationEvent}
505 @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
506 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
507 to get a resource. This event may be vetoed to prevent navigating to this
508 resource. Note that if the displayed HTML document has several frames, one
509 such event will be generated per frame.
510 @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
511 Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
512 confirmed that a resource would be requested. This event may not be vetoed.
513 Note that if the displayed HTML document has several frames, one such event
514 will be generated per frame.
515 @event{EVT_WEB_VIEW_LOADED(id, func)}
516 Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
517 is fully loaded and displayed. Note that if the displayed HTML document has
518 several frames, one such event will be generated per frame.
519 @event{EVT_WEB_VIEW_ERRROR(id, func)}
520 Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
522 The integer associated with this event will be a wxWebNavigationError item.
523 The string associated with this event may contain a backend-specific more
524 precise error message/code.
525 @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
526 Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
527 window is created. This event may be vetoed to prevent a new window showing,
528 for example if you want to open the url in the existing window or a new tab.
532 @category{events,web}
536 class wxWebNavigationEvent
: public wxCommandEvent
539 wxWebNavigationEvent();
540 wxWebNavigationEvent(wxEventType type
, int id
, const wxString href
,
541 const wxString target
, bool canVeto
);
543 Get the URL being visited
545 const wxString
& GetHref() const { return m_href
; }
548 Get the target (frame or window) in which the URL that caused this event
549 is viewed, or an empty string if not available.
551 const wxString
& GetTarget() const;
553 virtual wxEvent
* Clone() const;
556 Get whether this event may be vetoed (stopped/prevented). Only
557 meaningful for events fired before navigation takes place or new
560 bool CanVeto() const;
563 Whether this event was vetoed (stopped/prevented). Only meaningful for
564 events fired before navigation takes place or new window events.
566 bool IsVetoed() const;
569 Veto (prevent/stop) this event. Only meaningful for events fired
570 before navigation takes place or new window events. Only valid
571 if CanVeto() returned true.