wxHTML classes description is now in alphabetical order

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4025 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex
index 25eb6181c1917b4ec3cc33962e0e7ff818ba4aa6..c4d472c67956ee6019bd3f75ad832bc5b6dff215 100644 (file)
--- a/docs/latex/wx/filesys.tex
+++ b/docs/latex/wx/filesys.tex
@@ -28,6 +28,25 @@ wxObject
 
 Constructor. 
 
 
 Constructor. 
 

+\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler}
+
+\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}}
+
+This static function adds new handler into the list of handlers.
+The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS.
+
+\wxheading{Note}
+
+You can call:
+
+\begin{verbatim}
+wxFileSystem::AddHandler(new My_FS_Handler);
+\end{verbatim}
+
+This is because (a) AddHandler is a static method, and (b) the handlers
+are deleted in wxFileSystem's destructor so that you don't have to
+care about it.
+

 \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
 
 \func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}}
 \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
 
 \func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}}


@@ -75,22 +94,3 @@ or NULL if failed. It first tries to open the file in relative scope
 (based on value passed to ChangePathTo() method) and then as an
 absolute path.
 
 (based on value passed to ChangePathTo() method) and then as an
 absolute path.
 

-\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler}
-
-\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}}
-
-This static function adds new handler into the list of handlers.
-The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS.
-
-\wxheading{Note}
-
-You can call:
-
-\begin{verbatim}
-wxFileSystem::AddHandler(new My_FS_Handler);
-\end{verbatim}
-
-This is because (a) AddHandler is a static method, and (b) the handlers
-are deleted in wxFileSystem's destructor so that you don't have to
-care about it.
-

diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex
index 80a02a6edb05b6be90f6d659a6b6e2bdeef9ea25..1bc86552579786ceca9b75eceff29c729c609f0e 100644 (file)
--- a/docs/latex/wx/filesysh.tex
+++ b/docs/latex/wx/filesysh.tex
@@ -60,28 +60,16 @@ bool MyHand::CanOpen(const wxString& location)
 
 Must be overwriten in derived handlers.
 
 
 Must be overwriten in derived handlers.
 

-\membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}
-
-\func{virtual wxFSFile*}{OpenFile}{\param{wxFileSystem\& }{fs}, \param{const wxString\& }{location}}
-
-Opens the file and returns wxFSFile pointer or NULL if failed.
-
-Must be overwriten in derived handlers.
-
-\wxheading{Parameters}
-
-\docparam{fs}{Parent FS (the FS from that OpenFile was called). See ZIP handler
-for details how to use it.}
-
-\docparam{location}{The {\bf absolute} location of file.}
+\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor}

 
 

-\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol}
+\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}}

 
 

-\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}}
+Returns anchor if present in the location.
+See \helpref{wxFSFile}{wxfsfilegetanchor} for details.

 
 

-Returns protocol string extracted from {\it location}. 
+Example : GetAnchor("index.htm\#chapter2") == "chapter2"

 
 

-Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
+{\bf Note:} anchor is NOT part of left location.

 
 \membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation}
 
 
 \membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation}
 


@@ -91,16 +79,22 @@ Returns left location string extracted from {\it location}.
 
 Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip"
 
 
 Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip"
 

-\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor}
+\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}

 
 

-\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}}
+\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}

 
 

-Returns anchor if present in the location.
-See \helpref{wxFSFile}{wxfsfilegetanchor} for details.
+Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType
+returns real MIME type - either extension-based or queried from HTTP)

 
 

-Example : GetAnchor("index.htm\#chapter2") == "chapter2"
+Example : GetMimeTypeFromExt("index.htm") == "text/html"

 
 

-{\bf Note:} anchor is NOT part of left location.
+\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol}
+
+\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}}
+
+Returns protocol string extracted from {\it location}. 
+
+Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"

 
 \membersection{wxFileSystemHandler::GetRightLocation}\label{wxfilesystemhandlergetrightlocation}
 
 
 \membersection{wxFileSystemHandler::GetRightLocation}\label{wxfilesystemhandlergetrightlocation}
 


@@ -110,12 +104,18 @@ Returns right location string extracted from {\it location}.
 
 Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
 
 
 Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
 

-\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}
+\membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}

 
 

-\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
+\func{virtual wxFSFile*}{OpenFile}{\param{wxFileSystem\& }{fs}, \param{const wxString\& }{location}}

 
 

-Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType
-returns real MIME type - either extension-based or queried from HTTP)
+Opens the file and returns wxFSFile pointer or NULL if failed.

 
 

-Example : GetMimeTypeFromExt("index.htm") == "text/html"
+Must be overwriten in derived handlers.
+
+\wxheading{Parameters}
+
+\docparam{fs}{Parent FS (the FS from that OpenFile was called). See ZIP handler
+for details how to use it.}
+
+\docparam{location}{The {\bf absolute} location of file.}

 
 

diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex
index 7c0e956aa13cff50c11df38f5f456622c3338bab..14b54ccd7d156daf8048ca71bf59c1ac95f8d3b1 100644 (file)
--- a/docs/latex/wx/fsfile.tex
+++ b/docs/latex/wx/fsfile.tex
@@ -67,24 +67,24 @@ class wxMyFSFile : public wxFSFile
 };
 \end{verbatim}
 
 };
 \end{verbatim}
 

-\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}
-
-\constfunc{wxInputStream*}{GetStream}{\void}
+\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}

 
 

-Returns pointer to the stream. You can use the returned
-stream to directly access data. You may suppose
-that the stream provide Seek and GetSize functionality
-(even in case of HTTP protocol which doesn't provide
-this by default. wxHtml is using local cache to workaround
-this and to speed up connection)
+\constfunc{const wxString\&}{GetAnchor}{\void}

 
 

-\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}
+Returns anchor (if present). The term of {\bf anchor} can be easily
+explained using few examples:

 
 

-\constfunc{const wxString\&}{GetMimeType}{\void}
+\begin{verbatim}
+index.htm#anchor                      /* 'anchor' is anchor */
+index/wx001.htm                       /* NO anchor here!    */
+archive/main.zip#zip:index.htm#global /* 'global'           */
+archive/main.zip#zip:index.htm        /* NO anchor here!    */
+\end{verbatim}

 
 

