summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc')
-rw-r--r--src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc103
1 files changed, 103 insertions, 0 deletions
diff --git a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc
new file mode 100644
index 000000000..864618309
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc
@@ -0,0 +1,103 @@
+/*
+ Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+
+// The documentation in this file was imported from QtWebKit and is thus constrained
+// by its LGPL license. Documentation written from scratch for new methods should be
+// placed inline in the code as usual.
+
+/*!
+ \class QWebInspector
+ \since 4.6
+ \inmodule QtWebKit
+ \brief The QWebInspector class allows the placement and control of a
+ QWebPage'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.
+
+ A typical use of QWebInspector follows:
+
+ \snippet webkitsnippets/qtwebkit_qwebinspector_snippet.cpp 0
+
+ A QWebInspector can be made visible either programmatically using
+ setVisible(), or by the user through the attached QWebPage's context
+ menu.
+
+ \note A QWebInspector will display a blank widget if either:
+ \list
+ \li page() is null
+ \li QWebSettings::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:
+ \list
+ \li an element is inspected
+ \li the QWebInspector is shown.
+ \endlist
+
+ \section1 Inspector configuration persistence
+
+ The inspector allows the user to configure some options through its
+ 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,
+ the only way to enable those settings to be persisted is currently to enable
+ local storage globally through QWebSettings::globalSettings().
+
+ \sa QWebSettings::localStoragePath(), QWebSettings::LocalStorageEnabled
+*/
+
+/*!
+ \fn QWebInspector::QWebInspector(QWidget* parent)
+ Constructs an unbound QWebInspector with \a parent as its parent.
+*/
+
+/*!
+ \fn QWebInspector::~QWebInspector()
+ Destroys the inspector.
+*/
+
+/*!
+ \fn void QWebInspector::setPage(QWebPage* page)
+ Bind this inspector to the QWebPage to be inspected.
+
+ \b {Notes:}
+ \list
+ \li There can only be one QWebInspector associated with a QWebPage
+ 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
+ \endlist
+
+ \sa page()
+*/
+
+/*!
+ \fn QWebPage* QWebInspector::page() const
+ Returns the inspected QWebPage.
+ If no web page is currently associated, a null pointer is returned.
+*/