documented VFS handlers

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

diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex
index e43faa8409db67e60d89125f320e5ca13b2f69de..6bed58e5066664cd69e552d888974cf7a41522c4 100644 (file)
--- a/docs/latex/wx/htcontnr.tex
+++ b/docs/latex/wx/htcontnr.tex
@@ -12,6 +12,10 @@ contain more cells in it. It is heavily used in the wxHTML layout algorithm.
 
 \helpref{wxHtmlCell}{wxhtmlcell}
 
+\wxheading{Include files}
+
+<wx/html/htmlcell.h>
+
 \wxheading{See Also}
 
 \helpref{Cells Overview}{cells}
@@ -53,7 +57,7 @@ instead.
 
 \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}
 with same {\it ind} parameter in order to correctly interpret the returned integer value.
@@ -64,16 +68,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}
 
@@ -102,9 +97,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,12 +115,12 @@ 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}
 
-\image{}{alignv.bmp}
+\helponly{\image{}{alignv.bmp}}
 }
 
 \membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
@@ -147,7 +143,7 @@ Sets the border (frame) colours. Border is rectangle around the container.
 
 \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,32 +155,32 @@ 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}
 
-\image{}{indent.bmp}
+\helponly{\image{}{indent.bmp}}
 }
 
 \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. 
+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
@@ -197,35 +193,37 @@ 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
+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!}
 
 \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
 
 \func{void}{SetWidthFloat}{\param{int }{w}, \param{int }{units}}
 
-\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}}
+\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}, \param{double }{pixel\_scale = 1.0}}
 
-Sets floating width adjustment. 
+Sets floating width adjustment.
 
-The normal behaviour of container is that its width is the same as the width of 
+The normal behaviour of container is that its width is the same as the width of
 parent container (and thus you can have only one sub-container per line).
 You can change this by setting FWA.
 
+{\it pixel\_scale} is number of real pixels that equals to 1 HTML pixel.
+
 \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
+complement to full width of parent container (e.g.
+{\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}
 }
@@ -233,3 +231,13 @@ of parent container}
 \docparam{tag}{In the second version of method, {\it w} and {\it units}
 info is extracted from tag's {\tt WIDTH} parameter.}
 
+\pythonnote{The second form of this method is named
+SetWidthFloatFromTag in wxPython.}
+
+
+
+
+
+
+
+