-Returns MIME type of the content of this file. It is either
-extension-based (see wxMimeTypesManager) or extracted from
-HTTP protocol Content-Type header.
+Usually anchor is presented only if mime type is 'text/html'.
+But it may have some meaning with other files
+(for example myanim.avi\#200 may refer to position in animation
+or reality.wrl\#MyView may refer to predefined view in VRML)

 
 \membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
 
 
 \membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
 


@@ -100,22 +100,22 @@ file:/home/vasek/index.htm
 relative-file.htm
 \end{verbatim}
 
 relative-file.htm
 \end{verbatim}
 

-\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
+\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}

 
 

-\constfunc{const wxString\&}{GetAnchor}{\void}
+\constfunc{const wxString\&}{GetMimeType}{\void}

 
 

-Returns anchor (if present). The term of {\bf anchor} can be easily
-explained using few examples:
+Returns MIME type of the content of this file. It is either
+extension-based (see wxMimeTypesManager) or extracted from
+HTTP protocol Content-Type header.

 
 

-\begin{verbatim}
-index.htm#anchor                      /* 'anchor' is anchor */
-index/wx001.htm                       /* NO anchor here!    */
-archive/main.zip#zip:index.htm#global /* 'global'           */
-archive/main.zip#zip:index.htm        /* NO anchor here!    */
-\end{verbatim}
+\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}

 
 

-Usually anchor is presented only if mime type is 'text/html'.
-But it may have some meaning with other files
-(for example myanim.avi\#200 may refer to position in animation
-or reality.wrl\#MyView may refer to predefined view in VRML)
+\constfunc{wxInputStream*}{GetStream}{\void}
+
+Returns pointer to the stream. You can use the returned
+stream to directly access data. You may suppose
+that the stream provide Seek and GetSize functionality
+(even in case of HTTP protocol which doesn't provide
+this by default. wxHtml is using local cache to workaround
+this and to speed up connection)

 
 

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index 1774f94f8ff09b67fa7e2c1adebe3ffb78075716..311186ecbf2c3a004cbff1206ecabdf54810e4e8 100644 (file)
--- a/docs/latex/wx/htcell.tex
+++ b/docs/latex/wx/htcell.tex
@@ -49,46 +49,70 @@ Usage :
 while (container->AdjustPagebreak(&p)) {}
 \end{verbatim}
 
 while (container->AdjustPagebreak(&p)) {}
 \end{verbatim}
 

-\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
+\membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw}

 
 

-\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}}
+\func{virtual void}{Draw}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{view\_y1}, \param{int }{view\_y2}}

 
 

-Sets parent container of this cell. This is called from
-\helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
+Renders the cell.

 
 

-\membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent}
+\wxheading{Parameters}

 
 

-\constfunc{wxHtmlContainerCell*}{GetParent}{\void}
+\docparam{dc}{Device context to which the cell is to be drawn}

 
 

-Returns pointer to parent container.
+\docparam{x,y}{Coordinates of parent's upper left corner (origin). You must
+add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
+Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}

 
 

-\membersection{wxHtmlCell::GetPosX}\label{wxhtmlcellgetposx}
+\docparam{view_y1}{y-coord of the first line visible in window. This is
+used to optimize rendering speed}

 
 

-\constfunc{int}{GetPosX}{\void}
+\docparam{view_y2}{y-coord of the last line visible in window. This is
+used to optimize rendering speed}

 
 

-Returns X position within parent (the value is relative to parent's
-upper left corner). The returned value is meaningful only if
-parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
+\membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible}

 
 

-\membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy}
+\func{virtual void}{DrawInvisible}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}}

 
 

-\constfunc{int}{GetPosY}{\void}
+This method is called instead of \helpref{Draw}{wxhtmlcelldraw} when the
+cell is certainly out of the screen (and thus invisible). This is not
+nonsense - some tags (like \helpref{wxHtmlColourCell}{wxhtmlcolourcell}
+or font setter) must be drawn even if they are invisible!

 
 

-Returns Y position within parent (the value is relative to parent's
-upper left corner). The returned value is meaningful only if
-parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
+\wxheading{Parameters}

 
 

-\membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth}
+\docparam{dc}{Device context to which the cell is to be drawn}

 
 

-\constfunc{int}{GetWidth}{\void}
+\docparam{x,y}{Coordinates of parent's upper left corner. You must
+add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
+Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}

 
 

-Returns width of the cell (m_Width member).
+\membersection{wxHtmlCell::Find}\label{wxhtmlcellfind}

 
 

-\membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
+\func{virtual const wxHtmlCell*}{Find}{\param{int }{condition}, \param{const void* }{param}}

 
 

-\constfunc{int}{GetHeight}{\void}
+Returns pointer to itself if this cell matches condition (or if any of the cells
+following in the list matches), NULL otherwise.
+(In other words if you call top-level container's Find it will
+return pointer to the first cell that matches the condition)

 
 

-Returns height of the cell (m_Height member).
+It is recommended way how to obtain pointer to particular cell or
+to cell of some type (e.g. wxHtmlAnchorCell reacts on
+HTML_COND_ISANCHOR condition)
+
+\wxheading{Parameters}
+
+\docparam{condition}{Unique integer identifier of condition}
+
+\docparam{param}{Optional parameters}
+
+\wxheading{Defined conditions}
+
+\begin{twocollist}
+\twocolitem{{\bf HTML_COND_ISANCHOR}}{Finds particular anchor.
+{\it param} is pointer to wxString with name of the anchor.}
+\twocolitem{{\bf HTML_COND_USER}}{User-defined conditions start
+from this number}
+\end{twocollist}

 
 \membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent}
 
 
 \membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent}
 


@@ -98,6 +122,12 @@ Returns descent value of the cell (m_Descent member). See explanation:
 
 \image{}{descent.bmp}
 
 
 \image{}{descent.bmp}
 

+\membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
+
+\constfunc{int}{GetHeight}{\void}
+
+Returns height of the cell (m_Height member).
+

 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 
 \constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 
 \constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}


@@ -118,25 +148,33 @@ upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)}
 Returns pointer to the next cell in list (see htmlcell.h if you're
 interested in details).
 
 Returns pointer to the next cell in list (see htmlcell.h if you're
 interested in details).
 

-\membersection{wxHtmlCell::SetPos}\label{wxhtmlcellsetpos}
+\membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent}

 
 

-\func{void}{SetPos}{\param{int }{x}, \param{int }{y}}
+\constfunc{wxHtmlContainerCell*}{GetParent}{\void}

 
 

-Sets cell's position within parent container.
+Returns pointer to parent container.

 
 

-\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
+\membersection{wxHtmlCell::GetPosX}\label{wxhtmlcellgetposx}

 
 

