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