Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

QNPlugin Class Reference

The QNPlugin class provides the main factory for plugin objects. More...

This class is part of the Qt Netscape Extension.

#include <qnp.h>

List of all member functions.

Public Members

• virtual ~QNPlugin ()
• void getVersionInfo ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )
• virtual QNPInstance * newInstance () = 0
• virtual const char * getMIMEDescription () const = 0
• virtual const char * getPluginNameString () const = 0
• virtual const char * getPluginDescriptionString () const = 0
• virtual void * getJavaClass ()
• virtual void unuseJavaClass ()
• void * getJavaEnv () const

Static Public Members

• QNPlugin * create ()
• QNPlugin * actual ()

Protected Members

• QNPlugin ()

Detailed Description

This class is defined in the Qt Netscape Extension, which can be found in the qt/extensions directory. It is not included in the main Qt API.

The QNPlugin class provides the main factory for plugin objects.

This class is the heart of the plugin. One instance of this object is created when the plugin is first needed, by calling QNPlugin::create(), which must be implemented in your plugin code to return some derived class of QNPlugin. The one QNPlugin object creates all QNPInstance instances for a web browser running in a single process.

Additionally, if Qt is linked to the plugin as a dynamic library, only one instance of QApplication will exist across all plugins that have been made with Qt. So, your plugin should tread lightly on global settings. Do not, for example, use QApplication::setFont() - that will change the font in every widget of every Qt-based plugin currently loaded!

Member Function Documentation

QNPlugin::QNPlugin () [protected]

QNPlugin::~QNPlugin () [virtual]

QNPlugin * QNPlugin::actual () [static]

QNPlugin * QNPlugin::create () [static]

This function must be implemented by your plugin code. It should return a derived class of QNPlugin.

void * QNPlugin::getJavaClass () [virtual]

If you override this class, you must also override QNPlugin::unuseJavaClass().

The return value is actually a jref; we use void* so as to avoid burdening plugins which do not require Java.

See also getJavaEnv() and QNPInstance::getJavaPeer().

void * QNPlugin::getJavaEnv () const

The return value is actually a JRIEnv*; we use void* so as to avoid burdening plugins which do not require Java.

See also getJavaClass() and QNPInstance::getJavaPeer().

const char * QNPlugin::getMIMEDescription () const [pure virtual]

Override this function to return the MIME description of the data formats supported by your plugin. The format of this string is shown by the following example:

    const char* getMIMEDescription() const
    {
        return "image/x-png:png:PNG Image;"
               "image/png:png:PNG Image;"
               "image/x-portable-bitmap:pbm:PBM Image;"
               "image/x-portable-graymap:pgm:PGM Image;"
               "image/x-portable-pixmap:ppm:PPM Image;"
               "image/bmp:bmp:BMP Image;"
               "image/x-ms-bmp:bmp:BMP Image;"
               "image/x-xpixmap:xpm:XPM Image;"
               "image/xpm:xpm:XPM Image";
    }

const char * QNPlugin::getPluginDescriptionString () const [pure virtual]

Returns a pointer to the plain-text description of the plugin.

const char * QNPlugin::getPluginNameString () const [pure virtual]

Returns a pointer to the plain-text name of the plugin.

void QNPlugin::getVersionInfo ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor )

QNPInstance * QNPlugin::newInstance () [pure virtual]

Override this function to return an appropriate derived class of QNPInstance.

void QNPlugin::unuseJavaClass () [virtual]

This file is part of the Qt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.