QWidgetPlugin Class Reference

Detailed Description

The widget plugin is a simple plugin interface that makes it easy to create custom widgets that can be included in forms using Qt Designer and used by applications.

Writing a widget plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys(), create(), group(), iconSet(), includeFile(), toolTip(), whatsThis() and isContainer(), and exporting the class with the Q_EXPORT_PLUGIN macro.

See the Qt Designer manual's, 'Creating Custom Widgets' section in the 'Creating Custom Widgets' chapter, for a complete example of a QWidgetPlugin.

See also the Plugins documentation and the QWidgetFactory class that is supplied with Qt Designer.

See also Plugins.

Member Function Documentation

QWidgetPlugin::QWidgetPlugin ()

QWidgetPlugin::~QWidgetPlugin ()

You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.

QWidget * QWidgetPlugin::create ( const QString & key, QWidget * parent = 0, const char * name = 0 ) [pure virtual]

Creates and returns a QWidget object for the widget key key. The widget key is the class name of the required widget. The name and parent arguments are passed to the custom widget's constructor.

See also keys().

QString QWidgetPlugin::group ( const QString & key ) const [virtual]

The default implementation returns QString::null.

QIconSet QWidgetPlugin::iconSet ( const QString & key ) const [virtual]

The default implementation returns an null iconset.

QString QWidgetPlugin::includeFile ( const QString & key ) const [virtual]

The default implementation returns QString::null.

bool QWidgetPlugin::isContainer ( const QString & key ) const [virtual]

The default implementation returns FALSE.

QStringList QWidgetPlugin::keys () const [pure virtual]

Returns the list of widget keys this plugin supports.

These keys must be the class names of the custom widgets that are implemented in the plugin.

See also create().

QString QWidgetPlugin::toolTip ( const QString & key ) const [virtual]

The default implementation returns QString::null.

QString QWidgetPlugin::whatsThis ( const QString & key ) const [virtual]

The default implementation returns QString::null.

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