diff --git a/docs/latex/wx/busyinfo.tex b/docs/latex/wx/busyinfo.tex index b4202dad12..da43b7e4e1 100644 --- a/docs/latex/wx/busyinfo.tex +++ b/docs/latex/wx/busyinfo.tex @@ -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}. diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex index 679e858d4f..c8da9fd39e 100644 --- a/docs/latex/wx/datstrm.tex +++ b/docs/latex/wx/datstrm.tex @@ -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. + diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index 67c3c68ad4..b3b7d56918 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -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} - diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 0e7ec2db5e..25eb6181c1 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -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. + diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index 04159d5e94..80a02a6edb 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -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}} diff --git a/docs/latex/wx/fs.tex b/docs/latex/wx/fs.tex index cf781071a5..5488d876f6 100644 --- a/docs/latex/wx/fs.tex +++ b/docs/latex/wx/fs.tex @@ -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 diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 0fcebe2c44..7c0e956aa1 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -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) + diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index bd2a01b524..58b81d46b1 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -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} - - - diff --git a/docs/latex/wx/htcolor.tex b/docs/latex/wx/htcolor.tex index 2bf15d69e4..de12b3c25c 100644 --- a/docs/latex/wx/htcolor.tex +++ b/docs/latex/wx/htcolor.tex @@ -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} - } diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index 907bd8c158..dbc690ebb3 100644 --- a/docs/latex/wx/htcontnr.tex +++ b/docs/latex/wx/htcontnr.tex @@ -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. - - diff --git a/docs/latex/wx/htfilter.tex b/docs/latex/wx/htfilter.tex index 8307d80382..c9956f817a 100644 --- a/docs/latex/wx/htfilter.tex +++ b/docs/latex/wx/htfilter.tex @@ -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: diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 9f01de6a8e..6acbc42042 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -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}} diff --git a/docs/latex/wx/htmlcell.tex b/docs/latex/wx/htmlcell.tex index 7e2411340e..b728800910 100644 --- a/docs/latex/wx/htmlcell.tex +++ b/docs/latex/wx/htmlcell.tex @@ -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). diff --git a/docs/latex/wx/htmlfilt.tex b/docs/latex/wx/htmlfilt.tex index 7edb17c8a5..b908668371 100644 --- a/docs/latex/wx/htmlfilt.tex +++ b/docs/latex/wx/htmlfilt.tex @@ -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}. diff --git a/docs/latex/wx/htmlhand.tex b/docs/latex/wx/htmlhand.tex index ab1503f7fe..1034c50246 100644 --- a/docs/latex/wx/htmlhand.tex +++ b/docs/latex/wx/htmlhand.tex @@ -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} + diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index ecb6a3ea2f..37c129e20b 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -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 \