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
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
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.
\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}
case under Solaris and IRIX, where the default visual is only 8-bit whereas certain
appications are supposed to run in TrueColour mode.
-Note that this function has to be called in the constructor of the {\tt wxApp}
+Note that this function has to be called in the constructor of the {\tt wxApp}
instance and won't have any effect when called later on.
This function currently only has effect under GTK.
You will have to initialize the objects of this class by passing a comparaison
function to the array object constructor like this:
+
\begin{verbatim}
int CompareInts(int n1, int n2)
{
If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as
\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
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
\membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
\func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
-Sorts the array in alphabetical order or in reverse alphabetical order if
+Sorts the array in alphabetical order or in reverse alphabetical order if
{\it reverseOrder} is TRUE.
{\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
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
See also: \helpref{Sort}{wxarraystringsortcallback}
Sorts the array using the specified {\it compareFunction} for item comparison.
{\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
second one.
{\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
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
See also: \helpref{Sort}{wxarraystringsort}
\section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject}
wxBitmapDataObject is a specialization of wxDataObject for bitmap data. It can
-be used without change to paste data into the
+be used without change to paste data into the
\helpref{wxClipboard}{wxclipboard} or a \helpref{wxDropSource}{wxdropsource}. A
user may wish to derive a new class from this class for providing a bitmap
on-demand in order to minimize memory consumption when offering data in several
\wxheading{Virtual functions to override}
-This class may be used as is, but
+This class may be used as is, but
\helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase
efficiency.
\wxheading{See also}
-\helpref{Clipboard and drag and drop overview}{wxdndoverview},
-\helpref{wxDataObject}{wxdataobject},
-\helpref{wxDataObjectSimple}{wxdataobjectsimple},
-\helpref{wxFileDataObject}{wxfiledataobject},
-\helpref{wxTextDataObject}{wxtextdataobject},
+\helpref{Clipboard and drag and drop overview}{wxdndoverview},
+\helpref{wxDataObject}{wxdataobject},
+\helpref{wxDataObjectSimple}{wxdataobjectsimple},
+\helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject},
\helpref{wxDataObject}{wxdataobject}
\func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
-Constructor, optionally passing a bitmap (otherwise use
-\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later)
+Constructor, optionally passing a bitmap (otherwise use
+\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later).
\membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}
\section{What is wxWindows?}
wxWindows is a C++ framework providing GUI (Graphical User
-Interface) and other facilities on more than one platform. Version 2.0 currently
-supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, and Unix with Motif.
-A Mac port is in an advanced state, an OS/2 port and a port to the MGL graphics library
-have been started.
+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+, Unix with Motif,
+and Mac. An OS/2 port is in progress.
wxWindows was originally developed at the Artificial Intelligence
-Applications Institute, University of Edinburgh, for internal use.
-wxWindows has been released into the public domain in the hope
-that others will also find it useful. Version 2.0 is written and
-maintained by Julian Smart, Robert Roebling, Vadim Zeitlin and others.
+Applications Institute, University of Edinburgh, for internal use,
+and was first made publicly available in 1993.
+Version 2 is a vastly improved version written and maintained by
+Julian Smart, Robert Roebling, Vadim Zeitlin and many others.
This manual discusses wxWindows in the context of multi-platform
development.\helpignore{For more detail on the wxWindows version 2.0 API
emerged. However, none has the range of features, flexibility, documentation and the
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
-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
without an independent development team), plus a robustness against
the transience of one individual or company. This openness and
thousands of lines of application code may depend upon the longevity of
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
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
overstated, since GUI application development is very time-consuming,
platform or audience. wxWindows helps to insulate the programmer from
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
-GUI program normally requires, plus some extras such as network programming
-and PostScript output, and can of course be extended as needs dictate. As a bonus, it provides
-a cleaner programming interface than the native
+GUI program normally requires, plus many extras such as network programming,
+PostScript output, and HTML rendering; and it can of course be extended as needs dictate. As a bonus, it provides
+a far cleaner and easier programming interface than the native
APIs. Programmers may find it worthwhile to use wxWindows even if they
are developing on only one platform.
\item You get the source.
\item Available on a variety of popular platforms.
\item Works with almost all popular C++ compilers and Python.
-\item Over 40 example programs.
-\item Over 900 pages of printable and on-line documentation.
+\item Over 50 example programs.
+\item Over 1000 pages of printable and on-line documentation.
\item Includes Tex2RTF, to allow you to produce your own documentation
in Windows Help, HTML and Word RTF formats.
\item Simple-to-use, object-oriented API.
\item Under MS Windows, support for creating metafiles and copying
them to the clipboard.
\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 Network support via a family of socket and protocol classes.
\item Support for platform independent image procesing.
\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}
-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:
GTK version of wxWindows 2.2 on Linux and Solaris will be libwx\_gtk-2.2.so.0.0.0,
on HP-UX, it will be libwx\_gtk-2.2.sl, on AIX just libwx\_gtk.a etc.
-Under Windows, use the library wx.lib for stand-alone Windows
-applications, or wxdll.lib for creating DLLs.
+Under Windows, use the library wx.lib (release) or wxd.lib (debug) for stand-alone Windows
+applications, or wxdll.lib (wxdlld.lib) for creating DLLs.
\section{Configuration}
\func{void}{RecalcSizes}{\void}
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
-by the users. Documented for information.
+by the user. Documented for information.
\membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin}
\func{wxSize}{CalcMin}{\void}
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}
\func{int}{GetOrientation}{\void}
-Returns the orientation of the boxsizer, either of wxVERTICAL
+Returns the orientation of the box sizer, either wxVERTICAL
or wxHORIZONTAL.
\input conditn.tex
\input config.tex
\input control.tex
+\input countstr.tex
\input critsect.tex
\input crtslock.tex
\input custdobj.tex
--- /dev/null
+% -----------------------------------------------------------------------------
+% 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.
+
\section{\class{wxCustomDataObject}}\label{wxcustomdataobject}
-wxCustomDataObject is a specialization of
+wxCustomDataObject is a specialization of
\helpref{wxDataObjectSimple}{wxdataobjectsimple} for some
application-specific data in arbitrary (either custom or one of the standard
ones). The only restriction is that it is supposed that this data can be
it contain a C++ object (though C struct is fine).
By default, wxCustomDataObject stores the data inside in a buffer. To put the
-data into the buffer you may use either
-\helpref{SetData}{wxcustomdataobjectsetdata} or
+data into the buffer you may use either
+\helpref{SetData}{wxcustomdataobjectsetdata} or
\helpref{TakeData}{wxcustomdataobjecttakedata} depending on whether you want
the object to make a copy of data or not.
\wxheading{Virtual functions to override}
This class may be used as is, but if you don't want store the data inside the
-object but provide it on demand instead, you should override
-\helpref{GetSize}{wxcustomdataobjectgetsize},
-\helpref{GetData}{wxcustomdataobjectgetdata} and
+object but provide it on demand instead, you should override
+\helpref{GetSize}{wxcustomdataobjectgetsize},
+\helpref{GetData}{wxcustomdataobjectgetdata} and
\helpref{SetData}{wxcustomdataobjectsetdata} (or may be only the first two or
only the last one if you only allow reading/writing the data)
\func{}{wxCustomDataObject}{\param{const wxDataFormat\& }{format = wxFormatInvalid}}
The constructor accepts a {\it format} argument which specifies the (single)
-format supported by this object. If it isn't set here,
+format supported by this object. If it isn't set here,
\helpref{SetFormat}{wxdataobjectsimplesetformat} should be used.
\membersection{wxCustomDataObject::\destruct{wxCustomDataObject}}\label{wxcustomdataobjectdtor}
Every database object represents an ODBC connection.
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}
\helpref{wxObject}{wxobject}
\wxheading{Virtual functions to override}
-None, this class doesn't have any.
+None
\wxheading{Derived from}
};
\end{verbatim}
-which allows to distinguish between them. See
+which allows to distinguish between them. See
\helpref{wxDataFormat}{wxdataformat} documentation for more about formats.
Not surprizingly, being 'smart' comes at a price of added complexity. This is
text.
To provide a solution for both cases, wxWindows has two predefined classes
-which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and
-\helpref{wxDataObjectComposite}{wxdataobjectcomposite}.
+which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and
+\helpref{wxDataObjectComposite}{wxdataobjectcomposite}.
\helpref{wxDataObjectSimple}{wxdataobjectsimple} is
the simplest wxDataObject possible and only holds data in a single format (such
as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is
one as soon as you want to transfer data via the clipboard or drag and drop):
\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
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
won't be able to communicate with other programs, but data transfer will work
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
standard or custom if you combine it with the previous solution).}
-\twocolitem{{\bf 3. Use wxDataObject directly}}{This is the solution for
-maximal flexibility and efficiency, but it also is the most difficult to
+\twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for
+maximal flexibility and efficiency, but it is also is the most difficult to
implement.}
\end{twocollist}
available.
There are several predefined data object classes derived from
-wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject},
-\helpref{wxTextDataObject}{wxtextdataobject} and
+wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject} and
\helpref{wxBitmapDataObject}{wxbitmapdataobject} which can be used without
change.
-You may also derive your own data object classes from
+You may also derive your own data object classes from
\helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The
format of user-defined data is given as mime-type string literal, such as
"application/word" or "image/png". These strings are used as they are under
translation under Windows is not yet finished.
\pythonnote{At this time this class is not directly usable from wxPython.
-Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple}
+Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple}
instead.}
\wxheading{Virtual functions to override}
of its functions which are pure virtual in the base class.
The data objects which only render their data or only set it (i.e. work in
-only one direction), should return 0 from
+only one direction), should return 0 from
\helpref{GetFormatCount}{wxdataobjectgetformatcount}.
\wxheading{Derived from}
\wxheading{See also}
-\helpref{Clipboard and drag and drop overview}{wxdndoverview},
-\helpref{DnD sample}{samplednd},
-\helpref{wxFileDataObject}{wxfiledataobject},
-\helpref{wxTextDataObject}{wxtextdataobject},
-\helpref{wxBitmapDataObject}{wxbitmapdataobject},
-\helpref{wxCustomDataObject}{wxcustomdataobject},
-\helpref{wxDropTarget}{wxdroptarget},
-\helpref{wxDropSource}{wxdropsource},
-\helpref{wxTextDropTarget}{wxtextdroptarget},
+\helpref{Clipboard and drag and drop overview}{wxdndoverview},
+\helpref{DnD sample}{samplednd},
+\helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject},
+\helpref{wxBitmapDataObject}{wxbitmapdataobject},
+\helpref{wxCustomDataObject}{wxcustomdataobject},
+\helpref{wxDropTarget}{wxdroptarget},
+\helpref{wxDropSource}{wxdropsource},
+\helpref{wxTextDropTarget}{wxtextdroptarget},
\helpref{wxFileDropTarget}{wxfiledroptarget}
\latexignore{\rtfignore{\wxheading{Members}}}
\constfunc{virtual void}{GetAllFormats}{ \param{wxDataFormat *}{formats}, \param{Direction}{ dir = Get}}
-Copy all supported formats in the given direction to the array pointed to by
+Copy all supported formats in the given direction to the array pointed to by
{\it formats}. There is enough space for GetFormatCount(dir) formats in it.
\membersection{wxDataObject::GetDataHere}\label{wxdataobjectgetdatahere}
A class for manipulating dates.
-{\bf NOTE:} this class should be
-used with caution, since it is not fully tested. It will be replaced
-with a new wxDateTime class in the near future.
+{\bf NOTE:} this class is retained only for compatibility,
+and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxDate
+may be withdrawn in future versions of wxWindows.
\wxheading{Derived from}
All the following constants are defined inside wxDateTime class (i.e., to refer to
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}
enum TZ
\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
the current moment, year, month or number of days in it, or do some general
calendar-related actions.
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
For example:
+
\begin{verbatim}
wxFileInputStream input( "mytext.dat" );
wxDataInputStream store( input );
When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
of the bitmap (all bits set to 1), and the current text background colour to draw the background
-(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
+(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
\membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
\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
from) this class only supports one format, so the number of virtual functions
to be implemented is reduced.
\wxheading{Virtual functions to override}
-The objects supporting rendering the data must override
-\helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and
+The objects supporting rendering the data must override
+\helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and
\helpref{GetDataHere}{wxdataobjectsimplegetdatahere} while the objects which
may be set must override \helpref{SetData}{wxdataobjectsimplesetdata}. Of
course, the objects supporting both operations must override all threee
\wxheading{See also}
-\helpref{Clipboard and drag and drop overview}{wxdndoverview},
-\helpref{DnD sample}{samplednd},
-\helpref{wxFileDataObject}{wxfiledataobject},
-\helpref{wxTextDataObject}{wxtextdataobject},
+\helpref{Clipboard and drag and drop overview}{wxdndoverview},
+\helpref{DnD sample}{samplednd},
+\helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject},
\helpref{wxBitmapDataObject}{wxbitmapdataobject}
\latexignore{\rtfignore{\wxheading{Members}}}
\pythonnote{When implementing this method in wxPython, the data comes
as a single string parameter rather than the two shown here.}
-
\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
streaming your own data. LoadObject is called by the framework
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}
\func{virtual void}{Modify}{\param{bool}{ modify}}
\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
streaming your own data. SaveObject is called by the framework
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}
\func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
This class represents a source for a drag and drop operation.
-See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
+See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
for more information.
\wxheading{Derived from}
\index{wxDragResult}wxDragResult is defined as follows:
-{\small\begin{verbatim}
+begin{verbatim}
enum wxDragResult
{
wxDragError, // error prevented the d&d operation from completing
wxDragCancel // the operation was cancelled by user (not an error)
};
\end{verbatim}
-}
\wxheading{See also}
\index{wxDragResult}wxDragResult is defined as follows:
-{\small\begin{verbatim}
+\begin{verbatim}
enum wxDragResult
{
wxDragError, // error prevented the d&d operation from completing
wxDragCancel // the operation was cancelled by user (not an error)
};
\end{verbatim}
-}
\wxheading{See also}
\func{virtual void}{AddPendingEvent}{\param{wxEvent\& }{event}}
Adds an event to be processed later. The function will return immediately and the
-event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}
+event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}
method.
\wxheading{Parameters}
Construct a list expression. The list's nodes' data should
themselves be {\bf wxExpr}s.
-The current version of this library no longer uses the {\bf wxList}
-internally, so this constructor turns the list into its internal
+wxExpr no longer uses the {\bf wxList} internally,
+so this constructor turns the list into its internal
format (assuming a non-nested list) and then deletes the supplied
list.
wxExprDatabase database(myErrorHandler);
\end{verbatim}
-
\func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute},
\rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}}
\section{\class{wxFileDataObject}}\label{wxfiledataobject}
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
-names (absolutep aths always), but internally it uses the same format as
+for file names. The program works with it just as if it were a list of absolute file
+names, but internally it uses the same format as
Explorer and other compatible programs under Windows or GNOME/KDE filemanager
under Unix which makes it possible to receive files from them using this
class.
\helpref{wxDataObject}{wxdataobject},
\helpref{wxDataObjectSimple}{wxdataobjectsimple},
\helpref{wxTextDataObject}{wxtextdataobject},
-\helpref{wxBitmapDataObject}{wxbitmapdataobject}
+\helpref{wxBitmapDataObject}{wxbitmapdataobject},
\helpref{wxDataObject}{wxdataobject}
\latexignore{\rtfignore{\wxheading{Members}}}
wx/file.h defines the following constants:
-{\small
\begin{verbatim}
#define wxS_IRUSR 00400
#define wxS_IWUSR 00200
// 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)
\end{verbatim}
-}
These constants define the file access rights and are used with
\helpref{wxFile::Create}{wxfilecreate} and \helpref{wxFile::Open}{wxfileopen}.
The interface of this class is the same as that of wxInputStream. Only a constructor
differs and it is documented below.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
% -----------
% ctor & dtor
% -----------
The use of this class is exactly the same as of wxOutputStream. Only a constructor
differs and it is documented below.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
% -----------
% ctor & dtor
% -----------
To do this, you just have to call one of EnumerateXXX() functions - either
\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or
\helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the
-corresponding callback (
-\helpref{OnFacename}{wxFontEnumeratoronfacename} or
+corresponding callback (\helpref{OnFacename}{wxFontEnumeratoronfacename} or
\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.
\wxheading{Virtual functions to override}
In case everything else fails (i.e. there is no record in config file
and "interactive" is FALSE or user denied to choose any replacement),
-the class queries \helpref{wxEncodingConverter}{wxencodingconverter}
+the class queries \helpref{wxEncodingConverter}{wxencodingconverter}
for "equivalent" encodings (e.g. iso8859-2 and cp1250) and tries them.
\wxheading{Global variables}
\helpref{wxEncodingConverter}{wxencodingconverter},
\helpref{Writing non-English applications}{nonenglishoverview}
-
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper}
Default ctor.
-
\membersection{wxFontMapper::\destruct{wxFontMapper}}\label{wxfontmapperdtor}
\func{}{\destruct{wxFontMapper}}{\void}
Virtual dtor for a base class.
-
\membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding}
\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}}
is better suitable for general use -- it returns wxFontEncoding which
can consequently be passed to wxFont constructor.
-
\membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable}
\func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}}
Check whether given encoding is available in given face or not.
If no facename is given, find {\it any} font in this encoding.
-
\membersection{wxFontMapper::CharsetToEncoding}\label{wxfontmappercharsettoencoding}
\func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = TRUE}}
Returns the encoding for the given charset (in the form of RFC 2046) or
wxFONTENCODING\_SYSTEM if couldn't decode it.
-
\membersection{wxFontMapper::GetEncodingName}\label{wxfontmappergetencodingname}
\func{static wxString}{GetEncodingName}{\param{wxFontEncoding }{encoding}}
-Return internal string identifier for the encoding (see also
+Return internal string identifier for the encoding (see also
\helpref{GetEncodingDescription()}{wxfontmappergetencodingdescription})
-
\membersection{wxFontMapper::GetEncodingDescription}\label{wxfontmappergetencodingdescription}
\func{static wxString}{GetEncodingDescription}{\param{wxFontEncoding }{encoding}}
Return user-readable string describing the given encoding.
-
\membersection{wxFontMapper::SetDialogParent}\label{wxfontmappersetdialogparent}
\func{void}{SetDialogParent}{\param{wxWindow* }{parent}}
The parent window for modal dialogs.
-
\membersection{wxFontMapper::SetDialogTitle}\label{wxfontmappersetdialogtitle}
\func{void}{SetDialogTitle}{\param{const wxString\& }{title}}
The title for the dialogs (note that default is quite reasonable).
-
\membersection{wxFontMapper::SetConfig}\label{wxfontmappersetconfig}
\func{void}{SetConfig}{\param{wxConfigBase* }{config}}
\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).
\membersection{wxFrame::GetTitle}\label{wxframegettitle}
-\func{wxString\&}{GetTitle}{\void}
+\constfunc{wxString}{GetTitle}{\void}
-Gets a temporary pointer to the frame title. See
-\helpref{wxFrame::SetTitle}{wxframesettitle}.
+Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.
\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).
\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.
\membersection{wxFrame::Maximize}\label{wxframemaximize}
-\func{void}{Maximize}{\param{const bool }{maximize}}
+\func{void}{Maximize}{\param{bool }{maximize}}
Maximizes or restores the frame.
\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}
(stream, filename, mime type, anchor).
{\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
other words after 10 calls to GetStream() you'll obtain ten identical
pointers.
\wxheading{See Also}
\helpref{wxFileSystemHandler}{wxfilesystemhandler},
-\helpref{wxFileSystem}{wxfilesystem},
+\helpref{wxFileSystem}{wxfilesystem},
\helpref{Overview}{fs}
\latexignore{\rtfignore{\wxheading{Members}}}
\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.
\wxheading{Notes}
-It is never used by end user but you'll need it if
-you're writing own virtual FS. For example you may need something
-similar to wxMemoryInputStream but because wxMemoryInputStream
-doesn't free the memory when destroyed and thus passing memory stream
+It is seldom used by the application programmer but you'll need it if
+you are writing your own virtual FS. For example you may need something
+similar to wxMemoryInputStream, but because wxMemoryInputStream
+doesn't free the memory when destroyed and thus passing a memory stream
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}
class wxMyFSFile : public wxFSFile
archive/main.zip#zip:index.htm /* NO anchor here! */
\end{verbatim}
-Usually anchor is presented only if mime type is 'text/html'.
-But it may have some meaning with other files
-(for example myanim.avi\#200 may refer to position in animation
-or reality.wrl\#MyView may refer to predefined view in VRML)
+Usually an anchor is presented only if the MIME type is 'text/html'.
+But it may have some meaning with other files;
+for example myanim.avi\#200 may refer to position in animation
+or reality.wrl\#MyView may refer to a predefined view in VRML.
\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
\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
HTTP protocol Content-Type header.
Returns pointer to the stream. You can use the returned
stream to directly access data. You may suppose
that the stream provide Seek and GetSize functionality
-(even in case of HTTP protocol which doesn't provide
-this by default. wxHtml is using local cache to workaround
-this and to speed up connection)
+(even in the case of the HTTP protocol which doesn't provide
+this by default. wxHtml uses local cache to work around
+this and to speed up the connection).
\wxheading{Return value}
-TRUE, if the command has been sent successfully, else FALSE.
+TRUE if the command has been sent successfully, else FALSE.
% ----------------------------------------------------------------------------
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
-Creates a new input stream on the the specified path. You can use all but seek
-functionnality of wxStream. Seek isn't available on all stream. For example,
-http or ftp streams doesn't deal with it. Other functions like Tell
-aren't available for the moment for this sort of stream.
+Creates a new input stream on the the specified path. You can use all but the seek
+functionality of wxStream. Seek isn't available on all streams. For example,
+http or ftp streams do not deal with it. Other functions like Tell
+are not available for this sort of stream, at present.
You will be notified when the EOF is reached by an error.
\wxheading{Return value}
Returns NULL if an error occured (it could be a network failure or the fact
that the file doesn't exist).
-Returns the initialized stream. You will have to delete it yourself once you
-don't use it anymore. The destructor close the DATA stream connection but
-will leave the COMMAND stream connection opened. It means that you still
-can send new commands without reconnecting.
+Returns the initialized stream. You will have to delete it yourself when you
+don't need it anymore. The destructor closes the DATA stream connection but
+will leave the COMMAND stream connection opened. It means that you can still
+send new commands without reconnecting.
\wxheading{Example of a standalone connection (without wxURL)}
wxYES\_NO or wxOK.}
\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
\twocolitem{wxCENTRE}{Centres the text.}
-\twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
-\twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
-\twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
-\twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
+\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
+\twocolitem{wxICON\_HAND}{Displays a hand symbol.}
+\twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
+\twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
\end{twocollist}
The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
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}
\helpref{wxPanel}{wxpanel}\\
\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.
\func{void}{OnChangeSelectionLabel}{\void}
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
number are concatenated to form the selection label.
\item wxWinHelpController, for controlling Windows Help.
\item wxExtHelpController, for controlling external browsers under Unix.
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
-is reasonably close to the wxWindows help controller API; see {\tt wx/helpwxht.h} for
+\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. See {\tt wx/helpwxht.h} for
details of use.
\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
recommended that you use the specific API for this class instead.
\end{itemize}
\func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
-Initializes the help instance with a help filename, and optionally a server (socket)
-number if using wxHelp. Does not invoke the help viewer.
+Initializes the help instance with a help filename, and optionally a server socket
+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
any attempts to communicate with the viewer.
\func{virtual void}{Layout}{\param{int }{w}}
-This method performs 2 actions:
+This method performs two actions:
\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.)
\item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members)
based on actual width {\it w}
\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
that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
\func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
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}
\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}
Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants.
-{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
+{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
with same {\it ind} parameter in order to correctly interpret the returned integer value.
It is NOT always in pixels!
Sets the container's alignment (both horizontal and vertical) according to
the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
-it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
+it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.
\membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
\func{void}{SetAlignHor}{\param{int }{al}}
-Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
+Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
each line is aligned according to {\it al} value.
\wxheading{Parameters}
\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}
\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}
-\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}
\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,
-wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the
-empty place!}
+wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the
+empty place.}
\membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
\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
-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
application (see {\it test} sample). The help system is based on {\bf books}
This class stores all neccessary information about hypertext
links (as represented by {\tt <A>} tag in HTML documents). In
-current implementation it stores URL and target frame name.
+current implementation it stores URL and target frame name.
{\it Note that frames are not currently supported by wxHTML!}
\wxheading{Derived from}
<wx/html/htmlpars.h>
-
\wxheading{See also}
\helpref{Cells Overview}{cells},
file or downloaded via HTTP protocol) in a window. The width
of the window is constant - given in the constructor - and virtual height
is changed dynamically depending on page size.
-Once the window is created you can set its content by calling
+Once the window is created you can set its content by calling
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
% htmlwinparser.tex at 14/Mar/99 20:13:37
%
-
\section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
its mail goal is to parse HTML input so that it can be displayed in
-\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special
+\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses a special
\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
\wxheading{Notes}
-\begin{enumerate}
-\item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
-\end{enumerate}
+The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.
\wxheading{Derived from}
\helpref{wxHtmlParser}{wxhtmlparser}
-
\wxheading{Include files}
<wx/html/winpars.h>
\func{virtual wxFont*}{CreateCurrentFont}{\void}
-Creates font based on current setting (see
-\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
-\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
-\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
-\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
+Creates font based on current setting (see
+\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
+\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
+\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
+\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
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}
\constfunc{const wxColour\&}{GetActualColor}{\void}
-Returns actual text color.
+Returns actual text colour.
\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
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()}.
\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
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()}
\membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
Returns pointer to the DC used during parsing.
-
\membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
\constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
Returns \helpref{wxEncodingConverter}{wxencodingconverter} class used
-to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
+to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
\membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
Returns actual font face name.
-
\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
\constfunc{int}{GetFontFixed}{\void}
Returns TRUE if actual font is italic, FALSE otherwise.
-
\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
\constfunc{int}{GetFontSize}{\void}
Returns input encoding.
-
\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
\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
if the parser is between {\tt <A>} and {\tt </A>} tags,
wxEmptyString otherwise.)
-
\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
\constfunc{const wxColour\&}{GetLinkColor}{\void}
-Returns color of hypertext link text.
-
+Returns the colour of hypertext link text.
\membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
test if it is non-NULL. For example {\tt TITLE} handler sets window
title only if some window is associated, otherwise it does nothing)
-
\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
\func{wxHtmlContainerCell*}{OpenContainer}{\void}
Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
-
\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
-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.
\membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
\func{void}{SetAlign}{\param{int }{a}}
-Sets default horizontal alignment (see
+Sets default horizontal alignment (see
\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
Alignment of newly opened container is set to this value.
-
\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
Allows you to directly set opened container. This is not recommended - you should use OpenContainer
-whereever possible.
-
+wherever possible.
\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
-
\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
\func{void}{SetFontBold}{\param{int }{x}}
Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
-
\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
\func{void}{SetFontSize}{\param{int }{s}}
Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
-
\membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
\func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}}
tables from document's encoding to some encoding supported by operating
system.
-
\membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
-Sets color of hypertext link.
-
+Sets colour of hypertext link.
Creates a new icon.
+\func{}{wxIcon}{\param{char**}{ bits}}
+
\func{}{wxIcon}{\param{const char**}{ bits}}
Creates an icon from XPM data.
The following image handlers are available. {\bf wxBMPHandler} is always
installed by default. To use other image formats, install the appropiate
-handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
\twocolwidtha{5cm}%
Depending on how wxWindows has been configured, not all formats may be available.
-Note : any handler other than BMP must be previously
-initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+Note: any handler other than BMP must be previously
+initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
\wxheading{See also}
\wxheading{See also}
-\helpref{wxImageHandler}{wximagehandler}
+\helpref{wxImageHandler}{wximagehandler},
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\membersection{wxImage::InsertHandler}
\wxheading{See also}
-\helpref{wxImage}{wximage}
+\helpref{wxImage}{wximage},
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\latexignore{\rtfignore{\wxheading{Members}}}
\wxheading{See also}
-\helpref{wxImage::LoadFile}{wximageloadfile}\\
-\helpref{wxImage::SaveFile}{wximagesavefile}\\
+\helpref{wxImage::LoadFile}{wximageloadfile},
+\helpref{wxImage::SaveFile}{wximagesavefile},
\helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
\membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
\wxheading{See also}
-\helpref{wxImage::LoadFile}{wximageloadfile}\\
-\helpref{wxImage::SaveFile}{wximagesavefile}\\
+\helpref{wxImage::LoadFile}{wximageloadfile},
+\helpref{wxImage::SaveFile}{wximagesavefile},
\helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
\membersection{wxImageHandler::SetName}
<wx/stream.h>
+\latexignore{\rtfignore{\wxheading{Members}}}
+
% -----------
% ctor & dtor
% -----------
{\bf NB:} This function does {\it not} send the
{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
-from the control would be too slow then (unlike
- \helpref{DeleteItem}{wxlistctrldeleteitem})
+from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
no such item found.
This function may be used to find all selected items in the control like this:
+
\begin{verbatim}
long item = -1;
for ( ;; )
\end{twocollist}
\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.}
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
mask had been added before to the list of allowed ones.
For example,
+
\begin{verbatim}
// wxTraceOleCalls is one of standard bit masks
wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef);
\end{verbatim}
will do something only if the current trace mask contains both
{\tt wxTraceRefCount} and {\tt wxTraceOle}, but
+
\begin{verbatim}
// wxTRACE_OleCalls is one of standard string masks
wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
\end{verbatim}
+
will log the message if it was preceded by
+
\begin{verbatim}
wxLog::AddTraceMask(wxTRACE_OleCalls);
\end{verbatim}
Any special menu codes are stripped out of source and target strings
before matching.
-\pythonnote{The name of this method in wxPython is {\tt FindItemById}
+\pythonnote{The name of this method in wxPython is {\tt FindItemById}
and it does not support the second parameter.}
\membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
\func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
Inserts the menu at the given position into the menu bar. Inserting menu at
-position $0$ will insert it in the very beginning of it, inserting at position
-\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
+position $0$ will insert it in the very beginning of it, inserting at position
+\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
\helpref{Append()}{wxmenubarappend}.
\wxheading{Parameters}
\func{wxMenu *}{Remove}{\param{size\_t }{pos}}
Removes the menu from the menu bar and returns the menu object - the caller is
-reposnbile for deleting it. This function may be used together with
+reposnbile for deleting it. This function may be used together with
\helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar
dynamically.
\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{See also}
-\helpref{GetText}{wxmenuitemgettext},
+\helpref{GetText}{wxmenuitemgettext},
\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
\membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext}
\wxheading{See also}
-\helpref{GetText}{wxmenuitemgettext},
+\helpref{GetText}{wxmenuitemgettext},
\helpref{GetLabel}{wxmenuitemgetlabel}
\membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth}
\wxheading{See also}
-\helpref{GetLabel}{wxmenuitemgetlabel},
+\helpref{GetLabel}{wxmenuitemgetlabel},
\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
\membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu}
Sets the text colour associated with the menu item (Windows only).
-
-
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "referenc"
-%%% End:
\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.
\wxheading{See also}
-\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition},
+\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition},
\helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection}
\latexignore{\rtfignore{\wxheading{Members}}}
In order to query the size of notebook page, this page needs to have its
own sizer, otherwise the wxNotebookSizer will ignore it. Notebook pages
-get there sizer by assiging one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer}
+get there sizer by assiging one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer}
and setting the auto-layout option to TRUE using
\helpref{wxWindow::SetAutolayout}{wxwindowsetautoLayout}. Here is one
example showing how to add a notebook page that the notebook sizer is
<wx/stream.h>
+\latexignore{\rtfignore{\wxheading{Members}}}
+
% -----------
% ctor & dtor
% -----------
in the current stream. The data is read until an error is raised
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.
-
\func{void}{SetOffsetY}{\param{int }{offsetY}}
When displaying several curves in one window, it is often useful to assign
-different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove}
+different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove}
to set this value after you have added the curve to the window.
\membersection{wxPlotCurve::SetStartY}\label{wxplotcurvesetstarty}
that this window is not useful for real-time measuring or for displaying charts
with error bars etc.
-A single curve in the plot window is represented by the \helpref{wxPlotCurve}{wxplotcurve}
+A single curve in the plot window is represented by the \helpref{wxPlotCurve}{wxplotcurve}
class.
The wxPlotWindow interacts with program using events, for example when clicking
\wxheading{See also}
-\helpref{wxPrintDialog}{wxprintdialog},
-\helpref{wxPageSetupDialog}{wxpagesetupdialog},
-\helpref{wxPrintDialogData}{wxprintdialogdata},
-\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata},
-\helpref{wxPrintDialog Overview}{wxprintdialogoverview},
-\helpref{wxPrinterDC}{wxprinterdc},
+\helpref{wxPrintDialog}{wxprintdialog},
+\helpref{wxPageSetupDialog}{wxpagesetupdialog},
+\helpref{wxPrintDialogData}{wxprintdialogdata},
+\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata},
+\helpref{wxPrintDialog Overview}{wxprintdialogoverview},
+\helpref{wxPrinterDC}{wxprinterdc},
\helpref{wxPostScriptDC}{wxpostscriptdc}
\wxheading{Remarks}
\section{\class{wxPrintPreview}}\label{wxprintpreview}
-\overview{Printing framework overview}{printingoverview}
-
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 wxPreviewFrame object. Previewing is started by initializing and showing
\twocolwidtha{7cm}
\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
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
reached. This flag prevents it from doing it - instead the dialog will wait
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
\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{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{wxGA\_SMOOTH}{This flag tells the dialog that it should use
+\twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
+\twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
+\twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
+\twocolitem{{\bf wxPD\_SMOOTH}}{This flag tells the dialog that it should use
smooth gauge (has effect only under 32bit Windows).}
\end{twocollist}%
}
\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}
\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}
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.
+\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxProperty::wxProperty}
\section{\class{wxFilenameListValidator}}\label{wxfilenamelistvalidator}
-\overview{Validator classes}{proplistvalidatorclasses}
-
-This class validates a filename for a list view, allowing the user to edit it textually and also popping up
+This class validates a filename for a \helpref{property list view}{wxpropertylistview}, allowing the user to edit it textually and also popping up
a file selector in ``detailed editing" mode.
+\wxheading{See also}
+
+\helpref{Validator classes}{proplistvalidatorclasses}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxFilenameListValidator::wxFilenameListValidator}
\func{void}{wxFilenameListValidator}{\param{wxString }{message = ``Select a file"}, \param{wxString }{wildcard = ``*.*"},
will pass OnClose and OnDefaultAction listbox messages to the view class for
processing.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyFormDialog::wxPropertyFormDialog}
\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"}}
Constructor.
Destructor.
-
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.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyFormFrame::wxPropertyFormFrame}
\func{void}{wxPropertyFormFrame}{\param{wxPropertyFormView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
\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.
Creates a panel. Override this to create a panel type other than wxPropertyFormPanel.
-
will pass OnDefaultAction listbox messages to the view class for
processing.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyFormPanel::wxPropertyFormPanel}
\func{void}{wxPropertyFormPanel}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent},
Destructor.
-
-
\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 programmer can create custom behaviour for kinds of property.
+\wxheading{See also}
+
+\helpref{wxPropertyFormValidator overview}{wxpropertyformvalidatoroverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyFormValidator::wxPropertyFormValidator}
\func{void}{wxPropertyFormValidator}{\param{long}{ flags = 0}}
\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}}
Called when the control corresponding to the property receives a command (if not intercepted
\membersection{wxPropertyFormValidator::OnCheckValue}
-\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
+\func{bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the view checks the property value. The value checked by this validator should be taken from the
\membersection{wxPropertyFormValidator::OnDisplayValue}
-\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
+\func{bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}}
Should display the property value in the appropriate control.
\membersection{wxPropertyFormValidator::OnDoubleClick}
-\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
+\func{bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the control corresponding to the property is double clicked (listboxes only).
\membersection{wxPropertyFormValidator::OnRetrieveValue}
-\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
+\func{bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
\param{wxWindow *}{parentWindow}}
Should do the transfer from the property editing area to the property itself.
-
\section{\class{wxPropertyFormView}}\label{wxpropertyformview}
-\overview{wxPropertyFormView overview}{wxpropertyformviewoverview}
-
The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
box which has already been created.
+\wxheading{See also}
+
+\helpref{wxPropertyFormView overview}{wxpropertyformviewoverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyFormView::wxPropertyFormView}
\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}
\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.
\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}
-\func{Bool}{TransferToDialog}{\void}
+\func{bool}{TransferToDialog}{\void}
Transfers property values to the controls in the dialog.
\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.
-
\section{\class{wxIntegerFormValidator}}\label{wxintegerformvalidator}
-\overview{Validator classes}{proplistvalidatorclasses}
-
-This class validates a range of integer values for a form view. The associated panel item must be a wxText
+This class validates a range of integer values for a form view. The associated control must be a wxTextCtrl
or wxSlider.
+\wxheading{See also}
+
+\helpref{Validator classes}{proplistvalidatorclasses}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxIntegerFormValidator::wxIntegerFormValidator}
\func{void}{wxIntegerFormValidator}{\param{long }{min=0}, \param{long }{max=0},
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
-
\section{\class{wxIntegerListValidator}}\label{wxintegerlistvalidator}
+This class validates a range of integer values for a list view.
+
+\wxheading{See also}
+
\overview{Validator classes}{proplistvalidatorclasses}
-This class validates a range of integer values for a list view.
+\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxIntegerListValidator::wxIntegerListValidator}
will pass OnClose and OnDefaultAction listbox messages to the view class for
processing.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyListDialog::wxPropertyListDialog}
\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"}}
Constructor.
Destructor.
-
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.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyListFrame::wxPropertyListFrame}
\func{void}{wxPropertyListFrame}{\param{wxPropertyListView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
\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.
Creates a panel. Override this to create a panel type other than wxPropertyListPanel.
-
will pass OnDefaultAction listbox messages to the view class for
processing.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyListPanel::wxPropertyListPanel}
\func{void}{wxPropertyListPanel}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent},
Destructor.
-
-
-
\item propform.h: wxPropertyListView and associated classes
\end{itemize}
-
-
-
-
-
-
-
-
\section{Topic overviews}\label{proplistoverviews}
This chapter contains a selection of topic overviews.
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.
-
-
\section{Classes by category}\label{proplistclassesbycat}
A classification of property sheet classes by category.
\item \helpref{wxPropertySheet}{wxpropertysheet}
\end{itemize}
-
\subsection{Validator classes}\label{proplistvalidatorclasses}
Validators check that the values the user has entered for a property are
\section{\class{wxPropertyListValidator}}\label{wxpropertylistvalidator}
-\overview{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview}
-
The {\bf wxPropertyListValidator} abstract class is the base class for
deriving validators for property lists.
+\wxheading{See also}
+
+\helpref{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyListValidator::wxPropertyListValidator}
\func{void}{wxPropertyListValidator}{\param{long}{ flags = wxPROP\_ALLOW\_TEXT\_EDITING}}
\membersection{wxPropertyListValidator::OnCheckValue}
-\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value
\membersection{wxPropertyListValidator::OnClearControls}
-\func{Bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property.
\membersection{wxPropertyListValidator::OnClearDetailControls}
-\func{Bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the focus is lost, if the validator is in detailed editing mode.
\membersection{wxPropertyListValidator::OnDisplayValue}
-\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Should display the value in the appropriate controls. The default implementation gets the
\membersection{wxPropertyListValidator::OnDoubleClick}
-\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the property is double clicked. Extra functionality can be provided,
\membersection{wxPropertyListValidator::OnEdit}
-\func{Bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the Edit (detailed editing) button is pressed. The default implementation
\membersection{wxPropertyListValidator::OnPrepareControls}
-\func{Bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called to allow the validator to setup the display, such enabling or disabling buttons, and
\membersection{wxPropertyListValidator::OnPrepareDetailControls}
-\func{Bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the property is edited `in detail', i.e. when the Edit button is pressed.
\membersection{wxPropertyListValidator::OnRetrieveValue}
-\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when Tick (Confirm) is pressed or focus is lost or view wants to update
\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}}
Called when the property is selected or deselected: typically displays the value
\membersection{wxPropertyListValidator::OnValueListSelect}
-\func{Bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
+\func{bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
\param{wxWindow *}{parentWindow}}
Called when the value listbox is selected. The default behaviour is to copy
string to text control, and retrieve the value into the property.
-
-
\section{\class{wxListOfStringsListValidator}}\label{wxlistofstringslistvalidator}
-\overview{Validator classes}{proplistvalidatorclasses}
-
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.
At present no constraints may be supplied.
sheet->AddProperty(new wxProperty("fred", strings, "stringlist"));
\end{verbatim}
+\wxheading{See also}
+
+\helpref{Validator classes}{proplistvalidatorclasses}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxListOfStringsListValidator::wxListofStringsListValidator}
\func{void}{wxListOfStringsListValidator}{\param{long}{ flags=0}}
\section{\class{wxPropertyListView}}\label{wxpropertylistview}
-\overview{wxPropertyListView overview}{wxpropertylistviewoverview}
-
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}
\func{void}{wxPropertyListView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
\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
wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty.
\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
gets called by wxPropertyListView::BeginShowingProperty, which is in turn called
\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
wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in
\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.
\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.
-
indexed by the `role name' of the property, by which groups of property
can be identified for the purpose of validation and editing.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}
\func{void}{wxPropertyValidatorRegistry}{\void}
\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.
+\wxheading{See also}
+
+\helpref{Validator classes}{proplistvalidatorclasses}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxRealFormValidator::wxRealFormValidator}
\func{void}{wxRealFormValidator}{\param{float }{min=0.0}, \param{float }{max=0.0},
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
-
\section{\class{wxRealListValidator}}\label{wxreallistvalidator}
-\overview{Validator classes}{proplistvalidatorclasses}
-
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},
\param{long}{ flags=wxPROP\_ALLOW\_TEXT\_EDITING}}
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
-
\section{\class{wxPropertySheet}}\label{wxpropertysheet}
-\overview{wxPropertySheet overview}{wxpropertysheetoverview}
-
The {\bf wxPropertySheet} class is used for storing a number of
wxProperty objects (essentially names and values).
+\wxheading{See also}
+
+\helpref{wxPropertySheet overview}{wxpropertysheetoverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertySheet::wxPropertySheet}
\func{void}{wxPropertySheet}{\param{const wxString}{ name = ""}}
\membersection{wxPropertySheet::SetAllModified}
-\func{void}{SetAllModified}{\param{Bool}{ flag}}
+\func{void}{SetAllModified}{\param{bool}{ flag}}
Sets the `modified' flag of each property value.
-
-
\section{\class{wxStringListValidator}}\label{wxstringlistvalidator}
-\overview{Validator classes}{proplistvalidatorclasses}
-
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}
\func{void}{wxStringListValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}
\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.
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
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}
\func{void}{wxStringFormValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}
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.
-
\item wxPropertyValueStringPtr
\end{itemize}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyValue::wxPropertyValue}
\func{void}{wxPropertyValue}{\void}
\func{void}{wxPropertyValue}{\param{long}{ val}}
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 an integer pointer.
-\func{void}{wxPropertyValue}{\param{Bool *}{val}}
+\func{void}{wxPropertyValue}{\param{bool *}{val}}
Construction from an boolean pointer.
\membersection{wxPropertyValue::BoolValue}
-\func{Bool}{BoolValue}{\void}
+\func{bool}{BoolValue}{\void}
Returns the boolean value.
\membersection{wxPropertyValue::BoolValuePtr}
-\func{Bool *}{BoolValuePtr}{\void}
+\func{bool *}{BoolValuePtr}{\void}
Returns the pointer to the boolean value.
\membersection{wxPropertyValue::GetModified}
-\func{Bool}{GetModified}{\void}
+\func{bool}{GetModified}{\void}
Returns TRUE if the value was modified since being created
(or since SetModified was called).
\membersection{wxPropertyValue::SetModified}
-\func{void}{SetModified}{\param{Bool}{ flag}}
+\func{void}{SetModified}{\param{bool}{ flag}}
Sets the `modified' flag.
\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 long *}{val}}
-\func{void}{operator $=$}{\param{const Bool *}{val}}
+\func{void}{operator $=$}{\param{const bool *}{val}}
\func{void}{operator $=$}{\param{const float *}{val}}
Assignment operators.
-
-
\section{\class{wxPropertyValidator}}\label{wxpropertyvalidator}
-\overview{wxPropertyValidator overview}{wxpropertyvalidatoroverview}
-
The {\bf wxPropertyValidator} abstract class is the base class for deriving
validators for properties.
+\wxheading{See also}
+
+\helpref{wxPropertyValidator overview}{wxpropertyvalidatoroverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyValidator::wxPropertyValidator}
\func{void}{wxPropertyValidator}{\param{long}{ flags = 0}}
Sets the property for the validator.
-
\section{\class{wxPropertyView}}\label{wxpropertyview}
-\overview{wxPropertyView overview}{wxpropertyviewoverview}
-
The {\bf wxPropertyView} abstract class is the base class for views
of property sheets, acting as intermediaries between properties and
actual windows.
+\wxheading{See also}
+
+\helpref{wxPropertyView overview}{wxpropertyviewoverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxPropertyView::wxPropertyView}
\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
\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.
\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
FALSE.
% Members
% ----------------------------------------------------------------------------
-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
at a time by using multiple wxRecordSets with a wxDatabase or you can make
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}
\helpref{wxObject}{wxobject}
You might use this pair of functions when implementing a drag feature, for example
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}
\func{bool}{EndDrawingOnTop}{\void}
\section{\class{wxSizer}}\label{wxsizer}
wxSizer is the abstract base class used for laying out subwindows in a window. You
-cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer},
+cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer},
\helpref{wxStaticBoxSizer}{wxstaticboxsizer} or \helpref{wxNotebookSizer}{wxnotebooksizer}.
The layout algorithm used by sizers in wxWindows is closely related to layout
\func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
Call this to force the sizer to take the given dimension and thus force the items owned
-by the sizer to resize themselves according to the rules defined by the paramater in the
+by the sizer to resize themselves according to the rules defined by the paramater in the
\helpref{wxSizer::Add}{wxsizeradd} and \helpref{wxSizer::Prepend}{wxsizerprepend} methods.
\membersection{wxSizer::GetSize}\label{wxsizergetsize}
available for reading. This will be the case if the input queue was
empty and new data arrives, or if the application has read some data
yet there is still more data available. This means that the application
-does not need to read all available data in response to a
+does not need to read all available data in response to a
{\bf wxSOCKET\_INPUT} event, as more events will be produced as
necessary.
events will be generated only after an output operation fails
with {\bf wxSOCKET\_WOULDBLOCK} and buffer space becomes available
again. This means that the application should assume that it
-can write data to the socket until an {\bf wxSOCKET\_WOULDBLOCK}
+can write data to the socket until an {\bf wxSOCKET\_WOULDBLOCK}
error occurs; after this, whenever the socket becomes writable
-again the application will be notified with another
+again the application will be notified with another
{\bf wxSOCKET\_OUTPUT} event.
The {\bf wxSOCKET\_CONNECTION} event is issued when a delayed connection
\helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxSocketClient}{wxsocketclient},
-\helpref{wxSocketServer}{wxsocketserver},
+\helpref{wxSocketServer}{wxsocketserver},
\helpref{Sockets sample}{samplesockets}
% ---------------------------------------------------------------------------
\func{}{wxSocketBase}{\void}
-Default constructor. Don't use it directly; instead, use
-\helpref{wxSocketClient}{wxsocketclient} to construct a socket client, or
+Default constructor. Don't use it directly; instead, use
+\helpref{wxSocketClient}{wxsocketclient} to construct a socket client, or
\helpref{wxSocketServer}{wxsocketserver} to construct a socket server.
\membersection{wxSocketBase::\destruct{wxSocketBase}}\label{wxsocketbasedestruct}
You can setup a callback function to be called when an event occurs.
The function will be called only for those events for which notification
-has been enabled with \helpref{Notify}{wxsocketbasenotify} and
+has been enabled with \helpref{Notify}{wxsocketbasenotify} and
\helpref{SetNotify}{wxsocketbasesetnotify}. The prototype of the
callback must be as follows:
\constfunc{void *}{GetClientData}{\void}
-Returns a pointer of the client data for this socket, as set with
+Returns a pointer of the client data for this socket, as set with
\helpref{SetClientData}{wxsocketbasesetclientdata}
%
when you \helpref{Close}{wxsocketbaseclose} a socket (and thus also upon
socket destruction), so you don't need to use it in these cases.
-\helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait},
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
+\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
%
This function saves the current state of the socket in a stack. Socket
state includes flags, as set with \helpref{SetFlags}{wxsocketbasesetflags},
-event mask, as set with \helpref{SetNotify}{wxsocketbasesetnotify} and
-\helpref{Notify}{wxsocketbasenotify}, user data, as set with
+event mask, as set with \helpref{SetNotify}{wxsocketbasesetnotify} and
+\helpref{Notify}{wxsocketbasenotify}, user data, as set with
\helpref{SetClientData}{wxsocketbasesetclientdata}, and asynchronous
-callback settings, as set with \helpref{Callback}{wxsocketbasecallback}
+callback settings, as set with \helpref{Callback}{wxsocketbasecallback}
and \helpref{CallbackData}{wxsocketbasecallbackdata}.
Calls to SaveState and RestoreState can be nested.
Sets user-supplied client data for this socket. All socket events will
contain a pointer to this data, which can be retrieved with the
-\helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata}
+\helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata}
function.
%
Sets an event handler to be called when a socket event occurs. The
handler will be called for those events for which notification is
-enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
+enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
\helpref{Notify}{wxsocketbasenotify}.
\wxheading{Parameters}
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketEvent}{wxsocketevent},
-\helpref{wxEvtHandler}{wxevthandler},
+\helpref{wxEvtHandler}{wxevthandler}
%
% SetFlags
\func{void}{SetTimeout}{\param{int }{seconds}}
This function sets the default socket timeout in seconds. This timeout
-applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait}
+applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait}
family of functions if you don't specify a wait interval. Initially, the
default is set to 10 minutes.
\func{wxSocketBase\&}{ReadMsg}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
-This function reads a buffer sent by \helpref{WriteMsg}{wxsocketbasewritemsg}
+This function reads a buffer sent by \helpref{WriteMsg}{wxsocketbasewritemsg}
on a socket. If the buffer passed to the function isn't big enough, the
remaining bytes will be discarded. This function always waits for the
buffer to be entirely filled, unless an error occurs.
\wxheading{See also}
-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
-\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
+\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
%
\wxheading{See also}
-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
\wxheading{See also}
-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
\func{wxSocketBase\&}{WriteMsg}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function writes a buffer of {\it nbytes} bytes from the socket, but it
-writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg}
-knows how much data should it actually read. So, a buffer sent with WriteMsg
+writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg}
+knows how much data should it actually read. So, a buffer sent with WriteMsg
{\bf must} be read with ReadMsg. This function always waits for the entire
buffer to be sent, unless an error occurs.
<wx/socket.h>
+\latexignore{\rtfignore{\wxheading{Members}}}
+
% ---------------------------------------------------------------------------
% Members
% ---------------------------------------------------------------------------
If {\it wait} was FALSE, and Connect returns FALSE, you should still
be prepared to handle the completion of this connection request, either
-with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by watching
+with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by watching
{\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.
\wxheading{See also}
WaitOnConnect returns TRUE if the connection request completes. This
does not necessarily mean that the connection was succesfully established;
-it might also happen that the connection was refused by the peer. Use
+it might also happen that the connection was refused by the peer. Use
\helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between
these two situations.
\wxheading{See also}
-\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
% ---------------------------------------------------------------------------
\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketFlags}{ flags = wxSOCKET_NONE}}
Constructs a new server and tries to bind to the specified {\it address}.
-Before trying to accept new connections, test whether it succeeded with
+Before trying to accept new connections, test whether it succeeded with
\helpref{wxSocketBase::Ok}{wxsocketbaseok}.
\wxheading{Parameters}
\func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}}
-Accepts an incoming connection request, and creates a new
+Accepts an incoming connection request, and creates a new
\helpref{wxSocketBase}{wxsocketbase} object which represents
the server-side of the connection.
If {\it wait} is FALSE, it will try to accept a pending connection
if there is one, but it will always return immediately without blocking
the GUI. If you want to use Accept in this way, you can either check for
-incoming connections with \helpref{WaitForAccept}{wxsocketserverwaitforaccept}
+incoming connections with \helpref{WaitForAccept}{wxsocketserverwaitforaccept}
or catch {\bf wxSOCKET\_CONNECTION} events, then call Accept once you know
that there is an incoming connection waiting to be accepted.
\func{bool}{WaitForAccept}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
-This function waits for an incoming connection. Use it if you want to call
-\helpref{Accept}{wxsocketserveraccept} or \helpref{AcceptWith}{wxsocketserveracceptwith}
+This function waits for an incoming connection. Use it if you want to call
+\helpref{Accept}{wxsocketserveraccept} or \helpref{AcceptWith}{wxsocketserveracceptwith}
with {\it wait} set to FALSE, to detect when an incoming connection is waiting
to be accepted.
\wxheading{See also}
-\docparam{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
+\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap}
and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read,
wxStreamBuffer::write, wxStreamBuffer::read\_write.
-
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
can call directly wxStreamBuffer::Read without any problems. Note that
\constfunc{wxStreamError}{LastError}{\void}
This function returns the last error.
+
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occured.}
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
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
the \helpref{wxFFile}{wxffile} class.
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
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
the \helpref{wxFFile}{wxffile} class.
\section{\class{wxFFileInputStream}}\label{wxffileinputstream}
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
the \helpref{wxFile}{wxfile} class.
\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
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
the \helpref{wxFile}{wxfile} class.
\subsection{wxDatabase overview}\label{wxdatabaseoverview}
-\overview{Database classes overview}{odbcoverview}
-
Class: \helpref{wxDatabase}{wxdatabase}
Every database object represents an ODBC connection. To do anything useful
can do with wxDatabase is opening/closing connections and getting some info
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}
the real data is stored. The links to user-defined variables are stored
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}
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.
-\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}
at a time by using multiple wxRecordSets with a wxDatabase or you can make
your queries in sequential order using the same wxRecordSet.
-\subsection{ODBC SQL data types}\label{sqltypes}
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
-\overview{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
types, not currently supported in wxWindows.
\twocolitem{SQL\_DOUBLE}{Same as SQL\_FLOAT.}
\end{twocollist}
-\subsection{A selection of SQL commands}\label{sqlcommands}
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
-\overview{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
examples.
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
+
\subsubsection{Create}
Creates a table.
This example sets a field in column `X' to the number 123, for the record
where the column ASSET has the value `BD34'.
-
-
Representation of time and date.
-NOTE: this class should be
-used with caution, since it is not fully tested. It will be replaced
-with a new wxDateTime class in the near future.
+{\bf NOTE:} this class is retained only for compatibility,
+and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxTime
+may be withdrawn in future versions of wxWindows.
\wxheading{Derived from}
typedef unsigned long clockTy;
enum tFormat { wx12h, wx24h };
enum tPrecision { wxStdMinSec, wxStdMin };
-\end{verbatim}}
+\end{verbatim}
+}
\wxheading{See also}
\wxheading{Remarks}
+
+
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:
projects / wxWidgets.git / commitdiff
