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::GetBackgroundColour}\label{wxhtmlcontainercellgetbackgroundcolour}
  45
  46 \func{wxColour}{GetBackgroundColour}{\void}
  47
  48 Returns the background colour of the container or {\tt wxNullColour} if no background
  49 colour is set.
  50
  51 \membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell}
  52
  53 \func{wxHtmlCell*}{GetFirstCell}{\void}
  54
  55 Returns pointer to the first cell in the list.
  56 You can then use wxHtmlCell's GetNext method to obtain pointer to the next
  57 cell in list.
  58
  59 {\bf Note:} This shouldn't be used by the end user. If you need some way of
  60 finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method
  61 instead.
  62
  63 \membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent}
  64
  65 \constfunc{int}{GetIndent}{\param{int }{ind}}
  66
  67 Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants.
  68
  69 {\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
  70 with same {\it ind} parameter in order to correctly interpret the returned integer value.
  71 It is NOT always in pixels!
  72
  73 \membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits}
  74
  75 \constfunc{int}{GetIndentUnits}{\param{int }{ind}}
  76
  77 Returns the units of indentation for {\it ind} where {\it ind} is one
  78 of the {\bf wxHTML\_INDENT\_*} constants.
  79
  80 \membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell}
  81
  82 \func{void}{InsertCell}{\param{wxHtmlCell }{*cell}}
  83
  84 Inserts new cell into the container.
  85
  86 \membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign}
  87
  88 \func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}}
  89
  90 Sets the container's alignment (both horizontal and vertical) according to
  91 the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
  92 it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
  93 and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.
  94
  95 \membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
  96
  97 \func{void}{SetAlignHor}{\param{int }{al}}
  98
  99 Sets the 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}\itemsep=0pt
 107 \twocolitem{{\bf wxHTML\_ALIGN\_LEFT}}{lines are left-aligned (default)}
 108 \twocolitem{{\bf wxHTML\_ALIGN\_JUSTIFY}}{lines are justified}
 109 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{lines are centered}
 110 \twocolitem{{\bf wxHTML\_ALIGN\_RIGHT}}{lines are right-aligned}
 111 \end{twocollist}
 112 }
 113
 114 \membersection{wxHtmlContainerCell::SetAlignVer}\label{wxhtmlcontainercellsetalignver}
 115
 116 \func{void}{SetAlignVer}{\param{int }{al}}
 117
 118 Sets the 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}\itemsep=0pt
 125 \twocolitem{{\bf wxHTML\_ALIGN\_BOTTOM}}{cells are over the line (default)}
 126 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{cells are centered on line}
 127 \twocolitem{{\bf wxHTML\_ALIGN\_TOP}}{cells are under the line}
 128 \end{twocollist}
 129
 130 \helponly{\image{}{alignv.bmp}}
 131 }
 132
 133 \membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
 134
 135 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
 136
 137 Sets the background colour 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 the border (frame) colours. A border is a rectangle around the container.
 144
 145 \wxheading{Parameters}
 146
 147 \docparam{clr1}{Colour of top and left lines}
 148
 149 \docparam{clr2}{Colour 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 = wxHTML\_UNITS\_PIXELS}}
 154
 155 Sets the 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 four borders we're setting. It is OR
 162 combination of following constants:
 163
 164 \begin{twocollist}\itemsep=0pt
 165 \twocolitem{{\bf wxHTML\_INDENT\_TOP}}{top border}
 166 \twocolitem{{\bf wxHTML\_INDENT\_BOTTOM}}{bottom}
 167 \twocolitem{{\bf wxHTML\_INDENT\_LEFT}}{left}
 168 \twocolitem{{\bf wxHTML\_INDENT\_RIGHT}}{right}
 169 \twocolitem{{\bf wxHTML\_INDENT\_HORIZONTAL}}{left and right}
 170 \twocolitem{{\bf wxHTML\_INDENT\_VERTICAL}}{top and bottom}
 171 \twocolitem{{\bf wxHTML\_INDENT\_ALL}}{all 4 borders}
 172 \end{twocollist}
 173
 174 \helponly{\image{}{indent.bmp}}
 175 }
 176
 177 \docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value.
 178
 179 \begin{twocollist}\itemsep=0pt
 180 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it i} is number of pixels}
 181 \twocolitem{{\bf wxHTML\_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 = wxHTML\_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 layed-out subcells. Calling 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 the minimum height, empty space must be inserted
 203 somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP,
 204 wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. 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}, \param{double }{pixel\_scale = 1.0}}
 212
 213 Sets floating width adjustment.
 214
 215 The normal behaviour of container is that its width is the same as the 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 {\it pixel\_scale} is number of real pixels that equals to 1 HTML pixel.
 220
 221 \wxheading{Parameters}
 222
 223 \docparam{w}{Width of the container. If the value is negative it means
 224 complement to full width of parent container (e.g.
 225 {\tt SetWidthFloat(-50, wxHTML\_UNITS\_PIXELS)} sets the width
 226 of container to parent's width minus 50 pixels. This is useful when
 227 creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))}
 228
 229 \docparam{units}{Units of {\it w} This parameter affects the interpretation of {\it} value.
 230
 231 \begin{twocollist}\itemsep=0pt
 232 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it w} is number of pixels}
 233 \twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it w} is interpreted as percents of width
 234 of parent container}
 235 \end{twocollist}
 236 }
 237
 238 \docparam{tag}{In the second version of method, {\it w} and {\it units}
 239 info is extracted from tag's {\tt WIDTH} parameter.}
 240
 241 \pythonnote{The second form of this method is named
 242 SetWidthFloatFromTag in wxPython.}
 243
 244
 245
 246
 247
 248
 249
 250