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