-\func{void}{SetLink}{\param{const wxString\& }{link}}
+\constfunc{int}{GetPosX}{\void}

 
 

-Sets the hypertext link asocciated with this cell. (Default value
-is wxEmptyString (no link))
+Returns X position within parent (the value is relative to parent's
+upper left corner). The returned value is meaningful only if
+parent's \helpref{Layout}{wxhtmlcelllayout} was called before!

 
 

-\membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
+\membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy}

 
 

-\func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
+\constfunc{int}{GetPosY}{\void}

 
 

-Sets the next cell in the list. This shouldn't be called by user - it is
-to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}
+Returns Y position within parent (the value is relative to parent's
+upper left corner). The returned value is meaningful only if
+parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
+
+\membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth}
+
+\constfunc{int}{GetWidth}{\void}
+
+Returns width of the cell (m_Width member).

 
 \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
 
 
 \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
 


@@ -155,71 +193,6 @@ It must be called before displaying cells structure because
 m\_PosX and m\_PosY are undefined (or invalid)
 before calling Layout.
 
 m\_PosX and m\_PosY are undefined (or invalid)
 before calling Layout.
 

-\membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw}
-
-\func{virtual void}{Draw}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{view\_y1}, \param{int }{view\_y2}}
-
-Renders the cell.
-
-\wxheading{Parameters}
-
-\docparam{dc}{Device context to which the cell is to be drawn}
-
-\docparam{x,y}{Coordinates of parent's upper left corner (origin). You must
-add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
-Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}
-
-\docparam{view_y1}{y-coord of the first line visible in window. This is
-used to optimize rendering speed}
-
-\docparam{view_y2}{y-coord of the last line visible in window. This is
-used to optimize rendering speed}
-
-\membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible}
-
-\func{virtual void}{DrawInvisible}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}}
-
-This method is called instead of \helpref{Draw}{wxhtmlcelldraw} when the
-cell is certainly out of the screen (and thus invisible). This is not
-nonsense - some tags (like \helpref{wxHtmlColourCell}{wxhtmlcolourcell}
-or font setter) must be drawn even if they are invisible!
-
-\wxheading{Parameters}
-
-\docparam{dc}{Device context to which the cell is to be drawn}
-
-\docparam{x,y}{Coordinates of parent's upper left corner. You must
-add this to m\_PosX,m\_PosY when passing coordinates to dc's methods
-Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}}
-
-\membersection{wxHtmlCell::Find}\label{wxhtmlcellfind}
-
-\func{virtual const wxHtmlCell*}{Find}{\param{int }{condition}, \param{const void* }{param}}
-
-Returns pointer to itself if this cell matches condition (or if any of the cells
-following in the list matches), NULL otherwise.
-(In other words if you call top-level container's Find it will
-return pointer to the first cell that matches the condition)
-
-It is recommended way how to obtain pointer to particular cell or
-to cell of some type (e.g. wxHtmlAnchorCell reacts on
-HTML_COND_ISANCHOR condition)
-
-\wxheading{Parameters}
-
-\docparam{condition}{Unique integer identifier of condition}
-
-\docparam{param}{Optional parameters}
-
-\wxheading{Defined conditions}
-
-\begin{twocollist}
-\twocolitem{{\bf HTML_COND_ISANCHOR}}{Finds particular anchor.
-{\it param} is pointer to wxString with name of the anchor.}
-\twocolitem{{\bf HTML_COND_USER}}{User-defined conditions start
-from this number}
-\end{twocollist}
-

 \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick}
 
 \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{bool }{left}, \param{bool }{middle}, \param{bool }{right}}
 \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick}
 
 \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{bool }{left}, \param{bool }{middle}, \param{bool }{right}}


@@ -242,3 +215,30 @@ key events or whatsoever) you should use wxHtmlBinderCell instead.
 \docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right
 button is pressed, FALSE otherwise}
 
 \docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right
 button is pressed, FALSE otherwise}
 

+\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
+
+\func{void}{SetLink}{\param{const wxString\& }{link}}
+
+Sets the hypertext link asocciated with this cell. (Default value
+is wxEmptyString (no link))
+
+\membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
+
+\func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
+
+Sets the next cell in the list. This shouldn't be called by user - it is
+to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}
+
+\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
+
+\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}}
+
+Sets parent container of this cell. This is called from
+\helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
+
+\membersection{wxHtmlCell::SetPos}\label{wxhtmlcellsetpos}
+
+\func{void}{SetPos}{\param{int }{x}, \param{int }{y}}
+
+Sets cell's position within parent container.
+

diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex
index dbc690ebb3eeb6e650ce9e98aefe31b9c8c9dff4..53cd3171c6c0488edb8e44795bb27ed5a8b8d6bd 100644 (file)
--- a/docs/latex/wx/htcontnr.tex
+++ b/docs/latex/wx/htcontnr.tex
@@ -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.
 
 
 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::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}}
 \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}}
 \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}
 }
 
 \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}
 
 
 \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
 


@@ -116,33 +183,26 @@ of parent container}
 \end{twocollist}
 }
 
 \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}
 
 
 \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
 


@@ -177,63 +237,3 @@ of parent container}
 info is extracted from tag's {\tt WIDTH} parameter.}
 
 
 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.
-

diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index 6acbc420422377c2255d88bc0cd155393b376460..01d37adc5c2b2ebdc1fd1578143ea77773b19e49 100644 (file)
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -40,22 +40,6 @@ wxEvtHandler
 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
-
-\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
-
-Sets format of title of the frame. Must contain exactly one "\%s"
-(for title of displayed HTML page).
-
-\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
-
-\func{void}{SetTempDir}{\param{const wxString\& }{path}}
-
-Sets path for storing temporary files (cached binary versions of index and contents files. These binary
-forms are much faster to read.) Default value is empty string (empty string means
-that no cached data are stored). Note that these files are NOT
-deleted when program exits!
-

 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}


@@ -117,6 +101,28 @@ Returns TRUE if the keyword was found.
 IMPORTANT! KeywordSearch searches only pages listed in .htc file(s)!
 (you should have all pages in contents file...)
 
 IMPORTANT! KeywordSearch searches only pages listed in .htc file(s)!
 (you should have all pages in contents file...)
 

+\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
+
+\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
+
+Reads controllers setting (position of window etc.)
+
+\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
+
+\func{void}{SetTempDir}{\param{const wxString\& }{path}}
+
+Sets path for storing temporary files (cached binary versions of index and contents files. These binary
+forms are much faster to read.) Default value is empty string (empty string means
+that no cached data are stored). Note that these files are NOT
+deleted when program exits!
+
+\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
+
+\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
+
+Sets format of title of the frame. Must contain exactly one "\%s"
+(for title of displayed HTML page).
+

 \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
 
 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
 \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
 
 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}


@@ -128,12 +134,6 @@ reads and writes settings (including wxHtmlWindow's settings) when needed.
 
 The only thing you must do is create wxConfig object and call UseConfig. 
 
 
 The only thing you must do is create wxConfig object and call UseConfig. 
 

-\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
-
-\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
-
-Reads controllers setting (position of window etc.)
-

 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 
 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 
 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}

diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex
index 7d486f7170e89aea6cb577936cd7097021f86952..9df02c7c111ffd4cec46d647ace0f22b5f7153ca 100644 (file)
--- a/docs/latex/wx/htparser.tex
+++ b/docs/latex/wx/htparser.tex
@@ -40,51 +40,53 @@ wxObject
 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
+\membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag}

 
 

-\func{void}{SetFS}{\param{wxFileSystem }{*fs}}
+\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}}

 
 

-Sets the virtual file system that will be used to request additional
-files. (For example {\tt <IMG>} tag handler requests wxFSFile with the
-image data.)
+This may (and may not) be overwriten in derived class.

 
 

-\membersection{wxHtmlParser::GetFS}\label{wxhtmlparsergetfs}
+This method is called each time new tag is about to be added. 
+{\it tag} contains information about the tag. (See \helpref{wxHtmlTag}{wxhtmltag}
+for details.)

 
 

-\constfunc{wxFileSystem*}{GetFS}{\void}
+Default (wxHtmlParser) behaviour is this:
+First it finds a handler capable of handling this tag and then it calls
+handler's HandleTag method.

 
 

-Returns pointer to the file system. Because each tag handler has
-reference to it's parent parser it can easily request the file by
-calling
+\membersection{wxHtmlParser::AddTagHandler}\label{wxhtmlparseraddtaghandler}

 
 

-\begin{verbatim}
-wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg");
-\end{verbatim}
+\func{virtual void}{AddTagHandler}{\param{wxHtmlTagHandler }{*handler}}

 
 

-\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse}
+Adds handler to the internal list (\& hash table) of handlers. This
+method should not be called directly by user but rather by derived class'
+constructor.

 
 

-\func{wxObject*}{Parse}{\param{const wxString\& }{source}}
+This adds the handler to this {\bf instance} of wxHtmlParser, not to
+all objects of this class! (Static front-end to AddTagHandler is provided
+by wxHtmlWinParser).

 
 

-Proceeds parsing of the document. This is end-user method. You can simply
-call it when you need to obtain parsed output (which is parser-specific)
+All handlers are deleted on object deletion.

 
 

-The method does these things:
+\membersection{wxHtmlParser::AddText}\label{wxhtmlparseraddword}

 
 

-\begin{enumerate}
-\item calls \helpref{InitParser(source)}{wxhtmlparserinitparser}
-\item calls \helpref{DoParsing}{wxhtmlparserdoparsing}
-\item calls \helpref{GetProduct}{wxhtmlparsergetproduct}
-\item calls \helpref{DoneParser}{wxhtmlparserdoneparser}
-\item returns value returned by GetProduct
-\end{enumerate}
+\func{virtual void}{AddWord}{\param{const char* }{txt}}

 
 

-You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly.
+Must be overwriten in derived class.

 
 

-\membersection{wxHtmlParser::InitParser}\label{wxhtmlparserinitparser}
+This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing}
+each time a part of text is parsed. {\it txt} is NOT only one word, it is
+substring of input. It is not formatted or preprocessed (so white spaces are
+unmodified).

 
 

-\func{virtual void}{InitParser}{\param{const wxString\& }{source}}
+\membersection{wxHtmlParser::DoParsing}\label{wxhtmlparserdoparsing}

 
 

-Setups the parser for parsing the {\it source} string. (Should be overriden
-in derived class)
+\func{void}{DoParsing}{\param{int }{begin\_pos}, \param{int }{end\_pos}}
+
+\func{void}{DoParsing}{\void}
+
+Parses the m\_Source from begin\_pos to end\_pos-1.
+(in noparams version it parses whole m\_Source)

 
 \membersection{wxHtmlParser::DoneParser}\label{wxhtmlparserdoneparser}
 
 
 \membersection{wxHtmlParser::DoneParser}\label{wxhtmlparserdoneparser}
 


@@ -92,14 +94,17 @@ in derived class)
 
 This must be called after DoParsing().
 
 
 This must be called after DoParsing().
 

-\membersection{wxHtmlParser::DoParsing}\label{wxhtmlparserdoparsing}
+\membersection{wxHtmlParser::GetFS}\label{wxhtmlparsergetfs}

 
 

-\func{void}{DoParsing}{\param{int }{begin\_pos}, \param{int }{end\_pos}}
+\constfunc{wxFileSystem*}{GetFS}{\void}

 
 

-\func{void}{DoParsing}{\void}
+Returns pointer to the file system. Because each tag handler has
+reference to it's parent parser it can easily request the file by
+calling

 
 

-Parses the m\_Source from begin\_pos to end\_pos-1.
-(in noparams version it parses whole m\_Source)
+\begin{verbatim}
+wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg");
+\end{verbatim}

 
 \membersection{wxHtmlParser::GetProduct}\label{wxhtmlparsergetproduct}
 
 
 \membersection{wxHtmlParser::GetProduct}\label{wxhtmlparsergetproduct}
 


@@ -111,20 +116,6 @@ representation in derived parser (but it must be derived from wxObject!).
 
 See wxHtmlWinParser for details.
 
 
 See wxHtmlWinParser for details.
 

-\membersection{wxHtmlParser::AddTagHandler}\label{wxhtmlparseraddtaghandler}
-
-\func{virtual void}{AddTagHandler}{\param{wxHtmlTagHandler }{*handler}}
-
-Adds handler to the internal list (\& hash table) of handlers. This
-method should not be called directly by user but rather by derived class'
-constructor.
-
-This adds the handler to this {\bf instance} of wxHtmlParser, not to
-all objects of this class! (Static front-end to AddTagHandler is provided
-by wxHtmlWinParser).
-
-All handlers are deleted on object deletion.
-

 \membersection{wxHtmlParser::GetSource}\label{wxhtmlparsergetsource}
 
 \func{wxString*}{GetSource}{\void}
 \membersection{wxHtmlParser::GetSource}\label{wxhtmlparsergetsource}
 
 \func{wxString*}{GetSource}{\void}


