Commit 3bcd1202 authored by hausmann@webkit.org's avatar hausmann@webkit.org
Browse files

David Boddie <dboddie@trolltech.com>

Some clarifications for the documentation.


git-svn-id: http://svn.webkit.org/repository/webkit/trunk@34195 268f45cc-cd09-0410-ab3c-d52691b4dbfc
parent 45ee7b5e
...@@ -956,8 +956,8 @@ QVariant QWebPage::inputMethodQuery(Qt::InputMethodQuery property) const ...@@ -956,8 +956,8 @@ QVariant QWebPage::inputMethodQuery(Qt::InputMethodQuery property) const
loadProgress() signal, on the other hand, is emitted whenever an element loadProgress() signal, on the other hand, is emitted whenever an element
of the web page completes loading, such as an embedded image, a script, of the web page completes loading, such as an embedded image, a script,
etc. Finally, the loadFinished() signal is emitted when the page has etc. Finally, the loadFinished() signal is emitted when the page has
loaded completely. It's argument - either \c true or \c false - indicates loaded completely. Its argument, either true or false, indicates whether
load success or failure. or not the load operation succeeded.
\section1 Using QWebPage in a Widget-less Environment \section1 Using QWebPage in a Widget-less Environment
......
...@@ -29,14 +29,17 @@ ...@@ -29,14 +29,17 @@
QWebPluginFactory is a factory for creating plugins for QWebPage. A plugin QWebPluginFactory is a factory for creating plugins for QWebPage. A plugin
factory can be installed on a QWebPage using QWebPage::setPluginFactory(). factory can be installed on a QWebPage using QWebPage::setPluginFactory().
\note The plugin factory is only used if plugins are enabled through QWebSettings.
You can provide a QWebPluginFactory by implementing the plugins() and the You can provide a QWebPluginFactory by implementing the plugins() and the
create() method. For plugins() it is necessary to describe the plugins the create() method. For plugins() it is necessary to describe the plugins the
factory can create, including a description and the supported mime types. The mime types are matched with the mime type factory can create, including a description and the supported MIME types.
specified in the HTML object tag. The create() method is called if the requested mime type is The MIME types each plugin can handle should match the ones specified in
supported. The implementation has to return a new instance of the plugin requested for the given in the HTML \c{<object>} tag.
mime type and the specified url.
\note The plugin factory is only used if plugins are enabled through QWebSettings. The create() method is called if the requested MIME type is supported. The
implementation has to return a new instance of the plugin requested for the
given MIME type and the specified URL.
*/ */
...@@ -69,7 +72,8 @@ ...@@ -69,7 +72,8 @@
/*! /*!
\variable QWebPluginFactory::MimeType::name \variable QWebPluginFactory::MimeType::name
The name of the mime type.
The full name of the MIME type; e.g., \c{text/plain} or \c{image/png}.
*/ */
/*! /*!
...@@ -121,11 +125,13 @@ void QWebPluginFactory::refreshPlugins() ...@@ -121,11 +125,13 @@ void QWebPluginFactory::refreshPlugins()
\fn QObject *QWebPluginFactory::create(const QString &mimeType, const QUrl &url, \fn QObject *QWebPluginFactory::create(const QString &mimeType, const QUrl &url,
const QStringList &argumentNames, const QStringList &argumentValues) const = 0 const QStringList &argumentNames, const QStringList &argumentValues) const = 0
Implemented in subclasses to create a new plugin that can display content of type \a mimeType. Implemented in subclasses to create a new plugin that can display content of
The url of the content is provided in \a url. the MIME type given by \a mimeType. The URL of the content is provided in \a url.
The returned object should be a QWidget.
The HTML object element can provide parameters through the param tag. The name and the value The HTML object element can provide parameters through the \c{<param>} tag.
attributes of these tags are provided in the \a argumentNames and \a argumentValues string lists. The name and the value attributes of these tags are specified by the
\a argumentNames and \a argumentValues string lists.
For example: For example:
...@@ -150,8 +156,6 @@ void QWebPluginFactory::refreshPlugins() ...@@ -150,8 +156,6 @@ void QWebPluginFactory::refreshPlugins()
\o "true" "false" \o "true" "false"
\endtable \endtable
The returned object should be a QWidget.
\note Ownership of the returned object will be transferred to the caller. \note Ownership of the returned object will be transferred to the caller.
*/ */
......
2008-05-29 David Boddie <dboddie@trolltech.com>
Reviewed by Simon.
Some clarifications for the documentation.
* Api/qwebpage.cpp:
* Api/qwebpluginfactory.cpp:
2008-05-27 Ariya Hidayat <ariya.hidayat@trolltech.com> 2008-05-27 Ariya Hidayat <ariya.hidayat@trolltech.com>
Reviewed by Simon. Reviewed by Simon.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment