com.trolltech.qt.webkit
Class QWebPluginFactory

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.core.QObject
                  extended by com.trolltech.qt.webkit.QWebPluginFactory
All Implemented Interfaces:
QtJambiInterface

public abstract class QWebPluginFactory
extends QObject

The QWebPluginFactory class creates plugins to be embedded into web pages. QWebPluginFactory is a factory for creating plugins for QWebPage. A plugin 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 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 each plugin can handle should match the ones specified in in the HTML <object> tag.

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.


Nested Class Summary
static class QWebPluginFactory.Extension
          This enum describes the types of extensions that the plugin factory can support.
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QWebPluginFactory()
          Constructs a QWebPluginFactory with parent parent.
QWebPluginFactory(QObject parent)
          Constructs a QWebPluginFactory with parent parent.
 
Method Summary
abstract  QObject create(java.lang.String mimeType, QUrl url, java.util.List argumentNames, java.util.List argumentValues)
          Implemented in subclasses to create a new plugin that can display content of the MIME type given by mimeType.
 boolean extension(QWebPluginFactory.Extension extension)
          This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions.
 boolean extension(QWebPluginFactory.Extension extension, QWebPluginFactory_ExtensionOption option)
          This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions.
 boolean extension(QWebPluginFactory.Extension extension, QWebPluginFactory_ExtensionOption option, QWebPluginFactory_ExtensionReturn output)
          This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions.
abstract  java.util.List plugins()
          This function is reimplemented in subclasses to return a list of supported plugins the factory can create.
 void refreshPlugins()
          This function is called to refresh the list of supported plugins.
 boolean supportsExtension(QWebPluginFactory.Extension extension)
          This virtual function returns true if the plugin factory supports extension; otherwise false is returned.
 
Methods inherited from class com.trolltech.qt.core.QObject
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QWebPluginFactory

public QWebPluginFactory()
Constructs a QWebPluginFactory with parent parent.


QWebPluginFactory

public QWebPluginFactory(QObject parent)
Constructs a QWebPluginFactory with parent parent.

Method Detail

create

public abstract QObject create(java.lang.String mimeType,
                               QUrl url,
                               java.util.List argumentNames,
                               java.util.List argumentValues)
Implemented in subclasses to create a new plugin that can display content of the MIME type given by mimeType. The URL of the content is provided in url. The returned object should be a QWidget.

The HTML object element can provide parameters through the <param> tag. The name and the value attributes of these tags are specified by the argumentNames and argumentValues string lists.

For example:

<object type="application/x-pdf" data="http://qtsoftware.com/document.pdf" width="500" height="400">
    <param name="showTableOfContents" value="true" />
    <param name="hideThumbnails" value="false" />
</object>
The above object element will result in a call to create() with the following arguments:
Parameter
Value
mimeType "application/x-pdf"
url "http://qtsoftware.com/document.pdf"
argumentNames "showTableOfContents" "hideThumbnails"
argumentVaues "true" "false"
Note: Ownership of the returned object will be transferred to the caller.


extension

public final boolean extension(QWebPluginFactory.Extension extension,
                               QWebPluginFactory_ExtensionOption option)
This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions. The option argument is provided as input to the extension; the output results can be stored in output.

The behaviour of this function is determined by extension.

You can call supportsExtension() to check if an extension is supported by the factory.

By default, no extensions are supported, and this function returns false.

See also:
supportsExtension(), and Extension .


extension

public final boolean extension(QWebPluginFactory.Extension extension)
This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions. The option argument is provided as input to the extension; the output results can be stored in output.

The behaviour of this function is determined by extension.

You can call supportsExtension() to check if an extension is supported by the factory.

By default, no extensions are supported, and this function returns false.

See also:
supportsExtension(), and Extension .


extension

public boolean extension(QWebPluginFactory.Extension extension,
                         QWebPluginFactory_ExtensionOption option,
                         QWebPluginFactory_ExtensionReturn output)
This virtual function can be reimplemented in a QWebPluginFactory subclass to provide support for extensions. The option argument is provided as input to the extension; the output results can be stored in output.

The behaviour of this function is determined by extension.

You can call supportsExtension() to check if an extension is supported by the factory.

By default, no extensions are supported, and this function returns false.

See also:
supportsExtension(), and Extension .


plugins

public abstract java.util.List plugins()
This function is reimplemented in subclasses to return a list of supported plugins the factory can create.

Note: Currently, this function is only called when JavaScript programs access the global plugins or mimetypes objects.


refreshPlugins

public void refreshPlugins()
This function is called to refresh the list of supported plugins. It may be called after a new plugin has been installed in the system.


supportsExtension

public boolean supportsExtension(QWebPluginFactory.Extension extension)
This virtual function returns true if the plugin factory supports extension; otherwise false is returned.

See also:
extension().