summaryrefslogtreecommitdiffstats
path: root/doc/html/qcombotableitem.html
blob: c71ea8d1a4f457fce0936ff8d52a50f5aada12f3 (plain)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!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/table/qtable.cpp:1154 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QComboTableItem 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&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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>QComboTableItem Class Reference<br><small>[<a href="table.html">table module</a>]</small></h1>

<p>The QComboTableItem class provides a means of using
comboboxes in QTables.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qtable-h.html">qtable.h</a>&gt;</tt>
<p>Inherits <a href="qtableitem.html">QTableItem</a>.
<p><a href="qcombotableitem-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QComboTableItem"><b>QComboTableItem</b></a> ( QTable&nbsp;*&nbsp;table, const&nbsp;QStringList&nbsp;&amp;&nbsp;list, bool&nbsp;editable = FALSE )</li>
<li class=fn><a href="#~QComboTableItem"><b>~QComboTableItem</b></a> ()</li>
<li class=fn>virtual void <a href="#setCurrentItem"><b>setCurrentItem</b></a> ( int&nbsp;i )</li>
<li class=fn>virtual void <a href="#setCurrentItem-2"><b>setCurrentItem</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;s )</li>
<li class=fn>int <a href="#currentItem"><b>currentItem</b></a> () const</li>
<li class=fn>QString <a href="#currentText"><b>currentText</b></a> () const</li>
<li class=fn>int <a href="#count"><b>count</b></a> () const</li>
<li class=fn>QString <a href="#text"><b>text</b></a> ( int&nbsp;i ) const</li>
<li class=fn>virtual void <a href="#setEditable"><b>setEditable</b></a> ( bool&nbsp;b )</li>
<li class=fn>bool <a href="#isEditable"><b>isEditable</b></a> () const</li>
<li class=fn>virtual void <a href="#setStringList"><b>setStringList</b></a> ( const&nbsp;QStringList&nbsp;&amp;&nbsp;l )</li>
<li class=fn>virtual int <a href="#rtti"><b>rtti</b></a> () const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QComboTableItem class provides a means of using
comboboxes in QTables.

<p> 

<p> A QComboTableItem is a table item which looks and behaves like a
combobox. The advantage of using QComboTableItems rather than real
comboboxes is that a QComboTableItem uses far less resources than
real comboboxes in <a href="qtable.html">QTable</a>s. When the cell has the focus it
displays a real combobox which the user can interact with. When
the cell does not have the focus the cell <em>looks</em> like a
combobox. Only text items (i.e. no pixmaps) may be used in
QComboTableItems.
<p> QComboTableItem items have the edit type <a href="qtableitem.html#EditType-enum">WhenCurrent</a> (see
<a href="qtableitem.html#EditType-enum">EditType</a>). The QComboTableItem's list of items is provided by
a <a href="qstringlist.html">QStringList</a> passed to the constructor.
<p> The list of items may be changed using <a href="#setStringList">setStringList</a>(). The
current item can be set with <a href="#setCurrentItem">setCurrentItem</a>() and retrieved with
<a href="#currentItem">currentItem</a>(). The text of the current item can be obtained with
<a href="#currentText">currentText</a>(), and the text of a particular item can be retrieved
with <a href="#text">text</a>().
<p> If <a href="#isEditable">isEditable</a>() is TRUE the QComboTableItem will permit the user
to either choose an existing list item, or create a new list item
by entering their own text; otherwise the user may only choose one
of the existing list items.
<p> To populate a table cell with a QComboTableItem use
<a href="qtable.html#setItem">QTable::setItem</a>().
<p> QComboTableItems may be deleted with <a href="qtable.html#clearCell">QTable::clearCell</a>().
<p> QComboTableItems can be distinguished from <a href="qtableitem.html">QTableItem</a>s and
<a href="qchecktableitem.html">QCheckTableItem</a>s using their Run Time Type Identification
number (see <a href="#rtti">rtti</a>()).
<p> <center><img src="qtableitems.png" alt="Table Items"></center> 
<p> <p>See also <a href="qchecktableitem.html">QCheckTableItem</a>, <a href="qtableitem.html">QTableItem</a>, <a href="qcombobox.html">QComboBox</a>, and <a href="advanced.html">Advanced Widgets</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QComboTableItem"></a>QComboTableItem::QComboTableItem ( <a href="qtable.html">QTable</a>&nbsp;*&nbsp;table, const&nbsp;<a href="qstringlist.html">QStringList</a>&nbsp;&amp;&nbsp;list, bool&nbsp;editable = FALSE )
</h3>
Creates a combo table item for the table <em>table</em>. The combobox's
list of items is passed in the <em>list</em> argument. If <em>editable</em> is
TRUE the user may type in new list items; if <em>editable</em> is FALSE
the user may only select from the list of items provided.
<p> By default QComboTableItems cannot be replaced by other table
items since <a href="qtableitem.html#isReplaceable">isReplaceable</a>() returns FALSE by default.
<p> <p>See also <a href="qtable.html#clearCell">QTable::clearCell</a>() and <a href="qtableitem.html#EditType-enum">EditType</a>.

