docs/latex/wx/htcontnr.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        htcontnr.tex
   3 %% Purpose:     wxHtmlContainerCell documentation
   4 %% Author:      wxWidgets Team
   5 %% Modified by:
   6 %% Created:     21/Mar/99 22:45:23
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets Team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxHtmlContainerCell}}\label{wxhtmlcontainercell}
  13
  14 The wxHtmlContainerCell class is an implementation of a cell that may
  15 contain more cells in it. It is heavily used in the wxHTML layout algorithm.
  16
  17 \wxheading{Derived from}
  18
  19 \helpref{wxHtmlCell}{wxhtmlcell}
  20
  21 \wxheading{Include files}
  22
  23 <wx/html/htmlcell.h>
  24
  25 \wxheading{Library}
  26
  27 \helpref{wxHtml}{librarieslist}
  28
  29 \wxheading{See Also}
  30
  31 \helpref{Cells Overview}{cells}
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35 \membersection{wxHtmlContainerCell::wxHtmlContainerCell}\label{wxhtmlcontainercellwxhtmlcontainercell}
  36
  37 \func{}{wxHtmlContainerCell}{\param{wxHtmlContainerCell }{*parent}}
  38
  39 Constructor. {\it parent} is pointer to parent container or NULL.
  40
  41
  42 \membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor}
  43
  44 \constfunc{int}{GetAlignHor}{\void}
  45
  46 Returns container's horizontal alignment.
  47
  48 \membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver}
  49
  50 \constfunc{int}{GetAlignVer}{\void}
  51
  52 Returns container's vertical alignment.
  53
  54 \membersection{wxHtmlContainerCell::GetBackgroundColour}\label{wxhtmlcontainercellgetbackgroundcolour}
  55
  56 \func{wxColour}{GetBackgroundColour}{\void}
  57
  58 Returns the background colour of the container or {\tt wxNullColour} if no background
  59 colour is set.
  60
  61 \membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent}
  62
  63 \constfunc{int}{GetIndent}{\param{int }{ind}}
  64
  65 Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants.
  66
  67 {\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
  68 with same {\it ind} parameter in order to correctly interpret the returned integer value.
  69 It is NOT always in pixels!
  70
  71 \membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits}
  72
  73 \constfunc{int}{GetIndentUnits}{\param{int }{ind}}
  74
  75 Returns the units of indentation for {\it ind} where {\it ind} is one
  76 of the {\bf wxHTML\_INDENT\_*} constants.
  77
  78 \membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell}
  79
  80 \func{void}{InsertCell}{\param{wxHtmlCell }{*cell}}
  81
  82 Inserts new cell into the container.
  83
  84 \membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign}
  85
  86 \func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}}
  87
  88 Sets the container's alignment (both horizontal and vertical) according to
  89 the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
  90 it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
  91 and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.
  92
  93 \membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
  94
  95 \func{void}{SetAlignHor}{\param{int }{al}}
  96
  97 Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
  98 each line is aligned according to {\it al} value.
  99
 100 \wxheading{Parameters}
 101
 102 \docparam{al}{new horizontal alignment. May be one of these values:
 103
 104 \begin{twocollist}\itemsep=0pt
 105 \twocolitem{{\bf wxHTML\_ALIGN\_LEFT}}{lines are left-aligned (default)}
 106 \twocolitem{{\bf wxHTML\_ALIGN\_JUSTIFY}}{lines are justified}
 107 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{lines are centered}
 108 \twocolitem{{\bf wxHTML\_ALIGN\_RIGHT}}{lines are right-aligned}
 109 \end{twocollist}
 110 }
 111
 112 \membersection{wxHtmlContainerCell::SetAlignVer}\label{wxhtmlcontainercellsetalignver}
 113
 114 \func{void}{SetAlignVer}{\param{int }{al}}
 115
 116 Sets the container's {\it vertical alignment}. This is per-line alignment!
 117
 118 \wxheading{Parameters}
 119
 120 \docparam{al}{new vertical alignment. May be one of these values:
 121
 122 \begin{twocollist}\itemsep=0pt
 123 \twocolitem{{\bf wxHTML\_ALIGN\_BOTTOM}}{cells are over the line (default)}
 124 \twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{cells are centered on line}
 125 \twocolitem{{\bf wxHTML\_ALIGN\_TOP}}{cells are under the line}
 126 \end{twocollist}
 127
 128 \helponly{\image{}{alignv.bmp}}
 129 }
 130
 131 \membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
 132
 133 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
 134
 135 Sets the background colour for this container.
 136
 137 \membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder}
 138
 139 \func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}}
 140
 141 Sets the border (frame) colours. A border is a rectangle around the container.
 142
 143 \wxheading{Parameters}
 144
 145 \docparam{clr1}{Colour of top and left lines}
 146
 147 \docparam{clr2}{Colour of bottom and right lines}
 148
 149 \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
 150
 151 \func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = wxHTML\_UNITS\_PIXELS}}
 152
 153 Sets the indentation (free space between borders of container and subcells).
 154
 155 \wxheading{Parameters}
 156
 157 \docparam{i}{Indentation value.}
 158
 159 \docparam{what}{Determines which of the four borders we're setting. It is OR
 160 combination of following constants:
 161
 162 \begin{twocollist}\itemsep=0pt
 163 \twocolitem{{\bf wxHTML\_INDENT\_TOP}}{top border}
 164 \twocolitem{{\bf wxHTML\_INDENT\_BOTTOM}}{bottom}
 165 \twocolitem{{\bf wxHTML\_INDENT\_LEFT}}{left}
 166 \twocolitem{{\bf wxHTML\_INDENT\_RIGHT}}{right}
 167 \twocolitem{{\bf wxHTML\_INDENT\_HORIZONTAL}}{left and right}
 168 \twocolitem{{\bf wxHTML\_INDENT\_VERTICAL}}{top and bottom}
 169 \twocolitem{{\bf wxHTML\_INDENT\_ALL}}{all 4 borders}
 170 \end{twocollist}
 171
 172 \helponly{\image{}{indent.bmp}}
 173 }
 174
 175 \docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value.
 176
 177 \begin{twocollist}\itemsep=0pt
 178 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it i} is number of pixels}
 179 \twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it i} is interpreted as percents of width
 180 of parent container}
 181 \end{twocollist}
 182 }
 183
 184 \membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight}
 185
 186 \func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = wxHTML\_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 layed-out subcells. Calling 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 the minimum height, empty space must be inserted
 201 somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP,
 202 wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the
 203 empty place.}
 204
 205 \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
 206
 207 \func{void}{SetWidthFloat}{\param{int }{w}, \param{int }{units}}
 208
 209 \func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}, \param{double }{pixel\_scale = 1.0}}
 210
 211 Sets floating width adjustment.
 212
 213 The normal behaviour of container is that its width is the same as the width of
 214 parent container (and thus you can have only one sub-container per line).
 215 You can change this by setting FWA.
 216
 217 {\it pixel\_scale} is number of real pixels that equals to 1 HTML pixel.
 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, wxHTML\_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 the interpretation of {\it} value.
 228
 229 \begin{twocollist}\itemsep=0pt
 230 \twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it w} is number of pixels}
 231 \twocolitem{{\bf wxHTML\_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 \pythonnote{The second form of this method is named
 240 SetWidthFloatFromTag in wxPython.}
 241
 242
 243
 244
 245
 246
 247
 248