@@ -157,28 +148,37 @@ must exist as long as the window is displaying text.
 
 GetTempData() solves the problem.
 
 
 GetTempData() solves the problem.
 

-\membersection{wxHtmlParser::AddText}\label{wxhtmlparseraddword}
+\membersection{wxHtmlParser::InitParser}\label{wxhtmlparserinitparser}

 
 

-\func{virtual void}{AddWord}{\param{const char* }{txt}}
+\func{virtual void}{InitParser}{\param{const wxString\& }{source}}

 
 

-Must be overwriten in derived class.
+Setups the parser for parsing the {\it source} string. (Should be overriden
+in derived class)

 
 

-This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing}
-each time a part of text is parsed. {\it txt} is NOT only one word, it is
-substring of input. It is not formatted or preprocessed (so white spaces are
-unmodified).
+\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse}

 
 

-\membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag}
+\func{wxObject*}{Parse}{\param{const wxString\& }{source}}

 
 

-\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}}
+Proceeds parsing of the document. This is end-user method. You can simply
+call it when you need to obtain parsed output (which is parser-specific)

 
 

-This may (and may not) be overwriten in derived class.
+The method does these things:

 
 

-This method is called each time new tag is about to be added. 
-{\it tag} contains information about the tag. (See \helpref{wxHtmlTag}{wxhtmltag}
-for details.)
+\begin{enumerate}
+\item calls \helpref{InitParser(source)}{wxhtmlparserinitparser}
+\item calls \helpref{DoParsing}{wxhtmlparserdoparsing}
+\item calls \helpref{GetProduct}{wxhtmlparsergetproduct}
+\item calls \helpref{DoneParser}{wxhtmlparserdoneparser}
+\item returns value returned by GetProduct
+\end{enumerate}

 
 

-Default (wxHtmlParser) behaviour is this:
-First it finds a handler capable of handling this tag and then it calls
-handler's HandleTag method.
+You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly.
+
+\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
+
+\func{void}{SetFS}{\param{wxFileSystem }{*fs}}
+
+Sets the virtual file system that will be used to request additional
+files. (For example {\tt <IMG>} tag handler requests wxFSFile with the
+image data.)

 
 

diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex
index 04ce4fb345e001941798e2629c9b0da523439edb..12bacbb8083b8203364bced654347b16bcd1e735 100644 (file)
--- a/docs/latex/wx/httag.tex
+++ b/docs/latex/wx/httag.tex
@@ -22,25 +22,61 @@ Constructor. You'll probably never have to construct wxHtmlTag object
 yourself. Feel free to ignore the constructor parameters...
 (have a look at lib/htmlparser.cpp if you're interested in creating it)
 
 yourself. Feel free to ignore the constructor parameters...
 (have a look at lib/htmlparser.cpp if you're interested in creating it)
 

-\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}
+\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams}

 
 

-\constfunc{wxString}{GetName}{\void}
+\constfunc{const wxString\&}{GetAllParams}{\void}

 
 

-Returns tag's name. The name is always in uppercase and it doesn't contain
-'<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
-and name of {\tt </table>} is "TABLE")
+Returns string with all params. 

 
 

-\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam}
+Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
+tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.

 
 

-\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}
+\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}

 
 

-Returns TRUE if the tag has parameter of the given name. 
-Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
-"SIZE" and "COLOR".
+\constfunc{int}{GetBeginPos}{\void}

 
 

-\wxheading{Parameters}
+Returns beginning position of the text {\it between} this tag and paired
+ending tag. 
+See explanation (returned position is marked with '^'):

 
 

-\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!}
+\begin{verbatim}
+bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+                   ^
+\end{verbatim}
+
+\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}
+
+\constfunc{int}{GetEndPos1}{\void}
+
+Returns ending position of the text {\it between} this tag and paired
+ending tag.
+See explanation (returned position is marked with '^'):
+
+\begin{verbatim}
+bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+                                        ^
+\end{verbatim}
+
+\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
+
+\constfunc{int}{GetEndPos2}{\void}
+
+Returns ending position 2 of the text {\it between} this tag and paired
+ending tag.
+See explanation (returned position is marked with '^'):
+
+\begin{verbatim}
+bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+                                               ^
+\end{verbatim}
+
+\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}
+
+\constfunc{wxString}{GetName}{\void}
+
+Returns tag's name. The name is always in uppercase and it doesn't contain
+'<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
+and name of {\tt </table>} is "TABLE")

 
 \membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
 
 
 \membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
 


@@ -69,44 +105,6 @@ dummy = tag.GetParam("COLOR", TRUE);
    // dummy == "\"#0000FF\"" -- see the difference!!
 \end{verbatim}
 
    // dummy == "\"#0000FF\"" -- see the difference!!
 \end{verbatim}
 

-\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
-
-\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}
-
-This method scans given parameter. Usage is exatly the same as sscanf's 
-usage except that you don't pass string but param name as the first parameter.
-
-\wxheading{Parameters}
-
-\docparam{par}{The name of tag you wanna query (in uppercase)}
-
-\docparam{format}{scanf()-like format string.}
-
-\wxheading{Cygwin and Mingw32}
-
-If you're using Cygwin beta 20 or Mingw32 compiler please remember
-that ScanParam() is only partially implemented!! The problem is
-that under Cygnus' GCC vsscanf() function is not implemented. I workarounded
-this in a way which causes that you can use only one parameter in ...
-(and only one \% in {\it format})
-
-\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams}
-
-\constfunc{const wxString\&}{GetAllParams}{\void}
-
-Returns string with all params. 
-
-Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
-tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.
-
-\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}
-
-\constfunc{bool}{IsEnding}{\void}
-
-Returns TRUE if this tag is ending one.
-({\tt </FONT>} is ending tag, {\tt <FONT>} is not)
-
-

 \membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}
 
 \constfunc{bool}{HasEnding}{\void}
 \membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}
 
 \constfunc{bool}{HasEnding}{\void}


@@ -128,42 +126,44 @@ In this example tags HTML and BODY have ending tags, first P and BR
 doesn't have ending tag while the second P has. The third P tag (which
 is ending itself) of course doesn't have ending tag.
 
 doesn't have ending tag while the second P has. The third P tag (which
 is ending itself) of course doesn't have ending tag.
 

-\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}
+\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam}

 
 

-\constfunc{int}{GetBeginPos}{\void}
+\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}

 
 