<h3 class=fn><a name="~QComboTableItem"></a>QComboTableItem::~QComboTableItem ()
</h3>
QComboTableItem destructor.

<h3 class=fn>int <a name="count"></a>QComboTableItem::count () const
</h3>
Returns the total number of list items in the combo table item.

<h3 class=fn>int <a name="currentItem"></a>QComboTableItem::currentItem () const
</h3>
Returns the index of the combo table item's current list item.
<p> <p>See also <a href="#setCurrentItem">setCurrentItem</a>().

<h3 class=fn><a href="qstring.html">QString</a> <a name="currentText"></a>QComboTableItem::currentText () const
</h3>
Returns the text of the combo table item's current list item.
<p> <p>See also <a href="#currentItem">currentItem</a>() and <a href="#text">text</a>().

<h3 class=fn>bool <a name="isEditable"></a>QComboTableItem::isEditable () const
</h3>
Returns TRUE if the user can add their own list items to the
combobox's list of items; otherwise returns FALSE.
<p> <p>See also <a href="#setEditable">setEditable</a>().

<h3 class=fn>int <a name="rtti"></a>QComboTableItem::rtti () const<tt> [virtual]</tt>
</h3>

<p> Returns 1.
<p> Make your derived classes return their own values for <a href="#rtti">rtti</a>()to
distinguish between different table item subclasses. You should
use values greater than 1000, preferably a large random number, to
allow for extensions to this class.
<p> <p>See also <a href="qtableitem.html#rtti">QTableItem::rtti</a>().

<p>Reimplemented from <a href="qtableitem.html#rtti">QTableItem</a>.
<h3 class=fn>void <a name="setCurrentItem"></a>QComboTableItem::setCurrentItem ( int&nbsp;i )<tt> [virtual]</tt>
</h3>
Sets the list item <em>i</em> to be the combo table item's current list
item.
<p> <p>See also <a href="#currentItem">currentItem</a>().

<p>Example: <a href="small-table-example-example.html#x2797">table/small-table-demo/main.cpp</a>.
<h3 class=fn>void <a name="setCurrentItem-2"></a>QComboTableItem::setCurrentItem ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;s )<tt> [virtual]</tt>
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the list item whose text is <em>s</em> to be the combo table item's
current list item. Does nothing if no list item has the text <em>s</em>.
<p> <p>See also <a href="#currentItem">currentItem</a>().

<h3 class=fn>void <a name="setEditable"></a>QComboTableItem::setEditable ( bool&nbsp;b )<tt> [virtual]</tt>
</h3>
If <em>b</em> is TRUE the combo table item can be edited, i.e. the user
may enter a new text item themselves. If <em>b</em> is FALSE the user may
may only choose one of the existing items.
<p> <p>See also <a href="#isEditable">isEditable</a>().

<h3 class=fn>void <a name="setStringList"></a>QComboTableItem::setStringList ( const&nbsp;<a href="qstringlist.html">QStringList</a>&nbsp;&amp;&nbsp;l )<tt> [virtual]</tt>
</h3>
Sets the list items of this QComboTableItem to the strings in the
string list <em>l</em>.

<h3 class=fn><a href="qstring.html">QString</a> <a name="text"></a>QComboTableItem::text ( int&nbsp;i ) const
</h3>
Returns the text of the combo's list item at index <em>i</em>.
<p> <p>See also <a href="#currentText">currentText</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 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 &copy; 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>