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