]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/htcontnr.tex
wxHTML classes description is now in alphabetical order
[wxWidgets.git] / docs / latex / wx / htcontnr.tex
index dbc690ebb3eeb6e650ce9e98aefe31b9c8c9dff4..53cd3171c6c0488edb8e44795bb27ed5a8b8d6bd 100644 (file)
@@ -25,12 +25,73 @@ contain more cells in it. It is heavily used in the wxHTML layout algorithm.
 Constructor. {\it parent} is pointer to parent container or NULL.
 
 
+\membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor}
+
+\constfunc{int}{GetAlignHor}{\void}
+
+Returns container's horizontal alignment.
+
+\membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver}
+
+\constfunc{int}{GetAlignVer}{\void}
+
+Returns container's vertical alignment.
+
+\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.
+
+\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::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::InsertCell}\label{wxhtmlcontainercellinsertcell}
 
 \func{void}{InsertCell}{\param{wxHtmlCell }{*cell}}
 
 Inserts new cell into the container.
 
+\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::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
 
 \func{void}{SetAlignHor}{\param{int }{al}}
@@ -50,12 +111,6 @@ each line is aligned according to {\it al} value.
 }
 
 
-\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}}
@@ -75,11 +130,23 @@ Sets container's {\it vertical alignment}. This is per-line alignment!
 \image{}{alignv.bmp}
 }
 
-\membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver}
+\membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
 
-\constfunc{int}{GetAlignVer}{\void}
+\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
 
-Returns container's vertical alignment.
+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::SetIndent}\label{wxhtmlcontainercellsetindent}
 
@@ -116,33 +183,26 @@ 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}}
+\membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight}
 
-Returns units of intentation value for {\it ind} where {\it ind} is one
-of the {\bf HTML\_INDENT\_*} constants.
+\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}}
 
+Sets minimal height of the container. 
 
-\membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign}
+(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.)
 
-\func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}}
+\wxheading{Parameters}
 
-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}.
+\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::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
 
@@ -177,63 +237,3 @@ of parent container}
 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.
-