diff options
Diffstat (limited to 'src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc')
| -rw-r--r-- | src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc | 53 |
1 files changed, 27 insertions, 26 deletions
diff --git a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc index 864618309..2e0c6ec82 100644 --- a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc @@ -1,4 +1,5 @@ /* + Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) This library is free software; you can redistribute it and/or @@ -22,39 +23,39 @@ // placed inline in the code as usual. /*! - \class QWebInspector + \class QWebEngineInspector \since 4.6 - \inmodule QtWebKit - \brief The QWebInspector class allows the placement and control of a - QWebPage's inspector. + \inmodule QtWebEngine + \brief The QWebEngineInspector class allows the placement and control of a + QWebEnginePage's inspector. The inspector can display a page's hierarchy, its loading statistics and the current state of its individual elements. It is mostly used by web developers. - The QWebPage to be inspected must be specified using the setPage() method. + The QWebEnginePage to be inspected must be specified using the setPage() method. - A typical use of QWebInspector follows: + A typical use of QWebEngineInspector follows: - \snippet webkitsnippets/qtwebkit_qwebinspector_snippet.cpp 0 + \snippet snippets/qtwebengine_qwebengineinspector_snippet.cpp 0 - A QWebInspector can be made visible either programmatically using - setVisible(), or by the user through the attached QWebPage's context + A QWebEngineInspector can be made visible either programmatically using + setVisible(), or by the user through the attached QWebEnginePage's context menu. - \note A QWebInspector will display a blank widget if either: + \note A QWebEngineInspector will display a blank widget if either: \list \li page() is null - \li QWebSettings::DeveloperExtrasEnabled is false + \li QWebEngineSettings::DeveloperExtrasEnabled is false \endlist \section1 Resources This class acts mostly as a container and a controller for the inspector. Most of the resources needed by the inspector are owned by the associated - QWebPage and are allocated the first time that: + QWebEnginePage and are allocated the first time that: \list \li an element is inspected - \li the QWebInspector is shown. + \li the QWebEngineInspector is shown. \endlist \section1 Inspector configuration persistence @@ -63,41 +64,41 @@ user interface (e.g. the resource tracking "Always enable" option). The inspector UI is itself a web page and is using HTML local storage to persist those settings. - Since the internal QWebPage used by the inspector isn't exposed in the API, + Since the internal QWebEnginePage used by the inspector isn't exposed in the API, the only way to enable those settings to be persisted is currently to enable - local storage globally through QWebSettings::globalSettings(). + local storage globally through QWebEngineSettings::globalSettings(). - \sa QWebSettings::localStoragePath(), QWebSettings::LocalStorageEnabled + \sa QWebEngineSettings::localStoragePath(), QWebEngineSettings::LocalStorageEnabled */ /*! - \fn QWebInspector::QWebInspector(QWidget* parent) - Constructs an unbound QWebInspector with \a parent as its parent. + \fn QWebEngineInspector::QWebEngineInspector(QWidget* parent) + Constructs an unbound QWebEngineInspector with \a parent as its parent. */ /*! - \fn QWebInspector::~QWebInspector() + \fn QWebEngineInspector::~QWebEngineInspector() Destroys the inspector. */ /*! - \fn void QWebInspector::setPage(QWebPage* page) - Bind this inspector to the QWebPage to be inspected. + \fn void QWebEngineInspector::setPage(QWebEnginePage* page) + Bind this inspector to the QWebEnginePage to be inspected. \b {Notes:} \list - \li There can only be one QWebInspector associated with a QWebPage + \li There can only be one QWebEngineInspector associated with a QWebEnginePage and vice versa. \li Calling this method with a null \a page will break the current association, if any. - \li If \a page is already associated to another QWebInspector, the association - will be replaced and the previous QWebInspector will become unbound + \li If \a page is already associated to another QWebEngineInspector, the association + will be replaced and the previous QWebEngineInspector will become unbound \endlist \sa page() */ /*! - \fn QWebPage* QWebInspector::page() const - Returns the inspected QWebPage. + \fn QWebEnginePage* QWebEngineInspector::page() const + Returns the inspected QWebEnginePage. If no web page is currently associated, a null pointer is returned. */ |