From 605d715ddd84ddc3e78423e3f3ae5c27c8ff4d43 Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Fri, 24 Dec 1999 23:40:13 +0000 Subject: [PATCH] many fixes in documentation so that it compiles with LaTeX - get rid of \end{document} troubles, \it{} -> {\it} and few more syntax fixes. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5109 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 2 +- docs/latex/wx/body.tex | 8 +-- docs/latex/wx/classes.tex | 2 - docs/latex/wx/datstrm.tex | 8 +-- docs/latex/wx/evthand.tex | 4 +- docs/latex/wx/file.tex | 2 +- docs/latex/wx/fontlist.tex | 2 +- docs/latex/wx/fs.tex | 2 +- docs/latex/wx/ftp.tex | 12 ++-- docs/latex/wx/function.tex | 4 +- docs/latex/wx/htcell.tex | 20 +++--- docs/latex/wx/htcontnr.tex | 14 ++-- docs/latex/wx/htdcrend.tex | 8 +-- docs/latex/wx/hthelpct.tex | 4 +- docs/latex/wx/htmlcell.tex | 6 +- docs/latex/wx/htmlhlpf.tex | 2 +- docs/latex/wx/htparser.tex | 25 ------- docs/latex/wx/httag.tex | 16 +++-- docs/latex/wx/http.tex | 4 +- docs/latex/wx/htwindow.tex | 4 +- docs/latex/wx/htwinprs.tex | 50 +++++++++----- docs/latex/wx/hworld.tex | 4 +- docs/latex/wx/image.tex | 2 +- docs/latex/wx/inputstr.tex | 4 +- docs/latex/wx/listbox.tex | 2 +- docs/latex/wx/manual.tex | 132 +++++++++++++++++++++---------------- docs/latex/wx/outptstr.tex | 4 +- docs/latex/wx/socket.tex | 18 ++--- docs/latex/wx/stream.tex | 20 +++--- docs/latex/wx/strmfile.tex | 32 ++++----- docs/latex/wx/strmmem.tex | 4 +- docs/latex/wx/tbitmap.tex | 2 +- docs/latex/wx/tlog.tex | 2 +- docs/latex/wx/toolbar.tex | 2 +- docs/latex/wx/treeevt.tex | 2 +- docs/latex/wx/tunicode.tex | 4 +- docs/latex/wx/txtstrm.tex | 12 ++-- docs/latex/wx/window.tex | 14 ++-- docs/latex/wx/wxPython.tex | 4 +- docs/latex/wx/wxhtml.tex | 2 +- 40 files changed, 240 insertions(+), 225 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index 12e553cd56..cd5a9fd400 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -451,5 +451,5 @@ can be overridden by the user to change the default icons. \wxheading{Parameters} -\docparam{which}{One of the wxICON_XXX defines and chooses which icon to return.} +\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.} diff --git a/docs/latex/wx/body.tex b/docs/latex/wx/body.tex index e1ed4458e5..d7f0e29828 100644 --- a/docs/latex/wx/body.tex +++ b/docs/latex/wx/body.tex @@ -320,11 +320,11 @@ multi-megabyte .pch files. \section{Libraries} The GTK and Motif ports of wxWindow can create either a static library or a shared -library on most Unix or Unix-like systems. The static library is called libwx_gtk.a -and libwx_motif.a whereas the name of the shared library is dependent on the +library on most Unix or Unix-like systems. The static library is called libwx\_gtk.a +and libwx\_motif.a whereas the name of the shared library is dependent on the system it is created on and the version you are using. The library name for the -GTK version of wxWindows 2.2 on Linux and Solaris will be libwx_gtk-2.2.so.0.0.0, -on HP-UX, it will be libwx_gtk-2.2.sl, on AIX just libwx_gtk.a etc. +GTK version of wxWindows 2.2 on Linux and Solaris will be libwx\_gtk-2.2.so.0.0.0, +on HP-UX, it will be libwx\_gtk-2.2.sl, on AIX just libwx\_gtk.a etc. Under Windows, use the library wx.lib for stand-alone Windows applications, or wxdll.lib for creating DLLs. diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 0d4e36165f..c6a7c56787 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -1,7 +1,6 @@ \chapter{Alphabetical class reference}\label{classref} \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage}% -\pagenumbering{arabic}% \input accel.tex \input activevt.tex @@ -249,4 +248,3 @@ \input strmzlib.tex \input function.tex \input keycode.tex - diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex index 037a730d16..f1adb8aed5 100644 --- a/docs/latex/wx/datstrm.tex +++ b/docs/latex/wx/datstrm.tex @@ -60,9 +60,9 @@ Destroys the wxDataInputStream object. \membersection{wxDataInputStream::BigEndianOrdered} -\func{void}{BigEndianOrdered}{\param{bool}{ be_order}} +\func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be_order} is TRUE, all data will be read in big-endian +If {\it be\_order} is TRUE, all data will be read in big-endian order, such as written by programs on a big endian architecture (e.g. Sparc) or written by Java-Streams (which always use big-endian order). @@ -143,9 +143,9 @@ Destroys the wxDataOutputStream object. \membersection{wxDataOutputStream::BigEndianOrdered} -\func{void}{BigEndianOrdered}{\param{bool}{ be_order}} +\func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be_order} is TRUE, all data will be written in big-endian +If {\it be\_order} is TRUE, all data will be written in big-endian order, e.g. for reading on a Sparc or from Java-Streams (which always use big-endian order), otherwise data will be written in little-endian order. diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex index 84bd8b92b4..79bec64648 100644 --- a/docs/latex/wx/evthand.tex +++ b/docs/latex/wx/evthand.tex @@ -101,11 +101,11 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo \membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect} \func{bool}{Disconnect}{\param{int}{ id}, - \param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL}, + \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \param{wxObject*}{ userData = NULL}} \func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1}, - \param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL}, + \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \param{wxObject*}{ userData = NULL}} Disconnects the given function dynamically from the event handler, using the specified diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 4795f3e862..8d799e648c 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -452,7 +452,7 @@ Returns the current position. \membersection{wxFFile::Write}\label{wxffilewrite} -\func{size_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} +\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} Writes the specified number of bytes from a buffer. diff --git a/docs/latex/wx/fontlist.tex b/docs/latex/wx/fontlist.tex index dbe63b0580..f46812756e 100644 --- a/docs/latex/wx/fontlist.tex +++ b/docs/latex/wx/fontlist.tex @@ -38,7 +38,7 @@ Used by wxWindows to add a font to the list, called in the font constructor. \membersection{wxFontList::FindOrCreateFont}\label{findorcreatefont} \func{wxFont *}{FindOrCreateFont}{\param{int}{ point\_size}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, \param{bool}{ underline = FALSE}, - \param{const wxString\& }{facename = NULL}, \param{wxFontEncoding }{encoding = wxFONTENCODING_DEFAULT}{}} + \param{const wxString\& }{facename = NULL}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}{}} Finds a font of the given specification, or creates one and adds it to the list. See the \helpref{wxFont constructor}{wxfontconstr} for details of the arguments. diff --git a/docs/latex/wx/fs.tex b/docs/latex/wx/fs.tex index a5f89c9513..277eb0ecef 100644 --- a/docs/latex/wx/fs.tex +++ b/docs/latex/wx/fs.tex @@ -48,7 +48,7 @@ file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax In this example, protocol is "zip", left location is "reference/fopen.htm", anchor is "syntax" and right location -is "file:archives/cpp_doc.zip". It is used by zip handler +is "file:archives/cpp\_doc.zip". It is used by zip handler to determine in what file this particular zip VFS is stored. In fact there are two protocols used in this example: zip and file. diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index 2d58aea087..b8c25d08b9 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -22,7 +22,7 @@ \func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}} -Send the specified \it{command} to the FTP server. \it{ret} specifies +Send the specified {\it command} to the FTP server. {\it ret} specifies the expected result. \wxheading{Return value} @@ -72,7 +72,7 @@ Returns the current FTP working directory. \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}} -Rename the specified \it{src} element to \it{dst}. Returns TRUE if successful. +Rename the specified {\it src} element to {\it dst}. Returns TRUE if successful. % ---------------------------------------------------------------------------- @@ -80,7 +80,7 @@ Rename the specified \it{src} element to \it{dst}. Returns TRUE if successful. \func{bool}{RmFile}{\param{const wxString\&}{ path}} -Delete the file specified by \it{path}. Returns TRUE if successful. +Delete the file specified by {\it path}. Returns TRUE if successful. % ---------------------------------------------------------------------------- @@ -124,8 +124,8 @@ to specify a user and a password. \func{wxList *}{GetList}{\param{const wxString\&}{ wildcard}} The GetList function is quite low-level. It returns the list of the files in -the current directory. The list can be filtered using the \it{wildcard} string. -If \it{wildcard} is a NULL string, it will return all files in directory. +the current directory. The list can be filtered using the {\it wildcard} string. +If {\it wildcard} is a NULL string, it will return all files in directory. The form of the list can change from one peer system to another. For example, for a UNIX peer system, it will look like this: @@ -154,7 +154,7 @@ The list is a string list and one node corresponds to a line sent by the peer. \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}} -Initializes an output stream to the specified \it{file}. The returned +Initializes an output stream to the specified {\it file}. The returned stream has all but the seek functionality of wxStreams. When the user finishes writing data, he has to delete the stream to close it. diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 9dcba0b2e7..3a5343e446 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -2026,7 +2026,7 @@ base classes. This macro loads a bitmap from either application resources (on the platforms for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to -avoid using {\tt #ifdef}s when creating bitmaps. +avoid using {\tt \#ifdef}s when creating bitmaps. \wxheading{See also} @@ -2090,7 +2090,7 @@ Example: This macro loads an icon from either application resources (on the platforms for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to -avoid using {\tt #ifdef}s when creating icons. +avoid using {\tt \#ifdef}s when creating icons. \wxheading{See also} diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index b59bb47f29..bd61fbd2ab 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -62,10 +62,10 @@ Renders the cell. add this to m\_PosX,m\_PosY when passing coordinates to dc's methods Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}} -\docparam{view_y1}{y-coord of the first line visible in window. This is +\docparam{view\_y1}{y-coord of the first line visible in window. This is used to optimize rendering speed} -\docparam{view_y2}{y-coord of the last line visible in window. This is +\docparam{view\_y2}{y-coord of the last line visible in window. This is used to optimize rendering speed} \membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible} @@ -96,7 +96,7 @@ return pointer to the first cell that matches the condition) It is recommended way how to obtain pointer to particular cell or to cell of some type (e.g. wxHtmlAnchorCell reacts on -HTML_COND_ISANCHOR condition) +HTML\_COND\_ISANCHOR condition) \wxheading{Parameters} @@ -107,9 +107,9 @@ HTML_COND_ISANCHOR condition) \wxheading{Defined conditions} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf HTML_COND_ISANCHOR}}{Finds particular anchor. +\twocolitem{{\bf HTML\_COND\_ISANCHOR}}{Finds particular anchor. {\it param} is pointer to wxString with name of the anchor.} -\twocolitem{{\bf HTML_COND_USER}}{User-defined conditions start +\twocolitem{{\bf HTML\_COND\_USER}}{User-defined conditions start from this number.} \end{twocollist} @@ -117,15 +117,17 @@ from this number.} \constfunc{int}{GetDescent}{\void} -Returns descent value of the cell (m_Descent member). See explanation: +Returns descent value of the cell (m\_Descent member). +\helponly{See explanation: \image{}{descent.bmp} +} \membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight} \constfunc{int}{GetHeight}{\void} -Returns height of the cell (m_Height member). +Returns height of the cell (m\_Height member). \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink} @@ -139,7 +141,7 @@ See \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}. \docparam{x,y}{Coordinates of position where the user pressed mouse button. These coordinates are used e.g. by COLORMAP. Values are relative to the -upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)} +upper left corner of THIS cell (i.e. from 0 to m\_Width or m\_Height)} \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext} @@ -174,7 +176,7 @@ parent's \helpref{Layout}{wxhtmlcelllayout} was called before! \constfunc{int}{GetWidth}{\void} -Returns width of the cell (m_Width member). +Returns width of the cell (m\_Width member). \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout} diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index 2053c88c87..a966c58cda 100644 --- a/docs/latex/wx/htcontnr.tex +++ b/docs/latex/wx/htcontnr.tex @@ -124,7 +124,7 @@ Sets the container's {\it vertical alignment}. This is per-line alignment! \twocolitem{{\bf HTML\_ALIGN\_TOP}}{cells are under the line} \end{twocollist} -\image{}{alignv.bmp} +\helponly{\image{}{alignv.bmp}} } \membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour} @@ -168,7 +168,7 @@ combination of following constants: \twocolitem{{\bf HTML\_INDENT\_ALL}}{all 4 borders} \end{twocollist} -\image{}{indent.bmp} +\helponly{\image{}{indent.bmp}} } \docparam{units}{Units of {\it i}. This parameter affects interpretation of {\it} value. @@ -182,7 +182,7 @@ of parent container} \membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight} -\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}} +\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML\_ALIGN\_TOP}} Sets minimal height of the container. @@ -197,15 +197,15 @@ much smaller area. \docparam{h}{The minimal height.} \docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted -somewhere in order to ensure minimal height. This parameter is one of {\bf HTML_ALIGN_TOP, -HTML_ALIGN_BOTTOM, HTML_ALIGN_CENTER} constants. It refers to the {\it contents}, not to the +somewhere in order to ensure minimal height. This parameter is one of {\bf HTML\_ALIGN\_TOP, +HTML\_ALIGN\_BOTTOM, HTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the empty place!} \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat} \func{void}{SetWidthFloat}{\param{int }{w}, \param{int }{units}} -\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}, \param{double }{pixel_scale = 1.0}} +\func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}, \param{double }{pixel\_scale = 1.0}} Sets floating width adjustment. @@ -213,7 +213,7 @@ The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting FWA. -{\it pixel_scale} is number of real pixels that equals to 1 HTML pixel. +{\it pixel\_scale} is number of real pixels that equals to 1 HTML pixel. \wxheading{Parameters} diff --git a/docs/latex/wx/htdcrend.tex b/docs/latex/wx/htdcrend.tex index 58ae47a2f9..7260505e0e 100644 --- a/docs/latex/wx/htdcrend.tex +++ b/docs/latex/wx/htdcrend.tex @@ -23,13 +23,13 @@ Constructor. \membersection{wxHtmlDCRenderer::SetDC}\label{wxhtmldcrenderersetdc} -\func{void}{SetDC}{\param{wxDC* }{dc}, \param{double }{pixel_scale = 1.0}} +\func{void}{SetDC}{\param{wxDC* }{dc}, \param{double }{pixel\_scale = 1.0}} Assign DC instance to the renderer. -{\it pixel_scale} can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics. -(Many dimensions in HTML are given in pixels - e.g. image sizes. 300x300 image would be only one -inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.) +{\it pixel\_scale} can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics. +(Many dimensions in HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one +inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.) \wxheading{Parameters} diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index f425708612..5bb81c9323 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -37,7 +37,7 @@ wxEvtHandler \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller} -\func{}{wxHtmlHelpController}{\param{int }{style = wxHF_DEFAULTSTYLE}} +\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}} Constructor. @@ -57,7 +57,7 @@ Default value : everything enabled. \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook} -\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}} +\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}} Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books. This must be called at least once before displaying any help. diff --git a/docs/latex/wx/htmlcell.tex b/docs/latex/wx/htmlcell.tex index 3329962e73..731cb02a12 100644 --- a/docs/latex/wx/htmlcell.tex +++ b/docs/latex/wx/htmlcell.tex @@ -25,7 +25,7 @@ See \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}, % Bitmap is corrupt! This image shows you cells and containers: -\image{}{contbox.bmp} +\helponly{\image{}{contbox.bmp}} \end{comment} \wxheading{Using Containers in Tag Handler} @@ -45,7 +45,7 @@ it returns "control" to the parent container. % Bitmap corrupt! See explanation: -\image{}{cont.bmp} +\helponly{\image{}{cont.bmp}} \end{comment} It's clear there must be same number of calls to OpenContainer as to CloseContainer... @@ -70,7 +70,7 @@ m_WParser -> OpenContainer(); % Bitmap corrupt! and here is image of the situation: -\image{}{hello.bmp} +\helponly{\image{}{hello.bmp}} \end{comment} You can see that there was opened container before running the code. We closed diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index cf3d5fce48..3ce8f02382 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -48,7 +48,7 @@ Contents file has HTML syntax and it can be parsed by regular HTML parser. It co \end{verbatim} You can modify value attributes of param tags. {\it topic name} is name of chapter/topic as is displayed in -contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric_id} is optional +contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric\_id} is optional - it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay} Items in the list may be nested - one \verb$
  • $ statement may contain a \verb$