Update documentation for new library name.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68790 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
467d261e9d
commit
43d53ee501
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: class_web.h
|
||||
// Purpose: Web classes group docs
|
||||
// Name: class_webview.h
|
||||
// Purpose: WebView classes group docs
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows licence
|
||||
@ -8,10 +8,10 @@
|
||||
|
||||
/**
|
||||
|
||||
@defgroup group_class_web Web
|
||||
@defgroup group_class_webview WebView
|
||||
@ingroup group_class
|
||||
|
||||
The wxWeb library is a set of classes for viewing complex web documents and
|
||||
The wxWebView library is a set of classes for viewing complex web documents and
|
||||
for internet browsing. It is built around a series of backends, and exposes
|
||||
common functions for them.
|
||||
|
@ -246,6 +246,7 @@ with the corresponding library. The following symbols are honoured:
|
||||
- wxNO_PROPGRID_LIB
|
||||
- wxNO_QA_LIB
|
||||
- wxNO_RICHTEXT_LIB
|
||||
- wxNO_WEBVIEW_LIB
|
||||
- wxNO_XML_LIB
|
||||
- wxNO_REGEX_LIB
|
||||
- wxNO_EXPAT_LIB
|
||||
|
@ -256,6 +256,7 @@ library:
|
||||
@itemdef{wxUSE_URL_NATIVE, Use native support for some operations with wxURL.}
|
||||
@itemdef{wxUSE_VALIDATORS, Use wxValidator class.}
|
||||
@itemdef{wxUSE_VARIANT, Use wxVariant class.}
|
||||
@itemdef{wxUSE_WEBVIEW, Use wxWebView class.}
|
||||
@itemdef{wxUSE_WIZARDDLG, Use wxWizard class.}
|
||||
@itemdef{wxUSE_WXHTML_HELP, Use wxHtmlHelpController and related classes.}
|
||||
@itemdef{wxUSE_XML, Use XML parsing classes.}
|
||||
|
@ -39,7 +39,7 @@ digraph Dependancies
|
||||
wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
|
||||
wxSTC [fillcolor = green, URL = "\ref page_libs_wxstc"];
|
||||
wxXRC [fillcolor = green, URL = "\ref page_libs_wxxrc"];
|
||||
wxWeb [fillcolor = green, URL = "\ref page_libs_wxweb"];
|
||||
wxWebView [fillcolor = green, URL = "\ref page_libs_wxwebview"];
|
||||
|
||||
wxCore -> wxBase;
|
||||
wxNet -> wxBase;
|
||||
@ -56,7 +56,7 @@ digraph Dependancies
|
||||
wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
|
||||
wxSTC -> wxCore;
|
||||
wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
|
||||
wxWeb -> wxCore;
|
||||
wxWebView -> wxCore;
|
||||
}
|
||||
@enddot
|
||||
|
||||
@ -204,9 +204,9 @@ text editor. See <http://www.scintilla.org/> for more info about Scintilla.
|
||||
|
||||
Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
|
||||
|
||||
@section page_libs_wxweb wxWeb
|
||||
@section page_libs_wxwebview wxWebView
|
||||
|
||||
The wxWeb library contains the wxWebView control.
|
||||
The wxWebView library contains the wxWebView control and its associated classes.
|
||||
|
||||
Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
|
||||
|
||||
|
@ -41,7 +41,7 @@ may find the following samples showing the corresponding controls:
|
||||
@li wxTreeCtrl: @ref page_samples_treectrl
|
||||
@li wxGrid: @ref page_samples_grid
|
||||
@li wxDataViewCtrl: @ref page_samples_dataview
|
||||
@li wxWebView: @ref page_samples_web
|
||||
@li wxWebView: @ref page_samples_webview
|
||||
|
||||
Finally, here is the full list of samples:
|
||||
<!--
|
||||
@ -134,7 +134,7 @@ TODO: Organize them in a more human-readable way.
|
||||
@li @sample{uiaction}
|
||||
@li @sample{validate}
|
||||
@li @sample{vscroll}
|
||||
@li @sample{web}
|
||||
@li @sample{webview}
|
||||
@li @sample{widgets}
|
||||
@li @sample{wizard}
|
||||
@li @sample{wrapsizer}
|
||||
@ -1020,14 +1020,14 @@ control.
|
||||
|
||||
@sampledir{vscroll}
|
||||
|
||||
@section page_samples_web wxWebView Sample
|
||||
@section page_samples_webview wxWebView Sample
|
||||
|
||||
The wxWebView sample demonstarates the various capabilities of the wxWebView
|
||||
control. It is set up as a simple single window web broswer, but with support
|
||||
for many of the more complex wxWebView features, including browsing through
|
||||
archives.
|
||||
|
||||
@sampledir{web}
|
||||
@sampledir{webview}
|
||||
|
||||
@section page_samples_widgets Widgets Sample
|
||||
|
||||
|
@ -92,8 +92,8 @@ enum wxWebViewBackend
|
||||
A simple class that contains the URL and title of an element of the history
|
||||
of a wxWebView.
|
||||
|
||||
@library{wxweb}
|
||||
@category{web}
|
||||
@library{wxwebview}
|
||||
@category{webview}
|
||||
|
||||
@see wxWebView
|
||||
*/
|
||||
@ -122,8 +122,8 @@ public:
|
||||
The base class for handling custom schemes in wxWebView, for example to
|
||||
allow virtual file system support.
|
||||
|
||||
@library{wxweb}
|
||||
@category{web}
|
||||
@library{wxwebview}
|
||||
@category{webview}
|
||||
|
||||
@see wxWebView
|
||||
*/
|
||||
@ -241,8 +241,8 @@ public:
|
||||
the page title changes. Use GetString to get the title.
|
||||
@endEventTable
|
||||
|
||||
@library{wxweb}
|
||||
@category{ctrl,web}
|
||||
@library{wxwebview}
|
||||
@category{ctrl,webview}
|
||||
@see wxWebViewHandler, wxWebViewEvent
|
||||
*/
|
||||
class wxWebView : public wxControl
|
||||
@ -621,8 +621,8 @@ public:
|
||||
the page title changes. Use GetString to get the title.
|
||||
@endEventTable
|
||||
|
||||
@library{wxweb}
|
||||
@category{events,web}
|
||||
@library{wxwebview}
|
||||
@category{events,webview}
|
||||
|
||||
@see wxWebView
|
||||
*/
|
||||
|
@ -1,5 +1,5 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: webfilehandler.h
|
||||
// Name: webviewarchivehandler.h
|
||||
// Purpose: interface of wxWebViewArchiveHandler
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
@ -15,8 +15,8 @@
|
||||
<code> scheme:///C:/exmaple/docs.zip;protocol=zip/main.htm </code>
|
||||
Currently the only supported protocol is @c zip.
|
||||
|
||||
@library{wxweb}
|
||||
@category{web}
|
||||
@library{wxwebview}
|
||||
@category{webview}
|
||||
|
||||
@see wxWebView, wxWebViewHandler
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user