\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}}
-Constructs a busy info object, displays {\it msg} .
-
+Constructs a busy info object, displays {\it msg}.
Writes {\it string} to the stream. Actually, this method writes the size of
the string before writing {\it string} itself.
+
\helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
-
% filesystem.tex at 21/Mar/99 23:00:52
%
-
\section{\class{wxFileSystem}}\label{wxfilesystem}
This class provides interface for opening files on different
\helpref{wxFSFile}{wxfsfile},
\helpref{Overview}{fs}
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxFileSystem::wxFileSystem}\label{wxfilesystemwxfilesystem}
\func{}{wxFileSystem}{\void}
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}}
(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}}
\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.
+
% filesystemhandler.tex at 21/Mar/99 23:00:52
%
-
\section{\class{wxFileSystemHandler}}\label{wxfilesystemhandler}
wxFileSystemHandler (or derived classes to be exact) is used
Please have a look at \helpref{overview}{fs} if you don't know how locations
are constructed.
-
\wxheading{Notes}
\begin{itemize}
\helpref{wxFSFile}{wxfsfile},
\helpref{Overview}{fs}
-
\membersection{wxFileSystemHandler::wxFileSystemHandler}\label{wxfilesystemhandlerwxfilesystemhandler}
\func{}{wxFileSystemHandler}{\void}
\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}
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}
Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
-
\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}
\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
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
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.
\wxheading{File Systems Included in wxHTML}
-\begin{enumerate}
+\begin{enumerate}\itemsep=0pt
\item Local files
\item HTTP protocol
\item FTP protocol
% fsfile.tex at 21/Mar/99 23:00:52
%
-
\section{\class{wxFSFile}}\label{wxfsfile}
This class represents single file opened by \helpref{wxFileSystem}{wxfilesystem}.
relative-file.htm
\end{verbatim}
-
\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
\constfunc{const wxString\&}{GetAnchor}{\void}
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)
+
% 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
\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}}
Sets cell's position within parent container.
-
\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
\func{void}{SetLink}{\param{const wxString\& }{link}}
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}}
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
\docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right
button is pressed, FALSE otherwise}
-
-
-
% htmlcolourcell.tex at 14/Mar/99 20:13:37
%
-
\section{\class{wxHtmlColourCell}}\label{wxhtmlcolourcell}
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}}
\twocolitem{{\bf HTML\_CLR\_BACKGROUND}}{change background color}
\end{twocollist}
-
}
% 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}
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlContainerCell::wxHtmlContainerCell}\label{wxhtmlcontainercellwxhtmlcontainercell}
\func{}{wxHtmlContainerCell}{\param{wxHtmlContainerCell }{*parent}}
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}}
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}}
\docparam{clr2}{Color of bottom and right lines}
-
-
\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell}
\func{wxHtmlCell*}{GetFirstCell}{\void}
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.
-
-
% htmlfilter.tex at 29/Mar/99 18:35:09
%
-
\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
This class is input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
\func{}{wxHtmlFilter}{\void}
\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
-
Reads the file and returns string with HTML document.
Example:
% 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
#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}}
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}}
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}}
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}}
This alternative form is used to search help contents by numeric IDs.
-
-
-
\membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
\func{void}{DisplayContents}{\void}
Displays help window and focuses index panel.
-
\membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
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}}
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}}
\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}.
\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}
\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();
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).
\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}.
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
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:
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}
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
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.
TAGS_MODULE_ADD(TITLE)
TAGS_MODULE_END(Examples)
\end{verbatim}
+
\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.)
</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}
\end{verbatim}
(Thanks to Julian Smart for sample)
+
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:
"</body></hmtl>");
\end{verbatim}
-I think the difference is quite clear...
+I think the difference is quite clear.
\wxheading{Displaying Help}
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:
\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).
% 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 -
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}
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlParser::wxHtmlParser}\label{wxhtmlparserwxhtmlparser}
\func{}{wxHtmlParser}{\void}
Constructor.
-
\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
\func{void}{SetFS}{\param{wxFileSystem }{*fs}}
wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg");
\end{verbatim}
-
\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse}
\func{wxObject*}{Parse}{\param{const wxString\& }{source}}
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}}
See wxHtmlWinParser for details.
-
\membersection{wxHtmlParser::AddTagHandler}\label{wxhtmlparseraddtaghandler}
\func{virtual void}{AddTagHandler}{\param{wxHtmlTagHandler }{*handler}}
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.
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
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.
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}
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.
+
% 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}}
'<' 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}}
// dummy == "\"#0000FF\"" -- see the difference!!
\end{verbatim}
-
-
\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}
^
\end{verbatim}
-
\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
\constfunc{int}{GetEndPos2}{\void}
\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
- ^
+ ^
\end{verbatim}
% htmltaghandler.tex at 18/Mar/99 19:20:29
%
-
\section{\class{wxHtmlTagHandler}}\label{wxhtmltaghandler}
\wxheading{Derived from}
\helpref{Overview}{handlers},
\helpref{wxHtmlTag}{wxhtmltag}
-
-
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHtmlTagHandler::m\_Parser}\label{wxhtmltaghandlermparser}
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}}
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}}
...<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!'.
+
%
% automatically generated by HelpGen from
% htmltagsmodule.tex at 14/Mar/99 20:13:37
-%
-
\section{\class{wxHtmlTagsModule}}\label{wxhtmltagsmodule}
\helpref{wxHtmlTagHandler}{wxhtmltaghandler},
\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler},
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlTagsModule::FillHandlersTable}\label{wxhtmltagsmodulefillhandlerstable}
\func{virtual void}{FillHandlersTable}{\param{wxHtmlWinParser }{*parser}}
\wxheading{Paremeters}
\docparam{parser}{Pointer to the parser that requested tables filling.}
+
The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type"
represent the same header.
+
% 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.
\helpref{wxHtmlCell}{wxhtmlcell}
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlWidgetCell::wxHtmlWidgetCell}\label{wxhtmlwidgetcellwxhtmlwidgetcell}
\func{}{wxHtmlWidgetCell}{\param{wxWindow* }{wnd}, \param{int }{w = 0}}
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)}
-
% htmlwindow.tex at 14/Mar/99 20:13:37
%
-
\section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
wxHtmlWindow is probably the only class you will directly use
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
-
\wxheading{Derived from}
wxScrolledWindow
\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}}
\docparam{source}{The HTML document source to be displayed.}
-
\wxheading{Return value}
FALSE if an error occured, TRUE otherwise
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::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
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}}
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}}
\docparam{b}{indentation from borders in pixels}
-
\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
\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.
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}}
\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}
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.
-
% 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.)
% 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
\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!
\end{enumerate}
-
\wxheading{Derived from}
\helpref{wxHtmlParser}{wxhtmlparser}
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}}
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}
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}
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!
+
\helpref{SetVerbose}{wxlogsetverbose}\\
\helpref{GetVerbose}{wxloggetverbose}\\
-\helpref{SetTimeStampFormat}{wxlogsettimestampformat}\\
-\helpref{GetTimeStampFormat}{wxloggettimestampformat}\\
+\helpref{SetTimestamp}{wxlogsettimestamp}\\
+\helpref{GetTimestamp}{wxloggettimestamp}\\
\helpref{SetTraceMask}{wxlogsettracemask}\\
\helpref{GetTraceMask}{wxloggettracemask}
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.
You would usually use this type in exactly the same manner as any other
(built-in) arithmetic type.
+
\twocolitem{{\bf wxMUTEX\_UNLOCKED}}{The calling thread tries to unlock an unlocked mutex.}
\end{twocollist}
-
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.
+
Can be used to continue with the dialog, after the user had chosen
ABORT.
-
Returns the position of the scrollbar.
-
Returns the position of the scrollbar.
-
\pythonnote{This static method is implemented in Python as a
standalone function named \tt{wxSystemSettings_GetSystemMetric}}
-
-
-
-
-
-
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.
+
output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
datas are only written when the cache is full or when the buffered stream is
destroyed.
+
CopyTo returns the number of bytes copied to the buffer. Generally it is either
len or the size of the stream buffer.
+
\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.
+
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.
+
last shown tip (as returned by
\helpref{wxTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip} and the flag
telling whether to show the tips at startup at all.
+
Writes {\it string} as a line. Depending on the operating system, it adds
$\backslash$n or $\backslash$r$\backslash$n.
+
It converts a non-standardized URI to a valid network URI. It encodes non
standard characters.
+
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...
\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
\input htmlfilt.tex
\input htmlcell.tex
\input htmlhand.tex
+
% zipstream.h at 02/May/99 19:54:25
%
-
\section{\class{wxZipInputStream}}\label{wxzipinputstream}
This class is input stream from ZIP archive. The archive
wxInputStream
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxZipInputStream::wxZipInputStream}\label{wxzipinputstreamwxzipinputstream}
\func{}{wxZipInputStream}{\param{const wxString\& }{archive}, \param{const wxString\& }{file}}
\docparam{file}{name of file stored in the archive}
-
projects / wxWidgets.git / commitdiff
