Cured some bugs/typos/spacing in docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3296 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
parent
e70f5e1301
commit
22d6efa851
@ -30,6 +30,5 @@ None
|
||||
|
||||
\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}}
|
||||
|
||||
Constructs a busy info object, displays {\it msg} .
|
||||
|
||||
Constructs a busy info object, displays {\it msg}.
|
||||
|
||||
|
||||
@ -172,3 +172,4 @@ Writes the double {\it f} to the stream using the IEEE format.
|
||||
|
||||
Writes {\it string} to the stream. Actually, this method writes the size of
|
||||
the string before writing {\it string} itself.
|
||||
|
||||
|
||||
@ -349,4 +349,3 @@ The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialo
|
||||
\helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
|
||||
\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% filesystem.tex at 21/Mar/99 23:00:52
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxFileSystem}}\label{wxfilesystem}
|
||||
|
||||
This class provides interface for opening files on different
|
||||
@ -21,10 +20,8 @@ wxObject
|
||||
\helpref{wxFSFile}{wxfsfile},
|
||||
\helpref{Overview}{fs}
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxFileSystem::wxFileSystem}\label{wxfilesystemwxfilesystem}
|
||||
|
||||
\func{}{wxFileSystem}{\void}
|
||||
@ -63,14 +60,12 @@ fs -> ChangePathTo("subdir/folder", TRUE);
|
||||
f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath}
|
||||
|
||||
\func{wxString}{GetPath}{\void}
|
||||
|
||||
Returns actual path (set by \helpref{ChangePathTo}{wxfilesystemchangepathto}).
|
||||
|
||||
|
||||
\membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
|
||||
|
||||
\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
|
||||
@ -80,7 +75,6 @@ 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.
|
||||
|
||||
|
||||
\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler}
|
||||
|
||||
\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}}
|
||||
@ -90,12 +84,13 @@ The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS.
|
||||
|
||||
\wxheading{Note}
|
||||
|
||||
You can call
|
||||
You can call:
|
||||
|
||||
\begin{verbatim}
|
||||
wxFileSystem::AddHandler(new My_FS_Handler);
|
||||
\end{verbatim}
|
||||
|
||||
This is because a) AddHandler is static method and b) the handlers
|
||||
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.
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% filesystemhandler.tex at 21/Mar/99 23:00:52
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxFileSystemHandler}}\label{wxfilesystemhandler}
|
||||
|
||||
wxFileSystemHandler (or derived classes to be exact) is used
|
||||
@ -17,7 +16,6 @@ GetAnchor, GetMimeTypeFromExt.
|
||||
Please have a look at \helpref{overview}{fs} if you don't know how locations
|
||||
are constructed.
|
||||
|
||||
|
||||
\wxheading{Notes}
|
||||
|
||||
\begin{itemize}
|
||||
@ -39,7 +37,6 @@ wxObject
|
||||
\helpref{wxFSFile}{wxfsfile},
|
||||
\helpref{Overview}{fs}
|
||||
|
||||
|
||||
\membersection{wxFileSystemHandler::wxFileSystemHandler}\label{wxfilesystemhandlerwxfilesystemhandler}
|
||||
|
||||
\func{}{wxFileSystemHandler}{\void}
|
||||
@ -78,15 +75,13 @@ for details how to use it.}
|
||||
|
||||
\docparam{location}{The {\bf absolute} location of file.}
|
||||
|
||||
|
||||
|
||||
\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"
|
||||
Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
|
||||
|
||||
\membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation}
|
||||
|
||||
@ -94,8 +89,7 @@ Example : GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
|
||||
|
||||
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}
|
||||
|
||||
@ -116,7 +110,6 @@ Returns right location string extracted from {\it location}.
|
||||
|
||||
Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
|
||||
|
||||
|
||||
\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}
|
||||
|
||||
\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
|
||||
|
||||
@ -10,14 +10,12 @@ were a local directory...)
|
||||
|
||||
Three classes are used in order to provide full VFS:
|
||||
|
||||
\begin{itemize}
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item The \helpref{wxFSFile}{wxfsfile} class provides information
|
||||
on opened file (name, input stream, mime type and anchor).
|
||||
|
||||
\item The \helpref{wxFileSystem}{wxfilesystem} class is the interface.
|
||||
Its main methods are ChangePathTo() and OpenFile(). This class
|
||||
is most often used by the end user.
|
||||
|
||||
\item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core
|
||||
if VFS mechanism. You can derive your own handler and pass it to
|
||||
wxFileSystem's AddHandler() method. In the new handler you only need to
|
||||
@ -28,16 +26,13 @@ overwrite OpenFile() and CanOpen() methods.
|
||||
|
||||
Locations (aka filenames aka addresses) are constructed from 4 parts:
|
||||
|
||||
\begin{itemize}
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item {\bf protocol} - handler can recognize if it is able to open a
|
||||
file by checking its protocol. Examples are "http", "file" or "ftp".
|
||||
|
||||
\item {\bf right location} - is the name of file within the protocol.
|
||||
In "http://www.wxwindows.org/index.html" the right location is "//www.wxwindows.org/index.html".
|
||||
|
||||
\item {\bf anchor} - anchor is optional and is usually not present.
|
||||
In "index.htm\#chapter2" the anchor is "chapter2".
|
||||
|
||||
\item {\bf left location} - this is usually an empty string.
|
||||
It is used by 'local' protocols such as ZIP.
|
||||
See Combined Protocols paragraph for details.
|
||||
@ -66,7 +61,7 @@ which is at WWW.
|
||||
|
||||
\wxheading{File Systems Included in wxHTML}
|
||||
|
||||
\begin{enumerate}
|
||||
\begin{enumerate}\itemsep=0pt
|
||||
\item Local files
|
||||
\item HTTP protocol
|
||||
\item FTP protocol
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% fsfile.tex at 21/Mar/99 23:00:52
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxFSFile}}\label{wxfsfile}
|
||||
|
||||
This class represents single file opened by \helpref{wxFileSystem}{wxfilesystem}.
|
||||
@ -101,7 +100,6 @@ file:/home/vasek/index.htm
|
||||
relative-file.htm
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
|
||||
|
||||
\constfunc{const wxString\&}{GetAnchor}{\void}
|
||||
@ -120,3 +118,4 @@ 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)
|
||||
|
||||
|
||||
@ -3,19 +3,17 @@
|
||||
% htmlcell.tex at 21/Mar/99 22:45:23
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlCell}}\label{wxhtmlcell}
|
||||
|
||||
Internal data structure. It represents fragments of parsed HTML
|
||||
page, so-called {\bf cell} - a word, picture, table, horizontal line and so on.
|
||||
It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and
|
||||
It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and
|
||||
\helpref{wxHtmlWinParser}{wxhtmlwinparser} to represent HTML page in memory.
|
||||
|
||||
You can divide cells into two groups : {\it visible} cells with non-zero width and
|
||||
height and {\it helper} cells (usually with zero width and height) that
|
||||
perform special actions such as color or font change.
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
wxObject
|
||||
@ -23,18 +21,16 @@ wxObject
|
||||
\wxheading{See Also}
|
||||
|
||||
\helpref{Cells Overview}{cells},
|
||||
\helpref{wxHtmlContainerCell}{wxhtmlcontainercell},
|
||||
\helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlCell::wxHtmlCell}\label{wxhtmlcellwxhtmlcell}
|
||||
|
||||
\func{}{wxHtmlCell}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
|
||||
|
||||
\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}}
|
||||
@ -110,7 +106,6 @@ interested in details).
|
||||
|
||||
Sets cell's position within parent container.
|
||||
|
||||
|
||||
\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
|
||||
|
||||
\func{void}{SetLink}{\param{const wxString\& }{link}}
|
||||
@ -179,7 +174,6 @@ or font setter) must be drawn even if they are invisible!
|
||||
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}}
|
||||
@ -208,11 +202,8 @@ HTML_COND_ISANCHOR condition)
|
||||
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}}
|
||||
|
||||
This function is simple event handler. Each time user clicks mouse button over a cell
|
||||
@ -233,6 +224,3 @@ 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}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% htmlcolourcell.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlColourCell}}\label{wxhtmlcolourcell}
|
||||
|
||||
This cell changes color of either background or foreground.
|
||||
@ -12,10 +11,8 @@ This cell changes color of either background or foreground.
|
||||
|
||||
\helpref{wxHtmlCell}{wxhtmlcell}
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlColourCell::wxHtmlColourCell}\label{wxhtmlcolourcellwxhtmlcolourcell}
|
||||
|
||||
\func{}{wxHtmlColourCell}{\param{wxColour }{clr}, \param{int }{flags = HTML\_CLR\_FOREGROUND}}
|
||||
@ -33,6 +30,5 @@ Constructor.
|
||||
\twocolitem{{\bf HTML\_CLR\_BACKGROUND}}{change background color}
|
||||
|
||||
\end{twocollist}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@ -3,12 +3,10 @@
|
||||
% htmlcontainercell.tex at 21/Mar/99 22:45:23
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlContainerCell}}\label{wxhtmlcontainercell}
|
||||
|
||||
wxHtmlContainerCell class an implementation of cell that may
|
||||
contain more cells in it. It is heavily used in layouting algorithm.
|
||||
|
||||
wxHtmlContainerCell class an implementation of a cell that may
|
||||
contain more cells in it. It is heavily used in the wxHTML layout algorithm.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
@ -20,7 +18,6 @@ contain more cells in it. It is heavily used in layouting algorithm.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlContainerCell::wxHtmlContainerCell}\label{wxhtmlcontainercellwxhtmlcontainercell}
|
||||
|
||||
\func{}{wxHtmlContainerCell}{\param{wxHtmlContainerCell }{*parent}}
|
||||
@ -84,7 +81,6 @@ Sets container's {\it vertical alignment}. This is per-line alignment!
|
||||
|
||||
Returns container's vertical alignment.
|
||||
|
||||
|
||||
\membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
|
||||
|
||||
\func{void}{SetIndent}{\param{int }{i}, \param{int }{what}, \param{int }{units = HTML\_UNITS\_PIXELS}}
|
||||
@ -211,15 +207,12 @@ 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}}
|
||||
@ -232,8 +225,6 @@ Sets border (frame) colours. Border is rectangle around the container.
|
||||
|
||||
\docparam{clr2}{Color of bottom and right lines}
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell}
|
||||
|
||||
\func{wxHtmlCell*}{GetFirstCell}{\void}
|
||||
@ -242,9 +233,7 @@ 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 end user. If you need some way of
|
||||
{\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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% htmlfilter.tex at 29/Mar/99 18:35:09
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
|
||||
|
||||
This class is input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
|
||||
@ -19,7 +18,6 @@ wxObject
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
|
||||
|
||||
\func{}{wxHtmlFilter}{\void}
|
||||
@ -45,7 +43,6 @@ bool MyFilter::CanRead(const wxFSFile& file)
|
||||
|
||||
\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
|
||||
|
||||
|
||||
Reads the file and returns string with HTML document.
|
||||
|
||||
Example:
|
||||
|
||||
@ -3,10 +3,9 @@
|
||||
% htmlhelp.h at 02/May/99 19:58:53
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
|
||||
|
||||
{\bf WARNING! This help controller has API incompatible with wxWindows
|
||||
{\bf WARNING! This help controller has an API incompatible with wxWindows
|
||||
wxHelpController!}
|
||||
|
||||
This help controller provides easy way how to display HTML help in your
|
||||
@ -29,23 +28,18 @@ have following line in your .rc file:
|
||||
#include "wx/html/msw/wxhtml.rc"
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
wxEvtHandler
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
|
||||
|
||||
\func{}{wxHtmlHelpController}{\void}
|
||||
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
|
||||
|
||||
\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
|
||||
@ -53,7 +47,6 @@ Constructor.
|
||||
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}}
|
||||
@ -63,7 +56,6 @@ forms are much faster to read.) Default value is empty string (empty string mean
|
||||
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}}
|
||||
@ -73,7 +65,6 @@ This must be called at least once before displaying any help.
|
||||
|
||||
If {\it show_wait_msg} is TRUE then a decorationless window with progress message is displayed.
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
|
||||
|
||||
\func{void}{Display}{\param{const wxString\& }{x}}
|
||||
@ -104,9 +95,6 @@ Looking for the page runs in these steps:
|
||||
|
||||
This alternative form is used to search help contents by numeric IDs.
|
||||
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
|
||||
|
||||
\func{void}{DisplayContents}{\void}
|
||||
@ -119,7 +107,6 @@ Displays help window and focuses contents panel.
|
||||
|
||||
Displays help window and focuses index panel.
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
|
||||
|
||||
\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
|
||||
@ -130,7 +117,6 @@ 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...)
|
||||
|
||||
|
||||
\membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
|
||||
|
||||
\func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
|
||||
@ -142,14 +128,12 @@ reads and writes settings (including wxHtmlWindow's settings) when needed.
|
||||
|
||||
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}}
|
||||
|
||||
@ -1,16 +1,15 @@
|
||||
\subsection{Cells and Containers}\label{cells}
|
||||
|
||||
This article describes mechanism used by
|
||||
\helpref{wxHtmlWinParser}{wxhtmlwinparser} and
|
||||
\helpref{wxHtmlWindow}{wxhtmlwindow}
|
||||
to parse and display HTML documents.
|
||||
\helpref{wxHtmlWinParser}{wxhtmlwinparser} and
|
||||
\helpref{wxHtmlWindow}{wxhtmlwindow} to parse and display HTML documents.
|
||||
|
||||
\wxheading{Cells}
|
||||
|
||||
You can divide any text (or HTML) into small fragments. Let's call these
|
||||
fragments {\bf cells}. Cell is for example one word, horizontal line, image
|
||||
or any other part of document. Each cell has width and height (except special
|
||||
"magic" cells with zero dimensions - e.g. color changers or font changers).
|
||||
"magic" cells with zero dimensions - e.g. colour changers or font changers).
|
||||
|
||||
See \helpref{wxHtmlCell}{wxhtmlcell}.
|
||||
|
||||
@ -24,22 +23,22 @@ See \helpref{wxHtmlContainerCell}{wxhtmlcontainercell},
|
||||
|
||||
\begin{comment}
|
||||
% Bitmap is corrupt!
|
||||
This image shows you cells\ &\ containers:
|
||||
This image shows you cells and containers:
|
||||
|
||||
\image{}{contbox.bmp}
|
||||
\end{comment}
|
||||
\wxheading{Using Containers in Tag Handler}
|
||||
|
||||
\helpref{wxHtmlWinParser}{wxhtmlwinparser} provides user-friendly way
|
||||
of managing containers. It's based on idea of opening and closing containers.
|
||||
\helpref{wxHtmlWinParser}{wxhtmlwinparser} provides a user-friendly way
|
||||
of managing containers. It's based on the idea of opening and closing containers.
|
||||
|
||||
Use \helpref{OpenContainer}{wxhtmlwinparseropencontainer} to open new
|
||||
container {\it within actually opened container}. This new container is
|
||||
{\it sub-container} of the old one. (If you want to create new container with
|
||||
same depth level you can call {\tt CloseContainer(); OpenContainer();}.)
|
||||
a container {\it within an already opened container}. This new container is a
|
||||
{\it sub-container} of the old one. (If you want to create a new container with
|
||||
the same depth level you can call {\tt CloseContainer(); OpenContainer();}.)
|
||||
|
||||
Use \helpref{CloseContaier}{wxhtmlwinparserclosecontainer} to close the
|
||||
container. This doesn't create new container with same depth level but
|
||||
container. This doesn't create a new container with same depth level but
|
||||
it returns "control" to the parent container.
|
||||
|
||||
\begin{comment}
|
||||
@ -53,8 +52,8 @@ OpenContainer as to CloseContainer...
|
||||
|
||||
\wxheading{Example}
|
||||
|
||||
This code creates new paragraph (container at same depth level)
|
||||
with "Hello, world!" :
|
||||
This code creates a new paragraph (container at same depth level)
|
||||
with "Hello, world!":
|
||||
|
||||
\begin{verbatim}
|
||||
m_WParser -> CloseContainer();
|
||||
@ -77,7 +76,7 @@ and here is image of the situation:
|
||||
You can see that there was opened container before running the code. We closed
|
||||
it, created our own container, then closed our container and opened
|
||||
new container. The result was that we had {\it same depth level} after
|
||||
executing. This is general rule that should be followed by tag handlers :
|
||||
executing. This is general rule that should be followed by tag handlers:
|
||||
leave depth level of containers unmodified (in other words, number of
|
||||
OpenContainer and CloseContainer calls should be same within \helpref{HandleTag}{wxhtmltaghandlerhandletag}'s body).
|
||||
|
||||
|
||||
@ -1,11 +1,10 @@
|
||||
\membersection{Input Filters}\label{filters}
|
||||
|
||||
The wxHTML library provides mechanism for reading and displaying
|
||||
The wxHTML library provides a mechanism for reading and displaying
|
||||
files of many different file formats.
|
||||
|
||||
\helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage} can load not
|
||||
only HTML files but any known file. To make a file type known to wxHtmlWindow
|
||||
you must create a \helpref{wxHtmlFilter}{wxhtmlfilter} filter and
|
||||
register it using \helpref{wxHtmlWindow::AddFilter}{wxhtmlwindowaddfilter}
|
||||
|
||||
register it using \helpref{wxHtmlWindow::AddFilter}{wxhtmlwindowaddfilter}.
|
||||
|
||||
|
||||
@ -43,13 +43,13 @@ Then you must define handlers and one module.
|
||||
The handler is derived from \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}
|
||||
(or directly from \helpref{wxHtmlTagHandler}{wxhtmltaghandler})
|
||||
|
||||
You can use set of macros to define the handler (see src/mod_*.cpp files
|
||||
for details). Handler definition must start with {\bf TAG_HANDLER_BEGIN} macro
|
||||
and end with {\bf TAG_HANDLER_END} macro. I strongly recommend to have a look
|
||||
at {\it include/wxhtml/mod_templ.h} file. Otherwise you won't understand
|
||||
You can use set of macros to define the handler (see src/mod\_*.cpp files
|
||||
for details). Handler definition must start with {\bf TAG\_HANDLER\_BEGIN} macro
|
||||
and end with {\bf TAG\_HANDLER\_END} macro. I strongly recommend to have a look
|
||||
at {\it include/wxhtml/mod\_templ.h} file. Otherwise you won't understand
|
||||
the structure of macros... See macros reference:
|
||||
|
||||
{\bf TAG_HANDLER_BEGIN}({\it name}, {\it tags})
|
||||
{\bf TAG\_HANDLER\_BEGIN}({\it name}, {\it tags})
|
||||
|
||||
Starts handler definition. {\it name} is handler identifier (in fact
|
||||
part of class name), {\it tags} is string containing list of tags
|
||||
@ -57,9 +57,9 @@ supported by this handler (in uppercase). This macro derives new class from
|
||||
wxHtmlWinTagHandler and implements it's
|
||||
\helpref{GetSupportedTags}{wxhtmltaghandlergetsupportedtags} method.
|
||||
|
||||
Example: TAG_HANDLER_BEGIN(FONTS, "B,I,U,T")
|
||||
Example: TAG\_HANDLER\_BEGIN(FONTS, "B,I,U,T")
|
||||
|
||||
{\bf TAG_HANDLER_VARS}
|
||||
{\bf TAG\_HANDLER\_VARS}
|
||||
|
||||
This macro starts block of variables definitions. (Variables are identical
|
||||
to class attributes.) Example:
|
||||
@ -74,10 +74,10 @@ TAG_HANDLER_END(VARS_ONLY)
|
||||
|
||||
This macro is used only in rare cases.
|
||||
|
||||
{\bf TAG_HANDLER_CONSTR}({\it name})
|
||||
{\bf TAG\_HANDLER\_CONSTR}({\it name})
|
||||
|
||||
This macro supplies object constructor. {\it name} is same name as the one
|
||||
from TAG_HANDLER_BEGIN macro. Body of constructor follow after
|
||||
from TAG\_HANDLER\_BEGIN macro. Body of constructor follow after
|
||||
this macro (you must use { and } ). Example:
|
||||
|
||||
\begin{verbatim}
|
||||
@ -93,7 +93,7 @@ TAG_HANDLER_END(VARS2)
|
||||
|
||||
Never used in wxHTML :-)
|
||||
|
||||
{\bf TAG_HANDLER_PROC}({\it varib})
|
||||
{\bf TAG\_HANDLER\_PROC}({\it varib})
|
||||
|
||||
This is very important macro. It defines \helpref{HandleTag}{wxhtmltaghandlerhandletag}
|
||||
method. {\it varib} is name of parameter passed to the method, usually
|
||||
@ -109,29 +109,29 @@ TAG_HANDLER_BEGIN(TITLE, "TITLE")
|
||||
TAG_HANDLER_END(TITLE)
|
||||
\end{verbatim}
|
||||
|
||||
{\bf TAG_HANDLER_END}({\it name})
|
||||
{\bf TAG\_HANDLER\_END}({\it name})
|
||||
|
||||
Ends definition of tag handler {\it name}.
|
||||
|
||||
|
||||
\wxheading{Tags Modules}
|
||||
|
||||
You can use set of 3 macros TAGS_MODULE_BEGIN, TAGS_MODULE_ADD and
|
||||
TAGS_MODULE_END to inherit new module from
|
||||
You can use set of 3 macros TAGS\_MODULE\_BEGIN, TAGS\_MODULE\_ADD and
|
||||
TAGS\_MODULE\_END to inherit new module from
|
||||
\helpref{wxHtmlTagsModule}{wxhtmltagsmodule} and to create instance of it.
|
||||
See macros reference:
|
||||
|
||||
{\bf TAGS_MODULE_BEGIN}({\it modname})
|
||||
{\bf TAGS\_MODULE\_BEGIN}({\it modname})
|
||||
|
||||
Begins module definition. {\it modname} is part of class name and must
|
||||
be unique.
|
||||
|
||||
{\bf TAGS_MODULE_ADD}({\it name})
|
||||
{\bf TAGS\_MODULE\_ADD}({\it name})
|
||||
|
||||
Adds the handler to this module. {\it name} is the identifier from
|
||||
TAG_HANDLER_BEGIN.
|
||||
TAG\_HANDLER\_BEGIN.
|
||||
|
||||
{\bf TAGS_MODULE_END}({\it modname})
|
||||
{\bf TAGS\_MODULE\_END}({\it modname})
|
||||
|
||||
Ends the definition of module.
|
||||
|
||||
@ -144,3 +144,4 @@ TAGS_MODULE_BEGIN(Examples)
|
||||
TAGS_MODULE_ADD(TITLE)
|
||||
TAGS_MODULE_END(Examples)
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
\membersection{Help Files Format}\label{helpformat}
|
||||
|
||||
wxHTML library uses reduced version of MS HTML Workshop format.
|
||||
wxHTML library uses a reduced version of MS HTML Workshop format.
|
||||
|
||||
(See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
|
||||
|
||||
@ -75,7 +75,6 @@ Items in the list may be nested - one \<li\> statement may contain \<ul\> sub-st
|
||||
</ul>
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\wxheading{Index file (.hhk)}
|
||||
|
||||
Index files have same format as contents file except that ID params are ignored and sublists are {\bf not}
|
||||
|
||||
@ -60,3 +60,4 @@ void MyPrintout::DrawPageOne(wxDC *dc)
|
||||
\end{verbatim}
|
||||
|
||||
(Thanks to Julian Smart for sample)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ First of all, you must include <wx/wxhtml.h>.
|
||||
|
||||
Class \helpref{wxHtmlWindow}{wxhtmlwindow} (derived from wxScrolledWindow)
|
||||
is used to display HTML documents.
|
||||
It has 2 important methods : \helpref{LoadPage}{wxhtmlwindowloadpage}
|
||||
It has two important methods : \helpref{LoadPage}{wxhtmlwindowloadpage}
|
||||
and \helpref{SetPage}{wxhtmlwindowsetpage}.
|
||||
LoadPage loads and displays HTML file while SetPage displays directly the
|
||||
passed {\bf string}. See the example:
|
||||
@ -19,7 +19,7 @@ passed {\bf string}. See the example:
|
||||
"</body></hmtl>");
|
||||
\end{verbatim}
|
||||
|
||||
I think the difference is quite clear...
|
||||
I think the difference is quite clear.
|
||||
|
||||
\wxheading{Displaying Help}
|
||||
|
||||
@ -30,9 +30,9 @@ See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
|
||||
Because wxHtmlWindow is derived from wxScrolledWindow and not from
|
||||
wxFrame, it doesn't have visible frame. But the user usually want to see
|
||||
the title of HTML page displayed somewhere and frame's titlebar is
|
||||
ideal place for it...
|
||||
ideal place for it.
|
||||
|
||||
wxHtmlWindow provides 2 methods in order to handle this :
|
||||
wxHtmlWindow provides 2 methods in order to handle this:
|
||||
\helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe} and
|
||||
\helpref{SetRelatedStatusBar}{wxhtmlwindowsetrelatedstatusbar}.
|
||||
See the example:
|
||||
@ -64,5 +64,5 @@ borders (space between border of window and displayed HTML). Related functions:
|
||||
\end{itemize}
|
||||
|
||||
The last two functions are used to store user customization info wxConfig stuff
|
||||
(for example registry under Windows or dotfile under Unix)
|
||||
(for example registry under Windows or dotfile under Unix).
|
||||
|
||||
|
||||
@ -3,13 +3,12 @@
|
||||
% htmlparser.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlParser}}\label{wxhtmlparser}
|
||||
|
||||
This class handles {\bf generic} parsing of HTML document : it scans
|
||||
This class handles the {\bf generic} parsing of HTML document: it scans
|
||||
the document and divide it into blocks of tags (where one block
|
||||
consists of begining and ending tag and of text between these
|
||||
2 tags).
|
||||
two tags).
|
||||
|
||||
It is independent from wxHtmlWindow and can be used as stand-alone parser
|
||||
(Julian Smart's idea of speech-only HTML viewer or wget-like utility -
|
||||
@ -19,9 +18,9 @@ It uses system of tag handlers to parse the HTML document. Tag handlers
|
||||
are not staticaly shared by all instances but are created for each
|
||||
wxHtmlParser instance. The reason is that the handler may contain
|
||||
document-specific temporary data used during parsing (e.g. complicated
|
||||
structures like tables)
|
||||
structures like tables).
|
||||
|
||||
Typically the user calls only \helpref{Parse}{wxhtmlparserparse} method.
|
||||
Typically the user calls only the \helpref{Parse}{wxhtmlparserparse} method.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
@ -35,14 +34,12 @@ wxObject
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::wxHtmlParser}\label{wxhtmlparserwxhtmlparser}
|
||||
|
||||
\func{}{wxHtmlParser}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
|
||||
|
||||
\func{void}{SetFS}{\param{wxFileSystem }{*fs}}
|
||||
@ -63,7 +60,6 @@ calling
|
||||
wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg");
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse}
|
||||
|
||||
\func{wxObject*}{Parse}{\param{const wxString\& }{source}}
|
||||
@ -90,14 +86,12 @@ You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly.
|
||||
Setups the parser for parsing the {\it source} string. (Should be overriden
|
||||
in derived class)
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::DoneParser}\label{wxhtmlparserdoneparser}
|
||||
|
||||
\func{virtual void}{DoneParser}{\void}
|
||||
|
||||
This must be called after DoParsing().
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::DoParsing}\label{wxhtmlparserdoparsing}
|
||||
|
||||
\func{void}{DoParsing}{\param{int }{begin\_pos}, \param{int }{end\_pos}}
|
||||
@ -117,7 +111,6 @@ representation in derived parser (but it must be derived from wxObject!).
|
||||
|
||||
See wxHtmlWinParser for details.
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::AddTagHandler}\label{wxhtmlparseraddtaghandler}
|
||||
|
||||
\func{virtual void}{AddTagHandler}{\param{wxHtmlTagHandler }{*handler}}
|
||||
@ -126,9 +119,9 @@ 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)
|
||||
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.
|
||||
|
||||
@ -138,14 +131,13 @@ All handlers are deleted on object deletion.
|
||||
|
||||
Returns pointer to the source being parsed.
|
||||
|
||||
|
||||
\membersection{wxHtmlParser::GetTempData}\label{wxhtmlparsergettempdata}
|
||||
|
||||
\func{virtual wxList*}{GetTempData}{\void}
|
||||
|
||||
This method returns list of wxObjects that represents
|
||||
all data allocated by the parser. These can't be freeded
|
||||
by destructor because they must be valid as long as
|
||||
all data allocated by the parser. These can't be freed
|
||||
by the destructor because they must be valid as long as
|
||||
GetProduct's return value is valid - the caller must
|
||||
explicitly call
|
||||
|
||||
@ -153,13 +145,13 @@ explicitly call
|
||||
delete (MyParser -> GetTempData());
|
||||
\end{verbatim}
|
||||
|
||||
to free the memory (this method always sets the list to delete its contents)
|
||||
to free the memory (this method always sets the list to delete its contents).
|
||||
|
||||
\wxheading{Example}
|
||||
|
||||
Why is this neccessary? Imagine wxHtmlWinParser : when handling
|
||||
FONT tag it creates some fonts. These fonts are then used by wxHtmlWindow
|
||||
to display the text. But wxHtmWinParser object is needed only when parsing
|
||||
Why is this neccessary? Imagine wxHtmlWinParser: when handling
|
||||
a FONT tag it creates some fonts. These fonts are then used by wxHtmlWindow
|
||||
to display the text. But the wxHtmWinParser object is needed only when parsing
|
||||
the document - it may be deleted then. But fonts CAN'T be deleted - they
|
||||
must exist as long as the window is displaying text.
|
||||
|
||||
@ -174,7 +166,7 @@ Must be overwriten 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)
|
||||
unmodified).
|
||||
|
||||
\membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag}
|
||||
|
||||
@ -182,10 +174,11 @@ unmodified)
|
||||
|
||||
This may (and may not) be overwriten in derived class.
|
||||
|
||||
This method is called each time new tag is about to be added.
|
||||
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.)
|
||||
|
||||
Default (wxHtmlParser) behaviour is this :
|
||||
Default (wxHtmlParser) behaviour is this:
|
||||
First it finds a handler capable of handling this tag and then it calls
|
||||
handler's HandleTag method.
|
||||
|
||||
|
||||
@ -3,20 +3,17 @@
|
||||
% htmltag.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlTag}}\label{wxhtmltag}
|
||||
|
||||
This class represents single HTML tag.
|
||||
It is used by \helpref{tag handlers}{handlers}.
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
wxObject
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlTag::wxHtmlTag}\label{wxhtmltagwxhtmltag}
|
||||
|
||||
\func{}{wxHtmlTag}{\param{const wxString\& }{source}, \param{int }{pos}, \param{int }{end\_pos}, \param{wxHtmlTagsCache* }{cache}}
|
||||
@ -33,7 +30,6 @@ 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::HasParam}\label{wxhtmltaghasparam}
|
||||
|
||||
\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}
|
||||
@ -73,8 +69,6 @@ dummy = tag.GetParam("COLOR", TRUE);
|
||||
// dummy == "\"#0000FF\"" -- see the difference!!
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
|
||||
|
||||
\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}
|
||||
@ -160,7 +154,6 @@ bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
|
||||
^
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
|
||||
|
||||
\constfunc{int}{GetEndPos2}{\void}
|
||||
@ -171,6 +164,6 @@ See explanation (returned position is marked with '^'):
|
||||
|
||||
\begin{verbatim}
|
||||
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
|
||||
^
|
||||
^
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% htmltaghandler.tex at 18/Mar/99 19:20:29
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlTagHandler}}\label{wxhtmltaghandler}
|
||||
|
||||
\wxheading{Derived from}
|
||||
@ -15,8 +14,6 @@ wxObject
|
||||
\helpref{Overview}{handlers},
|
||||
\helpref{wxHtmlTag}{wxhtmltag}
|
||||
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxHtmlTagHandler::m\_Parser}\label{wxhtmltaghandlermparser}
|
||||
@ -46,7 +43,6 @@ is guaranteed to be called only from the parser.
|
||||
Returns list of supported tags. The list is in uppercase and tags
|
||||
are delimited by ','. Example : {\tt "I,B,FONT,P" }
|
||||
|
||||
|
||||
\membersection{wxHtmlTagHandler::HandleTag}\label{wxhtmltaghandlerhandletag}
|
||||
|
||||
\func{virtual bool}{HandleTag}{\param{const wxHtmlTag\& }{tag}}
|
||||
@ -75,7 +71,6 @@ bool MyHandler::HandleTag(const wxHtmlTag& tag)
|
||||
|
||||
You shouldn't call ParseInner if the tag is not paired with ending one.
|
||||
|
||||
|
||||
\membersection{wxHtmlTagHandler::ParseInner}\label{wxhtmltaghandlerparseinner}
|
||||
|
||||
\func{void}{ParseInner}{\param{const wxHtmlTag\& }{tag}}
|
||||
@ -87,5 +82,6 @@ for the string between this tag and paired ending tag:
|
||||
...<A HREF="x.htm">Hello, world!</A>...
|
||||
\end{verbatim}
|
||||
|
||||
In this example, 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!'.
|
||||
|
||||
|
||||
@ -1,8 +1,6 @@
|
||||
%
|
||||
% automatically generated by HelpGen from
|
||||
% htmltagsmodule.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlTagsModule}}\label{wxhtmltagsmodule}
|
||||
|
||||
@ -20,10 +18,8 @@ wxModule
|
||||
\helpref{wxHtmlTagHandler}{wxhtmltaghandler},
|
||||
\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler},
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlTagsModule::FillHandlersTable}\label{wxhtmltagsmodulefillhandlerstable}
|
||||
|
||||
\func{virtual void}{FillHandlersTable}{\param{wxHtmlWinParser }{*parser}}
|
||||
@ -40,3 +36,4 @@ I recommend using {\bf TAGS\_MODULE\_*} macros.
|
||||
\wxheading{Paremeters}
|
||||
|
||||
\docparam{parser}{Pointer to the parser that requested tables filling.}
|
||||
|
||||
|
||||
@ -67,3 +67,4 @@ If the field doesn't exist, it will return an empty string and not a NULL string
|
||||
|
||||
The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type"
|
||||
represent the same header.
|
||||
|
||||
|
||||
@ -3,11 +3,8 @@
|
||||
% htmlcell.h at 14/Apr/99 20:12:40
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlWidgetCell}}\label{wxhtmlwidgetcell}
|
||||
|
||||
|
||||
|
||||
wxHtmlWidgetCell is class that provides connection between HTML cell and widget (object derived
|
||||
from wxWindow). You can use it to display things like forms, input boxes etc. in HTML window.
|
||||
|
||||
@ -17,10 +14,8 @@ wxHtmlWidgetCell takes care of resizing and moving window.
|
||||
|
||||
\helpref{wxHtmlCell}{wxhtmlcell}
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlWidgetCell::wxHtmlWidgetCell}\label{wxhtmlwidgetcellwxhtmlwidgetcell}
|
||||
|
||||
\func{}{wxHtmlWidgetCell}{\param{wxWindow* }{wnd}, \param{int }{w = 0}}
|
||||
@ -36,4 +31,3 @@ which it is displayed!}
|
||||
always {\it w} percents of parent container's width. (For example w = 100 means that the window
|
||||
will always have same width as parent container)}
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% htmlwindow.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
|
||||
|
||||
wxHtmlWindow is probably the only class you will directly use
|
||||
@ -18,7 +17,6 @@ Once the window is created you can set it's content by calling
|
||||
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
|
||||
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
wxScrolledWindow
|
||||
@ -40,11 +38,9 @@ Constructor. The parameters are same as in wxScrollWindow ctor.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{style}{wxHW_SCROLLBAR_NEVER, or wxHW_SCROLLBAR_AUTO.
|
||||
\docparam{style}{wxHW\_SCROLLBAR\_NEVER, or wxHW\_SCROLLBAR\_AUTO.
|
||||
Affects appearance of vertical scrollbar in the window.}
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
|
||||
|
||||
\func{bool}{SetPage}{\param{const wxString\& }{source}}
|
||||
@ -63,7 +59,6 @@ If you want to load document from some location use
|
||||
|
||||
\docparam{source}{The HTML document source to be displayed.}
|
||||
|
||||
|
||||
\wxheading{Return value}
|
||||
|
||||
FALSE if an error occured, TRUE otherwise
|
||||
@ -87,8 +82,6 @@ htmlwin -> SetPage("help/myproject/index.htm");
|
||||
|
||||
FALSE if an error occured, TRUE otherwise
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
|
||||
|
||||
\func{wxString}{GetOpenedPage}{\void}
|
||||
@ -96,8 +89,6 @@ FALSE if an error occured, TRUE otherwise
|
||||
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::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
|
||||
|
||||
\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
|
||||
@ -106,16 +97,12 @@ 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.
|
||||
|
||||
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
|
||||
|
||||
\constfunc{wxFrame*}{GetRelatedFrame}{\void}
|
||||
|
||||
Returns the related frame.
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
|
||||
|
||||
\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
|
||||
@ -172,7 +159,6 @@ 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)
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
|
||||
|
||||
\func{void}{SetBorders}{\param{int }{b}}
|
||||
@ -185,7 +171,6 @@ This function sets the space between border of window and HTML contents. See ima
|
||||
|
||||
\docparam{b}{indentation from borders in pixels}
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
|
||||
|
||||
\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
|
||||
@ -202,14 +187,13 @@ Read values : all things set by SetFonts, SetBorders.
|
||||
|
||||
\docparam{path}{Optional path in config tree. If not given current path is used.}
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
|
||||
|
||||
\func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
|
||||
|
||||
Saves custom settings into wxConfig. It uses the path 'path'
|
||||
if given, otherwise it saves info into currently selected path.
|
||||
Regardless path is given or not the function creates sub-path
|
||||
Regardless path is given or not the function creates sub-path
|
||||
{\tt wxHtmlWindow}
|
||||
|
||||
Saved values : all things set by SetFonts, SetBorders.
|
||||
@ -227,11 +211,9 @@ Saved values : all things set by SetFonts, SetBorders.
|
||||
|
||||
Returns pointer to the top-level container.
|
||||
|
||||
See also :
|
||||
\helpref{Cells Overview}{cells},
|
||||
See also: \helpref{Cells Overview}{cells},
|
||||
\helpref{Printing Overview}{printing}
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
|
||||
|
||||
\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
|
||||
@ -245,7 +227,6 @@ filters. These filters are present by default:
|
||||
\item Plain Text filter (this filter is used if no other filter matches)
|
||||
\end{itemize}
|
||||
|
||||
|
||||
\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
|
||||
|
||||
\func{bool}{HistoryBack}{\void}
|
||||
@ -253,7 +234,6 @@ filters. These filters are present by default:
|
||||
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}
|
||||
@ -266,12 +246,10 @@ Moves to next page in history.
|
||||
|
||||
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
|
||||
Called when user clicks on hypertext link. Default behaviour is to call
|
||||
\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
|
||||
|
||||
|
||||
|
||||
@ -3,30 +3,24 @@
|
||||
% htmlwintaghandler.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlWinTagHandler}}\label{wxhtmlwintaghandler}
|
||||
|
||||
This is basicly wxHtmlTagHandler except
|
||||
This is basically wxHtmlTagHandler except that
|
||||
it is extended with protected member m\_WParser pointing to
|
||||
the wxHtmlWinParser object (value of this member is identical
|
||||
to wxHtmlParser's m\_Parser).
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxHtmlTagHandler}{wxhtmltaghandler}
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxHtmlWinTagHandler::m\_WParser}\label{wxhtmlwintaghandlerwxhtmlwintaghandlermwparser}
|
||||
|
||||
{\bf wxHtmlWinParser* m\_WParser}
|
||||
|
||||
Value of this attribute is identical to value of m\_Parser. The only different
|
||||
is that m\_WParser points to wxHtmlWinParser object while m\_Parser
|
||||
points to wxHtmlParser object.
|
||||
(The same object, but overcasted)
|
||||
|
||||
points to wxHtmlParser object. (The same object, but overcast.)
|
||||
|
||||
|
||||
@ -3,10 +3,8 @@
|
||||
% htmlwinparser.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
|
||||
|
||||
|
||||
This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
|
||||
its mail goal is to parse HTML input so that it can be displayed in
|
||||
\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special
|
||||
@ -20,7 +18,6 @@ its mail goal is to parse HTML input so that it can be displayed in
|
||||
\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxHtmlParser}{wxhtmlparser}
|
||||
@ -40,7 +37,6 @@ 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})
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
|
||||
|
||||
\func{virtual void}{SetDC}{\param{wxDC }{*dc}}
|
||||
@ -86,14 +82,12 @@ title only if some window is associated, otherwise it does nothing)
|
||||
|
||||
Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
|
||||
|
||||
\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}
|
||||
|
||||
Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
|
||||
|
||||
\constfunc{wxHtmlContainerCell*}{GetContainer}{\void}
|
||||
@ -127,8 +121,6 @@ Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
|
||||
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}
|
||||
@ -259,3 +251,4 @@ and returns pointer to it.
|
||||
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!
|
||||
|
||||
|
||||
@ -96,8 +96,8 @@ format disables timestamping of the messages completely.
|
||||
|
||||
\helpref{SetVerbose}{wxlogsetverbose}\\
|
||||
\helpref{GetVerbose}{wxloggetverbose}\\
|
||||
\helpref{SetTimeStampFormat}{wxlogsettimestampformat}\\
|
||||
\helpref{GetTimeStampFormat}{wxloggettimestampformat}\\
|
||||
\helpref{SetTimestamp}{wxlogsettimestamp}\\
|
||||
\helpref{GetTimestamp}{wxloggettimestamp}\\
|
||||
\helpref{SetTraceMask}{wxlogsettracemask}\\
|
||||
\helpref{GetTraceMask}{wxloggettracemask}
|
||||
|
||||
@ -162,18 +162,18 @@ logged as the normal ones instead of being silently dropped.
|
||||
|
||||
Returns whether the verbose mode is currently active.
|
||||
|
||||
\membersection{wxLog::SetTimeStampFormat}\label{wxlogsettimestampformat}
|
||||
\membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
|
||||
|
||||
\func{void}{SetTimeStampFormat}{\param{const char * }{ format}}
|
||||
\func{void}{SetTimestamp}{\param{const char * }{ format}}
|
||||
|
||||
Sets the timestamp format prepended by the default log targets to all
|
||||
messages. The string may contain any normal characters as well as \%
|
||||
prefixed format specificators, see {\it strftime()} manual for details.
|
||||
Passing an empty string to this function disables message timestamping.
|
||||
Passing a null value (not empty string) to this function disables message timestamping.
|
||||
|
||||
\membersection{wxLog::GetTimeStampFormat}\label{wxloggettimestampformat}
|
||||
\membersection{wxLog::GetTimestamp}\label{wxloggettimestamp}
|
||||
|
||||
\constfunc{const char *}{GetTimeStampFormat}{\void}
|
||||
\constfunc{const char *}{GetTimestamp}{\void}
|
||||
|
||||
Returns the current timestamp format string.
|
||||
|
||||
|
||||
@ -14,3 +14,4 @@ also has operators for implicit construction from and conversion to the native
|
||||
|
||||
You would usually use this type in exactly the same manner as any other
|
||||
(built-in) arithmetic type.
|
||||
|
||||
|
||||
@ -142,4 +142,3 @@ One of:
|
||||
\twocolitem{{\bf wxMUTEX\_UNLOCKED}}{The calling thread tries to unlock an unlocked mutex.}
|
||||
\end{twocollist}
|
||||
|
||||
|
||||
|
||||
@ -50,3 +50,4 @@ Prevents the change announced by this event from happening.
|
||||
It is in general a good idea to notify the user about the reasons for vetoing
|
||||
the change because otherwise the applications behaviour (which just refuses to
|
||||
do what the user wants) might be quite surprising.
|
||||
|
||||
|
||||
@ -96,4 +96,3 @@ dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
|
||||
Can be used to continue with the dialog, after the user had chosen
|
||||
ABORT.
|
||||
|
||||
|
||||
|
||||
@ -65,4 +65,3 @@ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollba
|
||||
|
||||
Returns the position of the scrollbar.
|
||||
|
||||
|
||||
|
||||
@ -76,4 +76,3 @@ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollba
|
||||
|
||||
Returns the position of the scrollbar.
|
||||
|
||||
|
||||
|
||||
@ -152,9 +152,3 @@ where it would otherwise present the information only in audible form; zero othe
|
||||
\pythonnote{This static method is implemented in Python as a
|
||||
standalone function named \tt{wxSystemSettings_GetSystemMetric}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -81,3 +81,4 @@ Returns TRUE if the line is vertical, FALSE if horizontal.
|
||||
This static function returns the size which will be given to the "lesser"
|
||||
dimension of the static line, i.e. its height for a horizontal line or its
|
||||
width for a vertical one.
|
||||
|
||||
|
||||
@ -44,3 +44,4 @@ This stream acts as a cache. It caches the bytes to be written to the specified
|
||||
output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
|
||||
datas are only written when the cache is full or when the buffered stream is
|
||||
destroyed.
|
||||
|
||||
|
||||
@ -85,3 +85,4 @@ the buffer.
|
||||
|
||||
CopyTo returns the number of bytes copied to the buffer. Generally it is either
|
||||
len or the size of the stream buffer.
|
||||
|
||||
|
||||
@ -49,3 +49,4 @@ The program usually remembers the value returned by this function after calling
|
||||
\helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which
|
||||
was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
|
||||
button in the tip dialog.
|
||||
|
||||
|
||||
@ -87,3 +87,4 @@ code:
|
||||
As I said previously, we could add a filter stream so it takes an istream
|
||||
argument and builds a wxInputStream from it: I don't think it should
|
||||
be difficult to implement it and it may be available in the fix of wxWindows 2.0.
|
||||
|
||||
|
||||
@ -40,3 +40,4 @@ probably want to store both the index of the
|
||||
last shown tip (as returned by
|
||||
\helpref{wxTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip} and the flag
|
||||
telling whether to show the tips at startup at all.
|
||||
|
||||
|
||||
@ -153,3 +153,4 @@ Writes the double {\it f} to the stream using the IEEE format.
|
||||
|
||||
Writes {\it string} as a line. Depending on the operating system, it adds
|
||||
$\backslash$n or $\backslash$r$\backslash$n.
|
||||
|
||||
|
||||
@ -152,3 +152,4 @@ Sets the proxy to use for this URL.
|
||||
|
||||
It converts a non-standardized URI to a valid network URI. It encodes non
|
||||
standard characters.
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ This addendum is written by Vaclav Slavik, the author of the wxHTML library.
|
||||
|
||||
The wxHTML library provides classes for parsing and displaying HTML.
|
||||
|
||||
It never intented to be hi-end HTML browser. If you're looking for
|
||||
It is not intended to be a high-end HTML browser. If you're looking for
|
||||
something like that try \urlref{http://www.mozilla.org}{http://www.mozilla.org} - there's a
|
||||
chance you'll be able to make their widget wxWindows-compatible. I'm sure
|
||||
everyone will enjoy your work in that case...
|
||||
@ -16,19 +16,17 @@ But back to wxHTML.
|
||||
|
||||
\section{wxHTML Sub-library Overview}\label{wxhtmloverview}
|
||||
|
||||
wxHTML can be used as generic rich text viewer - for example to display
|
||||
nice About Box (like these of GNOME apps) or to display the result of
|
||||
wxHTML can be used as a generic rich text viewer - for example to display
|
||||
a nice About Box (like those of GNOME apps) or to display the result of
|
||||
database searching. There is a \helpref{wxFileSystem}{wxfilesystem}
|
||||
class which allows you to use your own virtual file systems...
|
||||
class which allows you to use your own virtual file systems.
|
||||
|
||||
wxHtmlWindow supports tag handlers. This means that you can easily
|
||||
extend wxHtml library with new, unsupported tags. Not only that,
|
||||
extend wxHtml library with new, unsupported tags. Not only that,
|
||||
you can even use your own application specific tags!
|
||||
See lib/mod_*.cpp files for details.
|
||||
|
||||
There is generic (non-wxHtmlWindow) wxHtmlParser class.
|
||||
|
||||
See lib/mod\_*.cpp files for details.
|
||||
|
||||
There is a generic (non-wxHtmlWindow) wxHtmlParser class.
|
||||
|
||||
\input htmlstrt.tex
|
||||
\input htmlprn.tex
|
||||
@ -36,3 +34,4 @@ There is generic (non-wxHtmlWindow) wxHtmlParser class.
|
||||
\input htmlfilt.tex
|
||||
\input htmlcell.tex
|
||||
\input htmlhand.tex
|
||||
|
||||
|
||||
@ -3,7 +3,6 @@
|
||||
% zipstream.h at 02/May/99 19:54:25
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxZipInputStream}}\label{wxzipinputstream}
|
||||
|
||||
This class is input stream from ZIP archive. The archive
|
||||
@ -14,10 +13,8 @@ It has all features including GetSize and seeking.
|
||||
|
||||
wxInputStream
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxZipInputStream::wxZipInputStream}\label{wxzipinputstreamwxzipinputstream}
|
||||
|
||||
\func{}{wxZipInputStream}{\param{const wxString\& }{archive}, \param{const wxString\& }{file}}
|
||||
@ -30,4 +27,3 @@ Constructor.
|
||||
|
||||
\docparam{file}{name of file stored in the archive}
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user