diff options
Diffstat (limited to 'doc/html/qwidgetplugin.html')
| -rw-r--r-- | doc/html/qwidgetplugin.html | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/doc/html/qwidgetplugin.html b/doc/html/qwidgetplugin.html new file mode 100644 index 0000000..801a410 --- /dev/null +++ b/doc/html/qwidgetplugin.html @@ -0,0 +1,146 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qwidgetplugin.cpp:48 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QWidgetPlugin Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QWidgetPlugin Class Reference</h1> + +<p>The QWidgetPlugin class provides an abstract base for custom QWidget plugins. +<a href="#details">More...</a> +<p><tt>#include <<a href="qwidgetplugin-h.html">qwidgetplugin.h</a>></tt> +<p><a href="qwidgetplugin-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QWidgetPlugin"><b>QWidgetPlugin</b></a> ()</li> +<li class=fn><a href="#~QWidgetPlugin"><b>~QWidgetPlugin</b></a> ()</li> +<li class=fn>virtual QStringList <a href="#keys"><b>keys</b></a> () const = 0</li> +<li class=fn>virtual QWidget * <a href="#create"><b>create</b></a> ( const QString & key, QWidget * parent = 0, const char * name = 0 ) = 0</li> +<li class=fn>virtual QString <a href="#group"><b>group</b></a> ( const QString & key ) const</li> +<li class=fn>virtual QIconSet <a href="#iconSet"><b>iconSet</b></a> ( const QString & key ) const</li> +<li class=fn>virtual QString <a href="#includeFile"><b>includeFile</b></a> ( const QString & key ) const</li> +<li class=fn>virtual QString <a href="#toolTip"><b>toolTip</b></a> ( const QString & key ) const</li> +<li class=fn>virtual QString <a href="#whatsThis"><b>whatsThis</b></a> ( const QString & key ) const</li> +<li class=fn>virtual bool <a href="#isContainer"><b>isContainer</b></a> ( const QString & key ) const</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QWidgetPlugin class provides an abstract base for custom <a href="qwidget.html">QWidget</a> plugins. +<p> +<p> The widget plugin is a simple plugin interface that makes it easy +to create custom widgets that can be included in forms using <a href="designer-manual.html">Qt Designer</a> and used by applications. +<p> Writing a widget plugin is achieved by subclassing this base +class, reimplementing the pure virtual functions <a href="#keys">keys</a>(), <a href="#create">create</a>(), +<a href="#group">group</a>(), <a href="#iconSet">iconSet</a>(), <a href="#includeFile">includeFile</a>(), <a href="#toolTip">toolTip</a>(), <a href="#whatsThis">whatsThis</a>() and +<a href="#isContainer">isContainer</a>(), and exporting the class with the <tt>Q_EXPORT_PLUGIN</tt> +macro. +<p> See the <a href="designer-manual.html">Qt Designer manual's</a>, +'Creating Custom Widgets' section in the 'Creating Custom Widgets' +chapter, for a complete example of a QWidgetPlugin. +<p> See also the <a href="plugins-howto.html">Plugins + documentation</a> and the <a href="qwidgetfactory.html">QWidgetFactory</a> class that is +supplied with <a href="designer-manual.html">Qt Designer</a>. +<p>See also <a href="plugins.html">Plugins</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QWidgetPlugin"></a>QWidgetPlugin::QWidgetPlugin () +</h3> +Constructs a widget plugin. This is invoked automatically by the +<tt>Q_EXPORT_PLUGIN</tt> macro. + +<h3 class=fn><a name="~QWidgetPlugin"></a>QWidgetPlugin::~QWidgetPlugin () +</h3> +Destroys the widget plugin. +<p> You never have to call this explicitly. Qt destroys a plugin +automatically when it is no longer used. + +<h3 class=fn><a href="qwidget.html">QWidget</a> * <a name="create"></a>QWidgetPlugin::create ( const <a href="qstring.html">QString</a> & key, <a href="qwidget.html">QWidget</a> * parent = 0, const char * name = 0 )<tt> [pure virtual]</tt> +</h3> + +<p> Creates and returns a <a href="qwidget.html">QWidget</a> object for the widget key <em>key</em>. +The widget key is the class name of the required widget. The <em>name</em> and <em>parent</em> arguments are passed to the custom widget's +constructor. +<p> <p>See also <a href="#keys">keys</a>(). + +<h3 class=fn><a href="qstring.html">QString</a> <a name="group"></a>QWidgetPlugin::group ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns the group (toolbar name) that the custom widget of class +<em>key</em> should be part of when <em>Qt Designer</em> loads it. +<p> The default implementation returns <a href="qstring.html#QString-null">QString::null</a>. + +<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="iconSet"></a>QWidgetPlugin::iconSet ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns the iconset that <em>Qt Designer</em> should use to represent +the custom widget of class <em>key</em> in the toolbar. +<p> The default implementation returns an null iconset. + +<h3 class=fn><a href="qstring.html">QString</a> <a name="includeFile"></a>QWidgetPlugin::includeFile ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns the name of the include file that <em>Qt Designer</em> and <tt>uic</tt> should use to include the custom widget of class <em>key</em> in +generated code. +<p> The default implementation returns <a href="qstring.html#QString-null">QString::null</a>. + +<h3 class=fn>bool <a name="isContainer"></a>QWidgetPlugin::isContainer ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns TRUE if the custom widget of class <em>key</em> can contain +other widgets, e.g. like <a href="qframe.html">QFrame</a>; otherwise returns FALSE. +<p> The default implementation returns FALSE. + +<h3 class=fn><a href="qstringlist.html">QStringList</a> <a name="keys"></a>QWidgetPlugin::keys () const<tt> [pure virtual]</tt> +</h3> + +<p> Returns the list of widget keys this plugin supports. +<p> These keys must be the class names of the custom widgets that are +implemented in the plugin. +<p> <p>See also <a href="#create">create</a>(). + +<h3 class=fn><a href="qstring.html">QString</a> <a name="toolTip"></a>QWidgetPlugin::toolTip ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns the text of the tooltip that <em>Qt Designer</em> should use +for the custom widget of class <em>key</em>'s toolbar button. +<p> The default implementation returns <a href="qstring.html#QString-null">QString::null</a>. + +<h3 class=fn><a href="qstring.html">QString</a> <a name="whatsThis"></a>QWidgetPlugin::whatsThis ( const <a href="qstring.html">QString</a> & key ) const<tt> [virtual]</tt> +</h3> +Returns the text of the whatsThis text that <em>Qt Designer</em> should +use when the user requests whatsThis help for the custom widget of +class <em>key</em>. +<p> The default implementation returns <a href="qstring.html#QString-null">QString::null</a>. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |