Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some doc proofreading

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-03-15 00:21:49 +00:00
parent 8cb9f0d0f8
commit fa482912e4
96 changed files with 559 additions and 486 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/latex/wx/app.tex
View File

@@ -246,7 +246,7 @@ wxWindows' strategy for OnIdle processing is as follows. After pending user inte
application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
sends an OnIdle event to each application window, allowing windows to do idle processing such as updating sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by
caling \helpref{wxIdleEvent::ReqestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
event to the application object. This will occur in a loop until either a user event is found to be event to the application object. This will occur in a loop until either a user event is found to be
pending, or OnIdle requests no more time. Then all pending user events are processed until the system pending, or OnIdle requests no more time. Then all pending user events are processed until the system
goes idle again, when OnIdle is called, and so on. goes idle again, when OnIdle is called, and so on.
@@ -476,7 +476,9 @@ can be overridden by the user to change the default icons.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.} \docparam{which}{One of the wxICON\_XXX specifies which icon to return.}
See \helpref{wxMessageBox}{wxmessagebox} for a list of icon identifiers.
\membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual} \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}

1
docs/latex/wx/array.tex
View File

@@ -261,6 +261,7 @@ WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
You will have to initialize the objects of this class by passing a comparaison You will have to initialize the objects of this class by passing a comparaison
function to the array object constructor like this: function to the array object constructor like this:
\begin{verbatim} \begin{verbatim}
int CompareInts(int n1, int n2) int CompareInts(int n1, int n2)
{ {

10
docs/latex/wx/arrstrng.tex
View File

@@ -175,9 +175,9 @@ Insert("foo", 0);
If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as
\helpref{Add}{wxarraystringadd}. \helpref{Add}{wxarraystringadd}.
{\bf Warning:} this function should not be used with sorted array because it {\bf Warning:} this function should not be used with sorted arrays because it
could break the order of items and, for example, subsequent calls to could break the order of items and, for example, subsequent calls to
\helpref{Index()}{wxarraystringindex} would not work then! \helpref{Index()}{wxarraystringindex} would then not work!
\membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty} \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
@@ -240,7 +240,7 @@ Sorts the array in alphabetical order or in reverse alphabetical order if
{\bf Warning:} this function should not be used with sorted array because it {\bf Warning:} this function should not be used with sorted array because it
could break the order of items and, for example, subsequent calls to could break the order of items and, for example, subsequent calls to
\helpref{Index()}{wxarraystringindex} would not work then! \helpref{Index()}{wxarraystringindex} would then not work!
See also: \helpref{Sort}{wxarraystringsortcallback} See also: \helpref{Sort}{wxarraystringsortcallback}
@@ -250,7 +250,7 @@ See also: \helpref{Sort}{wxarraystringsortcallback}
Sorts the array using the specified {\it compareFunction} for item comparison. Sorts the array using the specified {\it compareFunction} for item comparison.
{\it CompareFunction} is defined as a function taking two {\it const {\it CompareFunction} is defined as a function taking two {\it const
wxString\&} parameters and returning {\it int} value less than, equal to or wxString\&} parameters and returning an {\it int} value less than, equal to or
greater than 0 if the first string is less than, equal to or greater than the greater than 0 if the first string is less than, equal to or greater than the
second one. second one.
@@ -278,7 +278,7 @@ array.Sort(CompareStringLen);
{\bf Warning:} this function should not be used with sorted array because it {\bf Warning:} this function should not be used with sorted array because it
could break the order of items and, for example, subsequent calls to could break the order of items and, for example, subsequent calls to
\helpref{Index()}{wxarraystringindex} would not work then! \helpref{Index()}{wxarraystringindex} would then not work!
See also: \helpref{Sort}{wxarraystringsort} See also: \helpref{Sort}{wxarraystringsort}

2
docs/latex/wx/bmpdatob.tex
View File

@@ -39,7 +39,7 @@ efficiency.
\func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}} \func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
Constructor, optionally passing a bitmap (otherwise use Constructor, optionally passing a bitmap (otherwise use
\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later) \helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later).
\membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap} \membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}

45
docs/latex/wx/body.tex
View File

@@ -6,16 +6,15 @@
\section{What is wxWindows?} \section{What is wxWindows?}
wxWindows is a C++ framework providing GUI (Graphical User wxWindows is a C++ framework providing GUI (Graphical User
Interface) and other facilities on more than one platform. Version 2.0 currently Interface) and other facilities on more than one platform. Version 2 currently
supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, and Unix with Motif. supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, Unix with Motif,
A Mac port is in an advanced state, an OS/2 port and a port to the MGL graphics library and Mac. An OS/2 port is in progress.
have been started.
wxWindows was originally developed at the Artificial Intelligence wxWindows was originally developed at the Artificial Intelligence
Applications Institute, University of Edinburgh, for internal use. Applications Institute, University of Edinburgh, for internal use,
wxWindows has been released into the public domain in the hope and was first made publicly available in 1993.
that others will also find it useful. Version 2.0 is written and Version 2 is a vastly improved version written and maintained by
maintained by Julian Smart, Robert Roebling, Vadim Zeitlin and others. Julian Smart, Robert Roebling, Vadim Zeitlin and many others.
This manual discusses wxWindows in the context of multi-platform This manual discusses wxWindows in the context of multi-platform
development.\helpignore{For more detail on the wxWindows version 2.0 API development.\helpignore{For more detail on the wxWindows version 2.0 API
@@ -44,9 +43,9 @@ Since wxWindows was started, several other free or almost-free GUI frameworks ha
emerged. However, none has the range of features, flexibility, documentation and the emerged. However, none has the range of features, flexibility, documentation and the
well-established development team that wxWindows has. well-established development team that wxWindows has.
As public domain software and a project open to everyone, wxWindows has As open source software, wxWindows has
benefited from comments, ideas, bug fixes, enhancements and the sheer benefited from comments, ideas, bug fixes, enhancements and the sheer
enthusiasm of users, especially via the Internet. This gives wxWindows a enthusiasm of users. This gives wxWindows a
certain advantage over its commercial competitors (and over free libraries certain advantage over its commercial competitors (and over free libraries
without an independent development team), plus a robustness against without an independent development team), plus a robustness against
the transience of one individual or company. This openness and the transience of one individual or company. This openness and
@@ -54,10 +53,10 @@ availability of source code is especially important when the future of
thousands of lines of application code may depend upon the longevity of thousands of lines of application code may depend upon the longevity of
the underlying class library. the underlying class library.
Version 2.0 goes much further than previous versions in terms of generality and features, Version 2 goes much further than previous versions in terms of generality and features,
allowing applications to be produced allowing applications to be produced
that are often indistinguishable from those produced using single-platform that are often indistinguishable from those produced using single-platform
toolkits such as Motif and MFC. toolkits such as Motif, GTK+ and MFC.
The importance of using a platform-independent class library cannot be The importance of using a platform-independent class library cannot be
overstated, since GUI application development is very time-consuming, overstated, since GUI application development is very time-consuming,
@@ -66,9 +65,9 @@ Code can very quickly become obsolete if it addresses the wrong
platform or audience. wxWindows helps to insulate the programmer from platform or audience. wxWindows helps to insulate the programmer from
these winds of change. Although wxWindows may not be suitable for these winds of change. Although wxWindows may not be suitable for
every application (such as an OLE-intensive program), it provides access to most of the functionality a every application (such as an OLE-intensive program), it provides access to most of the functionality a
GUI program normally requires, plus some extras such as network programming GUI program normally requires, plus many extras such as network programming,
and PostScript output, and can of course be extended as needs dictate. As a bonus, it provides PostScript output, and HTML rendering; and it can of course be extended as needs dictate. As a bonus, it provides
a cleaner programming interface than the native a far cleaner and easier programming interface than the native
APIs. Programmers may find it worthwhile to use wxWindows even if they APIs. Programmers may find it worthwhile to use wxWindows even if they
are developing on only one platform. are developing on only one platform.
@@ -80,8 +79,8 @@ here are some of the benefits:
\item You get the source. \item You get the source.
\item Available on a variety of popular platforms. \item Available on a variety of popular platforms.
\item Works with almost all popular C++ compilers and Python. \item Works with almost all popular C++ compilers and Python.
\item Over 40 example programs. \item Over 50 example programs.
\item Over 900 pages of printable and on-line documentation. \item Over 1000 pages of printable and on-line documentation.
\item Includes Tex2RTF, to allow you to produce your own documentation \item Includes Tex2RTF, to allow you to produce your own documentation
in Windows Help, HTML and Word RTF formats. in Windows Help, HTML and Word RTF formats.
\item Simple-to-use, object-oriented API. \item Simple-to-use, object-oriented API.
@@ -97,7 +96,7 @@ in Windows Help, HTML and Word RTF formats.
\item Under MS Windows, support for creating metafiles and copying \item Under MS Windows, support for creating metafiles and copying
them to the clipboard. them to the clipboard.
\item An API for invoking help from applications. \item An API for invoking help from applications.
\item Ready to use HTML window (supporting a subset of HTML). \item Ready-to-use HTML window (supporting a subset of HTML).
\item Dialog Editor for building dialogs. \item Dialog Editor for building dialogs.
\item Network support via a family of socket and protocol classes. \item Network support via a family of socket and protocol classes.
\item Support for platform independent image procesing. \item Support for platform independent image procesing.
@@ -222,9 +221,11 @@ Metrowerks CodeWarrior.
\section{Availability and location of wxWindows} \section{Availability and location of wxWindows}
wxWindows is available by anonymous FTP and World Wide Web \winhelponly{wxWindows is available by anonymous FTP and World Wide Web
from ftp://www.remstar.com/pub/wxwin and/or http://www.wxwindows.org.}
\winhelpignore{wxWindows is available by anonymous FTP and World Wide Web
from \urlref{ftp://www.remstar.com/pub/wxwin}{ftp://www.remstar.com/pub/wxwin} from \urlref{ftp://www.remstar.com/pub/wxwin}{ftp://www.remstar.com/pub/wxwin}
and/or \urlref{http://www.wxwindows.org}{http://www.wxwindows.org} and/or \urlref{http://www.wxwindows.org}{http://www.wxwindows.org}.}
You can also buy a CD-ROM using the form on the Web site, or by contacting: You can also buy a CD-ROM using the form on the Web site, or by contacting:
@@ -326,8 +327,8 @@ 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, 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. 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 Under Windows, use the library wx.lib (release) or wxd.lib (debug) for stand-alone Windows
applications, or wxdll.lib for creating DLLs. applications, or wxdll.lib (wxdlld.lib) for creating DLLs.
\section{Configuration} \section{Configuration}

6
docs/latex/wx/boxsizer.tex
View File

@@ -102,19 +102,19 @@ or wxHORIZONTAL for creating either a column sizer or a row sizer.
Implements the calculation of a box sizer's dimensions and then sets Implements the calculation of a box sizer's dimensions and then sets
the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize} the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize}
if the child is a window). It is used internally only and must not be called if the child is a window). It is used internally only and must not be called
by the users. Documented for information. by the user. Documented for information.
\membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin} \membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin}
\func{wxSize}{CalcMin}{\void} \func{wxSize}{CalcMin}{\void}
Implements the calculation of a box sizer's minimal. It is used internally Implements the calculation of a box sizer's minimal. It is used internally
only and must not be called by the users. Documented for information. only and must not be called by the user. Documented for information.
\membersection{wxBoxSizer::GetOrientation}\label{wxboxsizergetorientation} \membersection{wxBoxSizer::GetOrientation}\label{wxboxsizergetorientation}
\func{int}{GetOrientation}{\void} \func{int}{GetOrientation}{\void}
Returns the orientation of the boxsizer, either of wxVERTICAL Returns the orientation of the box sizer, either wxVERTICAL
or wxHORIZONTAL. or wxHORIZONTAL.

1
docs/latex/wx/classes.tex
View File

@@ -37,6 +37,7 @@
\input conditn.tex \input conditn.tex
\input config.tex \input config.tex
\input control.tex \input control.tex
\input countstr.tex
\input critsect.tex \input critsect.tex
\input crtslock.tex \input crtslock.tex
\input custdobj.tex \input custdobj.tex

46
docs/latex/wx/countstr.tex Normal file
View File

@@ -0,0 +1,46 @@
% -----------------------------------------------------------------------------
% wxCountingOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
wxCountingOutputStream is a specialized output stream which does not write any data anyway,
instead it counts how many bytes would get written if this were a normal stream. This
can sometimes be useful or required if some data gets serialized to a stream or compressed
by using stream compression and thus the final size of the stream cannot be known other
than pretending to write the stream. One case where the resulting size would have to be
known is if the data has to be written to a piece of memory and the memory has to be
allocated before writing to it (which is probably always the case when writing to a
memory stream).
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/stream.h>
\latexignore{\rtfignore{\wxheading{Members}}}
% -----------
% ctor & dtor
% -----------
\membersection{wxCountingOutputStream::wxCountingOutputStream}
\func{}{wxCountingOutputStream}{\void}
Creates a wxCountingOutputStream object.
\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
\func{}{\destruct{wxCountingOutputStream}}{\void}
Destructor.
\membersection{wxCountingOutputStream::GetSize}
\constfunc{size\_t}{GetSize}{\void}
Returns the current size of the stream.

3
docs/latex/wx/database.tex
View File

