summaryrefslogtreecommitdiffstats
path: root/doc/html/qlayoutitem.html
blob: 439ef9af24687c42e34ccf06be647b65d7b16c50 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<!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/kernel/qabstractlayout.cpp:56 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QLayoutItem 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>QLayoutItem Class Reference</h1>

<p>The QLayoutItem class provides an abstract item that a
QLayout manipulates.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qlayout-h.html">qlayout.h</a>&gt;</tt>
<p>Inherited by <a href="qlayout.html">QLayout</a>, <a href="qspaceritem.html">QSpacerItem</a>, and <a href="qwidgetitem.html">QWidgetItem</a>.
<p><a href="qlayoutitem-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QLayoutItem"><b>QLayoutItem</b></a> ( int&nbsp;alignment = 0 )</li>
<li class=fn>virtual <a href="#~QLayoutItem"><b>~QLayoutItem</b></a> ()</li>
<li class=fn>virtual QSize <a href="#sizeHint"><b>sizeHint</b></a> () const = 0</li>
<li class=fn>virtual QSize <a href="#minimumSize"><b>minimumSize</b></a> () const = 0</li>
<li class=fn>virtual QSize <a href="#maximumSize"><b>maximumSize</b></a> () const = 0</li>
<li class=fn>virtual QSizePolicy::ExpandData <a href="#expanding"><b>expanding</b></a> () const = 0</li>
<li class=fn>virtual void <a href="#setGeometry"><b>setGeometry</b></a> ( const&nbsp;QRect&nbsp;&amp;&nbsp;r ) = 0</li>
<li class=fn>virtual QRect <a href="#geometry"><b>geometry</b></a> () const = 0</li>
<li class=fn>virtual bool <a href="#isEmpty"><b>isEmpty</b></a> () const = 0</li>
<li class=fn>virtual bool <a href="#hasHeightForWidth"><b>hasHeightForWidth</b></a> () const</li>
<li class=fn>virtual int <a href="#heightForWidth"><b>heightForWidth</b></a> ( int&nbsp;w ) const</li>
<li class=fn>virtual void <a href="#invalidate"><b>invalidate</b></a> ()</li>
<li class=fn>virtual QWidget * <a href="#widget"><b>widget</b></a> ()</li>
<li class=fn>virtual QLayoutIterator <a href="#iterator"><b>iterator</b></a> ()</li>
<li class=fn>virtual QLayout * <a href="#layout"><b>layout</b></a> ()</li>
<li class=fn>virtual QSpacerItem * <a href="#spacerItem"><b>spacerItem</b></a> ()</li>
<li class=fn>int <a href="#alignment"><b>alignment</b></a> () const</li>
<li class=fn>virtual void <a href="#setAlignment"><b>setAlignment</b></a> ( int&nbsp;a )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>




The QLayoutItem class provides an abstract item that a
<a href="qlayout.html">QLayout</a> manipulates.
<p> This is used by custom layouts.
<p> Pure virtual functions are provided to return information about
the layout, including, <a href="#sizeHint">sizeHint</a>(), <a href="#minimumSize">minimumSize</a>(), <a href="#maximumSize">maximumSize</a>()
and <a href="#expanding">expanding</a>().
<p> The layout's geometry can be set and retrieved with <a href="#setGeometry">setGeometry</a>()
and <a href="#geometry">geometry</a>(), and its alignment with <a href="#setAlignment">setAlignment</a>() and
<a href="#alignment">alignment</a>().
<p> <a href="#isEmpty">isEmpty</a>() returns whether the layout is empty. <a href="#iterator">iterator</a>() returns
an iterator for the layout's children. If the concrete item is a
<a href="qwidget.html">QWidget</a>, it can be retrieved using <a href="#widget">widget</a>(). Similarly for
<a href="#layout">layout</a>() and <a href="#spacerItem">spacerItem</a>().
<p> <p>See also <a href="qlayout.html">QLayout</a>, <a href="appearance.html">Widget Appearance and Style</a>, and <a href="geomanagement.html">Layout Management</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QLayoutItem"></a>QLayoutItem::QLayoutItem ( int&nbsp;alignment = 0 )
</h3>

<p> Constructs a layout item with an <em>alignment</em> that is a bitwise OR
of the <a href="qt.html#AlignmentFlags-enum">Qt::AlignmentFlags</a>. Not all subclasses support
alignment.

<h3 class=fn><a name="~QLayoutItem"></a>QLayoutItem::~QLayoutItem ()<tt> [virtual]</tt>
</h3>
Destroys the QLayoutItem.

<h3 class=fn>int <a name="alignment"></a>QLayoutItem::alignment () const
</h3>

<p> Returns the alignment of this item.

<h3 class=fn><a href="qsizepolicy.html#ExpandData-enum">QSizePolicy::ExpandData</a> <a name="expanding"></a>QLayoutItem::expanding () const<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to return the direction(s) this item
"wants" to expand in (if any).

<p>Reimplemented in <a href="qlayout.html#expanding">QLayout</a>, <a href="qspaceritem.html#expanding">QSpacerItem</a>, and <a href="qwidgetitem.html#expanding">QWidgetItem</a>.
<h3 class=fn><a href="qrect.html">QRect</a> <a name="geometry"></a>QLayoutItem::geometry () const<tt> [pure virtual]</tt>
</h3>

<p> Returns the rectangle covered by this layout item.

<p>Example: <a href="customlayout-example.html#x1495">customlayout/border.cpp</a>.
<h3 class=fn>bool <a name="hasHeightForWidth"></a>QLayoutItem::hasHeightForWidth () const<tt> [virtual]</tt>
</h3>
Returns TRUE if this layout's preferred height depends on its
width; otherwise returns FALSE. The default implementation returns
FALSE.
<p> Reimplement this function in layout managers that support height
for width.
<p> <p>See also <a href="#heightForWidth">heightForWidth</a>() and <a href="qwidget.html#heightForWidth">QWidget::heightForWidth</a>().

<p>Examples: <a href="customlayout-example.html#x1496">customlayout/border.cpp</a> and <a href="customlayout-example.html#x1472">customlayout/flow.cpp</a>.
<p>Reimplemented in <a href="qgridlayout.html#hasHeightForWidth">QGridLayout</a> and <a href="qboxlayout.html#hasHeightForWidth">QBoxLayout</a>.
<h3 class=fn>int <a name="heightForWidth"></a>QLayoutItem::heightForWidth ( int&nbsp;w ) const<tt> [virtual]</tt>
</h3>
Returns the preferred height for this layout item, given the width
<em>w</em>.
<p> The default implementation returns -1, indicating that the
preferred height is independent of the width of the item. Using
the function <a href="#hasHeightForWidth">hasHeightForWidth</a>() will typically be much faster
than calling this function and testing for -1.
<p> Reimplement this function in layout managers that support height
for width. A typical implementation will look like this:
<pre>
        int MyLayout::heightForWidth( int w ) const
        {
            if ( cache_dirty || cached_width != w ) {
                // not all C++ compilers support "mutable"
                MyLayout *that = (MyLayout*)this;
                int h = calculateHeightForWidth( w );
                that-&gt;cached_hfw = h;
                return h;
            }
            return cached_hfw;
        }
    </pre>
 
<p> Caching is strongly recommended; without it layout will take
exponential time.
<p> <p>See also <a href="#hasHeightForWidth">hasHeightForWidth</a>().

<p>Example: <a href="customlayout-example.html#x1473">customlayout/flow.cpp</a>.
<p>Reimplemented in <a href="qgridlayout.html#heightForWidth">QGridLayout</a> and <a href="qboxlayout.html#heightForWidth">QBoxLayout</a>.
<h3 class=fn>void <a name="invalidate"></a>QLayoutItem::invalidate ()<tt> [virtual]</tt>
</h3>
Invalidates any cached information in this layout item.

<p>Reimplemented in <a href="qlayout.html#invalidate">QLayout</a>.
<h3 class=fn>bool <a name="isEmpty"></a>QLayoutItem::isEmpty () const<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to return whether this item is empty,
i.e. whether it contains any widgets.

<p>Reimplemented in <a href="qlayout.html#isEmpty">QLayout</a>, <a href="qspaceritem.html#isEmpty">QSpacerItem</a>, and <a href="qwidgetitem.html#isEmpty">QWidgetItem</a>.
<h3 class=fn><a href="qlayoutiterator.html">QLayoutIterator</a> <a name="iterator"></a>QLayoutItem::iterator ()<tt> [virtual]</tt>
</h3>
Returns an iterator over this item's QLayoutItem children. The
default implementation returns an empty iterator.
<p> Reimplement this function in subclasses that can have children.

<p>Reimplemented in <a href="qlayout.html#iterator">QLayout</a>.
<h3 class=fn><a href="qlayout.html">QLayout</a>&nbsp;* <a name="layout"></a>QLayoutItem::layout ()<tt> [virtual]</tt>
</h3>
If this item is a <a href="qlayout.html">QLayout</a>, it is returned as a QLayout; otherwise
0 is returned. This function provides type-safe casting.

<h3 class=fn><a href="qsize.html">QSize</a> <a name="maximumSize"></a>QLayoutItem::maximumSize () const<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to return the maximum size of this item.

<p>Reimplemented in <a href="qlayout.html#maximumSize">QLayout</a>, <a href="qspaceritem.html#maximumSize">QSpacerItem</a>, and <a href="qwidgetitem.html#maximumSize">QWidgetItem</a>.
<h3 class=fn><a href="qsize.html">QSize</a> <a name="minimumSize"></a>QLayoutItem::minimumSize () const<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to return the minimum size of this item.

<p>Examples: <a href="customlayout-example.html#x1497">customlayout/border.cpp</a>, <a href="customlayout-example.html#x1515">customlayout/card.cpp</a>, and <a href="customlayout-example.html#x1474">customlayout/flow.cpp</a>.
<p>Reimplemented in <a href="qlayout.html#minimumSize">QLayout</a>, <a href="qspaceritem.html#minimumSize">QSpacerItem</a>, and <a href="qwidgetitem.html#minimumSize">QWidgetItem</a>.
<h3 class=fn>void <a name="setAlignment"></a>QLayoutItem::setAlignment ( int&nbsp;a )<tt> [virtual]</tt>
</h3>
Sets the alignment of this item to <em>a</em>, which is a bitwise OR of
the <a href="qt.html#AlignmentFlags-enum">Qt::AlignmentFlags</a>. Not all subclasses support alignment.

<p>Example: <a href="tutorial2-09.html#x2644">chart/optionsform.cpp</a>.
<h3 class=fn>void <a name="setGeometry"></a>QLayoutItem::setGeometry ( const&nbsp;<a href="qrect.html">QRect</a>&nbsp;&amp;&nbsp;r )<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to set this item's geometry to <em>r</em>.

<p>Examples: <a href="customlayout-example.html#x1498">customlayout/border.cpp</a>, <a href="customlayout-example.html#x1516">customlayout/card.cpp</a>, and <a href="customlayout-example.html#x1475">customlayout/flow.cpp</a>.
<p>Reimplemented in <a href="qlayout.html#setGeometry">QLayout</a>, <a href="qspaceritem.html#setGeometry">QSpacerItem</a>, and <a href="qwidgetitem.html#setGeometry">QWidgetItem</a>.
<h3 class=fn><a href="qsize.html">QSize</a> <a name="sizeHint"></a>QLayoutItem::sizeHint () const<tt> [pure virtual]</tt>
</h3>

<p> Implemented in subclasses to return the preferred size of this item.

<p>Examples: <a href="customlayout-example.html#x1499">customlayout/border.cpp</a>, <a href="customlayout-example.html#x1517">customlayout/card.cpp</a>, and <a href="customlayout-example.html#x1476">customlayout/flow.cpp</a>.
<p>Reimplemented in <a href="qspaceritem.html#sizeHint">QSpacerItem</a>, <a href="qwidgetitem.html#sizeHint">QWidgetItem</a>, <a href="qgridlayout.html#sizeHint">QGridLayout</a>, and <a href="qboxlayout.html#sizeHint">QBoxLayout</a>.
<h3 class=fn><a href="qspaceritem.html">QSpacerItem</a>&nbsp;* <a name="spacerItem"></a>QLayoutItem::spacerItem ()<tt> [virtual]</tt>
</h3>
If this item is a <a href="qspaceritem.html">QSpacerItem</a>, it is returned as a QSpacerItem;
otherwise 0 is returned. This function provides type-safe casting.

<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="widget"></a>QLayoutItem::widget ()<tt> [virtual]</tt>
</h3>
If this item is a <a href="qwidget.html">QWidget</a>, it is returned as a QWidget; otherwise
0 is returned. This function provides type-safe casting.

<p>Reimplemented in <a href="qwidgetitem.html#widget">QWidgetItem</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>