]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/htcontnr.tex
Minor mods
[wxWidgets.git] / docs / latex / wx / htcontnr.tex
1 %
2 % automatically generated by HelpGen from
3 % htmlcontainercell.tex at 21/Mar/99 22:45:23
4 %
5
6 \section{\class{wxHtmlContainerCell}}\label{wxhtmlcontainercell}
7
8 The wxHtmlContainerCell class is an implementation of a cell that may
9 contain more cells in it. It is heavily used in the wxHTML layout algorithm.
10
11 \wxheading{Derived from}
12
13 \helpref{wxHtmlCell}{wxhtmlcell}
14
15 \wxheading{Include files}
16
17 <wx/html/htmlcell.h>
18
19 \wxheading{See Also}
20
21 \helpref{Cells Overview}{cells}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25 \membersection{wxHtmlContainerCell::wxHtmlContainerCell}\label{wxhtmlcontainercellwxhtmlcontainercell}
26
27 \func{}{wxHtmlContainerCell}{\param{wxHtmlContainerCell }{*parent}}
28
29 Constructor. {\it parent} is pointer to parent container or NULL.
30
31
32 \membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor}
33
34 \constfunc{int}{GetAlignHor}{\void}
35
36 Returns container's horizontal alignment.
37
38 \membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver}
39
40 \constfunc{int}{GetAlignVer}{\void}
41
42 Returns container's vertical alignment.
43
44 \membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell}
45
46 \func{wxHtmlCell*}{GetFirstCell}{\void}
47
48 Returns pointer to the first cell in the list.
49 You can then use wxHtmlCell's GetNext method to obtain pointer to the next
50 cell in list.
51
52 {\bf Note:} This shouldn't be used by the end user. If you need some way of
53 finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method
54 instead.
55
56 \membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent}
57
58 \constfunc{int}{GetIndent}{\param{int }{ind}}
59
60 Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants.
61
62 {\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
63 with same {\it ind} parameter in order to correctly interpret the returned integer value.
64 It is NOT always in pixels!
65
66 \membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits}
67
68 \constfunc{int}{GetIndentUnits}{\param{int }{ind}}
69
70 Returns the units of indentation for {\it ind} where {\it ind} is one
71 of the {\bf wxHTML\_INDENT\_*} constants.
72
73 \membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell}
74
75 \func{void}{InsertCell}{\param{wxHtmlCell }{*cell}}
76
77 Inserts new cell into the container.
78
79 \membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign}
80
81 \func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}}
82
83 Sets the container's alignment (both horizontal and vertical) according to
84 the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
85 it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
86 and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.
87
88 \membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
89
90 \func{void}{SetAlignHor}{\param{int }{al}}
91
92 Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
93 each line is aligned according to {\it al} value.
94
95 \wxheading{Parameters}
96
97 \docparam{al}{new horizontal alignment. May be one of these values:
98
99 \begin{twocollist}\itemsep=0pt
100 \twocolitem{{\bf wxHTML\_ALIGN\_LEFT}}{lines are left-aligned (default)}
101 \twocolitem{{\bf wxHTML\_ALIGN\_JUSTIFY}}{lines are justified}
102 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{lines are centered}
103 \twocolitem{{\bf wxHTML\_ALIGN\_RIGHT}}{lines are right-aligned}
104 \end{twocollist}
105 }
106
107 \membersection{wxHtmlContainerCell::SetAlignVer}\label{wxhtmlcontainercellsetalignver}
108
109 \func{void}{SetAlignVer}{\param{int }{al}}
110
111 Sets the container's {\it vertical alignment}. This is per-line alignment!
112
113 \wxheading{Parameters}
114
115 \docparam{al}{new vertical alignment. May be one of these values:
116
117 \begin{twocollist}\itemsep=0pt
118 \twocolitem{{\bf wxHTML\_ALIGN\_BOTTOM}}{cells are over the line (default)}
119 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{cells are centered on line}
120 \twocolitem{{\bf wxHTML\_ALIGN\_TOP}}{cells are under the line}
121 \end{twocollist}
122
123 \helponly{\image{}{alignv.bmp}}
124 }
125
126 \membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
127
128 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
129
130 Sets the background colour for this container.
131
132 \membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder}
133
134 \func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}}
135
136 Sets the border (frame) colours. A border is a rectangle around the container.
137
138 \wxheading{Parameters}
139
140 \docparam{clr1}{Colour of top and left lines}
141
142 \docparam{clr2}{Colour of bottom and right lines}
143
144 \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
145
146 \func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = wxHTML\_UNITS\_PIXELS}}
147
148 Sets the indentation (free space between borders of container and subcells).
149
150 \wxheading{Parameters}
151
152 \docparam{i}{Indentation value.}
153
154 \docparam{what}{Determines which of the four borders we're setting. It is OR
155 combination of following constants:
156
157 \begin{twocollist}\itemsep=0pt
158 \twocolitem{{\bf wxHTML\_INDENT\_TOP}}{top border}
159 \twocolitem{{\bf wxHTML\_INDENT\_BOTTOM}}{bottom}
160 \twocolitem{{\bf wxHTML\_INDENT\_LEFT}}{left}
161 \twocolitem{{\bf wxHTML\_INDENT\_RIGHT}}{right}
162 \twocolitem{{\bf wxHTML\_INDENT\_HORIZONTAL}}{left and right}
163 \twocolitem{{\bf wxHTML\_INDENT\_VERTICAL}}{top and bottom}
164 \twocolitem{{\bf wxHTML\_INDENT\_ALL}}{all 4 borders}
165 \end{twocollist}
166
167 \helponly{\image{}{indent.bmp}}
168 }
169
170 \docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value.
171
172 \begin{twocollist}\itemsep=0pt
173 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it i} is number of pixels}
174 \twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it i} is interpreted as percents of width
175 of parent container}
176 \end{twocollist}
177 }
178
179 \membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight}
180
181 \func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = wxHTML\_ALIGN\_TOP}}
182
183 Sets minimal height of the container.
184
185 When container's \helpref{Layout}{wxhtmlcelllayout} is called, m\_Height
186 is set depending on layout of subcells to the height of area covered
187 by layed-out subcells. Calling this method guarantees you that the height
188 of container is never smaller than {\it h} - even if the subcells cover
189 much smaller area.
190
191 \wxheading{Parameters}
192
193 \docparam{h}{The minimal height.}
194
195 \docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted
196 somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP,
197 wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the
198 empty place.}
199
200 \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
201
202 \func{void}{SetWidthFloat}{\param{int }{w}, \param{int }{units}}
203
204 \func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}, \param{double }{pixel\_scale = 1.0}}
205
206 Sets floating width adjustment.
207
208 The normal behaviour of container is that its width is the same as the width of
209 parent container (and thus you can have only one sub-container per line).
210 You can change this by setting FWA.
211
212 {\it pixel\_scale} is number of real pixels that equals to 1 HTML pixel.
213
214 \wxheading{Parameters}
215
216 \docparam{w}{Width of the container. If the value is negative it means
217 complement to full width of parent container (e.g.
218 {\tt SetWidthFloat(-50, wxHTML\_UNITS\_PIXELS)} sets the width
219 of container to parent's width minus 50 pixels. This is useful when
220 creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))}
221
222 \docparam{units}{Units of {\it w} This parameter affects the interpretation of {\it} value.
223
224 \begin{twocollist}\itemsep=0pt
225 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it w} is number of pixels}
226 \twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it w} is interpreted as percents of width
227 of parent container}
228 \end{twocollist}
229 }
230
231 \docparam{tag}{In the second version of method, {\it w} and {\it units}
232 info is extracted from tag's {\tt WIDTH} parameter.}
233
234 \pythonnote{The second form of this method is named
235 SetWidthFloatFromTag in wxPython.}
236
237
238
239
240
241
242
243