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