\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.}
\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.
\chapter{Alphabetical class reference}\label{classref}
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
-\pagenumbering{arabic}%
\input accel.tex
\input activevt.tex
\input strmzlib.tex
\input function.tex
\input keycode.tex
-
\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).
\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.
\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
\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.
\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.
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.
\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}
\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.
% ----------------------------------------------------------------------------
\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.
% ----------------------------------------------------------------------------
\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:
\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.
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}
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}
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}
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}
\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}
\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}
\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}
\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}
\twocolitem{{\bf HTML\_ALIGN\_TOP}}{cells are under the line}
\end{twocollist}
-\image{}{alignv.bmp}
+\helponly{\image{}{alignv.bmp}}
}
\membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour}
\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.
\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.
\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.
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}
\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}
\membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
-\func{}{wxHtmlHelpController}{\param{int }{style = wxHF_DEFAULTSTYLE}}
+\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}}
Constructor.
\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.
% 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}
% 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...
% 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
\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$<li>$ statement may contain a \verb$<ul>$ sub-statement:
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 freed
-by the destructor because they must be valid as long as
-GetProduct's return value is valid - the caller must
-explicitly call
-
-\begin{verbatim}
-delete (MyParser -> GetTempData());
-\end{verbatim}
-
-to free the memory (this method always sets the list to delete its contents).
-
-\wxheading{Example}
-
-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.
-
-GetTempData() solves the problem.
\membersection{wxHtmlParser::InitParser}\label{wxhtmlparserinitparser}
Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.
+
\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}
\constfunc{int}{GetBeginPos}{\void}
Returns beginning position of the text {\it between} this tag and paired
ending tag.
-See explanation (returned position is marked with '^'):
+See explanation (returned position is marked with `|'):
\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
- ^
+ |
\end{verbatim}
+
\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}
\constfunc{int}{GetEndPos1}{\void}
Returns ending position of the text {\it between} this tag and paired
ending tag.
-See explanation (returned position is marked with '^'):
+See explanation (returned position is marked with `|'):
\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
- ^
+ |
\end{verbatim}
+
\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
\constfunc{int}{GetEndPos2}{\void}
Returns ending position 2 of the text {\it between} this tag and paired
ending tag.
-See explanation (returned position is marked with '^'):
+See explanation (returned position is marked with `|'):
\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
- ^
+ |
\end{verbatim}
\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}
'<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
and name of {\tt </table>} is "TABLE")
+
\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}}
\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}}
It sets data of a field to be sent during the next request to the HTTP server. The field
-name is specified by \it{header} and the content by \it{h\_data}.
+name is specified by {\it header} and the content by {\it h\_data}.
This is a low level function and it assumes that you know what you are doing.
\membersection{wxHTTP::GetHeader}
\func{wxString}{GetHeader}{\param{const wxString\&}{ header}}
-Returns the data attached with a field whose name is specified by \it{header}.
+Returns the data attached with a field whose name is specified by {\it header}.
If the field doesn't exist, it will return an empty string and not a NULL string.
\wxheading{Note}
Default constructor.
-\func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW_SCROLLBAR_AUTO}, \param{const wxString\& }{name = "htmlWindow"}}
+\func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW\_SCROLLBAR\_AUTO}, \param{const wxString\& }{name = "htmlWindow"}}
Constructor. The parameters are the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor.
This function sets the space between border of window and HTML contents. See image:
-\image{}{border.bmp}
+\helponly{\image{}{border.bmp}}
\wxheading{Parameters}
\begin{enumerate}
\item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
-\item This parser produces temporary data! You should call
-\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!
\end{enumerate}
\wxheading{Derived from}
and returns pointer to it.
(If the font was already created only a pointer is returned.)
-Fonts created during parsing are temporary data and are not freed on DoneParser.
-You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata}
-to free the memory!
\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
Returns TRUE if actual font is bold, FALSE otherwise.
+\membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface}
+
+\constfunc{wxString}{GetFontFace}{\void}
+
+Returns actual font face name.
+
+
\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
\constfunc{int}{GetFontFixed}{\void}
Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
-%
+
\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
Alignment of newly opened container is set to this value.
-%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
-%
-%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
-%
-%Allows you to directly set opened container. This is not recommended - you should use OpenContainer
-%whereever possible.
-%
+
+\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
+
+\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
+
+Allows you to directly set opened container. This is not recommended - you should use OpenContainer
+whereever possible.
+
\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
-\func{virtual void}{SetDC}{\param{wxDC }{*dc}, \param{double }{pixel_scale = 1.0}}
+\func{virtual void}{SetDC}{\param{wxDC }{*dc}, \param{double }{pixel\_scale = 1.0}}
+
+Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
+{\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.)
-Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}! {\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.)
\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
+\membersection{wxHtmlWinParser::SetFontFace}\label{wxhtmlwinparsersetfontface}
+
+\func{void}{SetFontFace}{\param{const wxString\& }{face}}
+
+Sets current font face to {\it face}. This affects either fixed size
+font or proportional, depending on context (whether the parser is
+inside {\tt <TT>} tag or not).
+
\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
\func{void}{SetFontFixed}{\param{int }{x}}
Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
+
\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
\func{void}{SetFontSize}{\param{int }{s}}
"Hello World":
You have to include wxWindows's header files, of course. This can
-be done on a file by file basis (such as #include "wx/window.h")
-or using one global include (#include "wx/wx.h"). This is
+be done on a file by file basis (such as \#include "wx/window.h")
+or using one global include (\#include "wx/wx.h"). This is
also useful on platforms which support precompiled headers such
as all major compilers on the Windows platform.
\membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
-\constfunc{wxImage}{GetSubImage}{\param{const wxRect&}{rect}}
+\constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{rect}}
Returns a sub image of the current one as long as the rect belongs entirely to
the image.
\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
-Reads the specified amount of bytes and stores the data in \it{buffer}.
+Reads the specified amount of bytes and stores the data in {\it buffer}.
\wxheading{Warning}
\func{size\_t}{Ungetch}{\param{const char*}{ buffer}, \param{size\_t}{ size}}
-This function is only useful in \it{read} mode. It is the manager of the "Write-Back"
+This function is only useful in {\it read} mode. It is the manager of the "Write-Back"
buffer. This buffer acts like a temporary buffer where datas which has to be
read during the next read IO call are put. This is useful when you get a big
block of data which you didn't want to read: you can replace them at the top
\membersection{wxListBox::GetSelections}\label{wxlistboxgetselections}
-\constfunc{int}{GetSelections}{\param{wxArrayInt& }{selections}}
+\constfunc{int}{GetSelections}{\param{wxArrayInt\& }{selections}}
Fill an array of ints with the positions of the currently selected items.
% A special table of contents for the WinHelp manual
\begin{comment}
\winhelponly{
-\chapter*{wxWindows class library reference}\label{winhelpcontents}
+\chapter{wxWindows class library reference}\label{winhelpcontents}
\center{
%\image{}{wxwin.wmf}
}
\end{comment}
-\chapter*{Copyright notice}
+\chapter{Copyright notice}
\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
Please also see the wxWindows licence files (preamble.txt, lgpl.txt, gpl.txt, licence.txt,
licendoc.txt) for conditions of software and documentation use.
-\begin{verbatim}
-wxWindows Library License, Version 3
-====================================
-
+\section*{wxWindows Library License, Version 3}
+
Copyright (C) 1998 Julian Smart, Robert Roebling, Vadim Zeitlin et al.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
-
- WXWINDOWS LIBRARY LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
+
+\begin{center}
+WXWINDOWS LIBRARY LICENSE\\
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+\end{center}
+
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
-
+
This library is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-
- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
General Public License for more details.
-
+
You should have received a copy of the GNU Library General Public License
along with this software, usually in a file named COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- Boston, MA 02111-1307 USA.
-
+ Boston, MA~02111-1307 USA.
+
EXCEPTION NOTICE
-
+
1. As a special exception, the copyright holders of this library give
permission for additional uses of the text contained in this release of
the library as licensed under the wxWindows Library License, applying
either version 3 of the License, or (at your option) any later version of
the License as published by the copyright holders of version 3 of the
License document.
-
+
2. The exception is that you may create binary object code versions of any
works using this library or based on this library, and use, copy, modify,
link and distribute such binary object code files unrestricted under terms
of your choice.
-
+
3. If you copy code from files distributed under the terms of the GNU
General Public License or the GNU Library General Public License into a
copy of this library, as this license permits, the exception does not
to the status of such modified files, you must delete this exception
notice from such code and/or adjust the licensing conditions notice
accordingly.
-
+
4. If you write modifications of your own for this library, it is your
choice whether to permit this exception to apply to your modifications.
If you do not wish that, you must delete the exception notice from such
code and/or adjust the licensing conditions notice accordingly.
-GNU Library General Public License, Version 2
-=============================================
+\section*{GNU Library General Public License, Version 2}
Copyright (C) 1991 Free Software Foundation, Inc.
- 675 Mass Ave, Cambridge, MA 02139, USA
+ 675 Mass Ave, Cambridge, MA 02139, USA
+
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
- Preamble
+\wxheading{Preamble}
The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
+freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
+free software -- to make sure the software is free for all its users.
This license, the Library General Public License, applies to some
specially designated Free Software Foundation software, and to any
Note that it is possible for a library to be covered by the ordinary
General Public License rather than by this special one.
- GNU LIBRARY GENERAL PUBLIC LICENSE
+\begin{center}
+ GNU LIBRARY GENERAL PUBLIC LICENSE\\
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+\end{center}
0. This License Agreement applies to any software library which
contains a notice placed by the copyright holder or other authorized
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
+\begin{indented}{1cm}
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
- root function must still compute square roots.)
+ root function must still compute square roots.)
+\end{indented}
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
directing the user to the copy of this License. Also, you must do one
of these things:
+
+\begin{indented}{1cm}
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
d) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
+\end{indented}
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
+\begin{indented}{1cm}
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
+\end{indented}
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
+\begin{center}
NO WARRANTY
+\end{center}
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
+
+\begin{center}
END OF TERMS AND CONDITIONS
+\end{center}
- Appendix: How to Apply These Terms to Your New Libraries
+\wxheading{Appendix: How to Apply These Terms to Your New Libraries}
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
- <one line to give the library's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.
+\footnotesize{
+\begin{verbatim}
+<one line to give the library's name and a brief idea of what it does.>
+Copyright (C) <year> <name of author>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Library General Public
+License as published by the Free Software Foundation; either
+version 2 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Library General Public License for more details.
+
+You should have received a copy of the GNU Library General Public
+License along with this library; if not, write to the Free
+Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+\end{verbatim}
+}
- You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the Free
- Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Also add information on how to contact you by electronic and paper mail.
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
- Yoyodyne, Inc., hereby disclaims all copyright interest in the
- library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+\footnotesize{
+\begin{verbatim}
+Yoyodyne, Inc., hereby disclaims all copyright interest in the
+library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+<signature of Ty Coon>, 1 April 1990
+Ty Coon, President of Vice
+\end{verbatim}
+}
- <signature of Ty Coon>, 1 April 1990
- Ty Coon, President of Vice
That's all there is to it!
-\end{verbatim}
-
\input{body.tex}
-\helpinput{classes.tex}
-\helpinput{category.tex}
-\helpinput{topics.tex}
-\helpinput{wxhtml.tex}
-\helpinput{wxPython.tex}
+\input{classes.tex}
+\input{category.tex}
+\input{topics.tex}
+\input{wxhtml.tex}
+\input{wxPython.tex}
\begin{comment}
\newpage
\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
-Writes the specified amount of bytes using the data of \it{buffer}.
-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+Writes the specified amount of bytes using the data of {\it buffer}.
+{\it WARNING!} The buffer absolutely needs to have at least the specified size.
This function returns a reference on the current object, so the user can test
any states of the stream right away.
\wxheading{Remark/Warning}
-wxSocketBase::WriteMsg() will behave as if the wxSOCKET_WAITALL flag was always set
-and it will always ignore the wxSOCKET_NOWAIT flag. The exact behaviour of WriteMsg
-depends on the wxSOCKET_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+wxSocketBase::WriteMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
+and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of WriteMsg
+depends on the wxSOCKET\_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
\wxheading{See also}
\wxheading{Remark/Warning}
-wxSocketBase::ReadMsg() will behave as if the wxSOCKET_WAITALL flag was always set
-and it will always ignore the wxSOCKET_NOWAIT flag. The exact behaviour of ReadMsg
-depends on the wxSOCKET_SPEED flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+wxSocketBase::ReadMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
+and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of ReadMsg
+depends on the wxSOCKET\_SPEED flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
\wxheading{See also}
%
\membersection{wxSocketBase::GetLocal}{wxsocketbasegetlocal}
-\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr_man}}
+\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr\_man}}
This function returns the local address field of the socket. The local
address field contains the complete local address of the socket (local
%
\membersection{wxSocketBase::GetPeer}{wxsocketbasegetlocal}
-\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr_man}}
+\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr\_man}}
This function returns the peer address field of the socket. The peer
address field contains the complete peer host address of the socket
[TODO:]
A brief note on how to use events.
-The wxSOCKET_INPUT event is generated when the
+The wxSOCKET\_INPUT event is generated when the
\wxheading{See also}
\func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
-Constructor, creates a new stream buffer using \it{stream} as a parent stream
-and \it{mode} as the IO mode. \it{mode} can be: wxStreamBuffer::read,
+Constructor, creates a new stream buffer using {\it stream} as a parent stream
+and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read,
wxStreamBuffer::write, wxStreamBuffer::read\_write.
\func{}{wxStreamBuffer}{\param{BufMode}{ mode}}
Constructor, creates a new empty stream buffer which won't flush any data
-to a stream. \it{mode} specifies the type of the buffer (read, write, read\_write).
+to a stream. {\it mode} specifies the type of the buffer (read, write, read\_write).
This stream buffer has the advantage to be stream independent and to
work only on memory buffers but it is still compatible with the rest of the
wxStream classes. You can write, read to this special stream and it will
\func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
-Reads a \it{buffer}. The function returns when \it{buffer} is full or when there isn't
+Reads a {\it buffer}. The function returns when {\it buffer} is full or when there isn't
data anymore in the current buffer.
\wxheading{See also}
\func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
-Writes a block of the specified \it{size} using datas of \it{buffer}. The datas
+Writes a block of the specified {\it size} using datas of {\it buffer}. The datas
are cached in a buffer before being sent in one block to the stream.
\func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
\constfunc{off\_t}{Tell}{\void}
Gets the current position in the stream. This position is calculated from
-the \it{real} position in the stream and from the internal buffer position: so
-it gives you the position in the \it{real} stream counted from the start of
+the {\it real} position in the stream and from the internal buffer position: so
+it gives you the position in the {\it real} stream counted from the start of
the stream.
\wxheading{Return value}
Changes the current position.
-\it{mode} may be one of the following:
+{\it mode} may be one of the following:
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\func{void}{Fixed}{\param{bool}{ fixed}}
Toggles the fixed flag. Usually this flag is toggled at the same time as
-\it{flushable}. This flag allows (when it has the FALSE value) or forbids
+{\it flushable}. This flag allows (when it has the FALSE value) or forbids
(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer.
\wxheading{See also}
\func{void}{Flushable}{\param{bool}{ flushable}}
-Toggles the flushable flag. If \it{flushable} is disabled, no datas are sent
+Toggles the flushable flag. If {\it flushable} is disabled, no datas are sent
to the parent stream.
\membersection{wxStreamBuffer::FlushBuffer}
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
-wxSTREAM_EOF after having read the last byte whereas wxFFileInputStream
-will report wxSTREAM_EOF after trying to read {\it past} the last byte.
+wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
+will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
-Opens the specified file using its \it{ifilename} name in read-only mode.
+Opens the specified file using its {\it ifilename} name in read-only mode.
\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
-Initializes a file stream in read-only mode using the file I/O object \it{file}.
+Initializes a file stream in read-only mode using the file I/O object {\it file}.
\func{}{wxFileInputStream}{\param{int}{ fd}}
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
-wxSTREAM_EOF after having read the last byte whereas wxFFileInputStream
-will report wxSTREAM_EOF after trying to read {\it past} the last byte.
+wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
+will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
-Creates a new file with \it{ofilename} name and initializes the stream in
+Creates a new file with {\it ofilename} name and initializes the stream in
write-only mode.
\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
-Initializes a file stream in write-only mode using the file I/O object \it{file}.
+Initializes a file stream in write-only mode using the file I/O object {\it file}.
\func{}{wxFileOutputStream}{\param{int}{ fd}}
-Initializes a file stream in write-only mode using the file descriptor \it{fd}.
+Initializes a file stream in write-only mode using the file descriptor {\it fd}.
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
\func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
Initializes a new file stream in read-write mode using the specified
-\it{iofilename} name.
+{\it iofilename} name.
% -----------------------------------------------------------------------------
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
-wxSTREAM_EOF after having read the last byte whereas wxFFileInputStream
-will report wxSTREAM_EOF after trying to read {\it past} the last byte.
+wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
+will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
-wxSTREAM_EOF after having read the last byte whereas wxFFileInputStream
-will report wxSTREAM_EOF after trying to read {\it past} the last byte.
+wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
+will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\func{}{wxFFileOutputStream}{\param{const wxString\&}{ ofileName}}
-Creates a new file with \it{ofilename} name and initializes the stream in
+Creates a new file with {\it ofilename} name and initializes the stream in
write-only mode.
\func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
Initializes a new file stream in read-write mode using the specified
-\it{iofilename} name.
+{\it iofilename} name.
\func{}{wxMemoryOutputStream}{\param{char *}{ data = NULL}, \param{size\_t}{ length = 0}}
-If \it{data} is NULL, then it will initialize a new empty buffer which will
+If {\it data} is NULL, then it will initialize a new empty buffer which will
grow if required.
\wxheading{Warning}
\constfunc{size\_t}{CopyTo}{\param{char *}{buffer}, \param{size\_t }{len}}
CopyTo allowed you to transfer data from the internal buffer of
-wxMemoryOutputStream to an external buffer. \it{len} specifies the size of
+wxMemoryOutputStream to an external buffer. {\it len} specifies the size of
the buffer.
\wxheading{Returned value}
You should always use wxICON and wxBITMAP macros because they work for any
platform (unlike the code above which doesn't deal with wxMac, wxBe, ...) and
-are more short and clear than versions with {\tt #ifdef}s.
+are more short and clear than versions with {\tt \#ifdef}s.
\subsection{Supported bitmap file formats}\label{supportedbitmapformats}
wxWindows has the notion of a {\it log target}: it's just a class deriving
from \helpref{wxLog}{wxlog}. As such, it implements the virtual functions of
the base class which are called when a message is logged. Only one log target
-is {\it active} at any moment, this is the one used by \it{wxLogXXX()}
+is {\it active} at any moment, this is the one used by {\it wxLogXXX()}
functions. The normal usage of a log object (i.e. object of a class derived
from wxLog) is to install it as the active target with a call to {\it
SetActiveTarget()} and it will be used automatically by all subsequent calls
\membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
-{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
+\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp
\param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
\membersection{wxTreeEvent::GetLabel}
-\constfunc{const wxString&}{GetLabel}{}
+\constfunc{const wxString\&}{GetLabel}{}
Returns the label if the event was a begin or end edit label event.
\end{verbatim}
Of course, it would be nearly impossibly to write such programs if it had to
-be done this way (try to imagine the number of {\tt #ifdef UNICODE} an average
+be done this way (try to imagine the number of {\tt \#ifdef UNICODE} an average
program would have had!). Luckily, there is another way - see the next
section.
int len = s.Len();
\end{verbatim}
-What happens here? First of all, you see that there are no more {\tt #ifdef}s
+What happens here? First of all, you see that there are no more {\tt \#ifdef}s
at all. Instead, we define some types and macros which behave differently in
the Unicode and ANSI builds and allows us to avoid using conditional
compilation in the program itself.
\section{\class{wxTextInputStream}}\label{wxtextinputstream}
This class provides functions that read text datas using an input stream.
-So, you can read \it{text} floats, integers.
+So, you can read {\it text} floats, integers.
The wxTextInputStream correctly reads text files (or streams) in DOS, Macintosh
and Unix formats and reports a single newline char as a line ending.
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
-\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL_NATIVE}}
+\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}}
Constructs a text stream object from an output stream. Only write methods will
be available.
\docparam{stream}{The output stream.}
-\docparam{mode}{The end-of-line mode. One of {\bf wxEOL_NATIVE}, {\bf wxEOL_DOS}, {\bf wxEOL_MAC} or {\bf wxEOL_UNIX}.}
+\docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.}
\membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}
\func{wxEOL}{wxTextOutputStream::GetMode}{\void}
-Returns the end-of-line mode. One of {\bf wxEOL_DOS}, {\bf wxEOL_MAC} or {\bf wxEOL_UNIX}.
+Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.
\membersection{wxTextOutputStream::SetMode}
-\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL_NATIVE}}
+\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}}
-Set the end-of-line mode. One of {\bf wxEOL_NATIVE}, {\bf wxEOL_DOS}, {\bf wxEOL_MAC} or {\bf wxEOL_UNIX}.
+Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.
\membersection{wxTextOutputStream::Write8}
\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
-\constfunc{bool}{IsExposed}{\param{wxPoint }{&pt}}
+\constfunc{bool}{IsExposed}{\param{wxPoint }{\&pt}}
\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, \param{int }{w}, \param{int }{h}}
-\constfunc{bool}{IsExposed}{\param{wxRect }{&rect}}
+\constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
Returns TRUE if the given point or rectange area has been exposed since the
last repaint. Call this in an paint event handler to optimize redrawing by
\small{%
\begin{verbatim}
- void MyWindow::OnPaint(wxPaintEvent& event)
+ void MyWindow::OnPaint(wxPaintEvent\& event)
{
wxPaintDC dc(this);
{\small%
\begin{verbatim}
// Called when window needs to be repainted.
-void MyWindow::OnPaint(wxPaintEvent& event)
+void MyWindow::OnPaint(wxPaintEvent\& event)
{
wxPaintDC dc(this);
\membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
-\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint& }{pos}}
+\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}}
\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
Note that this function is actually disabled for wxWindow. It has
effect for wxDialog, wxFrame, wxPanel and wxScrolledWindow. Windows
of other types that need to invoke the Layout algorithm should provide
-an EVT_SIZE handler and call
+an EVT\_SIZE handler and call
\helpref{wxWindow::Layout}{wxwindowlayout} from within it.
\wxheading{See also}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE_AUTO)}}{}
+\twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE\_AUTO)}}{}
\twocolitem{\bf{SetSize(size)}}{}
\twocolitem{\bf{SetPosition(point)}}{}
\end{twocollist}}
\chapter{wxPython Notes}\label{wxPython}
-\pagenumbering{arabic}%
+
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
it by issuing this command:
\begin{indented}{1cm}
- \bftt{python DialogUnits.py}
+ {\bf\tt python DialogUnits.py}
\end{indented}
\hrule
\chapter{wxHTML Notes}\label{wxHTML}
-\pagenumbering{arabic}%
+
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
projects / wxWidgets.git / commitdiff
