Added blank line to end (Tex2RTF requirement)

[wxWidgets.git] / docs / latex / wx / htcontnr.tex

%
% automatically generated by HelpGen from
% htmlcontainercell.tex at 21/Mar/99 22:45:23
%

\section{\class{wxHtmlContainerCell}}\label{wxhtmlcontainercell}

wxHtmlContainerCell class an implementation of a cell that may
contain more cells in it. It is heavily used in the wxHTML layout algorithm.

\wxheading{Derived from}

\helpref{wxHtmlCell}{wxhtmlcell}

\wxheading{See Also}

\helpref{Cells Overview}{cells}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxHtmlContainerCell::wxHtmlContainerCell}\label{wxhtmlcontainercellwxhtmlcontainercell}

\func{}{wxHtmlContainerCell}{\param{wxHtmlContainerCell }{*parent}}

Constructor. {\it parent} is pointer to parent container or NULL.


\membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell}

\func{void}{InsertCell}{\param{wxHtmlCell }{*cell}}

Inserts new cell into the container.

\membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}

\func{void}{SetAlignHor}{\param{int }{al}}

Sets container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
each line is aligned according to {\it al} value.

\wxheading{Parameters}

\docparam{al}{new horizontal alignment. May be one of these values:

\begin{twocollist}
\twocolitem{{\bf HTML\_ALIGN\_LEFT}}{lines are left-aligned (default)}
\twocolitem{{\bf HTML\_ALIGN\_CENTER\_H}}{lines are centered}
\twocolitem{{\bf HTML\_ALIGN\_RIGHT}}{lines are right-aligned}
\end{twocollist}
}


\membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor}

\constfunc{int}{GetAlignHor}{\void}

Returns container's horizontal alignment.

\membersection{wxHtmlContainerCell::SetAlignVer}\label{wxhtmlcontainercellsetalignver}

\func{void}{SetAlignVer}{\param{int }{al}}

Sets container's {\it vertical alignment}. This is per-line alignment!

\wxheading{Parameters}

\docparam{al}{new vertical alignment. May be one of these values:

\begin{twocollist}
\twocolitem{{\bf HTML\_ALIGN\_BOTTOM}}{cells are over the line (default)}
\twocolitem{{\bf HTML\_ALIGN\_CENTER\_V}}{cells are centered on line}
\twocolitem{{\bf HTML\_ALIGN\_TOP}}{cells are under the line}
\end{twocollist}

\image{}{alignv.bmp}
}

\membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver}

\constfunc{int}{GetAlignVer}{\void}

Returns container's vertical alignment.

\membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}

\func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = HTML\_UNITS\_PIXELS}}

Sets indentation (free space between borders of container and subcells).

\wxheading{Parameters}

\docparam{i}{Indentation value.}

\docparam{what}{Determines which of the 4 borders we're setting. It is OR
combination of following constants:

\begin{twocollist}
\twocolitem{{\bf HTML\_INDENT\_TOP}}{top border}
\twocolitem{{\bf HTML\_INDENT\_BOTTOM}}{bottom}
\twocolitem{{\bf HTML\_INDENT\_LEFT}}{left}
\twocolitem{{\bf HTML\_INDENT\_RIGHT}}{right}
\twocolitem{{\bf HTML\_INDENT\_HORIZONTAL}}{left and right}
\twocolitem{{\bf HTML\_INDENT\_VERTICAL}}{top and bottom}
\twocolitem{{\bf HTML\_INDENT\_ALL}}{all 4 borders}
\end{twocollist}

\image{}{indent.bmp}
}

\docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value.

\begin{twocollist}
\twocolitem{{\bf HTML\_UNITS\_PIXELS}}{{\it i} is number of pixels}
\twocolitem{{\bf HTML\_UNITS\_PERCENT}}{{\it i} is interpreted as percents of width
of parent container}
\end{twocollist}
}

\membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent}

\constfunc{int}{GetIndent}{\param{int }{ind}}

Returns the indentation. {\it ind} is one of the {\bf HTML\_INDENT\_*} constants.

{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
with same {\it ind} parameter in order to correctly interpret the returned integer value.
It is NOT always in pixels!

\membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits}

\constfunc{int}{GetIndentUnits}{\param{int }{ind}}

Returns units of intentation value for {\it ind} where {\it ind} is one
of the {\bf HTML\_INDENT\_*} constants.


\membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign}

\func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}}

Sets container's alignment (both horizontal and vertical) according to
the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.


\membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}

\func{void}{SetWidthFloat}{\param{int }{w}, \param{int }{units}}

\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}}

Sets floating width adjustment. 

Normal behaviour of container is that it's width is same as width of 
parent container (and thus you can have only one sub-container per line).
You can change this by setting FWA.

\wxheading{Parameters}

\docparam{w}{Width of the container. If the value is negative it means
complement to full width of parent container (e.g. 
{\tt SetWidthFloat(-50, HTML\_UNITS\_PIXELS)} sets the width
of container to parent's width minus 50 pixels. This is useful when
creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))}

\docparam{units}{Units of {\it w} This parameter affects interpretation of {\it} value.

\begin{twocollist}
\twocolitem{{\bf HTML\_UNITS\_PIXELS}}{{\it w} is number of pixels}
\twocolitem{{\bf HTML\_UNITS\_PERCENT}}{{\it w} is interpreted as percents of width
of parent container}
\end{twocollist}
}

\docparam{tag}{In the second version of method, {\it w} and {\it units}
info is extracted from tag's {\tt WIDTH} parameter.}


\membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight}

\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}}

Sets minimal height of the container. 

(When container's \helpref{Layout}{wxhtmlcelllayout} is called, m_Height
is set depending on layout of subcells to the height of area covered
by layouted subcells. Call to this method guarantees you that the height
of container is never smaller than {\it h} - even if the subcells cover
much smaller area.)

\wxheading{Parameters}

\docparam{h}{The minimal height.}

\docparam{align}{If height of the container is lower than min. height, empty space must be inserted
somewhere in order to ensure minimal height. This parameter is one of {\bf HTML_ALIGN_TOP,
HTML_ALIGN_BOTTOM, HTML_ALIGN_CENTER} constants. It refers to the {\it contents}, not to the
empty place!}

\membersection{wxHtmlContainerCell::GetMaxLineWidth}\label{wxhtmlcontainercellgetmaxlinewidth}

\constfunc{int}{GetMaxLineWidth}{\void}

Returns width of widest line (note : this may be more than GetWidth()!!
E.g. if you have 640x480 image and the wxHtmlWindow is only 100x100...)

Call to this method is valid only after calling \helpref{Layout}{wxhtmlcelllayout}

\membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}

\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}

Sets background color for this container.

\membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder}

\func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}}

Sets border (frame) colours. Border is rectangle around the container.

\wxheading{Parameters}

\docparam{clr1}{Color of top and left lines}

\docparam{clr2}{Color of bottom and right lines}

\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell}

\func{wxHtmlCell*}{GetFirstCell}{\void}

Returns pointer to the first cell in the list.
You can then use wxHtmlCell's GetNext method to obtain pointer to the next
cell in list.

{\bf Note} : This shouldn't be used by the end user. If you need some way of
finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method
instead.