-Returns beginning position of the text {\it between} this tag and paired
-ending tag. 
-See explanation (returned position is marked with '^'):
+Returns TRUE if the tag has parameter of the given name. 
+Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
+"SIZE" and "COLOR".

 
 

-\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
-                   ^
-\end{verbatim}
+\wxheading{Parameters}

 
 

-\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}
+\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!}

 
 

-\constfunc{int}{GetEndPos1}{\void}
+\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}

 
 

-Returns ending position of the text {\it between} this tag and paired
-ending tag.
-See explanation (returned position is marked with '^'):
+\constfunc{bool}{IsEnding}{\void}

 
 

-\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
-                                        ^
-\end{verbatim}
+Returns TRUE if this tag is ending one.
+({\tt </FONT>} is ending tag, {\tt <FONT>} is not)

 
 

-\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}

 
 

-\constfunc{int}{GetEndPos2}{\void}
+\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}

 
 

-Returns ending position 2 of the text {\it between} this tag and paired
-ending tag.
-See explanation (returned position is marked with '^'):
+\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}

 
 

-\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
-                                               ^
-\end{verbatim}
+This method scans given parameter. Usage is exatly the same as sscanf's 
+usage except that you don't pass string but param name as the first parameter.
+
+\wxheading{Parameters}
+
+\docparam{par}{The name of tag you wanna query (in uppercase)}
+
+\docparam{format}{scanf()-like format string.}
+
+\wxheading{Cygwin and Mingw32}
+
+If you're using Cygwin beta 20 or Mingw32 compiler please remember
+that ScanParam() is only partially implemented!! The problem is
+that under Cygnus' GCC vsscanf() function is not implemented. I workarounded
+this in a way which causes that you can use only one parameter in ...
+(and only one \% in {\it format})

 
 

diff --git a/docs/latex/wx/httaghnd.tex b/docs/latex/wx/httaghnd.tex
index 12e1a0cfb331c539fd7e32229aa09c9ecb2120fd..28877fb0447126940e0c2a4407718f01a9021770 100644 (file)
--- a/docs/latex/wx/httaghnd.tex
+++ b/docs/latex/wx/httaghnd.tex
@@ -29,13 +29,6 @@ it can't be accessed by user but can be accessed from derived classes.
 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser}
-
-\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}}
-
-Assigns {\it parser} to this handler. Each {\bf instance} of handler 
-is guaranteed to be called only from the parser.
-

 \membersection{wxHtmlTagHandler::GetSupportedTags}\label{wxhtmltaghandlergetsupportedtags}
 
 \func{virtual wxString}{GetSupportedTags}{\void}
 \membersection{wxHtmlTagHandler::GetSupportedTags}\label{wxhtmltaghandlergetsupportedtags}
 
 \func{virtual wxString}{GetSupportedTags}{\void}


@@ -85,3 +78,10 @@ for the string between this tag and paired ending tag:
 In this example, a call to ParseInner (with {\it tag} pointing to A tag)
 will parse 'Hello, world!'.
 
 In this example, a call to ParseInner (with {\it tag} pointing to A tag)
 will parse 'Hello, world!'.
 

+\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser}
+
+\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}}
+
+Assigns {\it parser} to this handler. Each {\bf instance} of handler 
+is guaranteed to be called only from the parser.
+

diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex
index 912719fa2f500ef4d5d8c10d03a15d3e51012439..361290ed339e240d71752e0689d7860b275fbe61 100644 (file)
--- a/docs/latex/wx/htwindow.tex
+++ b/docs/latex/wx/htwindow.tex
@@ -41,27 +41,59 @@ Constructor. The parameters are same as in wxScrollWindow ctor.
 \docparam{style}{wxHW\_SCROLLBAR\_NEVER,  or wxHW\_SCROLLBAR\_AUTO. 
 Affects appearance of vertical scrollbar in the window.}
 
 \docparam{style}{wxHW\_SCROLLBAR\_NEVER,  or wxHW\_SCROLLBAR\_AUTO. 
 Affects appearance of vertical scrollbar in the window.}
 

-\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
+\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}

 
 

-\func{bool}{SetPage}{\param{const wxString\& }{source}}
+\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}

 
 

-Sets HTML page and display it. This won't {\bf load} the page!!
-It will display the {\it source}. See example:
+Adds \helpref{input filter}{filters} to the static list of available
+filters. These filters are present by default:

 
 

