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