<!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/tqwidgetplugin.cpp:48 -->
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > TQWidgetPlugin 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 > TQWidgetPlugin Class Reference< / h1 >
< p > The TQWidgetPlugin class provides an abstract base for custom TQWidget plugins.
< a href = "#details" > More...< / a >
< p > < tt > #include < < a href = "tqwidgetplugin-h.html" > tqwidgetplugin.h< / a > > < / tt >
< p > < a href = "tqwidgetplugin-members.html" > List of all member functions.< / a >
< h2 > Public Members< / h2 >
< ul >
< li class = fn > < a href = "#TQWidgetPlugin" > < b > TQWidgetPlugin< / b > < / a > ()< / li >
< li class = fn > < a href = "#~TQWidgetPlugin" > < b > ~TQWidgetPlugin< / b > < / a > ()< / li >
< li class = fn > virtual TQStringList < a href = "#keys" > < b > keys< / b > < / a > () const = 0< / li >
< li class = fn > virtual TQWidget * < a href = "#create" > < b > create< / b > < / a > ( const TQString & key, TQWidget * parent = 0, const char * name = 0 ) = 0< / li >
< li class = fn > virtual TQString < a href = "#group" > < b > group< / b > < / a > ( const TQString & key ) const< / li >
< li class = fn > virtual TQIconSet < a href = "#iconSet" > < b > iconSet< / b > < / a > ( const TQString & key ) const< / li >
< li class = fn > virtual TQString < a href = "#includeFile" > < b > includeFile< / b > < / a > ( const TQString & key ) const< / li >
< li class = fn > virtual TQString < a href = "#toolTip" > < b > toolTip< / b > < / a > ( const TQString & key ) const< / li >
< li class = fn > virtual TQString < a href = "#whatsThis" > < b > whatsThis< / b > < / a > ( const TQString & key ) const< / li >
< li class = fn > virtual bool < a href = "#isContainer" > < b > isContainer< / b > < / a > ( const TQString & key ) const< / li >
< / ul >
< hr > < a name = "details" > < / a > < h2 > Detailed Description< / h2 >
The TQWidgetPlugin class provides an abstract base for custom < a href = "tqwidget.html" > TQWidget< / 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" > TQt 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 > TQ_EXPORT_PLUGIN< / tt >
macro.
< p > See the < a href = "designer-manual.html" > TQt Designer manual's< / a > ,
'Creating Custom Widgets' section in the 'Creating Custom Widgets'
chapter, for a complete example of a TQWidgetPlugin.
< p > See also the < a href = "plugins-howto.html" > Plugins
documentation< / a > and the < a href = "tqwidgetfactory.html" > TQWidgetFactory< / a > class that is
supplied with < a href = "designer-manual.html" > TQt Designer< / a > .
< p > See also < a href = "plugins.html" > Plugins< / a > .
< hr > < h2 > Member Function Documentation< / h2 >
< h3 class = fn > < a name = "TQWidgetPlugin" > < / a > TQWidgetPlugin::TQWidgetPlugin ()
< / h3 >
Constructs a widget plugin. This is invoked automatically by the
< tt > TQ_EXPORT_PLUGIN< / tt > macro.
< h3 class = fn > < a name = "~TQWidgetPlugin" > < / a > TQWidgetPlugin::~TQWidgetPlugin ()
< / h3 >
Destroys the widget plugin.
< p > You never have to call this explicitly. TQt destroys a plugin
automatically when it is no longer used.
< h3 class = fn > < a href = "tqwidget.html" > TQWidget< / a > * < a name = "create" > < / a > TQWidgetPlugin::create ( const < a href = "tqstring.html" > TQString< / a > & key, < a href = "tqwidget.html" > TQWidget< / a > * parent = 0, const char * name = 0 )< tt > [pure virtual]< / tt >
< / h3 >
< p > Creates and returns a < a href = "tqwidget.html" > TQWidget< / 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 = "tqstring.html" > TQString< / a > < a name = "group" > < / a > TQWidgetPlugin::group ( const < a href = "tqstring.html" > TQString< / 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 > TQt Designer< / em > loads it.
< p > The default implementation returns < a href = "tqstring.html#TQString-null" > TQString::null< / a > .
< h3 class = fn > < a href = "tqiconset.html" > TQIconSet< / a > < a name = "iconSet" > < / a > TQWidgetPlugin::iconSet ( const < a href = "tqstring.html" > TQString< / a > & key ) const< tt > [virtual]< / tt >
< / h3 >
Returns the iconset that < em > TQt 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 = "tqstring.html" > TQString< / a > < a name = "includeFile" > < / a > TQWidgetPlugin::includeFile ( const < a href = "tqstring.html" > TQString< / a > & key ) const< tt > [virtual]< / tt >
< / h3 >
Returns the name of the include file that < em > TQt 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 = "tqstring.html#TQString-null" > TQString::null< / a > .
< h3 class = fn > bool < a name = "isContainer" > < / a > TQWidgetPlugin::isContainer ( const < a href = "tqstring.html" > TQString< / 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 = "tqframe.html" > TQFrame< / a > ; otherwise returns FALSE.
< p > The default implementation returns FALSE.
< h3 class = fn > < a href = "tqstringlist.html" > TQStringList< / a > < a name = "keys" > < / a > TQWidgetPlugin::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 = "tqstring.html" > TQString< / a > < a name = "toolTip" > < / a > TQWidgetPlugin::toolTip ( const < a href = "tqstring.html" > TQString< / a > & key ) const< tt > [virtual]< / tt >
< / h3 >
Returns the text of the tooltip that < em > TQt Designer< / em > should use
for the custom widget of class < em > key< / em > 's toolbar button.
< p > The default implementation returns < a href = "tqstring.html#TQString-null" > TQString::null< / a > .
< h3 class = fn > < a href = "tqstring.html" > TQString< / a > < a name = "whatsThis" > < / a > TQWidgetPlugin::whatsThis ( const < a href = "tqstring.html" > TQString< / a > & key ) const< tt > [virtual]< / tt >
< / h3 >
Returns the text of the whatsThis text that < em > TQt 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 = "tqstring.html#TQString-null" > TQString::null< / a > .
<!-- eof -->
< hr > < p >
This file is part of the < a href = "index.html" > TQt 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 > TQt 3.3.8< / div >
< / table > < / div > < / address > < / body >
< / html >
