← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qdesignercustomwidgetinterface.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qdesignercustomwidgetinterface.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/doc/src/qtdesigner.qdoc -->
 
6
<head>
 
7
    <title>Qt 4.0: QDesignerCustomWidgetInterface Class Reference</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QDesignerCustomWidgetInterface Class Reference</h1>
 
21
<p>The QDesignerCustomWidgetInterface provides an interface to a custom widget in <i>Qt Designer</i>. <a href="#details">More...</a></p>
 
22
<pre>#include &lt;QDesignerCustomWidgetInterface&gt;</pre><p>Part of the <a href="qtdesigner.html">QtDesigner</a> module.</p>
 
23
<ul>
 
24
<li><a href="qdesignercustomwidgetinterface-members.html">List of all members, including inherited members</a></li>
 
25
</ul>
 
26
<a name="public-functions"></a>
 
27
<h3>Public Functions</h3>
 
28
<ul>
 
29
<li><div class="fn"/>virtual <b><a href="qdesignercustomwidgetinterface.html#dtor.QDesignerCustomWidgetInterface">~QDesignerCustomWidgetInterface</a></b> ()</li>
 
30
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#codeTemplate">codeTemplate</a></b> () const</li>
 
31
<li><div class="fn"/>virtual QWidget * <b><a href="qdesignercustomwidgetinterface.html#createWidget">createWidget</a></b> ( QWidget * <i>parent</i> ) = 0</li>
 
32
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#domXml">domXml</a></b> () const</li>
 
33
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#group">group</a></b> () const = 0</li>
 
34
<li><div class="fn"/>virtual QIcon <b><a href="qdesignercustomwidgetinterface.html#icon">icon</a></b> () const = 0</li>
 
35
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#includeFile">includeFile</a></b> () const = 0</li>
 
36
<li><div class="fn"/>virtual void <b><a href="qdesignercustomwidgetinterface.html#initialize">initialize</a></b> ( QDesignerFormEditorInterface * <i>core</i> )</li>
 
37
<li><div class="fn"/>virtual bool <b><a href="qdesignercustomwidgetinterface.html#isContainer">isContainer</a></b> () const = 0</li>
 
38
<li><div class="fn"/>virtual bool <b><a href="qdesignercustomwidgetinterface.html#isInitialized">isInitialized</a></b> () const</li>
 
39
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#name">name</a></b> () const = 0</li>
 
40
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#toolTip">toolTip</a></b> () const = 0</li>
 
41
<li><div class="fn"/>virtual QString <b><a href="qdesignercustomwidgetinterface.html#whatsThis">whatsThis</a></b> () const = 0</li>
 
42
</ul>
 
43
<a name="details"></a>
 
44
<hr />
 
45
<h2>Detailed Description</h2>
 
46
<p>The QDesignerCustomWidgetInterface provides an interface to a custom widget in <i>Qt Designer</i>.</p>
 
47
<p>See also Custom Widgets for Qt Designer.</p>
 
48
<hr />
 
49
<h2>Member Function Documentation</h2>
 
50
<h3 class="fn"><a name="dtor.QDesignerCustomWidgetInterface"></a>QDesignerCustomWidgetInterface::~QDesignerCustomWidgetInterface ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
51
<p>Destroys the custom widget interface.</p>
 
52
<h3 class="fn"><a name="codeTemplate"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::codeTemplate () const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
53
<p>Returns the code template that <i>Qt Designer</i> includes in forms that contain the custom widget when they are saved.</p>
 
54
<p>uic uses the code template to provide code for constructing the custom widget.</p>
 
55
<h3 class="fn"><a name="createWidget"></a><a href="qwidget.html">QWidget</a> * QDesignerCustomWidgetInterface::createWidget ( <a href="qwidget.html">QWidget</a> * <i>parent</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
56
<p>Returns a new widget with the given <i>parent</i>.</p>
 
57
<h3 class="fn"><a name="domXml"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::domXml () const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
58
<p>Returns the XML that is used to describe widget properties to <i>Qt Designer</i>.</p>
 
59
<h3 class="fn"><a name="group"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::group () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
60
<p>Returns the name of the group to which the custom widget belongs.</p>
 
61
<h3 class="fn"><a name="icon"></a><a href="qicon.html">QIcon</a> QDesignerCustomWidgetInterface::icon () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
62
<p>Returns the icon used to represent the custom widget in <i>Qt Designer</i>'s widget box.</p>
 
63
<h3 class="fn"><a name="includeFile"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::includeFile () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
64
<p>Returns the path to the include file that uic uses when creating code for the custom widget.</p>
 
65
<h3 class="fn"><a name="initialize"></a>void QDesignerCustomWidgetInterface::initialize ( <a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a> * <i>core</i> )&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
66
<p>Initializes the widget for use with the form editor with the specified <i>core</i> interface.</p>
 
67
<p>See also <a href="qdesignercustomwidgetinterface.html#isInitialized">isInitialized</a>().</p>
 
68
<h3 class="fn"><a name="isContainer"></a>bool QDesignerCustomWidgetInterface::isContainer () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
69
<p>Returns true if the custom widget is intended to be used as a container; otherwise returns false.</p>
 
70
<p>Most custom widgets are not used to hold other widgets, so their implementations of this function will return false, but custom containers will return true to ensure that they behave correctly in <i>Qt Designer</i>.</p>
 
71
<h3 class="fn"><a name="isInitialized"></a>bool QDesignerCustomWidgetInterface::isInitialized () const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
72
<h3 class="fn"><a name="name"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::name () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
73
<p>Returns the name of the class that implements the custom widget.</p>
 
74
<h3 class="fn"><a name="toolTip"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::toolTip () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
75
<p>Returns a short description of the widget that can be used by <i>Qt Designer</i> in a tool tip.</p>
 
76
<h3 class="fn"><a name="whatsThis"></a><a href="qstring.html">QString</a> QDesignerCustomWidgetInterface::whatsThis () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
77
<p>Returns a description of the widget that can be used by <i>Qt Designer</i> in &quot;What's This?&quot; help for the widget.</p>
 
78
<p /><address><hr /><div align="center">
 
79
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
80
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
81
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
82
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
83
</tr></table></div></address></body>
 
84
</html>