1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qitemeditorfactory.cpp -->
<title>Qt 4.8: QItemEditorCreatorBase Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QItemEditorCreatorBase</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QItemEditorCreatorBase Class Reference</h1>
<!-- $$$QItemEditorCreatorBase-brief -->
<p>The QItemEditorCreatorBase class provides an abstract base class that must be subclassed when implementing new item editor creators. <a href="#details">More...</a></p>
<!-- @@@QItemEditorCreatorBase -->
<pre class="cpp"> <span class="preprocessor">#include <QItemEditorCreatorBase></span></pre><p><b>Inherited by: </b><a href="qitemeditorcreator.html">QItemEditorCreator</a> and <a href="qstandarditemeditorcreator.html">QStandardItemEditorCreator</a>.</p>
<p>This class was introduced in Qt 4.2.</p>
<ul>
<li><a href="qitemeditorcreatorbase-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qitemeditorcreatorbase.html#dtor.QItemEditorCreatorBase">~QItemEditorCreatorBase</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QWidget * </td><td class="memItemRight bottomAlign"><b><a href="qitemeditorcreatorbase.html#createWidget">createWidget</a></b> ( QWidget * <i>parent</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qitemeditorcreatorbase.html#valuePropertyName">valuePropertyName</a></b> () const = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$QItemEditorCreatorBase-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QItemEditorCreatorBase class provides an abstract base class that must be subclassed when implementing new item editor creators.</p>
<p>QItemEditorCreatorBase objects are specialized widget factories that provide editor widgets for one particular <a href="qvariant.html">QVariant</a> data type. They are used by <a href="qitemeditorfactory.html">QItemEditorFactory</a> to create editors for <a href="qitemdelegate.html">QItemDelegate</a>s. Creator bases must be registered with <a href="qitemeditorfactory.html#registerEditor">QItemEditorFactory::registerEditor</a>().</p>
<p>An editor should provide a user property for the data it edits. QItemDelagates can then access the property using Qt's <a href="metaobjects.html#meta-object-system">meta-object system</a> to set and retrieve the editing data. A property is set as the user property with the USER keyword:</p>
<pre class="cpp"> <a href="qobject.html#Q_PROPERTY">Q_PROPERTY</a>(<span class="type"><a href="qcolor.html">QColor</a></span> color READ color WRITE setColor USER <span class="keyword">true</span>)</pre>
<p>If the editor does not provide a user property, it must return the name of the property from <a href="qitemeditorcreatorbase.html#valuePropertyName">valuePropertyName</a>(); delegates will then use the name to access the property. If a user property exists, item delegates will not call <a href="qitemeditorcreatorbase.html#valuePropertyName">valuePropertyName</a>().</p>
<p><a href="qstandarditemeditorcreator.html">QStandardItemEditorCreator</a> is a convenience template class that can be used to register widgets without the need to subclass QItemEditorCreatorBase.</p>
</div>
<p><b>See also </b><a href="qstandarditemeditorcreator.html">QStandardItemEditorCreator</a>, <a href="qitemeditorfactory.html">QItemEditorFactory</a>, <a href="model-view-programming.html">Model/View Programming</a>, and <a href="itemviews-coloreditorfactory.html">Color Editor Factory Example</a>.</p>
<!-- @@@QItemEditorCreatorBase -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QItemEditorCreatorBase[overload1]$$$~QItemEditorCreatorBase -->
<h3 class="fn"><a name="dtor.QItemEditorCreatorBase"></a>QItemEditorCreatorBase::<span class="name">~QItemEditorCreatorBase</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the editor creator object.</p>
<!-- @@@~QItemEditorCreatorBase -->
<!-- $$$createWidget[overload1]$$$createWidgetQWidget* -->
<h3 class="fn"><a name="createWidget"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * QItemEditorCreatorBase::<span class="name">createWidget</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns an editor widget with the given <i>parent</i>.</p>
<p>When implementing this function in subclasses of this class, you must construct and return new editor widgets with the parent widget specified.</p>
<!-- @@@createWidget -->
<!-- $$$valuePropertyName[overload1]$$$valuePropertyName -->
<h3 class="fn"><a name="valuePropertyName"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> QItemEditorCreatorBase::<span class="name">valuePropertyName</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the name of the property used to get and set values in the creator's editor widgets.</p>
<p>When implementing this function in subclasses, you must ensure that the editor widget's property specified by this function can accept the type the creator is registered for. For example, a creator which constructs <a href="qcheckbox.html">QCheckBox</a> widgets to edit boolean values would return the <a href="qabstractbutton.html#checkable-prop">checkable</a> property name from this function, and must be registered in the item editor factory for the <a href="qvariant.html#Type-enum">QVariant::Bool</a> type.</p>
<p>Note: Since Qt 4.2 the item delegates query the user property of widgets, and only call this function if the widget has no user property. You can override this behavior by reimplementing <a href="qabstractitemdelegate.html#setModelData">QAbstractItemDelegate::setModelData</a>() and <a href="qabstractitemdelegate.html#setEditorData">QAbstractItemDelegate::setEditorData</a>().</p>
<p><b>See also </b><a href="qmetaobject.html#userProperty">QMetaObject::userProperty</a>() and <a href="qitemeditorfactory.html#registerEditor">QItemEditorFactory::registerEditor</a>().</p>
<!-- @@@valuePropertyName -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