-\begin{verbatim}
-htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
-\end{verbatim}
+\begin{itemize}
+\item {\tt text/html} MIME type
+\item {\tt image/*} MIME types
+\item Plain Text filter (this filter is used if no other filter matches)
+\end{itemize}

 
 

-If you want to load document from some location use
-\helpref{LoadPage}{wxhtmlwindowloadpage} instead.
+\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}

 
 

-\wxheading{Parameters}
+\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}

 
 

-\docparam{source}{The HTML document source to be displayed.}
+Returns pointer to the top-level container.

 
 

-\wxheading{Return value}
+See also: \helpref{Cells Overview}{cells}, 
+\helpref{Printing Overview}{printing}

 
 

-FALSE if an error occured, TRUE otherwise
+\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
+
+\func{wxString}{GetOpenedPage}{\void}
+
+Returns full location of the opened page. If no page is opened or if the displayed page wasn't
+produced by call to LoadPage, empty string is returned.
+
+\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
+
+\constfunc{wxFrame*}{GetRelatedFrame}{\void}
+
+Returns the related frame.
+
+\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
+
+\func{bool}{HistoryBack}{\void}
+
+Moves back to the previous page. (each page displayed using 
+\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
+
+\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
+
+\func{void}{HistoryClear}{\void}
+
+Clears history.
+
+\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
+
+\func{bool}{HistoryForward}{\void}
+
+Moves to next page in history.

 
 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 
 
 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 


@@ -82,38 +114,40 @@ htmlwin -> SetPage("help/myproject/index.htm");
 
 FALSE if an error occured, TRUE otherwise
 
 
 FALSE if an error occured, TRUE otherwise
 

-\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
+\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}

 
 

-\func{wxString}{GetOpenedPage}{\void}
+\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}}

 
 

-Returns full location of the opened page. If no page is opened or if the displayed page wasn't
-produced by call to LoadPage, empty string is returned.
+Called when user clicks on hypertext link. Default behaviour is to call 
+\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.

 
 

-\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
+\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}

 
 

-\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
+\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}

 
 

-Sets frame in which page title will be displayed. {\it format} is format of
-frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
-\%s is substituted with HTML page title.
+This reads custom settings from wxConfig. It uses the path 'path'
+if given, otherwise it saves info into currently selected path.
+The values are stored in sub-path {\tt wxHtmlWindow}

 
 

-\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
+Read values : all things set by SetFonts, SetBorders.

 
 

-\constfunc{wxFrame*}{GetRelatedFrame}{\void}
+\wxheading{Parameters}

 
 

-Returns the related frame.
+\docparam{cfg}{wxConfig from which you wanna read configuration}

 
 

-\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
+\docparam{path}{Optional path in config tree. If not given current path is used.}

 
 

-\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
+\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}

 
 

-{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
-this sets statusbar slot where messages will be displayed.
-(Default is -1 = no messages.)
+\func{void}{SetBorders}{\param{int }{b}}
+
+This function sets the space between border of window and HTML contents. See image:
+
+\image{}{border.bmp}

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{bar}{statusbar slot number (0..n)}
+\docparam{b}{indentation from borders in pixels}

 
 \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
 
 
 \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
 


@@ -159,33 +193,47 @@ Under Windows:
 Athough it seems different the fact is that the fonts are of approximately
 same size under both platforms (due to wxMSW / wxGTK inconsistency)
 
 Athough it seems different the fact is that the fonts are of approximately
 same size under both platforms (due to wxMSW / wxGTK inconsistency)
 

-\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
+\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}

 
 

-\func{void}{SetBorders}{\param{int }{b}}
+\func{bool}{SetPage}{\param{const wxString\& }{source}}

 
 

-This function sets the space between border of window and HTML contents. See image:
+Sets HTML page and display it. This won't {\bf load} the page!!
+It will display the {\it source}. See example:

 
 

-\image{}{border.bmp}
+\begin{verbatim}
+htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
+\end{verbatim}
+
+If you want to load document from some location use
+\helpref{LoadPage}{wxhtmlwindowloadpage} instead.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{b}{indentation from borders in pixels}
+\docparam{source}{The HTML document source to be displayed.}

 
 

-\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
+\wxheading{Return value}

 
 

-\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
+FALSE if an error occured, TRUE otherwise

 
 

-This reads custom settings from wxConfig. It uses the path 'path'
-if given, otherwise it saves info into currently selected path.
-The values are stored in sub-path {\tt wxHtmlWindow}
+\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}

 
 

-Read values : all things set by SetFonts, SetBorders.
+\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}

 
 

-\wxheading{Parameters}
+Sets frame in which page title will be displayed. {\it format} is format of
+frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
+\%s is substituted with HTML page title.

 
 

-\docparam{cfg}{wxConfig from which you wanna read configuration}
+\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}

 
 

-\docparam{path}{Optional path in config tree. If not given current path is used.}
+\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
+
+{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
+this sets statusbar slot where messages will be displayed.
+(Default is -1 = no messages.)
+
+\wxheading{Parameters}
+
+\docparam{bar}{statusbar slot number (0..n)}

 
 \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
 
 
 \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
 


@@ -205,51 +253,3 @@ Saved values : all things set by SetFonts, SetBorders.
 \docparam{path}{Optional path in config tree. If not given current path is used.}
 
 
 \docparam{path}{Optional path in config tree. If not given current path is used.}
 
 

-\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
-
-\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
-
-Returns pointer to the top-level container.
-
-See also: \helpref{Cells Overview}{cells}, 
-\helpref{Printing Overview}{printing}
-
-\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
-
-\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
-
-Adds \helpref{input filter}{filters} to the static list of available
-filters. These filters are present by default:
-
-\begin{itemize}
-\item {\tt text/html} MIME type
-\item {\tt image/*} MIME types
-\item Plain Text filter (this filter is used if no other filter matches)
-\end{itemize}
-
-\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
-
-\func{bool}{HistoryBack}{\void}
-
-Moves back to the previous page. (each page displayed using 
-\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
-
-\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
-
-\func{bool}{HistoryForward}{\void}
-
-Moves to next page in history.
-
-\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
-
-\func{void}{HistoryClear}{\void}
-
-Clears history.
-
-\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
-
-\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}}
-
-Called when user clicks on hypertext link. Default behaviour is to call 
-\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
-

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 6bb22d25c6c099f262ef44b8f6a519c78e9ee1ac..26c538b3926107309ba822a459ed4e327476ec6a 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -37,56 +37,65 @@ its mail goal is to parse HTML input so that it can be displayed in
 Constructor. Don't use the default one, use constructor with
 {\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
 
 Constructor. Don't use the default one, use constructor with
 {\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
 

-\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
+\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}

 
 

-\func{virtual void}{SetDC}{\param{wxDC }{*dc}}
+\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}

 
 

-Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
+Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.

 
 

-\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}
+\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer}

 
 

-\func{wxDC*}{GetDC}{\void}
+\func{wxHtmlContainerCell*}{CloseContainer}{\void}

 
 

-Returns pointer to the DC used during parsing.
+Closes the container, sets actual container to the parent one
+and returns pointer to it (see \helpref{Overview}{cells}).

 
 

-\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}
+\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}

 
 

-\constfunc{int}{GetCharHeight}{\void}
+\func{virtual wxFont*}{CreateCurrentFont}{\void}

 
 

-Returns (average) char height in standard font. It's used as DC-independent metrics.
+Creates font based on current setting (see 
+\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
+\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
+\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
+\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
+\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
+and returns pointer to it.
+(If the font was already created only a pointer is returned.)

 
 

-{\bf Note:} This function doesn't return {\it actual} height. If you wanna
-know height of current font, call {\tt GetDC -> GetCharHeight()}
+Fonts created during parsing are temporary data and are not freed on DoneParser. 
+You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata}
+to free the memory!

 
 

-\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
+\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}

 
 

-\constfunc{int}{GetCharWidth}{\void}
+\constfunc{const wxColour\&}{GetActualColor}{\void}

 
 

-Returns average char width in standard font. It's used as DC-independent metrics.
+Returns actual text color.

 
 

-{\bf Note:} This function doesn't return {\it actual} width. If you wanna
-know height of current font, call {\tt GetDC -> GetCharWidth()}
+\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}

 
 

-\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
+\constfunc{int}{GetAlign}{\void}

 
 

-\func{wxWindow*}{GetWindow}{\void}
+Returns default horizontal alignment.

 
 

-Returns associated window (wxHtmlWindow). This may be NULL! (You should always
-test if it is non-NULL. For example {\tt TITLE} handler sets window
-title only if some window is associated, otherwise it does nothing)
+\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}

 
 

+\constfunc{int}{GetCharHeight}{\void}

 
 

-\membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
+Returns (average) char height in standard font. It's used as DC-independent metrics.

 
 

-\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}}
+{\bf Note:} This function doesn't return {\it actual} height. If you wanna
+know height of current font, call {\tt GetDC -> GetCharHeight()}

 
 

-Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
+\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}

 
 

-\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
+\constfunc{int}{GetCharWidth}{\void}

 
 

-\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}
+Returns average char width in standard font. It's used as DC-independent metrics.

 
 

-Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
+{\bf Note:} This function doesn't return {\it actual} width. If you wanna
+know height of current font, call {\tt GetDC -> GetCharWidth()}

 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 
 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 


@@ -99,39 +108,11 @@ Common use:
 m_WParser -> GetContainer() -> InsertCell(new ...);
 \end{verbatim}
 
 m_WParser -> GetContainer() -> InsertCell(new ...);
 \end{verbatim}
 

-\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
-
-\func{wxHtmlContainerCell*}{OpenContainer}{\void}
-
-Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
-
-%
-%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
-%
-%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
-%
-%Allows you to directly set opened container. This is not recommended - you should use OpenContainer
-%whereever possible.
-%
-
-\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer}
-
-\func{wxHtmlContainerCell*}{CloseContainer}{\void}
-
-Closes the container, sets actual container to the parent one
-and returns pointer to it (see \helpref{Overview}{cells}).
-
-\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
-
-\constfunc{int}{GetFontSize}{\void}
-
-Returns actual font size (HTML size varies from -2 to +4)
-
-\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
+\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}

 
 

-\func{void}{SetFontSize}{\param{int }{s}}
+\func{wxDC*}{GetDC}{\void}

 
 

-Sets actual font size (HTML size varies from -2 to +4)
+Returns pointer to the DC used during parsing.

 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 


@@ -139,11 +120,11 @@ Sets actual font size (HTML size varies from -2 to +4)
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 

-\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
+\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}

 
 

-\func{void}{SetFontBold}{\param{int }{x}}
+\constfunc{int}{GetFontFixed}{\void}

 
 

-Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns TRUE if actual font is fixed face, FALSE otherwise.

 
 \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic}
 
 
 \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic}
 


@@ -152,11 +133,11 @@ Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
 Returns TRUE if actual font is italic, FALSE otherwise.
 
 
 Returns TRUE if actual font is italic, FALSE otherwise.
 
 

-\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}
+\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}

 
 

-\func{void}{SetFontItalic}{\param{int }{x}}
+\constfunc{int}{GetFontSize}{\void}

 
 

-Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns actual font size (HTML size varies from -2 to +4)

 
 \membersection{wxHtmlWinParser::GetFontUnderlined}\label{wxhtmlwinparsergetfontunderlined}
 
 
 \membersection{wxHtmlWinParser::GetFontUnderlined}\label{wxhtmlwinparsergetfontunderlined}
 


@@ -164,29 +145,43 @@ Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 

-\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
+\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}

 
 

-\func{void}{SetFontUnderlined}{\param{int }{x}}
+\constfunc{const wxString\&}{GetLink}{\void}

 
 

-Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns actual hypertext link. (This value is non-empty string
+if the parser is between {\tt <A>} and {\tt </A>} tags,
+wxEmptyString otherwise.

 
 

-\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}

 
 

-\constfunc{int}{GetFontFixed}{\void}
+\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}

 
 

-Returns TRUE if actual font is fixed face, FALSE otherwise.
+\constfunc{const wxColour\&}{GetLinkColor}{\void}

 
 

-\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
+Returns color of hypertext link text.

 
 

-\func{void}{SetFontFixed}{\param{int }{x}}
+\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}

 
 

-Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
+\func{wxWindow*}{GetWindow}{\void}

 
 

-\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
+Returns associated window (wxHtmlWindow). This may be NULL! (You should always
+test if it is non-NULL. For example {\tt TITLE} handler sets window
+title only if some window is associated, otherwise it does nothing)

 
 

-\constfunc{int}{GetAlign}{\void}

 
 

-Returns default horizontal alignment.
+\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
+
+\func{wxHtmlContainerCell*}{OpenContainer}{\void}
+
+Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
+
+%
+\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
+
+\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
+
+Sets actual text color. Note: this DOESN'T change the color! 
+You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.

 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 


@@ -195,39 +190,55 @@ Returns default horizontal alignment.
 Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
 Alignment of newly opened container is set to this value.
 
 Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
 Alignment of newly opened container is set to this value.
 

-\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
+%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
+%
+%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
+%
+%Allows you to directly set opened container. This is not recommended - you should use OpenContainer
+%whereever possible.
+%

 
 

-\constfunc{const wxColour\&}{GetLinkColor}{\void}
+\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}

 
 

-Returns color of hypertext link text.
+\func{virtual void}{SetDC}{\param{wxDC }{*dc}}

 
 

-\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
+Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!

 
 

-\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
+\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}

 
 

-Sets color of hypertext link.
+\func{void}{SetFontBold}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
+Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\constfunc{const wxColour\&}{GetActualColor}{\void}
+\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}

 
 

-Returns actual text color.
+\func{void}{SetFontFixed}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
+Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
+\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}

 
 

-Sets actual text color. Note: this DOESN'T change the color! 
-You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
+\func{void}{SetFontItalic}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
+Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\constfunc{const wxString\&}{GetLink}{\void}
+\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}

 
 

-Returns actual hypertext link. (This value is non-empty string
-if the parser is between {\tt <A>} and {\tt </A>} tags,
-wxEmptyString otherwise.
+\func{void}{SetFontSize}{\param{int }{s}}
+
+Sets actual font size (HTML size varies from -2 to +4)
+
+\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
+
+\func{void}{SetFontUnderlined}{\param{int }{x}}
+
+Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
+
+\membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}

 
 

+\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}}
+
+Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}

 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 
 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 


@@ -235,20 +246,9 @@ wxEmptyString otherwise.
 
 Sets actual hypertext link. wxEmptyString means no link.
 
 
 Sets actual hypertext link. wxEmptyString means no link.
 

-\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}
-
-\func{virtual wxFont*}{CreateCurrentFont}{\void}
+\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}

 
 

-Creates font based on current setting (see 
-\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
-\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
-\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
-\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
-\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
-and returns pointer to it.
-(If the font was already created only a pointer is returned.)
+\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}

 
 

-Fonts created during parsing are temporary data and are not freed on DoneParser. 
-You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata}
-to free the memory!
+Sets color of hypertext link.