X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dff873d1aaeaab36167f66bb0c993735d954d733..dc484d491b15355285a89da275c58c2ef247d1f4:/docs/latex/wx/htcontnr.tex diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index b79bf11022..091c665b8f 100644 --- a/docs/latex/wx/htcontnr.tex +++ b/docs/latex/wx/htcontnr.tex @@ -1,7 +1,13 @@ -% -% automatically generated by HelpGen from -% htmlcontainercell.tex at 21/Mar/99 22:45:23 -% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: htcontnr.tex +%% Purpose: wxHtmlContainerCell documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: 21/Mar/99 22:45:23 +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxHtmlContainerCell}}\label{wxhtmlcontainercell} @@ -12,6 +18,10 @@ contain more cells in it. It is heavily used in the wxHTML layout algorithm. \helpref{wxHtmlCell}{wxhtmlcell} +\wxheading{Include files} + + + \wxheading{See Also} \helpref{Cells Overview}{cells} @@ -37,17 +47,12 @@ Returns container's horizontal alignment. Returns container's vertical alignment. -\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell} - -\func{wxHtmlCell*}{GetFirstCell}{\void} +\membersection{wxHtmlContainerCell::GetBackgroundColour}\label{wxhtmlcontainercellgetbackgroundcolour} -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. +\func{wxColour}{GetBackgroundColour}{\void} -{\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. +Returns the background colour of the container or {\tt wxNullColour} if no background +colour is set. \membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent} @@ -55,7 +60,7 @@ instead. Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants. -{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits} +{\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! @@ -78,14 +83,14 @@ Inserts new cell into the container. Sets the 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} +it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor} and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}. \membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor} \func{void}{SetAlignHor}{\param{int }{al}} -Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout} +Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout} each line is aligned according to {\it al} value. \wxheading{Parameters} @@ -123,19 +128,19 @@ Sets the container's {\it vertical alignment}. This is per-line alignment! \func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}} -Sets the background color for this container. +Sets the background colour for this container. \membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder} \func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}} -Sets the border (frame) colours. Border is rectangle around the container. +Sets the border (frame) colours. A border is a rectangle around the container. \wxheading{Parameters} -\docparam{clr1}{Color of top and left lines} +\docparam{clr1}{Colour of top and left lines} -\docparam{clr2}{Color of bottom and right lines} +\docparam{clr2}{Colour of bottom and right lines} \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent} @@ -190,8 +195,8 @@ much smaller area. \docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP, -wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the -empty place!} +wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the +empty place.} \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}