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