X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/605d715ddd84ddc3e78423e3f3ae5c27c8ff4d43..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/htcontnr.tex?ds=sidebyside diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index a966c58cda..dac106978a 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} @@ -10,7 +16,16 @@ contain more cells in it. It is heavily used in the wxHTML layout algorithm. \wxheading{Derived from} -\helpref{wxHtmlCell}{wxhtmlcell} +\helpref{wxHtmlCell}{wxhtmlcell}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} \wxheading{See Also} @@ -37,25 +52,20 @@ 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} \constfunc{int}{GetIndent}{\param{int }{ind}} -Returns the indentation. {\it ind} is one of the {\bf HTML\_INDENT\_*} constants. +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! @@ -64,16 +74,7 @@ It is NOT always in pixels! \constfunc{int}{GetIndentUnits}{\param{int }{ind}} Returns the units of indentation for {\it ind} where {\it ind} is one -of the {\bf HTML\_INDENT\_*} constants. - -\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} +of the {\bf wxHTML\_INDENT\_*} constants. \membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell} @@ -87,14 +88,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} @@ -102,9 +103,10 @@ each line is aligned according to {\it al} value. \docparam{al}{new horizontal alignment. May be one of these values: \begin{twocollist}\itemsep=0pt -\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} +\twocolitem{{\bf wxHTML\_ALIGN\_LEFT}}{lines are left-aligned (default)} +\twocolitem{{\bf wxHTML\_ALIGN\_JUSTIFY}}{lines are justified} +\twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{lines are centered} +\twocolitem{{\bf wxHTML\_ALIGN\_RIGHT}}{lines are right-aligned} \end{twocollist} } @@ -119,9 +121,9 @@ Sets the container's {\it vertical alignment}. This is per-line alignment! \docparam{al}{new vertical alignment. May be one of these values: \begin{twocollist}\itemsep=0pt -\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} +\twocolitem{{\bf wxHTML\_ALIGN\_BOTTOM}}{cells are over the line (default)} +\twocolitem{{\bf wxHTML\_ALIGN\_CENTER}}{cells are centered on line} +\twocolitem{{\bf wxHTML\_ALIGN\_TOP}}{cells are under the line} \end{twocollist} \helponly{\image{}{alignv.bmp}} @@ -131,23 +133,23 @@ 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} -\func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = HTML\_UNITS\_PIXELS}} +\func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = wxHTML\_UNITS\_PIXELS}} Sets the indentation (free space between borders of container and subcells). @@ -159,13 +161,13 @@ Sets the indentation (free space between borders of container and subcells). combination of following constants: \begin{twocollist}\itemsep=0pt -\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} +\twocolitem{{\bf wxHTML\_INDENT\_TOP}}{top border} +\twocolitem{{\bf wxHTML\_INDENT\_BOTTOM}}{bottom} +\twocolitem{{\bf wxHTML\_INDENT\_LEFT}}{left} +\twocolitem{{\bf wxHTML\_INDENT\_RIGHT}}{right} +\twocolitem{{\bf wxHTML\_INDENT\_HORIZONTAL}}{left and right} +\twocolitem{{\bf wxHTML\_INDENT\_VERTICAL}}{top and bottom} +\twocolitem{{\bf wxHTML\_INDENT\_ALL}}{all 4 borders} \end{twocollist} \helponly{\image{}{indent.bmp}} @@ -174,15 +176,15 @@ combination of following constants: \docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value. \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf HTML\_UNITS\_PIXELS}}{{\it i} is number of pixels} -\twocolitem{{\bf HTML\_UNITS\_PERCENT}}{{\it i} is interpreted as percents of width +\twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it i} is number of pixels} +\twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it i} is interpreted as percents of width of parent container} \end{twocollist} } \membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight} -\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML\_ALIGN\_TOP}} +\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = wxHTML\_ALIGN\_TOP}} Sets minimal height of the container. @@ -197,9 +199,9 @@ much smaller area. \docparam{h}{The minimal height.} \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 HTML\_ALIGN\_TOP, -HTML\_ALIGN\_BOTTOM, HTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the -empty place!} +somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP, +wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the +empty place.} \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat} @@ -219,15 +221,15 @@ You can change this by setting FWA. \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 +{\tt SetWidthFloat(-50, wxHTML\_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 the interpretation of {\it} value. \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf HTML\_UNITS\_PIXELS}}{{\it w} is number of pixels} -\twocolitem{{\bf HTML\_UNITS\_PERCENT}}{{\it w} is interpreted as percents of width +\twocolitem{{\bf wxHTML\_UNITS\_PIXELS}}{{\it w} is number of pixels} +\twocolitem{{\bf wxHTML\_UNITS\_PERCENT}}{{\it w} is interpreted as percents of width of parent container} \end{twocollist} }