From fa482912e420a40e9f2e55a0f5407562826dd15e Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Wed, 15 Mar 2000 00:21:49 +0000 Subject: [PATCH] Some doc proofreading git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 8 ++-- docs/latex/wx/array.tex | 1 + docs/latex/wx/arrstrng.tex | 12 +++--- docs/latex/wx/bmpdatob.tex | 18 ++++----- docs/latex/wx/body.tex | 45 +++++++++++---------- docs/latex/wx/boxsizer.tex | 8 ++-- docs/latex/wx/classes.tex | 1 + docs/latex/wx/countstr.tex | 46 +++++++++++++++++++++ docs/latex/wx/custdobj.tex | 14 +++---- docs/latex/wx/database.tex | 3 ++ docs/latex/wx/dataform.tex | 2 +- docs/latex/wx/dataobj.tex | 46 ++++++++++----------- docs/latex/wx/date.tex | 6 +-- docs/latex/wx/datetime.tex | 5 +-- docs/latex/wx/datstrm.tex | 1 + docs/latex/wx/dc.tex | 2 +- docs/latex/wx/dobjsmpl.tex | 15 ++++--- docs/latex/wx/document.tex | 10 +++++ docs/latex/wx/dropsrc.tex | 5 +-- docs/latex/wx/droptrgt.tex | 3 +- docs/latex/wx/evthand.tex | 2 +- docs/latex/wx/expr.tex | 5 +-- docs/latex/wx/fildatob.tex | 6 +-- docs/latex/wx/file.tex | 2 - docs/latex/wx/fltinstr.tex | 2 + docs/latex/wx/fltoutst.tex | 2 + docs/latex/wx/fontenum.tex | 5 +-- docs/latex/wx/fontmap.tex | 14 +------ docs/latex/wx/frame.tex | 15 ++++--- docs/latex/wx/fsfile.tex | 32 +++++++-------- docs/latex/wx/ftp.tex | 18 ++++----- docs/latex/wx/function.tex | 8 ++-- docs/latex/wx/grid.tex | 8 +++- docs/latex/wx/helpinst.tex | 9 ++--- docs/latex/wx/htcell.tex | 8 ++-- docs/latex/wx/htcolor.tex | 2 +- docs/latex/wx/htcontnr.tex | 18 ++++----- docs/latex/wx/hthelpct.tex | 4 +- docs/latex/wx/htlnkinf.tex | 2 +- docs/latex/wx/htparser.tex | 1 - docs/latex/wx/htwindow.tex | 2 +- docs/latex/wx/htwinprs.tex | 55 +++++++++---------------- docs/latex/wx/icon.tex | 2 + docs/latex/wx/image.tex | 18 ++++----- docs/latex/wx/inputstr.tex | 2 + docs/latex/wx/listctrl.tex | 6 +-- docs/latex/wx/log.tex | 4 ++ docs/latex/wx/menu.tex | 10 ++--- docs/latex/wx/menuitem.tex | 12 ++---- docs/latex/wx/mouseevt.tex | 4 +- docs/latex/wx/mutex.tex | 2 +- docs/latex/wx/nbsizer.tex | 2 +- docs/latex/wx/outptstr.tex | 46 +-------------------- docs/latex/wx/plotcurve.tex | 2 +- docs/latex/wx/plotwindow.tex | 2 +- docs/latex/wx/print.tex | 14 +++---- docs/latex/wx/progdlg.tex | 14 +++---- docs/latex/wx/propbfva.tex | 9 ++++- docs/latex/wx/propblva.tex | 8 +++- docs/latex/wx/property.tex | 1 + docs/latex/wx/propflva.tex | 10 +++-- docs/latex/wx/propford.tex | 5 ++- docs/latex/wx/propforf.tex | 5 ++- docs/latex/wx/propforp.tex | 4 +- docs/latex/wx/propforv.tex | 19 +++++---- docs/latex/wx/propfovi.tex | 15 ++++--- docs/latex/wx/propifva.tex | 11 +++-- docs/latex/wx/propilva.tex | 6 ++- docs/latex/wx/proplisd.tex | 5 ++- docs/latex/wx/proplisf.tex | 5 ++- docs/latex/wx/proplisp.tex | 5 +-- docs/latex/wx/proplist.tex | 11 ----- docs/latex/wx/propliva.tex | 32 ++++++++------- docs/latex/wx/proplosv.tex | 8 +++- docs/latex/wx/proplstv.tex | 19 +++++---- docs/latex/wx/propregv.tex | 2 + docs/latex/wx/proprfva.tex | 9 +++-- docs/latex/wx/proprlva.tex | 13 ++++-- docs/latex/wx/propsht.tex | 12 +++--- docs/latex/wx/propslv.tex | 8 +++- docs/latex/wx/propstfv.tex | 11 +++-- docs/latex/wx/propval.tex | 22 +++++----- docs/latex/wx/propvald.tex | 9 +++-- docs/latex/wx/propview.tex | 12 ++++-- docs/latex/wx/protocol.tex | 2 +- docs/latex/wx/recrdset.tex | 3 ++ docs/latex/wx/screendc.tex | 7 ++++ docs/latex/wx/sizer.tex | 4 +- docs/latex/wx/socket.tex | 78 ++++++++++++++++++------------------ docs/latex/wx/statbmp.tex | 2 +- docs/latex/wx/stream.tex | 1 - docs/latex/wx/strmbase.tex | 1 + docs/latex/wx/strmfile.tex | 8 ++-- docs/latex/wx/tdb.tex | 38 +++++++++++------- docs/latex/wx/time.tex | 9 +++-- docs/latex/wx/window.tex | 5 ++- 96 files changed, 559 insertions(+), 486 deletions(-) create mode 100644 docs/latex/wx/countstr.tex diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index e894a39d17..b5e7d31340 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -246,7 +246,7 @@ wxWindows' strategy for OnIdle processing is as follows. After pending user inte application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself 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. @@ -476,7 +476,9 @@ can be overridden by the user to change the default icons. \wxheading{Parameters} -\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.} +\docparam{which}{One of the wxICON\_XXX specifies which icon to return.} + +See \helpref{wxMessageBox}{wxmessagebox} for a list of icon identifiers. \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual} @@ -487,7 +489,7 @@ on systems that support several visual on the same display. This is typically th 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. diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex index 8a84b9ad45..c5aca501c3 100644 --- a/docs/latex/wx/array.tex +++ b/docs/latex/wx/array.tex @@ -261,6 +261,7 @@ WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass); 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) { diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 9750e4e7ad..dc15f1dd0f 100644 --- a/docs/latex/wx/arrstrng.tex +++ b/docs/latex/wx/arrstrng.tex @@ -175,9 +175,9 @@ Insert("foo", 0); 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} @@ -235,12 +235,12 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man \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} @@ -250,7 +250,7 @@ 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. @@ -278,7 +278,7 @@ array.Sort(CompareStringLen); {\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} diff --git a/docs/latex/wx/bmpdatob.tex b/docs/latex/wx/bmpdatob.tex index 95b02fd9cf..fb7b1c8535 100644 --- a/docs/latex/wx/bmpdatob.tex +++ b/docs/latex/wx/bmpdatob.tex @@ -1,7 +1,7 @@ \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 @@ -14,7 +14,7 @@ methods.} \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. @@ -29,17 +29,17 @@ 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} diff --git a/docs/latex/wx/body.tex b/docs/latex/wx/body.tex index 499db281e3..e19128f347 100644 --- a/docs/latex/wx/body.tex +++ b/docs/latex/wx/body.tex @@ -6,16 +6,15 @@ \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 @@ -44,9 +43,9 @@ Since wxWindows was started, several other free or almost-free GUI frameworks ha emerged. However, none has the range of features, flexibility, documentation and the 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 @@ -54,10 +53,10 @@ availability of source code is especially important when the future of thousands of lines of application code may depend upon the longevity of 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, @@ -66,9 +65,9 @@ Code can very quickly become obsolete if it addresses the wrong platform or audience. wxWindows helps to insulate the programmer from 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. @@ -80,8 +79,8 @@ here are some of the benefits: \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. @@ -97,7 +96,7 @@ in Windows Help, HTML and Word RTF formats. \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. @@ -222,9 +221,11 @@ Metrowerks CodeWarrior. \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: @@ -326,8 +327,8 @@ system it is created on and the version you are using. The library name for the GTK version of wxWindows 2.2 on Linux and Solaris will be libwx\_gtk-2.2.so.0.0.0, 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} diff --git a/docs/latex/wx/boxsizer.tex b/docs/latex/wx/boxsizer.tex index 42a0cf1104..638ceca882 100644 --- a/docs/latex/wx/boxsizer.tex +++ b/docs/latex/wx/boxsizer.tex @@ -100,21 +100,21 @@ or wxHORIZONTAL for creating either a column sizer or a row sizer. \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. diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 8893178c04..72e42a34ea 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -37,6 +37,7 @@ \input conditn.tex \input config.tex \input control.tex +\input countstr.tex \input critsect.tex \input crtslock.tex \input custdobj.tex diff --git a/docs/latex/wx/countstr.tex b/docs/latex/wx/countstr.tex new file mode 100644 index 0000000000..d2f1876f4b --- /dev/null +++ b/docs/latex/wx/countstr.tex @@ -0,0 +1,46 @@ +% ----------------------------------------------------------------------------- +% wxCountingOutputStream +% ----------------------------------------------------------------------------- +\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream} + +wxCountingOutputStream is a specialized output stream which does not write any data anyway, +instead it counts how many bytes would get written if this were a normal stream. This +can sometimes be useful or required if some data gets serialized to a stream or compressed +by using stream compression and thus the final size of the stream cannot be known other +than pretending to write the stream. One case where the resulting size would have to be +known is if the data has to be written to a piece of memory and the memory has to be +allocated before writing to it (which is probably always the case when writing to a +memory stream). + +\wxheading{Derived from} + +\helpref{wxOutputStream}{wxoutputstream} +\helpref{wxStreamBase}{wxstreambase} + +\wxheading{Include files} + + + +\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. + diff --git a/docs/latex/wx/custdobj.tex b/docs/latex/wx/custdobj.tex index 2f2a71043e..ffffc6ad73 100644 --- a/docs/latex/wx/custdobj.tex +++ b/docs/latex/wx/custdobj.tex @@ -1,6 +1,6 @@ \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 @@ -8,8 +8,8 @@ copied bitwise (i.e. with {\tt memcpy()}), so it would be a bad idea to make 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. @@ -20,9 +20,9 @@ the virtual functions mentioned below. \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) @@ -46,7 +46,7 @@ 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} diff --git a/docs/latex/wx/database.tex b/docs/latex/wx/database.tex index cc884b99d2..6647678df7 100644 --- a/docs/latex/wx/database.tex +++ b/docs/latex/wx/database.tex @@ -3,6 +3,9 @@ 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} diff --git a/docs/latex/wx/dataform.tex b/docs/latex/wx/dataform.tex index 62e0fdb5c7..755b888236 100644 --- a/docs/latex/wx/dataform.tex +++ b/docs/latex/wx/dataform.tex @@ -48,7 +48,7 @@ do clipboard format registration at this time will usually lead to a crash! \wxheading{Virtual functions to override} -None, this class doesn't have any. +None \wxheading{Derived from} diff --git a/docs/latex/wx/dataobj.tex b/docs/latex/wx/dataobj.tex index 55e03819b7..f38c7c16b6 100644 --- a/docs/latex/wx/dataobj.tex +++ b/docs/latex/wx/dataobj.tex @@ -33,7 +33,7 @@ enum Direction }; \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 @@ -42,8 +42,8 @@ but may be annoying if you only want to do something simple like cut and paste 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 @@ -54,18 +54,18 @@ So, you have several solutions when you need a wxDataObject class (and you need one as soon as you want to transfer data via the clipboard or drag and drop): \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} @@ -86,12 +86,12 @@ clipboard after having pressed 'Copy' - in reality it is only declared to be 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 @@ -101,7 +101,7 @@ and from the clipboard and for drag and drop). Note that the format string 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} @@ -110,7 +110,7 @@ Each class derived directly from wxDataObject must override and implement all 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} @@ -123,15 +123,15 @@ None \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}}} @@ -152,7 +152,7 @@ Destructor. \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} diff --git a/docs/latex/wx/date.tex b/docs/latex/wx/date.tex index a0d6d15239..c09e0d66da 100644 --- a/docs/latex/wx/date.tex +++ b/docs/latex/wx/date.tex @@ -2,9 +2,9 @@ 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} diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex index cad3676d56..b7cd210493 100644 --- a/docs/latex/wx/datetime.tex +++ b/docs/latex/wx/datetime.tex @@ -26,8 +26,7 @@ wxDateTime object. 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 @@ -116,7 +115,7 @@ wxDateSpan,\rtfsp \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. diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex index 2a144b54db..7eaabb563d 100644 --- a/docs/latex/wx/datstrm.tex +++ b/docs/latex/wx/datstrm.tex @@ -17,6 +17,7 @@ is defined as signed int on 32-bit architectures) so that you cannot use long. T problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types. For example: + \begin{verbatim} wxFileInputStream input( "mytext.dat" ); wxDataInputStream store( input ); diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index ea39bed045..a7ccf42499 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -176,7 +176,7 @@ a transparency mask, the bitmap will be drawn transparently. 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} diff --git a/docs/latex/wx/dobjsmpl.tex b/docs/latex/wx/dobjsmpl.tex index 8a6c747ede..2d98a385d4 100644 --- a/docs/latex/wx/dobjsmpl.tex +++ b/docs/latex/wx/dobjsmpl.tex @@ -11,7 +11,7 @@ \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. @@ -26,8 +26,8 @@ methods.} \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 @@ -43,10 +43,10 @@ methods. \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}}} @@ -99,4 +99,3 @@ the derived class if the object supports setting its data. \pythonnote{When implementing this method in wxPython, the data comes as a single string parameter rather than the two shown here.} - diff --git a/docs/latex/wx/document.tex b/docs/latex/wx/document.tex index 7bb4d774d2..23ba287409 100644 --- a/docs/latex/wx/document.tex +++ b/docs/latex/wx/document.tex @@ -191,10 +191,15 @@ See also \helpref{Modify}{wxdocumentmodify}. \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}} @@ -297,10 +302,15 @@ Prompts the user for a file to save to, and then calls OnSaveDocument. \func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}} +\func{virtual 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}} diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex index 1711e603ec..dd426c53d8 100644 --- a/docs/latex/wx/dropsrc.tex +++ b/docs/latex/wx/dropsrc.tex @@ -2,7 +2,7 @@ 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} @@ -17,7 +17,7 @@ None \index{wxDragResult}wxDragResult is defined as follows: -{\small\begin{verbatim} +begin{verbatim} enum wxDragResult { wxDragError, // error prevented the d&d operation from completing @@ -27,7 +27,6 @@ enum wxDragResult wxDragCancel // the operation was cancelled by user (not an error) }; \end{verbatim} -} \wxheading{See also} diff --git a/docs/latex/wx/droptrgt.tex b/docs/latex/wx/droptrgt.tex index d601fb6242..235118dd32 100644 --- a/docs/latex/wx/droptrgt.tex +++ b/docs/latex/wx/droptrgt.tex @@ -26,7 +26,7 @@ None \index{wxDragResult}wxDragResult is defined as follows: -{\small\begin{verbatim} +\begin{verbatim} enum wxDragResult { wxDragError, // error prevented the d&d operation from completing @@ -36,7 +36,6 @@ enum wxDragResult wxDragCancel // the operation was cancelled by user (not an error) }; \end{verbatim} -} \wxheading{See also} diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex index 79bec64648..2d74c6a41c 100644 --- a/docs/latex/wx/evthand.tex +++ b/docs/latex/wx/evthand.tex @@ -37,7 +37,7 @@ each other. \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} diff --git a/docs/latex/wx/expr.tex b/docs/latex/wx/expr.tex index ad8b3e63db..5bb30904b6 100644 --- a/docs/latex/wx/expr.tex +++ b/docs/latex/wx/expr.tex @@ -46,8 +46,8 @@ Construct a floating point expression. 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. @@ -376,7 +376,6 @@ bool myErrorHandler(int err, chat *msg) wxExprDatabase database(myErrorHandler); \end{verbatim} - \func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute}, \rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}} diff --git a/docs/latex/wx/fildatob.tex b/docs/latex/wx/fildatob.tex index 13cc3a6aee..df7c1adbfa 100644 --- a/docs/latex/wx/fildatob.tex +++ b/docs/latex/wx/fildatob.tex @@ -1,8 +1,8 @@ \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. @@ -30,7 +30,7 @@ None. \helpref{wxDataObject}{wxdataobject}, \helpref{wxDataObjectSimple}{wxdataobjectsimple}, \helpref{wxTextDataObject}{wxtextdataobject}, -\helpref{wxBitmapDataObject}{wxbitmapdataobject} +\helpref{wxBitmapDataObject}{wxbitmapdataobject}, \helpref{wxDataObject}{wxdataobject} \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 8d799e648c..45c210b98b 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -18,7 +18,6 @@ None. wx/file.h defines the following constants: -{\small \begin{verbatim} #define wxS_IRUSR 00400 #define wxS_IWUSR 00200 @@ -35,7 +34,6 @@ wx/file.h defines the following constants: // default mode for the new files: corresponds to umask 022 #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}. diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex index 34de127891..395751351d 100644 --- a/docs/latex/wx/fltinstr.tex +++ b/docs/latex/wx/fltinstr.tex @@ -21,6 +21,8 @@ from another stream and pass it to the requester. The interface of this class is the same as that of wxInputStream. Only a constructor differs and it is documented below. +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- diff --git a/docs/latex/wx/fltoutst.tex b/docs/latex/wx/fltoutst.tex index a6b0eea02d..5b6e6d37d9 100644 --- a/docs/latex/wx/fltoutst.tex +++ b/docs/latex/wx/fltoutst.tex @@ -22,6 +22,8 @@ stream. 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 % ----------- diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex index 54ca070cd3..188cf5b819 100644 --- a/docs/latex/wx/fontenum.tex +++ b/docs/latex/wx/fontenum.tex @@ -19,10 +19,9 @@ the given \helpref{encoding}{wxfontencodingoverview}. 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} diff --git a/docs/latex/wx/fontmap.tex b/docs/latex/wx/fontmap.tex index 4a440bf7be..c9460d4a53 100644 --- a/docs/latex/wx/fontmap.tex +++ b/docs/latex/wx/fontmap.tex @@ -20,7 +20,7 @@ never TRUE, the config file is never created anyhow. 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} @@ -72,7 +72,6 @@ No base class \helpref{wxEncodingConverter}{wxencodingconverter}, \helpref{Writing non-English applications}{nonenglishoverview} - \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper} @@ -81,14 +80,12 @@ No base class 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}} @@ -104,7 +101,6 @@ The first form is for wxWindows' internal use while the second one is better suitable for general use -- it returns wxFontEncoding which can consequently be passed to wxFont constructor. - \membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable} \func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}} @@ -112,7 +108,6 @@ can consequently be passed to wxFont constructor. Check whether given encoding is available in given face or not. 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}} @@ -120,36 +115,31 @@ If no facename is given, find {\it any} font in this encoding. Returns the encoding for the given charset (in the form of RFC 2046) or 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}} diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 017a133f34..b775220626 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -235,7 +235,7 @@ Returns a pointer to the menubar currently associated with the frame (if any). \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). @@ -245,14 +245,13 @@ 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). @@ -263,7 +262,7 @@ 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. @@ -289,13 +288,13 @@ Returns TRUE if the frame is maximized. \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} diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 642ecb21f6..0ce31a68b5 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -10,7 +10,7 @@ It provides more information than wxWindow's input stream (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. @@ -26,7 +26,7 @@ pointers. \wxheading{See Also} \helpref{wxFileSystemHandler}{wxfilesystemhandler}, -\helpref{wxFileSystem}{wxfilesystem}, +\helpref{wxFileSystem}{wxfilesystem}, \helpref{Overview}{fs} \latexignore{\rtfignore{\wxheading{Members}}} @@ -47,17 +47,17 @@ Constructor. You probably won't use it. See Notes for details. \docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.} -If you aren't sure what do these params mean see description of GetXXXX() +If you are not sure of the meaning of these params, see the description of the GetXXXX() functions. \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 @@ -85,10 +85,10 @@ archive/main.zip#zip:index.htm#global /* 'global' */ 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} @@ -108,7 +108,7 @@ relative-file.htm \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. @@ -125,7 +125,7 @@ Returns time when this file was modified. 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). diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index e5e591b1e0..07d711056e 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -27,7 +27,7 @@ the expected result. \wxheading{Return value} -TRUE, if the command has been sent successfully, else FALSE. +TRUE if the command has been sent successfully, else FALSE. % ---------------------------------------------------------------------------- @@ -172,10 +172,10 @@ An initialized write-only stream. \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} -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} @@ -183,10 +183,10 @@ You will be notified when the EOF is reached by an error. Returns NULL if an error occured (it could be a network failure or the fact 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)} diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 13e2bbb853..776ed77822 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -730,10 +730,10 @@ wxCANCEL.} 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. diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index 540ed2fed1..0cb5bac38f 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -2,6 +2,10 @@ 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}\\ @@ -338,7 +342,7 @@ Returns the row scroll position. \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. @@ -382,7 +386,7 @@ and rows numerically. \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. diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex index 02d878d1d3..f0bcaaccb6 100644 --- a/docs/latex/wx/helpinst.tex +++ b/docs/latex/wx/helpinst.tex @@ -33,11 +33,10 @@ There are currently the following help controller classes defined: \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} @@ -80,8 +79,8 @@ Destroys the help instance, closing down the viewer if it is running. \func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}} -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. diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index c2d3e5c4e2..54781c468c 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -186,10 +186,10 @@ Returns width of the cell (m\_Width member). \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} @@ -203,7 +203,7 @@ before calling Layout. \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}. @@ -233,7 +233,7 @@ is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link)) \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} diff --git a/docs/latex/wx/htcolor.tex b/docs/latex/wx/htcolor.tex index d157797e1d..5048e26e45 100644 --- a/docs/latex/wx/htcolor.tex +++ b/docs/latex/wx/htcolor.tex @@ -5,7 +5,7 @@ \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} diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index 6bed58e506..a723a4420d 100644 --- a/docs/latex/wx/htcontnr.tex +++ b/docs/latex/wx/htcontnr.tex @@ -59,7 +59,7 @@ instead. 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! @@ -82,14 +82,14 @@ Inserts new cell into the container. 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} @@ -127,19 +127,19 @@ Sets the container's {\it vertical alignment}. This is per-line alignment! \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} @@ -194,8 +194,8 @@ much smaller area. \docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted 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} diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 8081007380..8d2a141ae1 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -5,9 +5,9 @@ \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} diff --git a/docs/latex/wx/htlnkinf.tex b/docs/latex/wx/htlnkinf.tex index 5a35711727..2c26d18da0 100644 --- a/docs/latex/wx/htlnkinf.tex +++ b/docs/latex/wx/htlnkinf.tex @@ -2,7 +2,7 @@ This class stores all neccessary information about hypertext links (as represented by {\tt } 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} diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex index fea721c027..9398443390 100644 --- a/docs/latex/wx/htparser.tex +++ b/docs/latex/wx/htparser.tex @@ -30,7 +30,6 @@ wxObject - \wxheading{See also} \helpref{Cells Overview}{cells}, diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index 38d926a76c..2c5345ca6a 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -13,7 +13,7 @@ The purpose of this class is to display HTML pages (either local 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}. diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex index 9e32372545..feea123a7c 100644 --- a/docs/latex/wx/htwinprs.tex +++ b/docs/latex/wx/htwinprs.tex @@ -3,25 +3,21 @@ % 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} @@ -58,21 +54,21 @@ and returns pointer to it (see \helpref{Overview}{cells}). \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} @@ -86,7 +82,7 @@ Returns default horizontal alignment. 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} @@ -95,7 +91,7 @@ know the height of the current font, call {\tt GetDC -> GetCharHeight()}. Returns average char width in standard font. It's used as DC-independent metrics. -{\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} @@ -115,13 +111,12 @@ m_WParser -> GetContainer() -> InsertCell(new ...); 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} @@ -136,7 +131,6 @@ Returns TRUE if actual font is bold, FALSE otherwise. Returns actual font face name. - \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed} \constfunc{int}{GetFontFixed}{\void} @@ -149,7 +143,6 @@ Returns TRUE if actual font is fixed face, FALSE otherwise. Returns TRUE if actual font is italic, FALSE otherwise. - \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize} \constfunc{int}{GetFontSize}{\void} @@ -168,23 +161,20 @@ Returns TRUE if actual font is underlined, FALSE otherwise. 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 } and {\tt } 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} @@ -201,37 +191,33 @@ Returns associated window (wxHtmlWindow). This may be NULL! (You should always 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} @@ -243,7 +229,6 @@ DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one 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}} @@ -270,7 +255,6 @@ Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE. Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. - \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} \func{void}{SetFontSize}{\param{int }{s}} @@ -289,7 +273,6 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE. Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} - \membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding} \func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}} @@ -298,7 +281,6 @@ Sets input encoding. The parser uses this information to build conversion tables from document's encoding to some encoding supported by operating system. - \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink} \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}} @@ -311,6 +293,5 @@ to wxEmptyString. \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}} -Sets color of hypertext link. - +Sets colour of hypertext link. diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index b5561fc37f..b7659df6c9 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -74,6 +74,8 @@ Creates an icon from an array of bits. Creates a new icon. +\func{}{wxIcon}{\param{char**}{ bits}} + \func{}{wxIcon}{\param{const char**}{ bits}} Creates an icon from XPM data. diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 68e11bd14c..136d07a3d5 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -18,7 +18,7 @@ creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object. 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}% @@ -116,8 +116,8 @@ Loads an image from an input stream. 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} @@ -331,7 +331,7 @@ the user. \wxheading{See also} -\helpref{wxImageHandler}{wximagehandler} +\helpref{wxImageHandler}{wximagehandler}, \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \membersection{wxImage::InsertHandler} @@ -653,7 +653,7 @@ created by IJG.) \wxheading{See also} -\helpref{wxImage}{wximage} +\helpref{wxImage}{wximage}, \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} \latexignore{\rtfignore{\wxheading{Members}}} @@ -733,8 +733,8 @@ TRUE if the operation succeeded, FALSE otherwise. \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} @@ -755,8 +755,8 @@ TRUE if the operation succeeded, FALSE otherwise. \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} diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index 236b1657c7..1b23a7b3dc 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -13,6 +13,8 @@ wxInputStream is an abstract base class which may not be used directly. +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index 3305ac71c3..f308ef62f1 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -157,8 +157,7 @@ Deletes all the items in the list control. {\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} @@ -331,6 +330,7 @@ Returns the first item with given state following {\it item} or -1 if 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 ( ;; ) @@ -413,7 +413,7 @@ wxLIST\_HITTEST\_ONITEMSTATEICON.} \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} diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 6704cdd0a2..03c4fa98bc 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -80,17 +80,21 @@ current mask while a message using string mask will be logged simply if the mask had been added before to the list of allowed ones. 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} diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 86c3d66860..4d9face292 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -254,7 +254,7 @@ Second form: returns the menu item object, or NULL if it is not found. 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} @@ -706,8 +706,8 @@ Returns the number of menus in this menubar. \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} @@ -765,7 +765,7 @@ Redraw the menu bar \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. @@ -777,7 +777,7 @@ 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} diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index f224111716..5f7de5341f 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -104,7 +104,7 @@ characaters it might contain. \wxheading{See also} -\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} \membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext} @@ -122,7 +122,7 @@ will return just {\tt "Hello"}. \wxheading{See also} -\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabel}{wxmenuitemgetlabel} \membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth} @@ -150,7 +150,7 @@ wxMenuItem constructor, i.e. with any accelerator characters it may contain. \wxheading{See also} -\helpref{GetLabel}{wxmenuitemgetlabel}, +\helpref{GetLabel}{wxmenuitemgetlabel}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} \membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu} @@ -233,9 +233,3 @@ Sets the text associated with the menu item. Sets the text colour associated with the menu item (Windows only). - - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "referenc" -%%% End: diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex index 586c5cd212..00967cad97 100644 --- a/docs/latex/wx/mouseevt.tex +++ b/docs/latex/wx/mouseevt.tex @@ -188,7 +188,9 @@ See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}. \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. diff --git a/docs/latex/wx/mutex.tex b/docs/latex/wx/mutex.tex index f102c519a0..4864ec96e0 100644 --- a/docs/latex/wx/mutex.tex +++ b/docs/latex/wx/mutex.tex @@ -67,7 +67,7 @@ None. \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}}} diff --git a/docs/latex/wx/nbsizer.tex b/docs/latex/wx/nbsizer.tex index 4575e9d87b..b4be9489ab 100644 --- a/docs/latex/wx/nbsizer.tex +++ b/docs/latex/wx/nbsizer.tex @@ -9,7 +9,7 @@ sizer. 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 diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex index 90873de8f9..0eb87f886e 100644 --- a/docs/latex/wx/outptstr.tex +++ b/docs/latex/wx/outptstr.tex @@ -13,6 +13,8 @@ wxOutputStream is an abstract base class which may not be used directly. +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- @@ -69,47 +71,3 @@ Reads data from the specified input stream and stores them in the current stream. The data is read until an error is raised 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} - - - -% ----------- -% 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. - diff --git a/docs/latex/wx/plotcurve.tex b/docs/latex/wx/plotcurve.tex index b3d16de55a..a6c375b4db 100644 --- a/docs/latex/wx/plotcurve.tex +++ b/docs/latex/wx/plotcurve.tex @@ -79,7 +79,7 @@ return 0.5 or maybe 1.0 for nicer aesthetics. \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} diff --git a/docs/latex/wx/plotwindow.tex b/docs/latex/wx/plotwindow.tex index 9b49449087..8a2e7bc227 100644 --- a/docs/latex/wx/plotwindow.tex +++ b/docs/latex/wx/plotwindow.tex @@ -14,7 +14,7 @@ of the curves, enlarging them or scrolling from one position to another. Note 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 diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex index 73424a6f45..38016dcd28 100644 --- a/docs/latex/wx/print.tex +++ b/docs/latex/wx/print.tex @@ -16,12 +16,12 @@ between the print dialogs and the application. \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} @@ -850,8 +850,6 @@ context to draw on. \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 diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index e07785da3c..39689596e3 100644 --- a/docs/latex/wx/progdlg.tex +++ b/docs/latex/wx/progdlg.tex @@ -45,20 +45,20 @@ bitmask constants defined in wx/defs.h: \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}% } diff --git a/docs/latex/wx/propbfva.tex b/docs/latex/wx/propbfva.tex index b77d1342d5..a091c492cf 100644 --- a/docs/latex/wx/propbfva.tex +++ b/docs/latex/wx/propbfva.tex @@ -1,8 +1,13 @@ \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} diff --git a/docs/latex/wx/propblva.tex b/docs/latex/wx/propblva.tex index 37179c6736..172bc51a43 100644 --- a/docs/latex/wx/propblva.tex +++ b/docs/latex/wx/propblva.tex @@ -1,8 +1,12 @@ \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} diff --git a/docs/latex/wx/property.tex b/docs/latex/wx/property.tex index c038840625..f981df8641 100644 --- a/docs/latex/wx/property.tex +++ b/docs/latex/wx/property.tex @@ -18,6 +18,7 @@ An alternative method is to use the {\it role} parameter to specify what kind of validator would be appropriate; for example, specifying ``filename" for the role would allow the property view to find an appropriate validator at edit time. +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxProperty::wxProperty} diff --git a/docs/latex/wx/propflva.tex b/docs/latex/wx/propflva.tex index d3de557e69..c8748be331 100644 --- a/docs/latex/wx/propflva.tex +++ b/docs/latex/wx/propflva.tex @@ -1,10 +1,14 @@ \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 = ``*.*"}, diff --git a/docs/latex/wx/propford.tex b/docs/latex/wx/propford.tex index 3c7bf01964..dbd0899576 100644 --- a/docs/latex/wx/propford.tex +++ b/docs/latex/wx/propford.tex @@ -5,10 +5,12 @@ be used for viewing a form property sheet. Pass a property form view object, and will pass OnClose and OnDefaultAction listbox messages to the view class for 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. @@ -19,4 +21,3 @@ Constructor. Destructor. - diff --git a/docs/latex/wx/propforf.tex b/docs/latex/wx/propforf.tex index 5b9e92cc81..3f7d9dddf1 100644 --- a/docs/latex/wx/propforf.tex +++ b/docs/latex/wx/propforf.tex @@ -7,6 +7,8 @@ will pass OnClose messages to the view class for processing. Call Initialize to create the panel and associate the view; override OnCreatePanel 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}, @@ -29,7 +31,7 @@ Returns the panel associated with the frame. \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. @@ -39,4 +41,3 @@ Must be called to create the panel and associate the view with the panel and fra Creates a panel. Override this to create a panel type other than wxPropertyFormPanel. - diff --git a/docs/latex/wx/propforp.tex b/docs/latex/wx/propforp.tex index 942debc2ff..c84f4eaa8a 100644 --- a/docs/latex/wx/propforp.tex +++ b/docs/latex/wx/propforp.tex @@ -5,6 +5,8 @@ be used for viewing a property form. Pass a property form view object, and the p will pass OnDefaultAction listbox messages to the view class for processing. +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxPropertyFormPanel::wxPropertyFormPanel} \func{void}{wxPropertyFormPanel}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent}, @@ -19,5 +21,3 @@ Constructor. Destructor. - - diff --git a/docs/latex/wx/propforv.tex b/docs/latex/wx/propforv.tex index e8fb7834d1..0a72305a4a 100644 --- a/docs/latex/wx/propforv.tex +++ b/docs/latex/wx/propforv.tex @@ -1,10 +1,14 @@ \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}} @@ -19,7 +23,7 @@ Destructor. \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 @@ -27,7 +31,7 @@ by a callback associated with the actual control). \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 @@ -35,23 +39,22 @@ panel item corresponding to the property. \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. - diff --git a/docs/latex/wx/propfovi.tex b/docs/latex/wx/propfovi.tex index c9d570003e..c252c940eb 100644 --- a/docs/latex/wx/propfovi.tex +++ b/docs/latex/wx/propfovi.tex @@ -1,10 +1,14 @@ \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}} @@ -28,7 +32,7 @@ association manually. \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. @@ -88,14 +92,13 @@ Sets the managed window (a frame or dialog) associated with the view. \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. - diff --git a/docs/latex/wx/propifva.tex b/docs/latex/wx/propifva.tex index b39468cacc..46af6ef034 100644 --- a/docs/latex/wx/propifva.tex +++ b/docs/latex/wx/propifva.tex @@ -1,10 +1,14 @@ \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}, @@ -12,4 +16,3 @@ or wxSlider. Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check. - diff --git a/docs/latex/wx/propilva.tex b/docs/latex/wx/propilva.tex index 76870b0c3b..7c6803a942 100644 --- a/docs/latex/wx/propilva.tex +++ b/docs/latex/wx/propilva.tex @@ -1,8 +1,12 @@ \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} diff --git a/docs/latex/wx/proplisd.tex b/docs/latex/wx/proplisd.tex index adf3992d70..8a6a673754 100644 --- a/docs/latex/wx/proplisd.tex +++ b/docs/latex/wx/proplisd.tex @@ -5,10 +5,12 @@ be used for viewing a property list. Pass a property list view object, and the d will pass OnClose and OnDefaultAction listbox messages to the view class for 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. @@ -19,4 +21,3 @@ Constructor. Destructor. - diff --git a/docs/latex/wx/proplisf.tex b/docs/latex/wx/proplisf.tex index 5b8ace2494..ee780a7ad8 100644 --- a/docs/latex/wx/proplisf.tex +++ b/docs/latex/wx/proplisf.tex @@ -7,6 +7,8 @@ will pass OnClose messages to the view class for processing. Call Initialize to create the panel and associate the view; override OnCreatePanel 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}, @@ -29,7 +31,7 @@ Returns the panel associated with the frame. \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. @@ -39,4 +41,3 @@ Must be called to create the panel and associate the view with the panel and fra Creates a panel. Override this to create a panel type other than wxPropertyListPanel. - diff --git a/docs/latex/wx/proplisp.tex b/docs/latex/wx/proplisp.tex index c5b1a6220b..926d749129 100644 --- a/docs/latex/wx/proplisp.tex +++ b/docs/latex/wx/proplisp.tex @@ -5,6 +5,8 @@ be used for viewing a property list. Pass a property list view object, and the p will pass OnDefaultAction listbox messages to the view class for processing. +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxPropertyListPanel::wxPropertyListPanel} \func{void}{wxPropertyListPanel}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent}, @@ -19,6 +21,3 @@ Constructor. Destructor. - - - diff --git a/docs/latex/wx/proplist.tex b/docs/latex/wx/proplist.tex index fb4036e9c5..d782b0c598 100644 --- a/docs/latex/wx/proplist.tex +++ b/docs/latex/wx/proplist.tex @@ -99,14 +99,6 @@ The property class library comprises the following files: \item propform.h: wxPropertyListView and associated classes \end{itemize} - - - - - - - - \section{Topic overviews}\label{proplistoverviews} This chapter contains a selection of topic overviews. @@ -483,8 +475,6 @@ as described elsewhere, and the user edits away. When the user has finished edit wxButtonWithProperties::SetProperty to transfer the wxProperty value back into the button 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. @@ -497,7 +487,6 @@ 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 diff --git a/docs/latex/wx/propliva.tex b/docs/latex/wx/propliva.tex index 0962211081..021c44f967 100644 --- a/docs/latex/wx/propliva.tex +++ b/docs/latex/wx/propliva.tex @@ -1,10 +1,14 @@ \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}} @@ -19,7 +23,7 @@ Destructor. \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 @@ -27,21 +31,21 @@ was invalid, which is a signal restores the old value. Return TRUE 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 @@ -49,7 +53,7 @@ textual value from the property and inserts it into the text edit control. \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, @@ -57,7 +61,7 @@ such as cycling through possible values. \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 @@ -66,7 +70,7 @@ this function to show the file selector. \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 @@ -75,14 +79,14 @@ value options). \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 @@ -90,7 +94,7 @@ the property list. Should do the transfer from the property editing area to the \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 @@ -98,11 +102,9 @@ in the edit control (having chosen a suitable control to display: (non)editable \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. - - diff --git a/docs/latex/wx/proplosv.tex b/docs/latex/wx/proplosv.tex index 0132b09830..601788a796 100644 --- a/docs/latex/wx/proplosv.tex +++ b/docs/latex/wx/proplosv.tex @@ -1,7 +1,5 @@ \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. @@ -19,6 +17,12 @@ For example: 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}} diff --git a/docs/latex/wx/proplstv.tex b/docs/latex/wx/proplstv.tex index a370762615..12b95e3dfc 100644 --- a/docs/latex/wx/proplstv.tex +++ b/docs/latex/wx/proplstv.tex @@ -1,9 +1,13 @@ \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}} @@ -36,14 +40,14 @@ Associates the window on which the controls will be displayed, with the view (se \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 @@ -51,7 +55,7 @@ from ShowProperty, called by OnPropertySelect, called by the listbox callback wh \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 @@ -95,14 +99,13 @@ Sets the managed window (a frame or dialog) associated with the view. \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. - diff --git a/docs/latex/wx/propregv.tex b/docs/latex/wx/propregv.tex index 97d77f0232..59a87d3cf0 100644 --- a/docs/latex/wx/propregv.tex +++ b/docs/latex/wx/propregv.tex @@ -4,6 +4,8 @@ The {\bf wxPropertyValidatorRegistry} class is used for storing validators, indexed by the `role name' of the property, by which groups of property can be identified for the purpose of validation and editing. +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry} \func{void}{wxPropertyValidatorRegistry}{\void} diff --git a/docs/latex/wx/proprfva.tex b/docs/latex/wx/proprfva.tex index 9f88b8ac17..7713336e72 100644 --- a/docs/latex/wx/proprfva.tex +++ b/docs/latex/wx/proprfva.tex @@ -1,9 +1,13 @@ \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}, @@ -11,4 +15,3 @@ This class validates a range of real values for form views. The associated panel Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check. - diff --git a/docs/latex/wx/proprlva.tex b/docs/latex/wx/proprlva.tex index bad236add1..1745a273d0 100644 --- a/docs/latex/wx/proprlva.tex +++ b/docs/latex/wx/proprlva.tex @@ -1,14 +1,19 @@ \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. - diff --git a/docs/latex/wx/propsht.tex b/docs/latex/wx/propsht.tex index b5d4b28f43..241c09d6fd 100644 --- a/docs/latex/wx/propsht.tex +++ b/docs/latex/wx/propsht.tex @@ -1,10 +1,14 @@ \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 = ""}} @@ -73,9 +77,7 @@ Sets property propname to value. Returns false if property is not a member of sh \membersection{wxPropertySheet::SetAllModified} -\func{void}{SetAllModified}{\param{Bool}{ flag}} +\func{void}{SetAllModified}{\param{bool}{ flag}} Sets the `modified' flag of each property value. - - diff --git a/docs/latex/wx/propslv.tex b/docs/latex/wx/propslv.tex index 557ec052a6..cc4f6578dd 100644 --- a/docs/latex/wx/propslv.tex +++ b/docs/latex/wx/propslv.tex @@ -1,9 +1,13 @@ \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}} diff --git a/docs/latex/wx/propstfv.tex b/docs/latex/wx/propstfv.tex index 279a5b21e9..0a879ab0a9 100644 --- a/docs/latex/wx/propstfv.tex +++ b/docs/latex/wx/propstfv.tex @@ -1,12 +1,16 @@ \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}} @@ -14,4 +18,3 @@ the validator. Note that this does not happen for XView wxChoice items since XVi Constructor. Supply a list of strings to indicate a choice, or no strings to allow the user to freely edit the string. The string list will be deleted when the validator is deleted. - diff --git a/docs/latex/wx/propval.tex b/docs/latex/wx/propval.tex index 6283a5a0d4..1abe60958e 100644 --- a/docs/latex/wx/propval.tex +++ b/docs/latex/wx/propval.tex @@ -18,6 +18,8 @@ A wxPropertyValue has one of the following types: \item wxPropertyValueStringPtr \end{itemize} +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxPropertyValue::wxPropertyValue} \func{void}{wxPropertyValue}{\void} @@ -35,9 +37,9 @@ Construction from a string value. \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. @@ -71,7 +73,7 @@ Construction from a string pointer. Construction from an integer pointer. -\func{void}{wxPropertyValue}{\param{Bool *}{val}} +\func{void}{wxPropertyValue}{\param{bool *}{val}} Construction from an boolean pointer. @@ -97,13 +99,13 @@ Appends a property value to the list. \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. @@ -133,7 +135,7 @@ Gets the last value in the list. \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). @@ -194,7 +196,7 @@ Returns the pointer to the floating point value. \membersection{wxPropertyValue::SetModified} -\func{void}{SetModified}{\param{Bool}{ flag}} +\func{void}{SetModified}{\param{bool}{ flag}} Sets the `modified' flag. @@ -224,7 +226,7 @@ Returns the value type. \func{void}{operator $=$}{\param{const long }{val}} -\func{void}{operator $=$}{\param{const Bool }{val}} +\func{void}{operator $=$}{\param{const bool }{val}} \func{void}{operator $=$}{\param{const float }{val}} @@ -232,11 +234,9 @@ Returns the value type. \func{void}{operator $=$}{\param{const long *}{val}} -\func{void}{operator $=$}{\param{const Bool *}{val}} +\func{void}{operator $=$}{\param{const bool *}{val}} \func{void}{operator $=$}{\param{const float *}{val}} Assignment operators. - - diff --git a/docs/latex/wx/propvald.tex b/docs/latex/wx/propvald.tex index 13c39ca971..69404e4cd2 100644 --- a/docs/latex/wx/propvald.tex +++ b/docs/latex/wx/propvald.tex @@ -1,10 +1,14 @@ \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}} @@ -35,4 +39,3 @@ Gets the property for the validator. Sets the property for the validator. - diff --git a/docs/latex/wx/propview.tex b/docs/latex/wx/propview.tex index 5fd469170f..4d21ae041d 100644 --- a/docs/latex/wx/propview.tex +++ b/docs/latex/wx/propview.tex @@ -1,11 +1,15 @@ \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}} @@ -68,7 +72,7 @@ Virtual function that will be called when the Cancel button on the physical wind \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. @@ -88,7 +92,7 @@ to respond immediately to property value changes. \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. diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index 0043092d7f..d83dce4fd6 100644 --- a/docs/latex/wx/protocol.tex +++ b/docs/latex/wx/protocol.tex @@ -16,7 +16,7 @@ % Members % ---------------------------------------------------------------------------- -\latexignore{\rtfignore{\membersection{Members}}} +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} diff --git a/docs/latex/wx/recrdset.tex b/docs/latex/wx/recrdset.tex index 568fd85a24..de7acc29ea 100644 --- a/docs/latex/wx/recrdset.tex +++ b/docs/latex/wx/recrdset.tex @@ -4,6 +4,9 @@ Each wxRecordSet represents an ODBC database query. You can make multiple querie at a time by using multiple wxRecordSets with a wxDatabase or you can make 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} diff --git a/docs/latex/wx/screendc.tex b/docs/latex/wx/screendc.tex index ab31f205bb..e11ccd5935 100644 --- a/docs/latex/wx/screendc.tex +++ b/docs/latex/wx/screendc.tex @@ -49,6 +49,13 @@ to implement this feature. 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} diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex index f0dcb27bcb..5bf380513a 100644 --- a/docs/latex/wx/sizer.tex +++ b/docs/latex/wx/sizer.tex @@ -1,7 +1,7 @@ \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 @@ -133,7 +133,7 @@ Returns TRUE if the child item was found and removed, FALSE otherwise. \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} diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 3247717456..7e67b86192 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -54,7 +54,7 @@ The {\bf wxSOCKET\_INPUT} event will be issued whenever there is data 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. @@ -64,9 +64,9 @@ with \helpref{Accept}{wxsocketserveraccept}. After that, new 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 @@ -93,7 +93,7 @@ handler macro to direct events to member functions that take a \helpref{wxSocketEvent}{wxsocketevent}, \helpref{wxSocketClient}{wxsocketclient}, -\helpref{wxSocketServer}{wxsocketserver}, +\helpref{wxSocketServer}{wxsocketserver}, \helpref{Sockets sample}{samplesockets} % --------------------------------------------------------------------------- @@ -189,8 +189,8 @@ releases of wxWindows. \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} @@ -210,7 +210,7 @@ socket objects in the stack. 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: @@ -328,7 +328,7 @@ following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg. \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} % @@ -385,11 +385,11 @@ some exception or abnormal problem. InterruptWait is automatically called 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} % @@ -512,10 +512,10 @@ Calls to SaveState and RestoreState can be nested. 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. @@ -533,7 +533,7 @@ 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. % @@ -545,7 +545,7 @@ 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} @@ -559,7 +559,7 @@ enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, \helpref{wxSocketEvent}{wxsocketevent}, -\helpref{wxEvtHandler}{wxevthandler}, +\helpref{wxEvtHandler}{wxevthandler} % % SetFlags @@ -663,7 +663,7 @@ For more information on socket events see \helpref{wxSocket events}{wxsocketbase \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. @@ -745,7 +745,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF \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. @@ -843,11 +843,11 @@ FALSE if the timeout was reached. \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} % @@ -904,7 +904,7 @@ Returns TRUE if the socket becomes readable, FALSE on timeout. \wxheading{See also} -\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, +\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, \helpref{wxSocketBase::Wait}{wxsocketbasewait} % @@ -934,7 +934,7 @@ Returns TRUE if the socket becomes writable, FALSE on timeout. \wxheading{See also} -\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, +\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, \helpref{wxSocketBase::Wait}{wxsocketbasewait} % @@ -980,8 +980,8 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF \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. @@ -1029,6 +1029,8 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset +\latexignore{\rtfignore{\wxheading{Members}}} + % --------------------------------------------------------------------------- % Members % --------------------------------------------------------------------------- @@ -1088,7 +1090,7 @@ and the connection failed. 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} @@ -1120,7 +1122,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} 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. @@ -1144,8 +1146,8 @@ bool success = client->IsConnected(); \wxheading{See also} -\helpref{wxSocketClient::Connect}{wxsocketclientconnect}, -\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, +\helpref{wxSocketClient::Connect}{wxsocketclientconnect}, +\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, \helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected} % --------------------------------------------------------------------------- @@ -1233,7 +1235,7 @@ Returns the socket event type. \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} @@ -1258,7 +1260,7 @@ Destructor (it doesn't close the accepted connections). \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. @@ -1269,7 +1271,7 @@ accepted, it will wait for the next incoming connection to arrive. 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. @@ -1317,8 +1319,8 @@ connections. \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. diff --git a/docs/latex/wx/statbmp.tex b/docs/latex/wx/statbmp.tex index 47cbbe5094..78ea1aac9c 100644 --- a/docs/latex/wx/statbmp.tex +++ b/docs/latex/wx/statbmp.tex @@ -92,5 +92,5 @@ Sets the bitmap label. \wxheading{See also} -\docparam{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap} +\helpref{wxStaticBitmap::GetBitmap}{wxstaticbitmapgetbitmap} diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index f334169836..397098dd8c 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -28,7 +28,6 @@ Constructor, creates a new stream buffer using {\it stream} as a parent stream and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read, 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 diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 40ce15f24f..0a6a5a38ef 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -54,6 +54,7 @@ Returns TRUE if no error occured on the stream. \constfunc{wxStreamError}{LastError}{\void} This function returns the last error. + \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt \twocolitem{{\bf wxSTREAM\_NO\_ERROR}}{No error occured.} diff --git a/docs/latex/wx/strmfile.tex b/docs/latex/wx/strmfile.tex index 70adf1af3e..02ea7fa19a 100644 --- a/docs/latex/wx/strmfile.tex +++ b/docs/latex/wx/strmfile.tex @@ -4,7 +4,7 @@ \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. @@ -65,7 +65,7 @@ Returns TRUE if the stream is initialized and ready. \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. @@ -154,7 +154,7 @@ Initializes a new file stream in read-write mode using the specified \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. @@ -215,7 +215,7 @@ Returns TRUE if the stream is initialized and ready. \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. diff --git a/docs/latex/wx/tdb.tex b/docs/latex/wx/tdb.tex index 2682a6647d..33a52a9b6f 100644 --- a/docs/latex/wx/tdb.tex +++ b/docs/latex/wx/tdb.tex @@ -73,8 +73,6 @@ also get deleted, so beware of holding onto invalid pointers. \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 @@ -82,9 +80,11 @@ with a database object you need to bind a wxRecordSet object to it. All you can do with wxDatabase is opening/closing connections and getting some info 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} @@ -93,9 +93,11 @@ It contains the name and type of a column and a list of wxQueryFields where the real data is stored. The links to user-defined variables are stored 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} @@ -108,9 +110,11 @@ or wxRecordSet::GoTo. If wxRecordSet is of the type wxOPEN\_TYPE\_SNAPSHOT, all data returned by an ODBC function will be loaded at once and the number 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} @@ -118,9 +122,11 @@ Each wxRecordSet represents a database query. You can make multiple queries at a time by using multiple wxRecordSets with a wxDatabase or you can make 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. @@ -153,13 +159,19 @@ These data types correspond to the following ODBC identifiers: \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. @@ -234,5 +246,3 @@ Example: This example sets a field in column `X' to the number 123, for the record where the column ASSET has the value `BD34'. - - diff --git a/docs/latex/wx/time.tex b/docs/latex/wx/time.tex index 85cd2a6055..59bad13e40 100644 --- a/docs/latex/wx/time.tex +++ b/docs/latex/wx/time.tex @@ -2,9 +2,9 @@ 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} @@ -23,7 +23,8 @@ typedef unsigned short secondTy; typedef unsigned long clockTy; enum tFormat { wx12h, wx24h }; enum tPrecision { wxStdMinSec, wxStdMin }; -\end{verbatim}} +\end{verbatim} +} \wxheading{See also} diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 14ff8c5178..424cc23d72 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1403,9 +1403,12 @@ Sent to the event handler when the window must be refreshed. \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: -- 2.45.2