@@ -3,6 +3,9 @@
Every database object represents an ODBC connection. Every database object represents an ODBC connection.
The connection may be closed and reopened. The connection may be closed and reopened.
Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable classes
(documented separately in Word and PDF format, as odbc.doc and odbc.pdf).
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxObject}{wxobject} \helpref{wxObject}{wxobject}

2
docs/latex/wx/dataform.tex
View File

@@ -48,7 +48,7 @@ do clipboard format registration at this time will usually lead to a crash!
\wxheading{Virtual functions to override} \wxheading{Virtual functions to override}
None, this class doesn't have any. None
\wxheading{Derived from} \wxheading{Derived from}

10
docs/latex/wx/dataobj.tex
View File

@@ -54,18 +54,18 @@ So, you have several solutions when you need a wxDataObject class (and you need
one as soon as you want to transfer data via the clipboard or drag and drop): one as soon as you want to transfer data via the clipboard or drag and drop):
\begin{twocollist}\itemsep=1cm \begin{twocollist}\itemsep=1cm
\twocolitem{{\bf 0. Use one of built-in classes}}{You may use wxTextDataObject, \twocolitem{{\bf 1. Use one of the built-in classes}}{You may use wxTextDataObject,
wxBitmapDataObject or wxFileDataObject in the simplest cases when you only need wxBitmapDataObject or wxFileDataObject in the simplest cases when you only need
to support one format and your data is either text, bitmap or list of files.} to support one format and your data is either text, bitmap or list of files.}
\twocolitem{{\bf 1. Use wxDataObjectSimple}}{Deriving from wxDataObjectSimple is the simplest \twocolitem{{\bf 2. Use wxDataObjectSimple}}{Deriving from wxDataObjectSimple is the simplest
solution for custom data - you will only support one format and so probably solution for custom data - you will only support one format and so probably
won't be able to communicate with other programs, but data transfer will work won't be able to communicate with other programs, but data transfer will work
in your program (or between different copies of it).} in your program (or between different copies of it).}
\twocolitem{{\bf 2. Use wxDataObjectComposite}}{This is a simple but powerful \twocolitem{{\bf 3. Use wxDataObjectComposite}}{This is a simple but powerful
solution which allows you to support any number of formats (either solution which allows you to support any number of formats (either
standard or custom if you combine it with the previous solution).} standard or custom if you combine it with the previous solution).}
\twocolitem{{\bf 3. Use wxDataObject directly}}{This is the solution for \twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for
maximal flexibility and efficiency, but it also is the most difficult to maximal flexibility and efficiency, but it is also is the most difficult to
implement.} implement.}
\end{twocollist} \end{twocollist}

6
docs/latex/wx/date.tex
View File

@@ -2,9 +2,9 @@
A class for manipulating dates. A class for manipulating dates.
{\bf NOTE:} this class should be {\bf NOTE:} this class is retained only for compatibility,
used with caution, since it is not fully tested. It will be replaced and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxDate
with a new wxDateTime class in the near future. may be withdrawn in future versions of wxWindows.
\wxheading{Derived from} \wxheading{Derived from}

5
docs/latex/wx/datetime.tex
View File

@@ -26,8 +26,7 @@ wxDateTime object.
All the following constants are defined inside wxDateTime class (i.e., to refer to All the following constants are defined inside wxDateTime class (i.e., to refer to
them you should prepend their names with {\tt wxDateTime::}). them you should prepend their names with {\tt wxDateTime::}).
Time zone symbolic names:%\label{wxdatetimetimezones} % Sorry, labels not allowed here. Time zone symbolic names:
\begin{verbatim} \begin{verbatim}
enum TZ enum TZ
@@ -116,7 +115,7 @@ wxDateSpan,\rtfsp
\membersection{Static functions} \membersection{Static functions}
For convinience, all static functions are collected here. These functions For convenience, all static functions are collected here. These functions
either set or return the static variables of wxDateSpan (the country), return either set or return the static variables of wxDateSpan (the country), return
the current moment, year, month or number of days in it, or do some general the current moment, year, month or number of days in it, or do some general
calendar-related actions. calendar-related actions.

1
docs/latex/wx/datstrm.tex
View File

@@ -17,6 +17,7 @@ is defined as signed int on 32-bit architectures) so that you cannot use long. T
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types. problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
For example: For example:
\begin{verbatim} \begin{verbatim}
wxFileInputStream input( "mytext.dat" ); wxFileInputStream input( "mytext.dat" );
wxDataInputStream store( input ); wxDataInputStream store( input );

3
docs/latex/wx/dobjsmpl.tex
View File

@@ -11,7 +11,7 @@
\section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple} \section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple}
This is the simplest possible implementation of This is the simplest possible implementation of the
\helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived \helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived
from) this class only supports one format, so the number of virtual functions from) this class only supports one format, so the number of virtual functions
to be implemented is reduced. to be implemented is reduced.
@@ -99,4 +99,3 @@ the derived class if the object supports setting its data.
\pythonnote{When implementing this method in wxPython, the data comes \pythonnote{When implementing this method in wxPython, the data comes
as a single string parameter rather than the two shown here.} as a single string parameter rather than the two shown here.}

10
docs/latex/wx/document.tex
View File

@@ -191,10 +191,15 @@ See also \helpref{Modify}{wxdocumentmodify}.
\func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}} \func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
\func{virtual wxInputStream\&}{LoadObject}{\param{wxInputStream\& }{stream}}
Override this function and call it from your own LoadObject before Override this function and call it from your own LoadObject before
streaming your own data. LoadObject is called by the framework streaming your own data. LoadObject is called by the framework
automatically when the document contents need to be loaded. automatically when the document contents need to be loaded.
Note that only one of these forms exists, depending on how wxWindows
was configured.
\membersection{wxDocument::Modify}\label{wxdocumentmodify} \membersection{wxDocument::Modify}\label{wxdocumentmodify}
\func{virtual void}{Modify}{\param{bool}{ modify}} \func{virtual void}{Modify}{\param{bool}{ modify}}
@@ -297,10 +302,15 @@ Prompts the user for a file to save to, and then calls OnSaveDocument.
\func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}} \func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
\func{virtual wxOutputStream\&}{SaveObject}{\param{wxOutputStream\& }{stream}}
Override this function and call it from your own SaveObject before Override this function and call it from your own SaveObject before
streaming your own data. SaveObject is called by the framework streaming your own data. SaveObject is called by the framework
automatically when the document contents need to be saved. automatically when the document contents need to be saved.
Note that only one of these forms exists, depending on how wxWindows
was configured.
\membersection{wxDocument::SetCommandProcessor} \membersection{wxDocument::SetCommandProcessor}
\func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}} \func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}

3
docs/latex/wx/dropsrc.tex
View File

@@ -17,7 +17,7 @@ None
\index{wxDragResult}wxDragResult is defined as follows: \index{wxDragResult}wxDragResult is defined as follows:
{\small\begin{verbatim} begin{verbatim}
enum wxDragResult enum wxDragResult
{ {
wxDragError, // error prevented the d&d operation from completing wxDragError, // error prevented the d&d operation from completing
@@ -27,7 +27,6 @@ enum wxDragResult
wxDragCancel // the operation was cancelled by user (not an error) wxDragCancel // the operation was cancelled by user (not an error)
}; };
\end{verbatim} \end{verbatim}
}
\wxheading{See also} \wxheading{See also}

3
docs/latex/wx/droptrgt.tex
View File

@@ -26,7 +26,7 @@ None
\index{wxDragResult}wxDragResult is defined as follows: \index{wxDragResult}wxDragResult is defined as follows:
{\small\begin{verbatim} \begin{verbatim}
enum wxDragResult enum wxDragResult
{ {
wxDragError, // error prevented the d&d operation from completing wxDragError, // error prevented the d&d operation from completing
@@ -36,7 +36,6 @@ enum wxDragResult
wxDragCancel // the operation was cancelled by user (not an error) wxDragCancel // the operation was cancelled by user (not an error)
}; };
\end{verbatim} \end{verbatim}
}
\wxheading{See also} \wxheading{See also}

5
docs/latex/wx/expr.tex
View File

@@ -46,8 +46,8 @@ Construct a floating point expression.
Construct a list expression. The list's nodes' data should Construct a list expression. The list's nodes' data should
themselves be {\bf wxExpr}s. themselves be {\bf wxExpr}s.
The current version of this library no longer uses the {\bf wxList} wxExpr no longer uses the {\bf wxList} internally,
internally, so this constructor turns the list into its internal so this constructor turns the list into its internal
format (assuming a non-nested list) and then deletes the supplied format (assuming a non-nested list) and then deletes the supplied
list. list.
@@ -376,7 +376,6 @@ bool myErrorHandler(int err, chat *msg)
wxExprDatabase database(myErrorHandler); wxExprDatabase database(myErrorHandler);
\end{verbatim} \end{verbatim}
\func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute}, \func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute},
\rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}} \rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}}

6
docs/latex/wx/fildatob.tex
View File

@@ -1,8 +1,8 @@
\section{\class{wxFileDataObject}}\label{wxfiledataobject} \section{\class{wxFileDataObject}}\label{wxfiledataobject}
wxFileDataObject is a specialization of \helpref{wxDataObject}{wxdataobject} wxFileDataObject is a specialization of \helpref{wxDataObject}{wxdataobject}
for file names. The program works with it just as if it were a list of file for file names. The program works with it just as if it were a list of absolute file
names (absolutep aths always), but internally it uses the same format as names, but internally it uses the same format as
Explorer and other compatible programs under Windows or GNOME/KDE filemanager Explorer and other compatible programs under Windows or GNOME/KDE filemanager
under Unix which makes it possible to receive files from them using this under Unix which makes it possible to receive files from them using this
class. class.
@@ -30,7 +30,7 @@ None.
\helpref{wxDataObject}{wxdataobject}, \helpref{wxDataObject}{wxdataobject},
\helpref{wxDataObjectSimple}{wxdataobjectsimple}, \helpref{wxDataObjectSimple}{wxdataobjectsimple},
\helpref{wxTextDataObject}{wxtextdataobject}, \helpref{wxTextDataObject}{wxtextdataobject},
\helpref{wxBitmapDataObject}{wxbitmapdataobject} \helpref{wxBitmapDataObject}{wxbitmapdataobject},
\helpref{wxDataObject}{wxdataobject} \helpref{wxDataObject}{wxdataobject}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}

2
docs/latex/wx/file.tex
View File

@@ -18,7 +18,6 @@ None.
wx/file.h defines the following constants: wx/file.h defines the following constants:
{\small
\begin{verbatim} \begin{verbatim}
#define wxS_IRUSR 00400 #define wxS_IRUSR 00400
#define wxS_IWUSR 00200 #define wxS_IWUSR 00200
@@ -35,7 +34,6 @@ wx/file.h defines the following constants:
// default mode for the new files: corresponds to umask 022 // default mode for the new files: corresponds to umask 022
#define wxS_DEFAULT (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP | wxS_IROTH | wxS_IWOTH) #define wxS_DEFAULT (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP | wxS_IROTH | wxS_IWOTH)
\end{verbatim} \end{verbatim}
}
These constants define the file access rights and are used with These constants define the file access rights and are used with
\helpref{wxFile::Create}{wxfilecreate} and \helpref{wxFile::Open}{wxfileopen}. \helpref{wxFile::Create}{wxfilecreate} and \helpref{wxFile::Open}{wxfileopen}.

2
docs/latex/wx/fltinstr.tex
View File

@@ -21,6 +21,8 @@ from another stream and pass it to the requester.
The interface of this class is the same as that of wxInputStream. Only a constructor The interface of this class is the same as that of wxInputStream. Only a constructor
differs and it is documented below. differs and it is documented below.
\latexignore{\rtfignore{\wxheading{Members}}}
% ----------- % -----------
% ctor & dtor % ctor & dtor
% ----------- % -----------

2
docs/latex/wx/fltoutst.tex
View File

@@ -22,6 +22,8 @@ stream.
The use of this class is exactly the same as of wxOutputStream. Only a constructor The use of this class is exactly the same as of wxOutputStream. Only a constructor
differs and it is documented below. differs and it is documented below.
\latexignore{\rtfignore{\wxheading{Members}}}
% ----------- % -----------
% ctor & dtor % ctor & dtor
% ----------- % -----------

5
docs/latex/wx/fontenum.tex
View File

@@ -19,10 +19,9 @@ the given \helpref{encoding}{wxfontencodingoverview}.
To do this, you just have to call one of EnumerateXXX() functions - either To do this, you just have to call one of EnumerateXXX() functions - either
\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or
\helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the
corresponding callback ( corresponding callback (\helpref{OnFacename}{wxFontEnumeratoronfacename} or
\helpref{OnFacename}{wxFontEnumeratoronfacename} or
\helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called
repeatedly until either all fonts (satisfying the specified criteria) are repeatedly until either all fonts satisfying the specified criteria are
exhausted or the callback returns FALSE. exhausted or the callback returns FALSE.
\wxheading{Virtual functions to override} \wxheading{Virtual functions to override}

10
docs/latex/wx/fontmap.tex
View File

@@ -72,7 +72,6 @@ No base class
\helpref{wxEncodingConverter}{wxencodingconverter}, \helpref{wxEncodingConverter}{wxencodingconverter},
\helpref{Writing non-English applications}{nonenglishoverview} \helpref{Writing non-English applications}{nonenglishoverview}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper} \membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper}
@@ -81,14 +80,12 @@ No base class
Default ctor. Default ctor.
\membersection{wxFontMapper::\destruct{wxFontMapper}}\label{wxfontmapperdtor} \membersection{wxFontMapper::\destruct{wxFontMapper}}\label{wxfontmapperdtor}
\func{}{\destruct{wxFontMapper}}{\void} \func{}{\destruct{wxFontMapper}}{\void}
Virtual dtor for a base class. Virtual dtor for a base class.
\membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding} \membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding}
\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}} \func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}}
@@ -104,7 +101,6 @@ The first form is for wxWindows' internal use while the second one
is better suitable for general use -- it returns wxFontEncoding which is better suitable for general use -- it returns wxFontEncoding which
can consequently be passed to wxFont constructor. can consequently be passed to wxFont constructor.
\membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable} \membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable}
\func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}} \func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}}
@@ -112,7 +108,6 @@ can consequently be passed to wxFont constructor.
Check whether given encoding is available in given face or not. Check whether given encoding is available in given face or not.
If no facename is given, find {\it any} font in this encoding. If no facename is given, find {\it any} font in this encoding.
\membersection{wxFontMapper::CharsetToEncoding}\label{wxfontmappercharsettoencoding} \membersection{wxFontMapper::CharsetToEncoding}\label{wxfontmappercharsettoencoding}
\func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = TRUE}} \func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = TRUE}}
@@ -120,7 +115,6 @@ If no facename is given, find {\it any} font in this encoding.
Returns the encoding for the given charset (in the form of RFC 2046) or Returns the encoding for the given charset (in the form of RFC 2046) or
wxFONTENCODING\_SYSTEM if couldn't decode it. wxFONTENCODING\_SYSTEM if couldn't decode it.
\membersection{wxFontMapper::GetEncodingName}\label{wxfontmappergetencodingname} \membersection{wxFontMapper::GetEncodingName}\label{wxfontmappergetencodingname}
\func{static wxString}{GetEncodingName}{\param{wxFontEncoding }{encoding}} \func{static wxString}{GetEncodingName}{\param{wxFontEncoding }{encoding}}
@@ -128,28 +122,24 @@ wxFONTENCODING\_SYSTEM if couldn't decode it.
Return internal string identifier for the encoding (see also Return internal string identifier for the encoding (see also
\helpref{GetEncodingDescription()}{wxfontmappergetencodingdescription}) \helpref{GetEncodingDescription()}{wxfontmappergetencodingdescription})
\membersection{wxFontMapper::GetEncodingDescription}\label{wxfontmappergetencodingdescription} \membersection{wxFontMapper::GetEncodingDescription}\label{wxfontmappergetencodingdescription}
\func{static wxString}{GetEncodingDescription}{\param{wxFontEncoding }{encoding}} \func{static wxString}{GetEncodingDescription}{\param{wxFontEncoding }{encoding}}
Return user-readable string describing the given encoding. Return user-readable string describing the given encoding.
\membersection{wxFontMapper::SetDialogParent}\label{wxfontmappersetdialogparent} \membersection{wxFontMapper::SetDialogParent}\label{wxfontmappersetdialogparent}
\func{void}{SetDialogParent}{\param{wxWindow* }{parent}} \func{void}{SetDialogParent}{\param{wxWindow* }{parent}}
The parent window for modal dialogs. The parent window for modal dialogs.
\membersection{wxFontMapper::SetDialogTitle}\label{wxfontmappersetdialogtitle} \membersection{wxFontMapper::SetDialogTitle}\label{wxfontmappersetdialogtitle}
\func{void}{SetDialogTitle}{\param{const wxString\& }{title}} \func{void}{SetDialogTitle}{\param{const wxString\& }{title}}
The title for the dialogs (note that default is quite reasonable). The title for the dialogs (note that default is quite reasonable).
\membersection{wxFontMapper::SetConfig}\label{wxfontmappersetconfig} \membersection{wxFontMapper::SetConfig}\label{wxfontmappersetconfig}
\func{void}{SetConfig}{\param{wxConfigBase* }{config}} \func{void}{SetConfig}{\param{wxConfigBase* }{config}}

15
docs/latex/wx/frame.tex
View File

@@ -235,7 +235,7 @@ Returns a pointer to the menubar currently associated with the frame (if any).
\membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar} \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
\func{wxStatusBar*}{GetStatusBar}{\void} \constfunc{wxStatusBar*}{GetStatusBar}{\void}
Returns a pointer to the status bar currently associated with the frame (if any). Returns a pointer to the status bar currently associated with the frame (if any).
@@ -245,14 +245,13 @@ Returns a pointer to the status bar currently associated with the frame (if any)
\membersection{wxFrame::GetTitle}\label{wxframegettitle} \membersection{wxFrame::GetTitle}\label{wxframegettitle}
\func{wxString\&}{GetTitle}{\void} \constfunc{wxString}{GetTitle}{\void}
Gets a temporary pointer to the frame title. See Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.
\helpref{wxFrame::SetTitle}{wxframesettitle}.
\membersection{wxFrame::GetToolBar}\label{wxframegettoolbar} \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
\func{wxToolBar*}{GetToolBar}{\void} \constfunc{wxToolBar*}{GetToolBar}{\void}
Returns a pointer to the toolbar currently associated with the frame (if any). Returns a pointer to the toolbar currently associated with the frame (if any).
@@ -263,7 +262,7 @@ Returns a pointer to the toolbar currently associated with the frame (if any).
\membersection{wxFrame::Iconize}\label{wxframeiconize} \membersection{wxFrame::Iconize}\label{wxframeiconize}
\func{void}{Iconize}{\param{const bool}{ iconize}} \func{void}{Iconize}{\param{bool}{ iconize}}
Iconizes or restores the frame. Windows only. Iconizes or restores the frame. Windows only.
@@ -289,13 +288,13 @@ Returns TRUE if the frame is maximized.
\membersection{wxFrame::Maximize}\label{wxframemaximize} \membersection{wxFrame::Maximize}\label{wxframemaximize}
\func{void}{Maximize}{\param{const bool }{maximize}} \func{void}{Maximize}{\param{bool }{maximize}}
Maximizes or restores the frame. Maximizes or restores the frame.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}. \docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it.}
\wxheading{Remarks} \wxheading{Remarks}

30
docs/latex/wx/fsfile.tex
View File

@@ -10,7 +10,7 @@ It provides more information than wxWindow's input stream
(stream, filename, mime type, anchor). (stream, filename, mime type, anchor).
{\bf Note:} Any pointer returned by wxFSFile's member is valid {\bf Note:} Any pointer returned by wxFSFile's member is valid
only as long as wxFSFile object exits. For example call to GetStream() only as long as wxFSFile object exists. For example a call to GetStream()
doesn't {\it create} the stream but only returns the pointer to it. In doesn't {\it create} the stream but only returns the pointer to it. In
other words after 10 calls to GetStream() you'll obtain ten identical other words after 10 calls to GetStream() you'll obtain ten identical
pointers. pointers.
@@ -47,17 +47,17 @@ Constructor. You probably won't use it. See Notes for details.
\docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.} \docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.}
If you aren't sure what do these params mean see description of GetXXXX() If you are not sure of the meaning of these params, see the description of the GetXXXX()
functions. functions.
\wxheading{Notes} \wxheading{Notes}
It is never used by end user but you'll need it if It is seldom used by the application programmer but you'll need it if
you're writing own virtual FS. For example you may need something you are writing your own virtual FS. For example you may need something
similar to wxMemoryInputStream but because wxMemoryInputStream similar to wxMemoryInputStream, but because wxMemoryInputStream
doesn't free the memory when destroyed and thus passing memory stream doesn't free the memory when destroyed and thus passing a memory stream
pointer into wxFSFile constructor would lead to memory leaks, you pointer into wxFSFile constructor would lead to memory leaks, you
can write your own class derived from wxFSFile : can write your own class derived from wxFSFile:
\begin{verbatim} \begin{verbatim}
class wxMyFSFile : public wxFSFile class wxMyFSFile : public wxFSFile
@@ -85,10 +85,10 @@ archive/main.zip#zip:index.htm#global /* 'global' */
archive/main.zip#zip:index.htm /* NO anchor here! */ archive/main.zip#zip:index.htm /* NO anchor here! */
\end{verbatim} \end{verbatim}
Usually anchor is presented only if mime type is 'text/html'. Usually an anchor is presented only if the MIME type is 'text/html'.
But it may have some meaning with other files But it may have some meaning with other files;
(for example myanim.avi\#200 may refer to position in animation for example myanim.avi\#200 may refer to position in animation
or reality.wrl\#MyView may refer to predefined view in VRML) or reality.wrl\#MyView may refer to a predefined view in VRML.
\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation} \membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
@@ -108,7 +108,7 @@ relative-file.htm
\constfunc{const wxString\&}{GetMimeType}{\void} \constfunc{const wxString\&}{GetMimeType}{\void}
Returns MIME type of the content of this file. It is either Returns the MIME type of the content of this file. It is either
extension-based (see wxMimeTypesManager) or extracted from extension-based (see wxMimeTypesManager) or extracted from
HTTP protocol Content-Type header. HTTP protocol Content-Type header.
@@ -125,7 +125,7 @@ Returns time when this file was modified.
Returns pointer to the stream. You can use the returned Returns pointer to the stream. You can use the returned
stream to directly access data. You may suppose stream to directly access data. You may suppose
that the stream provide Seek and GetSize functionality that the stream provide Seek and GetSize functionality
(even in case of HTTP protocol which doesn't provide (even in the case of the HTTP protocol which doesn't provide
this by default. wxHtml is using local cache to workaround this by default. wxHtml uses local cache to work around
this and to speed up connection) this and to speed up the connection).

18
docs/latex/wx/ftp.tex
View File

@@ -27,7 +27,7 @@ the expected result.
\wxheading{Return value} \wxheading{Return value}
TRUE, if the command has been sent successfully, else FALSE. TRUE if the command has been sent successfully, else FALSE.
% ---------------------------------------------------------------------------- % ----------------------------------------------------------------------------
@@ -172,10 +172,10 @@ An initialized write-only stream.
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
Creates a new input stream on the the specified path. You can use all but seek Creates a new input stream on the the specified path. You can use all but the seek
functionnality of wxStream. Seek isn't available on all stream. For example, functionality of wxStream. Seek isn't available on all streams. For example,
http or ftp streams doesn't deal with it. Other functions like Tell http or ftp streams do not deal with it. Other functions like Tell
aren't available for the moment for this sort of stream. are not available for this sort of stream, at present.
You will be notified when the EOF is reached by an error. You will be notified when the EOF is reached by an error.
\wxheading{Return value} \wxheading{Return value}
@@ -183,10 +183,10 @@ You will be notified when the EOF is reached by an error.
Returns NULL if an error occured (it could be a network failure or the fact Returns NULL if an error occured (it could be a network failure or the fact
that the file doesn't exist). that the file doesn't exist).
Returns the initialized stream. You will have to delete it yourself once you Returns the initialized stream. You will have to delete it yourself when you
don't use it anymore. The destructor close the DATA stream connection but don't need it anymore. The destructor closes the DATA stream connection but
will leave the COMMAND stream connection opened. It means that you still will leave the COMMAND stream connection opened. It means that you can still
can send new commands without reconnecting. send new commands without reconnecting.
\wxheading{Example of a standalone connection (without wxURL)} \wxheading{Example of a standalone connection (without wxURL)}

8
docs/latex/wx/function.tex
View File

@@ -730,10 +730,10 @@ wxCANCEL.}
wxYES\_NO or wxOK.} wxYES\_NO or wxOK.}
\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.} \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
\twocolitem{wxCENTRE}{Centres the text.} \twocolitem{wxCENTRE}{Centres the text.}
\twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.} \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
\twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.} \twocolitem{wxICON\_HAND}{Displays a hand symbol.}
\twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.} \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
\twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.} \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
\end{twocollist} \end{twocollist}
The return value is one of: wxYES, wxNO, wxCANCEL, wxOK. The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.

8
docs/latex/wx/grid.tex
View File

@@ -2,6 +2,10 @@
wxGrid is a class for displaying and editing tabular information. wxGrid is a class for displaying and editing tabular information.
{\bf Note:} there is a new grid implementation from wxWindows 2.1.14,
with an API that is backwardly compatible with the one documented here.
This documentation is awaiting updates for the new and improved API.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxPanel}{wxpanel}\\ \helpref{wxPanel}{wxpanel}\\
@@ -338,7 +342,7 @@ Returns the row scroll position.
\membersection{wxGrid::GetTextItem}\label{wxgridgettextitem} \membersection{wxGrid::GetTextItem}\label{wxgridgettextitem}
\constfunc{wxText *}{GetTextItem}{\void} \constfunc{wxTextCtrl *}{GetTextItem}{\void}
Returns a pointer to the text item used for entering text into a cell. Returns a pointer to the text item used for entering text into a cell.
@@ -382,7 +386,7 @@ and rows numerically.
\func{void}{OnChangeSelectionLabel}{\void} \func{void}{OnChangeSelectionLabel}{\void}
Called when a cell is selected, to allow the application an Called when a cell is selected, to allow the application an
opportunity to update the selection label (the label of the wxText item opportunity to update the selection label (the label of the wxTextCtrl
used for entering cell text). By default, the cell column letter and row used for entering cell text). By default, the cell column letter and row
number are concatenated to form the selection label. number are concatenated to form the selection label.

9
docs/latex/wx/helpinst.tex
View File

@@ -33,11 +33,10 @@ There are currently the following help controller classes defined:
\item wxWinHelpController, for controlling Windows Help. \item wxWinHelpController, for controlling Windows Help.
\item wxExtHelpController, for controlling external browsers under Unix. \item wxExtHelpController, for controlling external browsers under Unix.
The default browser is Netscape Navigator. The 'help' sample shows its use. The default browser is Netscape Navigator. The 'help' sample shows its use.
\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. The API for this class \item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. See {\tt wx/helpwxht.h} for
is reasonably close to the wxWindows help controller API; see {\tt wx/helpwxht.h} for
details of use. details of use.
\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in \item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
a similar style to the Windows HTML Help viewer and using some of the same files. a similar style to the Microsoft HTML Help viewer and using some of the same files.
Although it has an API compatible with other help controllers, it has more advanced features, so it is Although it has an API compatible with other help controllers, it has more advanced features, so it is
recommended that you use the specific API for this class instead. recommended that you use the specific API for this class instead.
\end{itemize} \end{itemize}
@@ -80,8 +79,8 @@ Destroys the help instance, closing down the viewer if it is running.
\func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}} \func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
Initializes the help instance with a help filename, and optionally a server (socket) Initializes the help instance with a help filename, and optionally a server socket
number if using wxHelp. Does not invoke the help viewer. number if using wxHelp (now obsolete). Does not invoke the help viewer.
This must be called directly after the help instance object is created and before This must be called directly after the help instance object is created and before
any attempts to communicate with the viewer. any attempts to communicate with the viewer.

8
docs/latex/wx/htcell.tex
View File

@@ -186,10 +186,10 @@ Returns width of the cell (m\_Width member).
\func{virtual void}{Layout}{\param{int }{w}} \func{virtual void}{Layout}{\param{int }{w}}
This method performs 2 actions: This method performs two actions:
\begin{enumerate}\itemsep=0pt \begin{enumerate}\itemsep=0pt
\item adjusts cell's width according to the fact that maximal possible width is {\it w}. \item adjusts the cell's width according to the fact that maximal possible width is {\it w}.
(this has sense when working with horizontal lines, tables etc.) (this has sense when working with horizontal lines, tables etc.)
\item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members) \item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members)
based on actual width {\it w} based on actual width {\it w}
@@ -203,7 +203,7 @@ before calling Layout.
\func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int}{x}, \param{int }{y}, \param{const wxMouseEvent\& }{event}} \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int}{x}, \param{int }{y}, \param{const wxMouseEvent\& }{event}}
This function is simple event handler. Each time user clicks mouse button over a cell This function is simple event handler. Each time the user clicks mouse button over a cell
within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is
that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}. that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
@@ -233,7 +233,7 @@ is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
\func{void}{SetNext}{\param{wxHtmlCell }{*cell}} \func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
Sets the next cell in the list. This shouldn't be called by user - it is Sets the next cell in the list. This shouldn't be called by user - it is
to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell} to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent} \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}

2
docs/latex/wx/htcolor.tex
View File

@@ -5,7 +5,7 @@
\section{\class{wxHtmlColourCell}}\label{wxhtmlcolourcell} \section{\class{wxHtmlColourCell}}\label{wxhtmlcolourcell}
This cell changes color of either background or foreground. This cell changes the colour of either the background or the foreground.
\wxheading{Derived from} \wxheading{Derived from}

12
docs/latex/wx/htcontnr.tex
View File

@@ -127,19 +127,19 @@ Sets the container's {\it vertical alignment}. This is per-line alignment!
\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}} \func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
Sets the background color for this container. Sets the background colour for this container.
\membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder} \membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder}
\func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}} \func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}}
Sets the border (frame) colours. Border is rectangle around the container. Sets the border (frame) colours. A border is a rectangle around the container.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{clr1}{Color of top and left lines} \docparam{clr1}{Colour of top and left lines}
\docparam{clr2}{Color of bottom and right lines} \docparam{clr2}{Colour of bottom and right lines}
\membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent} \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
@@ -194,8 +194,8 @@ much smaller area.
\docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted \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 wxHTML\_ALIGN\_TOP, somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP,
wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the
empty place!} empty place.}
\membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat} \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}

4
docs/latex/wx/hthelpct.tex
View File

@@ -5,9 +5,9 @@
\section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller} \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
{\bf WARNING! Although this class has an API compatible with other wxWindows {\bf WARNING!} Although this class has an API compatible with other wxWindows
help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.} is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
This help controller provides an easy way of displaying HTML help in your This help controller provides an easy way of displaying HTML help in your
application (see {\it test} sample). The help system is based on {\bf books} application (see {\it test} sample). The help system is based on {\bf books}

1
docs/latex/wx/htparser.tex
View File

@@ -30,7 +30,6 @@ wxObject
<wx/html/htmlpars.h> <wx/html/htmlpars.h>
\wxheading{See also} \wxheading{See also}
\helpref{Cells Overview}{cells}, \helpref{Cells Overview}{cells},

41
docs/latex/wx/htwinprs.tex
View File

@@ -3,25 +3,21 @@
% htmlwinparser.tex at 14/Mar/99 20:13:37 % htmlwinparser.tex at 14/Mar/99 20:13:37
% %
\section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser} \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
its mail goal is to parse HTML input so that it can be displayed in its mail goal is to parse HTML input so that it can be displayed in
\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special \helpref{wxHtmlWindow}{wxhtmlwindow}. It uses a special
\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}. \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
\wxheading{Notes} \wxheading{Notes}
\begin{enumerate} The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.
\item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
\end{enumerate}
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxHtmlParser}{wxhtmlparser} \helpref{wxHtmlParser}{wxhtmlparser}
\wxheading{Include files} \wxheading{Include files}
<wx/html/winpars.h> <wx/html/winpars.h>
@@ -65,14 +61,14 @@ Creates font based on current setting (see
\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed}, \helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined}) \helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
and returns pointer to it. and returns pointer to it.
(If the font was already created only a pointer is returned.) If the font was already created only a pointer is returned.
\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor} \membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
\constfunc{const wxColour\&}{GetActualColor}{\void} \constfunc{const wxColour\&}{GetActualColor}{\void}
Returns actual text color. Returns actual text colour.
\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign} \membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
@@ -86,7 +82,7 @@ Returns default horizontal alignment.
Returns (average) char height in standard font. It's used as DC-independent metrics. Returns (average) char height in standard font. It's used as DC-independent metrics.
{\bf Note:} This function doesn't return {\it actual} height. If you want to {\bf Note:} This function doesn't return the {\it actual} height. If you want to
know the height of the current font, call {\tt GetDC -> GetCharHeight()}. know the height of the current font, call {\tt GetDC -> GetCharHeight()}.
\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth} \membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
@@ -95,7 +91,7 @@ know the height of the current font, call {\tt GetDC -> GetCharHeight()}.
Returns average char width in standard font. It's used as DC-independent metrics. Returns average char width in standard font. It's used as DC-independent metrics.
{\bf Note:} This function doesn't return {\it actual} width. If you want to {\bf Note:} This function doesn't return the {\it actual} width. If you want to
know the height of the current font, call {\tt GetDC -> GetCharWidth()} know the height of the current font, call {\tt GetDC -> GetCharWidth()}
\membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer} \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
@@ -115,7 +111,6 @@ m_WParser -> GetContainer() -> InsertCell(new ...);
Returns pointer to the DC used during parsing. Returns pointer to the DC used during parsing.
\membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter} \membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
\constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void} \constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
@@ -136,7 +131,6 @@ Returns TRUE if actual font is bold, FALSE otherwise.
Returns actual font face name. Returns actual font face name.
\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed} \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
\constfunc{int}{GetFontFixed}{\void} \constfunc{int}{GetFontFixed}{\void}
@@ -149,7 +143,6 @@ Returns TRUE if actual font is fixed face, FALSE otherwise.
Returns TRUE if actual font is italic, FALSE otherwise. Returns TRUE if actual font is italic, FALSE otherwise.
\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize} \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
\constfunc{int}{GetFontSize}{\void} \constfunc{int}{GetFontSize}{\void}
@@ -168,23 +161,20 @@ Returns TRUE if actual font is underlined, FALSE otherwise.
Returns input encoding. Returns input encoding.
\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink} \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
\constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void} \constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}
Returns actual hypertext link. (This value has non-empty Returns actual hypertext link. (This value has a non-empty
\helpref{Href}{wxhtmllinkinfogethref} string \helpref{Href}{wxhtmllinkinfogethref} string
if the parser is between {\tt <A>} and {\tt </A>} tags, if the parser is between {\tt <A>} and {\tt </A>} tags,
wxEmptyString otherwise.) wxEmptyString otherwise.)
\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor} \membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
\constfunc{const wxColour\&}{GetLinkColor}{\void} \constfunc{const wxColour\&}{GetLinkColor}{\void}
Returns color of hypertext link text. Returns the colour of hypertext link text.
\membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding} \membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
@@ -201,19 +191,17 @@ Returns associated window (wxHtmlWindow). This may be NULL! (You should always
test if it is non-NULL. For example {\tt TITLE} handler sets window test if it is non-NULL. For example {\tt TITLE} handler sets window
title only if some window is associated, otherwise it does nothing) title only if some window is associated, otherwise it does nothing)
\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer} \membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
\func{wxHtmlContainerCell*}{OpenContainer}{\void} \func{wxHtmlContainerCell*}{OpenContainer}{\void}
Opens new container and returns pointer to it (see \helpref{Overview}{cells}). Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor} \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
\func{void}{SetActualColor}{\param{const wxColour\& }{clr}} \func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
Sets actual text color. Note: this DOESN'T change the color! Sets actual text colour. Note: this DOESN'T change the colour!
You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself. You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
\membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign} \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
@@ -224,14 +212,12 @@ Sets default horizontal alignment (see
\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.) \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
Alignment of newly opened container is set to this value. Alignment of newly opened container is set to this value.
\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer} \membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}} \func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
Allows you to directly set opened container. This is not recommended - you should use OpenContainer Allows you to directly set opened container. This is not recommended - you should use OpenContainer
whereever possible. wherever possible.
\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc} \membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
@@ -243,7 +229,6 @@ 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 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.) inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold} \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
\func{void}{SetFontBold}{\param{int }{x}} \func{void}{SetFontBold}{\param{int }{x}}
@@ -270,7 +255,6 @@ Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
\func{void}{SetFontSize}{\param{int }{s}} \func{void}{SetFontSize}{\param{int }{s}}
@@ -289,7 +273,6 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
\membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding} \membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
\func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}} \func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}}
@@ -298,7 +281,6 @@ Sets input encoding. The parser uses this information to build conversion
tables from document's encoding to some encoding supported by operating tables from document's encoding to some encoding supported by operating
system. system.
\membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink} \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}} \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
@@ -311,6 +293,5 @@ to wxEmptyString.
\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}} \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
Sets color of hypertext link. Sets colour of hypertext link.

2
docs/latex/wx/icon.tex
View File

@@ -74,6 +74,8 @@ Creates an icon from an array of bits.
Creates a new icon. Creates a new icon.
\func{}{wxIcon}{\param{char**}{ bits}}
\func{}{wxIcon}{\param{const char**}{ bits}} \func{}{wxIcon}{\param{const char**}{ bits}}
Creates an icon from XPM data. Creates an icon from XPM data.

14
docs/latex/wx/image.tex
View File

@@ -116,7 +116,7 @@ Loads an image from an input stream.
Depending on how wxWindows has been configured, not all formats may be available. Depending on how wxWindows has been configured, not all formats may be available.
Note : any handler other than BMP must be previously Note: any handler other than BMP must be previously
initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}. \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
@@ -331,7 +331,7 @@ the user.
\wxheading{See also} \wxheading{See also}
\helpref{wxImageHandler}{wximagehandler} \helpref{wxImageHandler}{wximagehandler},
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\membersection{wxImage::InsertHandler} \membersection{wxImage::InsertHandler}
@@ -653,7 +653,7 @@ created by IJG.)
\wxheading{See also} \wxheading{See also}
\helpref{wxImage}{wximage} \helpref{wxImage}{wximage},
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
@@ -733,8 +733,8 @@ TRUE if the operation succeeded, FALSE otherwise.
\wxheading{See also} \wxheading{See also}
\helpref{wxImage::LoadFile}{wximageloadfile}\\ \helpref{wxImage::LoadFile}{wximageloadfile},
\helpref{wxImage::SaveFile}{wximagesavefile}\\ \helpref{wxImage::SaveFile}{wximagesavefile},
\helpref{wxImageHandler::SaveFile}{wximagehandlersavefile} \helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
\membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile} \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
@@ -755,8 +755,8 @@ TRUE if the operation succeeded, FALSE otherwise.
\wxheading{See also} \wxheading{See also}
\helpref{wxImage::LoadFile}{wximageloadfile}\\ \helpref{wxImage::LoadFile}{wximageloadfile},
\helpref{wxImage::SaveFile}{wximagesavefile}\\ \helpref{wxImage::SaveFile}{wximagesavefile},
\helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile} \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
\membersection{wxImageHandler::SetName} \membersection{wxImageHandler::SetName}

2
docs/latex/wx/inputstr.tex
View File

@@ -13,6 +13,8 @@ wxInputStream is an abstract base class which may not be used directly.
<wx/stream.h> <wx/stream.h>
\latexignore{\rtfignore{\wxheading{Members}}}
% ----------- % -----------
% ctor & dtor % ctor & dtor
% ----------- % -----------

6
docs/latex/wx/listctrl.tex
View File

@@ -157,8 +157,7 @@ Deletes all the items in the list control.
{\bf NB:} This function does {\it not} send the {\bf NB:} This function does {\it not} send the
{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
from the control would be too slow then (unlike from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
\helpref{DeleteItem}{wxlistctrldeleteitem})
\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn} \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
@@ -331,6 +330,7 @@ Returns the first item with given state following {\it item} or -1 if
no such item found. no such item found.
This function may be used to find all selected items in the control like this: This function may be used to find all selected items in the control like this:
\begin{verbatim} \begin{verbatim}
long item = -1; long item = -1;
for ( ;; ) for ( ;; )
@@ -413,7 +413,7 @@ wxLIST\_HITTEST\_ONITEMSTATEICON.}
\end{twocollist} \end{twocollist}
\pythonnote{A tuple of values is returned in the wxPython version of \pythonnote{A tuple of values is returned in the wxPython version of
thsi method. The first value is the item id and the second is the this method. The first value is the item id and the second is the
flags value mentioned above.} flags value mentioned above.}
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}

4
docs/latex/wx/log.tex
View File

@@ -80,17 +80,21 @@ current mask while a message using string mask will be logged simply if the
mask had been added before to the list of allowed ones. mask had been added before to the list of allowed ones.
For example, For example,
\begin{verbatim} \begin{verbatim}
// wxTraceOleCalls is one of standard bit masks // wxTraceOleCalls is one of standard bit masks
wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef); wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef);
\end{verbatim} \end{verbatim}
will do something only if the current trace mask contains both will do something only if the current trace mask contains both
{\tt wxTraceRefCount} and {\tt wxTraceOle}, but {\tt wxTraceRefCount} and {\tt wxTraceOle}, but
\begin{verbatim} \begin{verbatim}
// wxTRACE_OleCalls is one of standard string masks // wxTRACE_OleCalls is one of standard string masks
wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called"); wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
\end{verbatim} \end{verbatim}
will log the message if it was preceded by will log the message if it was preceded by
\begin{verbatim} \begin{verbatim}
wxLog::AddTraceMask(wxTRACE_OleCalls); wxLog::AddTraceMask(wxTRACE_OleCalls);
\end{verbatim} \end{verbatim}

2
docs/latex/wx/menu.tex
View File

@@ -777,7 +777,7 @@ dynamically.
\func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}} \func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
Replaces the menu at givenm position with another one. Replaces the menu at the given position with another one.
\wxheading{Parameters} \wxheading{Parameters}

6
docs/latex/wx/menuitem.tex
View File

@@ -233,9 +233,3 @@ Sets the text associated with the menu item.
Sets the text colour associated with the menu item (Windows only). Sets the text colour associated with the menu item (Windows only).
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "referenc"
%%% End:

4
docs/latex/wx/mouseevt.tex
View File

@@ -188,7 +188,9 @@ See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
\constfunc{wxPoint}{GetPosition}{\void} \constfunc{wxPoint}{GetPosition}{\void}
\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}} \constfunc{void}{GetPosition}{\param{wxCoord*}{ x}, \param{wxCoord*}{ y}}
\constfunc{void}{GetPosition}{\param{long*}{ x}, \param{long*}{ y}}
Sets *x and *y to the position at which the event occurred. Sets *x and *y to the position at which the event occurred.

46
docs/latex/wx/outptstr.tex
View File

@@ -13,6 +13,8 @@ wxOutputStream is an abstract base class which may not be used directly.
<wx/stream.h> <wx/stream.h>
\latexignore{\rtfignore{\wxheading{Members}}}
% ----------- % -----------
% ctor & dtor % ctor & dtor
% ----------- % -----------
@@ -69,47 +71,3 @@ Reads data from the specified input stream and stores them
in the current stream. The data is read until an error is raised in the current stream. The data is read until an error is raised
by one of the two streams. by one of the two streams.
% -----------------------------------------------------------------------------
% wxCountingOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
wxCountingOutputStream is specialized output stream which does not write any data anyway,
instead it counts how many bytes would get written if this were a normal stream. This
can sometimes be useful or required if some data gets serialized to a stream or compressed
by using stream compression and thus the final size of the stream cannot be known other
than pretending to write the stream. One case where the resulting size would have to be
known is if the data has to be written to a piece of memory and the memory has to be
allocated before writing to it (which is probably always the case when writing to a
memory stream).
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/stream.h>
% -----------
% ctor & dtor
% -----------
\membersection{wxCountingOutputStream::wxCountingOutputStream}
\func{}{wxCountingOutputStream}{\void}
Creates a wxCountingOutputStream object.
\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
\func{}{\destruct{wxCountingOutputStream}}{\void}
Destructor.
\membersection{wxCountingOutputStream::GetSize}
\constfunc{size\_t}{GetSize}{\void}
Returns the current size of the stream.

2
docs/latex/wx/print.tex
View File

@@ -850,8 +850,6 @@ context to draw on.
\section{\class{wxPrintPreview}}\label{wxprintpreview} \section{\class{wxPrintPreview}}\label{wxprintpreview}
\overview{Printing framework overview}{printingoverview}
Objects of this class manage the print preview process. The object is passed Objects of this class manage the print preview process. The object is passed
a wxPrintout object, and the wxPrintPreview object itself is passed to a wxPrintout object, and the wxPrintPreview object itself is passed to
a wxPreviewFrame object. Previewing is started by initializing and showing a wxPreviewFrame object. Previewing is started by initializing and showing

14
docs/latex/wx/progdlg.tex
View File

@@ -45,20 +45,20 @@ bitmask constants defined in wx/defs.h:
\twocolwidtha{7cm} \twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{wxPD\_APP\_MODAL}{Make the progress dialog modal. If this flag is \twocolitem{{\bf wxPD\_APP\_MODAL}}{Make the progress dialog modal. If this flag is
not given, it is only "locally" modal - that is the input to the parent not given, it is only "locally" modal - that is the input to the parent
window is disabled, but not to the other ones.} window is disabled, but not to the other ones.}
\twocolitem{wxPD\_AUTO\_HIDE}{By default, the progress dialog will disappear \twocolitem{{\bf wxPD\_AUTO\_HIDE}}{By default, the progress dialog will disappear
from screen as soon as the maximum value of the progress meter has been from screen as soon as the maximum value of the progress meter has been
reached. This flag prevents it from doing it - instead the dialog will wait reached. This flag prevents it from doing it - instead the dialog will wait
until the user closes it.} until the user closes it.}
\twocolitem{wxPD\_CAN\_ABORT}{This flag tells the dialog that it should have a \twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
"Cancel" button which the user may press. If this happens, the next call to "Cancel" button which the user may press. If this happens, the next call to
\helpref{Update()}{wxprogressdialogupdate} will return FALSE.} \helpref{Update()}{wxprogressdialogupdate} will return FALSE.}
\twocolitem{wxPD\_ELAPSED\_TIME}{This flag tells the dialog that it should show elapsed time (since creating the dialog).} \twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
\twocolitem{wxPD\_ESTIMATED\_TIME}{This flag tells the dialog that it should show estimated time.} \twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
\twocolitem{wxPD\_REMAINING\_TIME}{This flag tells the dialog that it should show remaining time.} \twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
\twocolitem{wxGA\_SMOOTH}{This flag tells the dialog that it should use \twocolitem{{\bf wxPD\_SMOOTH}}{This flag tells the dialog that it should use
smooth gauge (has effect only under 32bit Windows).} smooth gauge (has effect only under 32bit Windows).}
\end{twocollist}% \end{twocollist}%
} }

9
docs/latex/wx/propbfva.tex
View File

@@ -1,8 +1,13 @@
\section{\class{wxBoolFormValidator}}\label{wxboolformvalidator} \section{\class{wxBoolFormValidator}}\label{wxboolformvalidator}
\overview{Validator classes}{proplistvalidatorclasses} This class validates a boolean value for a \helpref{form view}{wxpropertyformview}.
The associated control must be a wxCheckBox.
This class validates a boolean value for a form view. The associated panel item must be a wxCheckBox. \wxheading{See also}
\helpref{Property validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxBoolFormValidator::wxBoolFormValidator} \membersection{wxBoolFormValidator::wxBoolFormValidator}

8
docs/latex/wx/propblva.tex
View File

@@ -1,8 +1,12 @@
\section{\class{wxBoolListValidator}}\label{wxboollistvalidator} \section{\class{wxBoolListValidator}}\label{wxboollistvalidator}
\overview{Validator classes}{proplistvalidatorclasses} This class validates a boolean value for a \helpref{property list view}{wxpropertylistview}.
This class validates a boolean value for a list view. \wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxBoolListValidator::wxBoolListValidator} \membersection{wxBoolListValidator::wxBoolListValidator}

1
docs/latex/wx/property.tex
View File

@@ -18,6 +18,7 @@ An alternative method is to use the {\it role} parameter to specify what kind
of validator would be appropriate; for example, specifying ``filename" for the role of validator would be appropriate; for example, specifying ``filename" for the role
would allow the property view to find an appropriate validator at edit time. would allow the property view to find an appropriate validator at edit time.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxProperty::wxProperty} \membersection{wxProperty::wxProperty}

10
docs/latex/wx/propflva.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxFilenameListValidator}}\label{wxfilenamelistvalidator} \section{\class{wxFilenameListValidator}}\label{wxfilenamelistvalidator}
\overview{Validator classes}{proplistvalidatorclasses} This class validates a filename for a \helpref{property list view}{wxpropertylistview}, allowing the user to edit it textually and also popping up
This class validates a filename for a list view, allowing the user to edit it textually and also popping up
a file selector in ``detailed editing" mode. a file selector in ``detailed editing" mode.
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFilenameListValidator::wxFilenameListValidator} \membersection{wxFilenameListValidator::wxFilenameListValidator}
\func{void}{wxFilenameListValidator}{\param{wxString }{message = ``Select a file"}, \param{wxString }{wildcard = ``*.*"}, \func{void}{wxFilenameListValidator}{\param{wxString }{message = ``Select a file"}, \param{wxString }{wildcard = ``*.*"},

5
docs/latex/wx/propford.tex
View File

@@ -5,10 +5,12 @@ be used for viewing a form property sheet. Pass a property form view object, and
will pass OnClose and OnDefaultAction listbox messages to the view class for will pass OnClose and OnDefaultAction listbox messages to the view class for
processing. processing.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyFormDialog::wxPropertyFormDialog} \membersection{wxPropertyFormDialog::wxPropertyFormDialog}
\func{void}{wxPropertyFormDialog}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title}, \func{void}{wxPropertyFormDialog}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title},
\param{Bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1}, \param{bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
\param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}} \param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}}
Constructor. Constructor.
@@ -19,4 +21,3 @@ Constructor.
Destructor. Destructor.

5
docs/latex/wx/propforf.tex
View File

@@ -7,6 +7,8 @@ will pass OnClose messages to the view class for processing.
Call Initialize to create the panel and associate the view; override OnCreatePanel Call Initialize to create the panel and associate the view; override OnCreatePanel
if you wish to use a panel class other than the default wxPropertyFormPanel. if you wish to use a panel class other than the default wxPropertyFormPanel.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyFormFrame::wxPropertyFormFrame} \membersection{wxPropertyFormFrame::wxPropertyFormFrame}
\func{void}{wxPropertyFormFrame}{\param{wxPropertyFormView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title}, \func{void}{wxPropertyFormFrame}{\param{wxPropertyFormView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
@@ -29,7 +31,7 @@ Returns the panel associated with the frame.
\membersection{wxPropertyFormFrame::Initialize} \membersection{wxPropertyFormFrame::Initialize}
\func{Bool}{Initialize}{\void} \func{bool}{Initialize}{\void}
Must be called to create the panel and associate the view with the panel and frame. Must be called to create the panel and associate the view with the panel and frame.
@@ -39,4 +41,3 @@ Must be called to create the panel and associate the view with the panel and fra
Creates a panel. Override this to create a panel type other than wxPropertyFormPanel. Creates a panel. Override this to create a panel type other than wxPropertyFormPanel.

4
docs/latex/wx/propforp.tex
View File

@@ -5,6 +5,8 @@ be used for viewing a property form. Pass a property form view object, and the p
will pass OnDefaultAction listbox messages to the view class for will pass OnDefaultAction listbox messages to the view class for
processing. processing.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyFormPanel::wxPropertyFormPanel} \membersection{wxPropertyFormPanel::wxPropertyFormPanel}
\func{void}{wxPropertyFormPanel}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent}, \func{void}{wxPropertyFormPanel}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent},
@@ -19,5 +21,3 @@ Constructor.
Destructor. Destructor.

19
docs/latex/wx/propforv.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxPropertyFormValidator}}\label{wxpropertyformvalidator} \section{\class{wxPropertyFormValidator}}\label{wxpropertyformvalidator}
\overview{wxPropertyFormValidator overview}{wxpropertyformvalidatoroverview}
The {\bf wxPropertyFormValidator} class defines a base class for form validators. By overriding virtual functions, The {\bf wxPropertyFormValidator} class defines a base class for form validators. By overriding virtual functions,
the programmer can create custom behaviour for kinds of property. the programmer can create custom behaviour for kinds of property.
\wxheading{See also}
\helpref{wxPropertyFormValidator overview}{wxpropertyformvalidatoroverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyFormValidator::wxPropertyFormValidator} \membersection{wxPropertyFormValidator::wxPropertyFormValidator}
\func{void}{wxPropertyFormValidator}{\param{long}{ flags = 0}} \func{void}{wxPropertyFormValidator}{\param{long}{ flags = 0}}
@@ -19,7 +23,7 @@ Destructor.
\membersection{wxPropertyFormValidator::OnCommand} \membersection{wxPropertyFormValidator::OnCommand}
\func{Bool}{OnCommand}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view}, \func{bool}{OnCommand}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}, \param{wxCommandEvent\& }{event}} \param{wxWindow *}{parentWindow}, \param{wxCommandEvent\& }{event}}
Called when the control corresponding to the property receives a command (if not intercepted Called when the control corresponding to the property receives a command (if not intercepted
@@ -27,7 +31,7 @@ by a callback associated with the actual control).
\membersection{wxPropertyFormValidator::OnCheckValue} \membersection{wxPropertyFormValidator::OnCheckValue}
\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view}, \func{bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the view checks the property value. The value checked by this validator should be taken from the Called when the view checks the property value. The value checked by this validator should be taken from the
@@ -35,23 +39,22 @@ panel item corresponding to the property.
\membersection{wxPropertyFormValidator::OnDisplayValue} \membersection{wxPropertyFormValidator::OnDisplayValue}
\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view}, \func{bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Should display the property value in the appropriate control. Should display the property value in the appropriate control.
\membersection{wxPropertyFormValidator::OnDoubleClick} \membersection{wxPropertyFormValidator::OnDoubleClick}
\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view}, \func{bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the control corresponding to the property is double clicked (listboxes only). Called when the control corresponding to the property is double clicked (listboxes only).
\membersection{wxPropertyFormValidator::OnRetrieveValue} \membersection{wxPropertyFormValidator::OnRetrieveValue}
\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view}, \func{bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Should do the transfer from the property editing area to the property itself. Should do the transfer from the property editing area to the property itself.

15
docs/latex/wx/propfovi.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxPropertyFormView}}\label{wxpropertyformview} \section{\class{wxPropertyFormView}}\label{wxpropertyformview}
\overview{wxPropertyFormView overview}{wxpropertyformviewoverview}
The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
box which has already been created. box which has already been created.
\wxheading{See also}
\helpref{wxPropertyFormView overview}{wxpropertyformviewoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyFormView::wxPropertyFormView} \membersection{wxPropertyFormView::wxPropertyFormView}
\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}} \func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}
@@ -28,7 +32,7 @@ association manually.
\membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck} \membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck}
\func{Bool}{Check}{\void} \func{bool}{Check}{\void}
Checks all properties by calling the appropriate validators; returns FALSE if a validation failed. Checks all properties by calling the appropriate validators; returns FALSE if a validation failed.
@@ -88,14 +92,13 @@ Sets the managed window (a frame or dialog) associated with the view.
\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog} \membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}
\func{Bool}{TransferToDialog}{\void} \func{bool}{TransferToDialog}{\void}
Transfers property values to the controls in the dialog. Transfers property values to the controls in the dialog.
\membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet} \membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet}
\func{Bool}{TransferToPropertySheet}{\void} \func{bool}{TransferToPropertySheet}{\void}
Transfers property values from the controls in the dialog to the property sheet. Transfers property values from the controls in the dialog to the property sheet.

11
docs/latex/wx/propifva.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxIntegerFormValidator}}\label{wxintegerformvalidator} \section{\class{wxIntegerFormValidator}}\label{wxintegerformvalidator}
\overview{Validator classes}{proplistvalidatorclasses} This class validates a range of integer values for a form view. The associated control must be a wxTextCtrl
This class validates a range of integer values for a form view. The associated panel item must be a wxText
or wxSlider. or wxSlider.
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxIntegerFormValidator::wxIntegerFormValidator} \membersection{wxIntegerFormValidator::wxIntegerFormValidator}
\func{void}{wxIntegerFormValidator}{\param{long }{min=0}, \param{long }{max=0}, \func{void}{wxIntegerFormValidator}{\param{long }{min=0}, \param{long }{max=0},
@@ -12,4 +16,3 @@ or wxSlider.
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check. Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.

6
docs/latex/wx/propilva.tex
View File

@@ -1,8 +1,12 @@
\section{\class{wxIntegerListValidator}}\label{wxintegerlistvalidator} \section{\class{wxIntegerListValidator}}\label{wxintegerlistvalidator}
This class validates a range of integer values for a list view.
\wxheading{See also}
\overview{Validator classes}{proplistvalidatorclasses} \overview{Validator classes}{proplistvalidatorclasses}
This class validates a range of integer values for a list view. \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxIntegerListValidator::wxIntegerListValidator} \membersection{wxIntegerListValidator::wxIntegerListValidator}

5
docs/latex/wx/proplisd.tex
View File

@@ -5,10 +5,12 @@ be used for viewing a property list. Pass a property list view object, and the d
will pass OnClose and OnDefaultAction listbox messages to the view class for will pass OnClose and OnDefaultAction listbox messages to the view class for
processing. processing.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyListDialog::wxPropertyListDialog} \membersection{wxPropertyListDialog::wxPropertyListDialog}
\func{void}{wxPropertyListDialog}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title}, \func{void}{wxPropertyListDialog}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title},
\param{Bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1}, \param{bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
\param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}} \param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}}
Constructor. Constructor.
@@ -19,4 +21,3 @@ Constructor.
Destructor. Destructor.

5
docs/latex/wx/proplisf.tex
View File

@@ -7,6 +7,8 @@ will pass OnClose messages to the view class for processing.
Call Initialize to create the panel and associate the view; override OnCreatePanel Call Initialize to create the panel and associate the view; override OnCreatePanel
if you wish to use a panel class other than the default wxPropertyListPanel. if you wish to use a panel class other than the default wxPropertyListPanel.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyListFrame::wxPropertyListFrame} \membersection{wxPropertyListFrame::wxPropertyListFrame}
\func{void}{wxPropertyListFrame}{\param{wxPropertyListView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title}, \func{void}{wxPropertyListFrame}{\param{wxPropertyListView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
@@ -29,7 +31,7 @@ Returns the panel associated with the frame.
\membersection{wxPropertyListFrame::Initialize} \membersection{wxPropertyListFrame::Initialize}
\func{Bool}{Initialize}{\void} \func{bool}{Initialize}{\void}
Must be called to create the panel and associate the view with the panel and frame. Must be called to create the panel and associate the view with the panel and frame.
@@ -39,4 +41,3 @@ Must be called to create the panel and associate the view with the panel and fra
Creates a panel. Override this to create a panel type other than wxPropertyListPanel. Creates a panel. Override this to create a panel type other than wxPropertyListPanel.

5
docs/latex/wx/proplisp.tex
View File

@@ -5,6 +5,8 @@ be used for viewing a property list. Pass a property list view object, and the p
will pass OnDefaultAction listbox messages to the view class for will pass OnDefaultAction listbox messages to the view class for
processing. processing.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyListPanel::wxPropertyListPanel} \membersection{wxPropertyListPanel::wxPropertyListPanel}
\func{void}{wxPropertyListPanel}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent}, \func{void}{wxPropertyListPanel}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent},
@@ -19,6 +21,3 @@ Constructor.
Destructor. Destructor.

11
docs/latex/wx/proplist.tex
View File

@@ -99,14 +99,6 @@ The property class library comprises the following files:
\item propform.h: wxPropertyListView and associated classes \item propform.h: wxPropertyListView and associated classes
\end{itemize} \end{itemize}
\section{Topic overviews}\label{proplistoverviews} \section{Topic overviews}\label{proplistoverviews}
This chapter contains a selection of topic overviews. This chapter contains a selection of topic overviews.
@@ -483,8 +475,6 @@ as described elsewhere, and the user edits away. When the user has finished edit
wxButtonWithProperties::SetProperty to transfer the wxProperty value back into the button wxButtonWithProperties::SetProperty to transfer the wxProperty value back into the button
by way of an appropriate call, wxWindow::SetSize in the case of width and height properties. by way of an appropriate call, wxWindow::SetSize in the case of width and height properties.
\section{Classes by category}\label{proplistclassesbycat} \section{Classes by category}\label{proplistclassesbycat}
A classification of property sheet classes by category. A classification of property sheet classes by category.
@@ -497,7 +487,6 @@ A classification of property sheet classes by category.
\item \helpref{wxPropertySheet}{wxpropertysheet} \item \helpref{wxPropertySheet}{wxpropertysheet}
\end{itemize} \end{itemize}
\subsection{Validator classes}\label{proplistvalidatorclasses} \subsection{Validator classes}\label{proplistvalidatorclasses}
Validators check that the values the user has entered for a property are Validators check that the values the user has entered for a property are

32
docs/latex/wx/propliva.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxPropertyListValidator}}\label{wxpropertylistvalidator} \section{\class{wxPropertyListValidator}}\label{wxpropertylistvalidator}
\overview{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview}
The {\bf wxPropertyListValidator} abstract class is the base class for The {\bf wxPropertyListValidator} abstract class is the base class for
deriving validators for property lists. deriving validators for property lists.
\wxheading{See also}
\helpref{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyListValidator::wxPropertyListValidator} \membersection{wxPropertyListValidator::wxPropertyListValidator}
\func{void}{wxPropertyListValidator}{\param{long}{ flags = wxPROP\_ALLOW\_TEXT\_EDITING}} \func{void}{wxPropertyListValidator}{\param{long}{ flags = wxPROP\_ALLOW\_TEXT\_EDITING}}
@@ -19,7 +23,7 @@ Destructor.
\membersection{wxPropertyListValidator::OnCheckValue} \membersection{wxPropertyListValidator::OnCheckValue}
\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value
@@ -27,21 +31,21 @@ was invalid, which is a signal restores the old value. Return TRUE if the value
\membersection{wxPropertyListValidator::OnClearControls} \membersection{wxPropertyListValidator::OnClearControls}
\func{Bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property. Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property.
\membersection{wxPropertyListValidator::OnClearDetailControls} \membersection{wxPropertyListValidator::OnClearDetailControls}
\func{Bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the focus is lost, if the validator is in detailed editing mode. Called when the focus is lost, if the validator is in detailed editing mode.
\membersection{wxPropertyListValidator::OnDisplayValue} \membersection{wxPropertyListValidator::OnDisplayValue}
\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Should display the value in the appropriate controls. The default implementation gets the Should display the value in the appropriate controls. The default implementation gets the
@@ -49,7 +53,7 @@ textual value from the property and inserts it into the text edit control.
\membersection{wxPropertyListValidator::OnDoubleClick} \membersection{wxPropertyListValidator::OnDoubleClick}
\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the property is double clicked. Extra functionality can be provided, Called when the property is double clicked. Extra functionality can be provided,
@@ -57,7 +61,7 @@ such as cycling through possible values.
\membersection{wxPropertyListValidator::OnEdit} \membersection{wxPropertyListValidator::OnEdit}
\func{Bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the Edit (detailed editing) button is pressed. The default implementation Called when the Edit (detailed editing) button is pressed. The default implementation
@@ -66,7 +70,7 @@ this function to show the file selector.
\membersection{wxPropertyListValidator::OnPrepareControls} \membersection{wxPropertyListValidator::OnPrepareControls}
\func{Bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called to allow the validator to setup the display, such enabling or disabling buttons, and Called to allow the validator to setup the display, such enabling or disabling buttons, and
@@ -75,14 +79,14 @@ value options).
\membersection{wxPropertyListValidator::OnPrepareDetailControls} \membersection{wxPropertyListValidator::OnPrepareDetailControls}
\func{Bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the property is edited `in detail', i.e. when the Edit button is pressed. Called when the property is edited `in detail', i.e. when the Edit button is pressed.
\membersection{wxPropertyListValidator::OnRetrieveValue} \membersection{wxPropertyListValidator::OnRetrieveValue}
\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when Tick (Confirm) is pressed or focus is lost or view wants to update Called when Tick (Confirm) is pressed or focus is lost or view wants to update
@@ -90,7 +94,7 @@ the property list. Should do the transfer from the property editing area to the
\membersection{wxPropertyListValidator::OnSelect} \membersection{wxPropertyListValidator::OnSelect}
\func{Bool}{OnSelect}{\param{Bool}{ select}, \param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnSelect}{\param{bool}{ select}, \param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the property is selected or deselected: typically displays the value Called when the property is selected or deselected: typically displays the value
@@ -98,11 +102,9 @@ in the edit control (having chosen a suitable control to display: (non)editable
\membersection{wxPropertyListValidator::OnValueListSelect} \membersection{wxPropertyListValidator::OnValueListSelect}
\func{Bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, \func{bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}} \param{wxWindow *}{parentWindow}}
Called when the value listbox is selected. The default behaviour is to copy Called when the value listbox is selected. The default behaviour is to copy
string to text control, and retrieve the value into the property. string to text control, and retrieve the value into the property.

8
docs/latex/wx/proplosv.tex
View File

@@ -1,7 +1,5 @@
\section{\class{wxListOfStringsListValidator}}\label{wxlistofstringslistvalidator} \section{\class{wxListOfStringsListValidator}}\label{wxlistofstringslistvalidator}
\overview{Validator classes}{proplistvalidatorclasses}
This class validates a list of strings for a list view. When editing the property, This class validates a list of strings for a list view. When editing the property,
a dialog box is presented for adding, deleting or editing entries in the list. a dialog box is presented for adding, deleting or editing entries in the list.
At present no constraints may be supplied. At present no constraints may be supplied.
@@ -19,6 +17,12 @@ For example:
sheet->AddProperty(new wxProperty("fred", strings, "stringlist")); sheet->AddProperty(new wxProperty("fred", strings, "stringlist"));
\end{verbatim} \end{verbatim}
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxListOfStringsListValidator::wxListofStringsListValidator} \membersection{wxListOfStringsListValidator::wxListofStringsListValidator}
\func{void}{wxListOfStringsListValidator}{\param{long}{ flags=0}} \func{void}{wxListOfStringsListValidator}{\param{long}{ flags=0}}

19
docs/latex/wx/proplstv.tex
View File

@@ -1,9 +1,13 @@
\section{\class{wxPropertyListView}}\label{wxpropertylistview} \section{\class{wxPropertyListView}}\label{wxpropertylistview}
\overview{wxPropertyListView overview}{wxpropertylistviewoverview}
The {\bf wxPropertyListView} class shows a wxPropertySheet as a Visual Basic-style property list. The {\bf wxPropertyListView} class shows a wxPropertySheet as a Visual Basic-style property list.
\wxheading{See also}
\helpref{wxPropertyListView overview}{wxpropertylistviewoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyListView::wxPropertyListView} \membersection{wxPropertyListView::wxPropertyListView}
\func{void}{wxPropertyListView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}} \func{void}{wxPropertyListView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
@@ -36,14 +40,14 @@ Associates the window on which the controls will be displayed, with the view (se
\membersection{wxPropertyListView::BeginShowingProperty}\label{wxpropertylistviewbeginshowingproperty} \membersection{wxPropertyListView::BeginShowingProperty}\label{wxpropertylistviewbeginshowingproperty}
\func{Bool}{BeginShowingProperty}{\param{wxProperty *}{property}} \func{bool}{BeginShowingProperty}{\param{wxProperty *}{property}}
Finds the appropriate validator and loads the property into the controls, by calling Finds the appropriate validator and loads the property into the controls, by calling
wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty. wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty.
\membersection{wxPropertyListView::DisplayProperty}\label{wxpropertylistviewdisplayproperty} \membersection{wxPropertyListView::DisplayProperty}\label{wxpropertylistviewdisplayproperty}
\func{Bool}{DisplayProperty}{\param{wxProperty *}{property}} \func{bool}{DisplayProperty}{\param{wxProperty *}{property}}
Calls wxPropertyValidator::OnDisplayValue for the current property's validator. This function Calls wxPropertyValidator::OnDisplayValue for the current property's validator. This function
gets called by wxPropertyListView::BeginShowingProperty, which is in turn called gets called by wxPropertyListView::BeginShowingProperty, which is in turn called
@@ -51,7 +55,7 @@ from ShowProperty, called by OnPropertySelect, called by the listbox callback wh
\membersection{wxPropertyListView::EndShowingProperty}\label{wxpropertylistviewendshowingproperty} \membersection{wxPropertyListView::EndShowingProperty}\label{wxpropertylistviewendshowingproperty}
\func{Bool}{EndShowingProperty}{\param{wxProperty *}{property}} \func{bool}{EndShowingProperty}{\param{wxProperty *}{property}}
Finds the appropriate validator and unloads the property from the controls, by calling Finds the appropriate validator and unloads the property from the controls, by calling
wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in
@@ -95,14 +99,13 @@ Sets the managed window (a frame or dialog) associated with the view.
\membersection{wxPropertyListView::UpdatePropertyDisplayInList}\label{wxpropertylistviewupdatepropdisplay} \membersection{wxPropertyListView::UpdatePropertyDisplayInList}\label{wxpropertylistviewupdatepropdisplay}
\func{Bool}{UpdatePropertyDisplayInList}{\param{wxProperty *}{property}} \func{bool}{UpdatePropertyDisplayInList}{\param{wxProperty *}{property}}
Updates the display for the given changed property. Updates the display for the given changed property.
\membersection{wxPropertyListView::UpdatePropertyList}\label{wxpropertylistviewupdateproplist} \membersection{wxPropertyListView::UpdatePropertyList}\label{wxpropertylistviewupdateproplist}
\func{Bool}{UpdatePropertyList}{\param{Bool }{clearEditArea = TRUE}} \func{bool}{UpdatePropertyList}{\param{bool }{clearEditArea = TRUE}}
Updates the whole property list display. Updates the whole property list display.

2
docs/latex/wx/propregv.tex
View File

@@ -4,6 +4,8 @@ The {\bf wxPropertyValidatorRegistry} class is used for storing validators,
indexed by the `role name' of the property, by which groups of property indexed by the `role name' of the property, by which groups of property
can be identified for the purpose of validation and editing. can be identified for the purpose of validation and editing.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry} \membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}
\func{void}{wxPropertyValidatorRegistry}{\void} \func{void}{wxPropertyValidatorRegistry}{\void}

9
docs/latex/wx/proprfva.tex
View File

@@ -1,9 +1,13 @@
\section{\class{wxRealFormValidator}}\label{wxrealformvalidator} \section{\class{wxRealFormValidator}}\label{wxrealformvalidator}
\overview{Validator classes}{proplistvalidatorclasses}
This class validates a range of real values for form views. The associated panel item must be a wxText. This class validates a range of real values for form views. The associated panel item must be a wxText.
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxRealFormValidator::wxRealFormValidator} \membersection{wxRealFormValidator::wxRealFormValidator}
\func{void}{wxRealFormValidator}{\param{float }{min=0.0}, \param{float }{max=0.0}, \func{void}{wxRealFormValidator}{\param{float }{min=0.0}, \param{float }{max=0.0},
@@ -11,4 +15,3 @@ This class validates a range of real values for form views. The associated panel
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check. Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.

13
docs/latex/wx/proprlva.tex
View File

@@ -1,14 +1,19 @@
\section{\class{wxRealListValidator}}\label{wxreallistvalidator} \section{\class{wxRealListValidator}}\label{wxreallistvalidator}
\overview{Validator classes}{proplistvalidatorclasses}
This class validates a range of real values for property lists. This class validates a range of real values for property lists.
\membersection{wxRealListValidator::wxreallistvalidator} \wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\helpref{wxPropertySheet overview}{wxpropertysheetoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxRealListValidator::wxRealListValidator}
\func{void}{wxRealListValidator}{\param{float }{min=0.0}, \param{float }{max=0.0}, \func{void}{wxRealListValidator}{\param{float }{min=0.0}, \param{float }{max=0.0},
\param{long}{ flags=wxPROP\_ALLOW\_TEXT\_EDITING}} \param{long}{ flags=wxPROP\_ALLOW\_TEXT\_EDITING}}
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check. Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.

12
docs/latex/wx/propsht.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxPropertySheet}}\label{wxpropertysheet} \section{\class{wxPropertySheet}}\label{wxpropertysheet}
\overview{wxPropertySheet overview}{wxpropertysheetoverview}
The {\bf wxPropertySheet} class is used for storing a number of The {\bf wxPropertySheet} class is used for storing a number of
wxProperty objects (essentially names and values). wxProperty objects (essentially names and values).
\wxheading{See also}
\helpref{wxPropertySheet overview}{wxpropertysheetoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertySheet::wxPropertySheet} \membersection{wxPropertySheet::wxPropertySheet}
\func{void}{wxPropertySheet}{\param{const wxString}{ name = ""}} \func{void}{wxPropertySheet}{\param{const wxString}{ name = ""}}
@@ -73,9 +77,7 @@ Sets property propname to value. Returns false if property is not a member of sh
\membersection{wxPropertySheet::SetAllModified} \membersection{wxPropertySheet::SetAllModified}
\func{void}{SetAllModified}{\param{Bool}{ flag}} \func{void}{SetAllModified}{\param{bool}{ flag}}
Sets the `modified' flag of each property value. Sets the `modified' flag of each property value.

8
docs/latex/wx/propslv.tex
View File

@@ -1,9 +1,13 @@
\section{\class{wxStringListValidator}}\label{wxstringlistvalidator} \section{\class{wxStringListValidator}}\label{wxstringlistvalidator}
\overview{Validator classes}{proplistvalidatorclasses}
This class validates a string value, with an optional choice of possible values. This class validates a string value, with an optional choice of possible values.
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxStringListValidator::wxStringListValidator} \membersection{wxStringListValidator::wxStringListValidator}
\func{void}{wxStringListValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}} \func{void}{wxStringListValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}

9
docs/latex/wx/propstfv.tex
View File

@@ -1,12 +1,16 @@
\section{\class{wxStringFormValidator}}\label{wxstringformvalidator} \section{\class{wxStringFormValidator}}\label{wxstringformvalidator}
\overview{Validator classes}{proplistvalidatorclasses}
This class validates a string value for a form view, with an optional choice of possible values. This class validates a string value for a form view, with an optional choice of possible values.
The associated panel item must be a wxText, wxListBox or wxChoice. For wxListBox and wxChoice items, The associated panel item must be a wxText, wxListBox or wxChoice. For wxListBox and wxChoice items,
if the item is empty, the validator attempts to initialize the item from the strings in if the item is empty, the validator attempts to initialize the item from the strings in
the validator. Note that this does not happen for XView wxChoice items since XView cannot reinitialize a wxChoice. the validator. Note that this does not happen for XView wxChoice items since XView cannot reinitialize a wxChoice.
\wxheading{See also}
\helpref{Validator classes}{proplistvalidatorclasses}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxStringFormValidator::wxStringFormValidator} \membersection{wxStringFormValidator::wxStringFormValidator}
\func{void}{wxStringFormValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}} \func{void}{wxStringFormValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}
@@ -14,4 +18,3 @@ the validator. Note that this does not happen for XView wxChoice items since XVi
Constructor. Supply a list of strings to indicate a choice, or no strings to allow the Constructor. Supply a list of strings to indicate a choice, or no strings to allow the
user to freely edit the string. The string list will be deleted when the validator is deleted. user to freely edit the string. The string list will be deleted when the validator is deleted.

22
docs/latex/wx/propval.tex
View File

@@ -18,6 +18,8 @@ A wxPropertyValue has one of the following types:
\item wxPropertyValueStringPtr \item wxPropertyValueStringPtr
\end{itemize} \end{itemize}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyValue::wxPropertyValue} \membersection{wxPropertyValue::wxPropertyValue}
\func{void}{wxPropertyValue}{\void} \func{void}{wxPropertyValue}{\void}
@@ -35,9 +37,9 @@ Construction from a string value.
\func{void}{wxPropertyValue}{\param{long}{ val}} \func{void}{wxPropertyValue}{\param{long}{ val}}
Construction from an integer value. You may need to cast to (long) to Construction from an integer value. You may need to cast to (long) to
avoid confusion with other constructors (such as the Bool constructor). avoid confusion with other constructors (such as the bool constructor).
\func{void}{wxPropertyValue}{\param{Bool}{ val}} \func{void}{wxPropertyValue}{\param{bool}{ val}}
Construction from a boolean value. Construction from a boolean value.
@@ -71,7 +73,7 @@ Construction from a string pointer.
Construction from an integer pointer. Construction from an integer pointer.
\func{void}{wxPropertyValue}{\param{Bool *}{val}} \func{void}{wxPropertyValue}{\param{bool *}{val}}
Construction from an boolean pointer. Construction from an boolean pointer.
@@ -97,13 +99,13 @@ Appends a property value to the list.
\membersection{wxPropertyValue::BoolValue} \membersection{wxPropertyValue::BoolValue}
\func{Bool}{BoolValue}{\void} \func{bool}{BoolValue}{\void}
Returns the boolean value. Returns the boolean value.
\membersection{wxPropertyValue::BoolValuePtr} \membersection{wxPropertyValue::BoolValuePtr}
\func{Bool *}{BoolValuePtr}{\void} \func{bool *}{BoolValuePtr}{\void}
Returns the pointer to the boolean value. Returns the pointer to the boolean value.
@@ -133,7 +135,7 @@ Gets the last value in the list.
\membersection{wxPropertyValue::GetModified} \membersection{wxPropertyValue::GetModified}
\func{Bool}{GetModified}{\void} \func{bool}{GetModified}{\void}
Returns TRUE if the value was modified since being created Returns TRUE if the value was modified since being created
(or since SetModified was called). (or since SetModified was called).
@@ -194,7 +196,7 @@ Returns the pointer to the floating point value.
\membersection{wxPropertyValue::SetModified} \membersection{wxPropertyValue::SetModified}
\func{void}{SetModified}{\param{Bool}{ flag}} \func{void}{SetModified}{\param{bool}{ flag}}
Sets the `modified' flag. Sets the `modified' flag.
@@ -224,7 +226,7 @@ Returns the value type.
\func{void}{operator $=$}{\param{const long }{val}} \func{void}{operator $=$}{\param{const long }{val}}
\func{void}{operator $=$}{\param{const Bool }{val}} \func{void}{operator $=$}{\param{const bool }{val}}
\func{void}{operator $=$}{\param{const float }{val}} \func{void}{operator $=$}{\param{const float }{val}}
@@ -232,11 +234,9 @@ Returns the value type.
\func{void}{operator $=$}{\param{const long *}{val}} \func{void}{operator $=$}{\param{const long *}{val}}
\func{void}{operator $=$}{\param{const Bool *}{val}} \func{void}{operator $=$}{\param{const bool *}{val}}
\func{void}{operator $=$}{\param{const float *}{val}} \func{void}{operator $=$}{\param{const float *}{val}}
Assignment operators. Assignment operators.

9
docs/latex/wx/propvald.tex
View File

@@ -1,10 +1,14 @@
\section{\class{wxPropertyValidator}}\label{wxpropertyvalidator} \section{\class{wxPropertyValidator}}\label{wxpropertyvalidator}
\overview{wxPropertyValidator overview}{wxpropertyvalidatoroverview}
The {\bf wxPropertyValidator} abstract class is the base class for deriving The {\bf wxPropertyValidator} abstract class is the base class for deriving
validators for properties. validators for properties.
\wxheading{See also}
\helpref{wxPropertyValidator overview}{wxpropertyvalidatoroverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyValidator::wxPropertyValidator} \membersection{wxPropertyValidator::wxPropertyValidator}
\func{void}{wxPropertyValidator}{\param{long}{ flags = 0}} \func{void}{wxPropertyValidator}{\param{long}{ flags = 0}}
@@ -35,4 +39,3 @@ Gets the property for the validator.
Sets the property for the validator. Sets the property for the validator.

12
docs/latex/wx/propview.tex
View File

@@ -1,11 +1,15 @@
\section{\class{wxPropertyView}}\label{wxpropertyview} \section{\class{wxPropertyView}}\label{wxpropertyview}
\overview{wxPropertyView overview}{wxpropertyviewoverview}
The {\bf wxPropertyView} abstract class is the base class for views The {\bf wxPropertyView} abstract class is the base class for views
of property sheets, acting as intermediaries between properties and of property sheets, acting as intermediaries between properties and
actual windows. actual windows.
\wxheading{See also}
\helpref{wxPropertyView overview}{wxpropertyviewoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyView::wxPropertyView} \membersection{wxPropertyView::wxPropertyView}
\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}} \func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
@@ -68,7 +72,7 @@ Virtual function that will be called when the Cancel button on the physical wind
\membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose} \membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose}
\func{Bool}{OnClose}{\void} \func{bool}{OnClose}{\void}
Virtual function that will be called when the physical window is closed. The default implementation returns FALSE. Virtual function that will be called when the physical window is closed. The default implementation returns FALSE.
@@ -88,7 +92,7 @@ to respond immediately to property value changes.
\membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview} \membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview}
\func{Bool}{OnUpdateView}{\void} \func{bool}{OnUpdateView}{\void}
Called by the viewed object to update the view. The default implementation just returns Called by the viewed object to update the view. The default implementation just returns
FALSE. FALSE.

2
docs/latex/wx/protocol.tex
View File

@@ -16,7 +16,7 @@
% Members % Members
% ---------------------------------------------------------------------------- % ----------------------------------------------------------------------------
\latexignore{\rtfignore{\membersection{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}

3
docs/latex/wx/recrdset.tex
View File

@@ -4,6 +4,9 @@ Each wxRecordSet represents an ODBC database query. You can make multiple querie
at a time by using multiple wxRecordSets with a wxDatabase or you can make at a time by using multiple wxRecordSets with a wxDatabase or you can make
your queries in sequential order using the same wxRecordSet. your queries in sequential order using the same wxRecordSet.
Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable classes
(documented separately in Word and PDF format, as odbc.doc and odbc.pdf).
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxObject}{wxobject} \helpref{wxObject}{wxobject}

7
docs/latex/wx/screendc.tex
View File

@@ -49,6 +49,13 @@ to implement this feature.
You might use this pair of functions when implementing a drag feature, for example You might use this pair of functions when implementing a drag feature, for example
as in the \helpref{wxSplitterWindow}{wxsplitterwindow} implementation. as in the \helpref{wxSplitterWindow}{wxsplitterwindow} implementation.
\wxheading{Remarks}
This function is probably obsolete since the X implementations
allow drawing directly on the screen now. However, the fact that this
function allows the screen to be refreshed afterwards, may be useful to
some applications.
\membersection{wxScreenDC::EndDrawingOnTop}\label{wxscreendcenddrawingontop} \membersection{wxScreenDC::EndDrawingOnTop}\label{wxscreendcenddrawingontop}
\func{bool}{EndDrawingOnTop}{\void} \func{bool}{EndDrawingOnTop}{\void}

4
docs/latex/wx/socket.tex
View File

@@ -559,7 +559,7 @@ enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, \helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketEvent}{wxsocketevent}, \helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxEvtHandler}{wxevthandler}, \helpref{wxEvtHandler}{wxevthandler}
% %
% SetFlags % SetFlags
@@ -1029,6 +1029,8 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset
<wx/socket.h> <wx/socket.h>
\latexignore{\rtfignore{\wxheading{Members}}}
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
% Members % Members
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------

2
docs/latex/wx/statbmp.tex
View File

@@ -92,5 +92,5 @@ Sets the bitmap label.
\wxheading{See also} \wxheading{See also}
\docparam{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap} \helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}

1
docs/latex/wx/stream.tex
View File

@@ -28,7 +28,6 @@ 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, and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read,
wxStreamBuffer::write, wxStreamBuffer::read\_write. wxStreamBuffer::write, wxStreamBuffer::read\_write.
One stream can have many stream buffers but only one is used internally to One stream can have many stream buffers but only one is used internally to
pass IO call (e.g. wxInputStream::Read() -> wxStreamBuffer::Read()), but you pass IO call (e.g. wxInputStream::Read() -> wxStreamBuffer::Read()), but you
can call directly wxStreamBuffer::Read without any problems. Note that can call directly wxStreamBuffer::Read without any problems. Note that

1
docs/latex/wx/strmbase.tex
View File

@@ -54,6 +54,7 @@ Returns TRUE if no error occured on the stream.
\constfunc{wxStreamError}{LastError}{\void} \constfunc{wxStreamError}{LastError}{\void}
This function returns the last error. This function returns the last error.
\twocolwidtha{5cm} \twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occured.} \twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occured.}

8
docs/latex/wx/strmfile.tex
View File

@@ -4,7 +4,7 @@
\section{\class{wxFileInputStream}}\label{wxfileinputstream} \section{\class{wxFileInputStream}}\label{wxfileinputstream}
This class represents data read in from a file. There are actually This class represents data read in from a file. There are actually
two such groups of classes: this one is based on the \helpref{wxFile}{wxfile} two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class. the \helpref{wxFFile}{wxffile} class.
@@ -65,7 +65,7 @@ Returns TRUE if the stream is initialized and ready.
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream} \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
This class represents data written to a file. There are actually This class represents data written to a file. There are actually
two such groups of classes: this one is based on the \helpref{wxFile}{wxfile} two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class. the \helpref{wxFFile}{wxffile} class.
@@ -154,7 +154,7 @@ Initializes a new file stream in read-write mode using the specified
\section{\class{wxFFileInputStream}}\label{wxffileinputstream} \section{\class{wxFFileInputStream}}\label{wxffileinputstream}
This class represents data read in from a file. There are actually This class represents data read in from a file. There are actually
two such groups of classes: this one is based on the \helpref{wxFFile}{wxffile} two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in
the \helpref{wxFile}{wxfile} class. the \helpref{wxFile}{wxfile} class.
@@ -215,7 +215,7 @@ Returns TRUE if the stream is initialized and ready.
\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream} \section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
This class represents data written to a file. There are actually This class represents data written to a file. There are actually
two such groups of classes: this one is based on the \helpref{wxFFile}{wxffile} two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFile}{wxfile} class. the \helpref{wxFile}{wxfile} class.

38
docs/latex/wx/tdb.tex
View File

@@ -73,8 +73,6 @@ also get deleted, so beware of holding onto invalid pointers.
\subsection{wxDatabase overview}\label{wxdatabaseoverview} \subsection{wxDatabase overview}\label{wxdatabaseoverview}
\overview{Database classes overview}{odbcoverview}
Class: \helpref{wxDatabase}{wxdatabase} Class: \helpref{wxDatabase}{wxdatabase}
Every database object represents an ODBC connection. To do anything useful Every database object represents an ODBC connection. To do anything useful
@@ -82,9 +80,11 @@ with a database object you need to bind a wxRecordSet object to it. All you
can do with wxDatabase is opening/closing connections and getting some info can do with wxDatabase is opening/closing connections and getting some info
about it (users, passwords, and so on). about it (users, passwords, and so on).
\subsection{wxQueryCol overview}\label{wxquerycoloverview} \wxheading{See also}
\overview{Database classes overview}{odbcoverview} \helpref{Database classes overview}{odbcoverview}
\subsection{wxQueryCol overview}\label{wxquerycoloverview}
Class: \helpref{wxQueryCol}{wxquerycol} Class: \helpref{wxQueryCol}{wxquerycol}
@@ -93,9 +93,11 @@ It contains the name and type of a column and a list of wxQueryFields where
the real data is stored. The links to user-defined variables are stored the real data is stored. The links to user-defined variables are stored
here, as well. here, as well.
\subsection{wxQueryField overview}\label{wxqueryfieldoverview} \wxheading{See also}
\overview{Database classes overview}{odbcoverview} \helpref{Database classes overview}{odbcoverview}
\subsection{wxQueryField overview}\label{wxqueryfieldoverview}
Class: \helpref{wxQueryField}{wxqueryfield} Class: \helpref{wxQueryField}{wxqueryfield}
@@ -108,9 +110,11 @@ or wxRecordSet::GoTo. If wxRecordSet is of the type wxOPEN\_TYPE\_SNAPSHOT,
all data returned by an ODBC function will be loaded at once and the number all data returned by an ODBC function will be loaded at once and the number
of wxQueryField instances for each column will depend on the number of records. of wxQueryField instances for each column will depend on the number of records.
\subsection{wxRecordSet overview}\label{wxrecordsetoverview} \wxheading{See also}
\overview{Database classes overview}{odbcoverview} \helpref{Database classes overview}{odbcoverview}
\subsection{wxRecordSet overview}\label{wxrecordsetoverview}
Class: \helpref{wxRecordSet}{wxrecordset} Class: \helpref{wxRecordSet}{wxrecordset}
@@ -118,9 +122,11 @@ Each wxRecordSet represents a database query. You can make multiple queries
at a time by using multiple wxRecordSets with a wxDatabase or you can make at a time by using multiple wxRecordSets with a wxDatabase or you can make
your queries in sequential order using the same wxRecordSet. your queries in sequential order using the same wxRecordSet.
\subsection{ODBC SQL data types}\label{sqltypes} \wxheading{See also}
\overview{Database classes overview}{odbcoverview} \helpref{Database classes overview}{odbcoverview}
\subsection{ODBC SQL data types}\label{sqltypes}
These are the data types supported in ODBC SQL. Note that there are other, extended level conformance These are the data types supported in ODBC SQL. Note that there are other, extended level conformance
types, not currently supported in wxWindows. types, not currently supported in wxWindows.
@@ -153,13 +159,19 @@ These data types correspond to the following ODBC identifiers:
\twocolitem{SQL\_DOUBLE}{Same as SQL\_FLOAT.} \twocolitem{SQL\_DOUBLE}{Same as SQL\_FLOAT.}
\end{twocollist} \end{twocollist}
\subsection{A selection of SQL commands}\label{sqlcommands} \wxheading{See also}
\overview{Database classes overview}{odbcoverview} \helpref{Database classes overview}{odbcoverview}
\subsection{A selection of SQL commands}\label{sqlcommands}
The following is a very brief description of some common SQL commands, with The following is a very brief description of some common SQL commands, with
examples. examples.
\wxheading{See also}
\helpref{Database classes overview}{odbcoverview}
\subsubsection{Create} \subsubsection{Create}
Creates a table. Creates a table.
@@ -234,5 +246,3 @@ Example:
This example sets a field in column `X' to the number 123, for the record This example sets a field in column `X' to the number 123, for the record
where the column ASSET has the value `BD34'. where the column ASSET has the value `BD34'.

9
docs/latex/wx/time.tex
View File

@@ -2,9 +2,9 @@
Representation of time and date. Representation of time and date.
NOTE: this class should be {\bf NOTE:} this class is retained only for compatibility,
used with caution, since it is not fully tested. It will be replaced and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxTime
with a new wxDateTime class in the near future. may be withdrawn in future versions of wxWindows.
\wxheading{Derived from} \wxheading{Derived from}
@@ -23,7 +23,8 @@ typedef unsigned short secondTy;
typedef unsigned long clockTy; typedef unsigned long clockTy;
enum tFormat { wx12h, wx24h }; enum tFormat { wx12h, wx24h };
enum tPrecision { wxStdMinSec, wxStdMin }; enum tPrecision { wxStdMinSec, wxStdMin };
\end{verbatim}} \end{verbatim}
}
\wxheading{See also} \wxheading{See also}

5
docs/latex/wx/window.tex
View File

@@ -1403,9 +1403,12 @@ Sent to the event handler when the window must be refreshed.
\wxheading{Remarks} \wxheading{Remarks}
Use the EVT\_PAINT macro in an event table definition to intercept paint events. Use the EVT\_PAINT macro in an event table definition to intercept paint events.
In a paint event handler, the application should always create a \helpref{wxPaintDC}{wxpaintdc} object. Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
For example: For example: