]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/webview.h
Add ctors for wxFileSystemWatcherEvent
[wxWidgets.git] / interface / wx / webview.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: webview.h
3 // Purpose: interface of wxWebView
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 Zoom levels available in wxWebView
11 */
12 enum wxWebViewZoom
13 {
14 wxWEB_VIEW_ZOOM_TINY,
15 wxWEB_VIEW_ZOOM_SMALL,
16 wxWEB_VIEW_ZOOM_MEDIUM, //!< default size
17 wxWEB_VIEW_ZOOM_LARGE,
18 wxWEB_VIEW_ZOOM_LARGEST
19 };
20
21 /**
22 The type of zooming that the web view control can perform
23 */
24 enum wxWebViewZoomType
25 {
26 /**
27 The entire layout scales when zooming, including images
28 */
29 wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
30 /**
31 Only the text changes in size when zooming, images and other layout
32 elements retain their initial size
33 */
34 wxWEB_VIEW_ZOOM_TYPE_TEXT
35 };
36
37 /**
38 Types of errors that can cause navigation to fail
39 */
40 enum wxWebViewNavigationError
41 {
42 /** Connection error (timeout, etc.) */
43 wxWEB_NAV_ERR_CONNECTION,
44 /** Invalid certificate */
45 wxWEB_NAV_ERR_CERTIFICATE,
46 /** Authentication required */
47 wxWEB_NAV_ERR_AUTH,
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*/
58 wxWEB_NAV_ERR_OTHER
59 };
60
61 /**
62 Type of refresh
63 */
64 enum wxWebViewReloadFlags
65 {
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
70 };
71
72 /**
73 * List of available backends for wxWebView
74 */
75 enum wxWebViewBackend
76 {
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,
80
81 /** The WebKit web engine */
82 wxWEB_VIEW_BACKEND_WEBKIT,
83
84 /** Use Microsoft Internet Explorer as web engine */
85 wxWEB_VIEW_BACKEND_IE
86 };
87
88 /**
89 @class wxWebViewHistoryItem
90
91 A simple class that contains the URL and title of an element of the history
92 of a wxWebView.
93
94 @since 2.9.3
95 @library{wxwebview}
96 @category{webview}
97
98 @see wxWebView
99 */
100 class wxWebViewHistoryItem
101 {
102 public:
103 /**
104 Construtor.
105 */
106 wxWebViewHistoryItem(const wxString& url, const wxString& title);
107
108 /**
109 @return The url of the page.
110 */
111 wxString GetUrl();
112
113 /**
114 @return The title of the page.
115 */
116 wxString GetTitle();
117 };
118
119 /**
120 @class wxWebViewHandler
121
122 The base class for handling custom schemes in wxWebView, for example to
123 allow virtual file system support.
124
125 @since 2.9.3
126 @library{wxwebview}
127 @category{webview}
128
129 @see wxWebView
130 */
131 class wxWebViewHandler
132 {
133 public:
134 /**
135 Constructor. Takes the name of the scheme that will be handled by this
136 class for example @c file or @c zip.
137 */
138 wxWebViewHandler(const wxString& scheme);
139
140 /**
141 @return A pointer to the file represented by @c uri.
142 */
143 virtual wxFSFile* GetFile(const wxString &uri) = 0;
144
145 /**
146 @return The name of the scheme, as passed to the constructor.
147 */
148 virtual wxString GetName() const;
149 };
150
151 /**
152 @class wxWebView
153
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
159 javascript and css.
160
161 @section descriptions Backend Descriptions
162
163 @par wxWEB_VIEW_BACKEND_IE (MSW)
164
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.
174
175 @par wxWEB_VIEW_WEBKIT (GTK)
176
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
183 data:// scheme.
184
185 @par wxWEB_VIEW_WEBKIT (OSX)
186
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
190 systems.
191
192 @section async Asynchronous Notifications
193
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.
201
202 @section vfs Virtual File Systems and Custom Schemes
203
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.
209
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
214
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
232 error occurs.
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.
243 @endEventTable
244
245 @since 2.9.3
246 @library{wxwebview}
247 @category{ctrl,webview}
248 @see wxWebViewHandler, wxWebViewEvent
249 */
250 class wxWebView : public wxControl
251 {
252 public:
253
254 /**
255 Creation function for two-step creation.
256 */
257 virtual bool Create(wxWindow* parent,
258 wxWindowID id,
259 const wxString& url = wxWebViewDefaultURLStr,
260 const wxPoint& pos = wxDefaultPosition,
261 const wxSize& size = wxDefaultSize,
262 long style = 0,
263 const wxString& name = wxWebViewNameStr) = 0;
264
265 /**
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
270 not available
271 */
272 static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
273
274 /**
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
285 is not available
286 */
287 static wxWebView* New(wxWindow* parent,
288 wxWindowID id,
289 const wxString& url = wxWebViewDefaultURLStr,
290 const wxPoint& pos = wxDefaultPosition,
291 const wxSize& size = wxDefaultSize,
292 wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
293 long style = 0,
294 const wxString& name = wxWebViewNameStr);
295
296 /**
297 Get the title of the current web page, or its URL/path if title is not
298 available.
299 */
300 virtual wxString GetCurrentTitle() const = 0;
301
302 /**
303 Get the URL of the currently displayed document.
304 */
305 virtual wxString GetCurrentURL() const = 0;
306
307 /**
308 Return the pointer to the native backend used by this control.
309
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.
315
316 For example, you could set the WebKit options using this method:
317 @code
318 #include <webkit/webkit.h>
319
320 #ifdef __WXGTK__
321 WebKitWebView*
322 wv = static_cast<WebKitWebView*>(m_window->GetNativeBackend());
323
324 WebKitWebSettings* settings = webkit_web_view_get_settings(wv);
325 g_object_set(G_OBJECT(settings),
326 "enable-frame-flattening", TRUE,
327 NULL);
328 #endif
329 @endcode
330
331 @since 2.9.5
332 */
333 virtual void* GetNativeBackend() const = 0;
334
335 /**
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
338 shown.
339 */
340 virtual wxString GetPageSource() const = 0;
341
342 /**
343 Get the text of the current page.
344 */
345 virtual wxString GetPageText() const = 0;
346
347 /**
348 Returns whether the web control is currently busy (e.g. loading a page).
349 */
350 virtual bool IsBusy() const = 0;
351
352 /**
353 Returns whether the web control is currently editable
354 */
355 virtual bool IsEditable() const = 0;
356
357 /**
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.
363 */
364 virtual void LoadURL(const wxString& url) = 0;
365
366 /**
367 Opens a print dialog so that the user may print the currently
368 displayed page.
369 */
370 virtual void Print() = 0;
371
372 /**
373 Registers a custom scheme handler.
374 @param handler A shared pointer to a wxWebHandler.
375 */
376 virtual void RegisterHandler(wxSharedPtr<wxWebViewHandler> handler) = 0;
377
378 /**
379 Reload the currently displayed URL.
380 @param flags A bit array that may optionally contain reload options.
381 */
382 virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
383
384 /**
385 Runs the given javascript code.
386 */
387 virtual void RunScript(const wxString& javascript) = 0;
388
389 /**
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.
393 */
394 virtual void SetEditable(bool enable = true) = 0;
395
396 /**
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.
401 */
402 virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
403
404 /**
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.
409 */
410 virtual void SetPage(wxInputStream& html, wxString baseUrl);
411
412 /**
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.
416 */
417 virtual void Stop() = 0;
418
419 /**
420 @name Clipboard
421 */
422
423 /**
424 Returns @true if the current selection can be copied.
425
426 @note This always returns @c true on the OSX WebKit backend.
427 */
428 virtual bool CanCopy() const = 0;
429
430 /**
431 Returns @true if the current selection can be cut.
432
433 @note This always returns @c true on the OSX WebKit backend.
434 */
435 virtual bool CanCut() const = 0;
436
437 /**
438 Returns @true if data can be pasted.
439
440 @note This always returns @c true on the OSX WebKit backend.
441 */
442 virtual bool CanPaste() const = 0;
443
444 /**
445 Copies the current selection.
446 */
447 virtual void Copy() = 0;
448
449 /**
450 Cuts the current selection.
451 */
452 virtual void Cut() = 0;
453
454 /**
455 Pastes the current data.
456 */
457 virtual void Paste() = 0;
458
459 /**
460 @name History
461 */
462
463 /**
464 Returns @true if it is possible to navigate backward in the history of
465 visited pages.
466 */
467 virtual bool CanGoBack() const = 0;
468
469 /**
470 Returns @true if it is possible to navigate forward in the history of
471 visited pages.
472 */
473 virtual bool CanGoForward() const = 0;
474
475 /**
476 Clear the history, this will also remove the visible page.
477 */
478 virtual void ClearHistory() = 0;
479
480 /**
481 Enable or disable the history. This will also clear the history.
482 */
483 virtual void EnableHistory(bool enable = true) = 0;
484
485 /**
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.
488 */
489 virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetBackwardHistory() = 0;
490
491 /**
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
494 loaded page.
495 */
496 virtual wxVector<wxSharedPtr<wxWebViewHistoryItem> > GetForwardHistory() = 0;
497
498 /**
499 Navigate back in the history of visited pages.
500 Only valid if CanGoBack() returns true.
501 */
502 virtual void GoBack() = 0;
503
504 /**
505 Navigate forward in the history of visited pages.
506 Only valid if CanGoForward() returns true.
507 */
508 virtual void GoForward() = 0;
509
510 /**
511 Loads a history item.
512 */
513 virtual void LoadHistoryItem(wxSharedPtr<wxWebViewHistoryItem> item) = 0;
514
515 /**
516 @name Selection
517 */
518
519 /**
520 Clears the current selection.
521 */
522 virtual void ClearSelection() = 0;
523
524 /**
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.
528 */
529 virtual void DeleteSelection() = 0;
530
531 /**
532 Returns the currently selected source, if any.
533 */
534 virtual wxString GetSelectedSource() const = 0;
535
536 /**
537 Returns the currently selected text, if any.
538 */
539 virtual wxString GetSelectedText() const = 0;
540
541 /**
542 Returns @true if there is a current selection.
543 */
544 virtual bool HasSelection() const = 0;
545
546 /**
547 Selects the entire page.
548 */
549 virtual void SelectAll() = 0;
550
551 /**
552 @name Undo / Redo
553 */
554
555 /**
556 Returns @true if there is an action to redo.
557 */
558 virtual bool CanRedo() const = 0;
559
560 /**
561 Returns @true if there is an action to undo.
562 */
563 virtual bool CanUndo() const = 0;
564
565 /**
566 Redos the last action.
567 */
568 virtual void Redo() = 0;
569
570 /**
571 Undos the last action.
572 */
573 virtual void Undo() = 0;
574
575 /**
576 @name Zoom
577 */
578
579 /**
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()).
584 */
585 virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
586
587 /**
588 Get the zoom factor of the page.
589 @return The current level of zoom.
590 */
591 virtual wxWebViewZoom GetZoom() const = 0;
592
593 /**
594 Get how the zoom factor is currently interpreted.
595 @return How the zoom factor is currently interpreted by the HTML engine.
596 */
597 virtual wxWebViewZoomType GetZoomType() const = 0;
598
599 /**
600 Set the zoom factor of the page.
601 @param zoom How much to zoom (scale) the HTML document.
602 */
603 virtual void SetZoom(wxWebViewZoom zoom) = 0;
604
605 /**
606 Set how to interpret the zoom factor.
607 @param zoomType How the zoom factor should be interpreted by the
608 HTML engine.
609 @note invoke CanSetZoomType() first, some HTML renderers may not
610 support all zoom types.
611 */
612 virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
613 };
614
615
616
617
618 /**
619 @class wxWebViewEvent
620
621 A navigation event holds information about events associated with
622 wxWebView objects.
623
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
641 error occurs.
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.
652 @endEventTable
653
654 @since 2.9.3
655 @library{wxwebview}
656 @category{events,webview}
657
658 @see wxWebView
659 */
660 class wxWebViewEvent : public wxNotifyEvent
661 {
662 public:
663 wxWebViewEvent();
664 wxWebViewEvent(wxEventType type, int id, const wxString href,
665 const wxString target);
666
667 /**
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.
671 */
672 const wxString& GetTarget() const;
673
674 /**
675 Get the URL being visited
676 */
677 const wxString& GetURL() const;
678 };
679
680
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;