From cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209 Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Sat, 18 Jan 2003 00:16:34 +0000 Subject: [PATCH] TRUE/FALSE -> true/false in documentation git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/accel.tex | 6 +- docs/latex/wx/activevt.tex | 6 +- docs/latex/wx/app.tex | 62 +++++----- docs/latex/wx/array.tex | 4 +- docs/latex/wx/arrstrng.tex | 14 +-- docs/latex/wx/autoobj.tex | 10 +- docs/latex/wx/bitmap.tex | 14 +-- docs/latex/wx/bmphand.tex | 6 +- docs/latex/wx/brush.tex | 6 +- docs/latex/wx/calctrl.tex | 18 +-- docs/latex/wx/caret.tex | 10 +- docs/latex/wx/checkbox.tex | 6 +- docs/latex/wx/checklst.tex | 6 +- docs/latex/wx/clasinfo.tex | 2 +- docs/latex/wx/clipbrd.tex | 16 +-- docs/latex/wx/closeevt.tex | 18 +-- docs/latex/wx/cmdevent.tex | 8 +- docs/latex/wx/cmdlpars.tex | 24 ++-- docs/latex/wx/cmdproc.tex | 4 +- docs/latex/wx/colour.tex | 8 +- docs/latex/wx/command.tex | 12 +- docs/latex/wx/conditn.tex | 4 +- docs/latex/wx/config.tex | 56 ++++----- docs/latex/wx/cshelp.tex | 6 +- docs/latex/wx/ctrlsub.tex | 2 +- docs/latex/wx/cursor.tex | 2 +- docs/latex/wx/database.tex | 16 +-- docs/latex/wx/dataform.tex | 4 +- docs/latex/wx/dataobj.tex | 4 +- docs/latex/wx/date.tex | 16 +-- docs/latex/wx/datespan.tex | 4 +- docs/latex/wx/datetime.tex | 52 ++++----- docs/latex/wx/datistrm.tex | 2 +- docs/latex/wx/datostrm.tex | 2 +- docs/latex/wx/db.tex | 212 +++++++++++++++++------------------ docs/latex/wx/dc.tex | 18 +-- docs/latex/wx/ddeclint.tex | 4 +- docs/latex/wx/ddeconn.tex | 16 +-- docs/latex/wx/ddeservr.tex | 2 +- docs/latex/wx/debugcxt.tex | 20 ++-- docs/latex/wx/dialog.tex | 24 ++-- docs/latex/wx/dialup.tex | 24 ++-- docs/latex/wx/dir.tex | 10 +- docs/latex/wx/dllload.tex | 4 +- docs/latex/wx/dobjcomp.tex | 4 +- docs/latex/wx/dobjsmpl.tex | 4 +- docs/latex/wx/docmanag.tex | 18 +-- docs/latex/wx/doctempl.tex | 2 +- docs/latex/wx/document.tex | 20 ++-- docs/latex/wx/dragimag.tex | 6 +- docs/latex/wx/dropsrc.tex | 4 +- docs/latex/wx/droptrgt.tex | 6 +- docs/latex/wx/dynlib.tex | 4 +- docs/latex/wx/encconv.tex | 2 +- docs/latex/wx/event.tex | 6 +- docs/latex/wx/evthand.tex | 14 +-- docs/latex/wx/expr.tex | 10 +- docs/latex/wx/ffile.tex | 20 ++-- docs/latex/wx/ffilestr.tex | 4 +- docs/latex/wx/fildrptg.tex | 2 +- docs/latex/wx/file.tex | 20 ++-- docs/latex/wx/fileistr.tex | 2 +- docs/latex/wx/fileostr.tex | 2 +- docs/latex/wx/filesys.tex | 12 +- docs/latex/wx/filesysh.tex | 6 +- docs/latex/wx/filetype.tex | 16 +-- docs/latex/wx/font.tex | 14 +-- docs/latex/wx/fontdlg.tex | 22 ++-- docs/latex/wx/fontenum.tex | 10 +- docs/latex/wx/fontlist.tex | 2 +- docs/latex/wx/fontmap.tex | 18 +-- docs/latex/wx/frame.tex | 12 +- docs/latex/wx/ftp.tex | 20 ++-- docs/latex/wx/function.tex | 140 +++++++++++------------ docs/latex/wx/grid.tex | 152 ++++++++++++------------- docs/latex/wx/gridattr.tex | 2 +- docs/latex/wx/gridedit.tex | 4 +- docs/latex/wx/gridevt.tex | 42 +++---- docs/latex/wx/hash.tex | 2 +- docs/latex/wx/hashmap.tex | 2 +- docs/latex/wx/helpevt.tex | 2 +- docs/latex/wx/helpinst.tex | 6 +- docs/latex/wx/helpprov.tex | 2 +- docs/latex/wx/htcell.tex | 6 +- docs/latex/wx/htdcrend.tex | 8 +- docs/latex/wx/hteasypr.tex | 8 +- docs/latex/wx/htfilter.tex | 2 +- docs/latex/wx/hthelpct.tex | 4 +- docs/latex/wx/hthlpfrm.tex | 6 +- docs/latex/wx/htprint.tex | 4 +- docs/latex/wx/httag.tex | 16 +-- docs/latex/wx/httaghnd.tex | 4 +- docs/latex/wx/htwindow.tex | 6 +- docs/latex/wx/htwinprs.tex | 16 +-- docs/latex/wx/hworld.tex | 10 +- docs/latex/wx/icon.tex | 10 +- docs/latex/wx/iconevt.tex | 4 +- docs/latex/wx/idleevt.tex | 4 +- docs/latex/wx/image.tex | 50 ++++----- docs/latex/wx/imaglist.tex | 12 +- docs/latex/wx/inputstr.tex | 2 +- docs/latex/wx/ipcclint.tex | 4 +- docs/latex/wx/ipcconn.tex | 16 +-- docs/latex/wx/ipcservr.tex | 2 +- docs/latex/wx/ipvaddr.tex | 10 +- docs/latex/wx/joyevent.tex | 12 +- docs/latex/wx/joystick.tex | 20 ++-- docs/latex/wx/keyevent.tex | 18 +-- docs/latex/wx/list.tex | 12 +- docs/latex/wx/listbox.tex | 2 +- docs/latex/wx/listctrl.tex | 10 +- docs/latex/wx/listevt.tex | 2 +- docs/latex/wx/listview.tex | 8 +- docs/latex/wx/locale.tex | 16 +-- docs/latex/wx/log.tex | 24 ++-- docs/latex/wx/menu.tex | 24 ++-- docs/latex/wx/menuevt.tex | 4 +- docs/latex/wx/menuitem.tex | 10 +- docs/latex/wx/metafile.tex | 6 +- docs/latex/wx/mimetype.tex | 10 +- docs/latex/wx/module.tex | 4 +- docs/latex/wx/mouseevt.tex | 76 ++++++------- docs/latex/wx/mutex.tex | 8 +- docs/latex/wx/mutexlck.tex | 2 +- docs/latex/wx/notebook.tex | 10 +- docs/latex/wx/notifevt.tex | 4 +- docs/latex/wx/object.tex | 2 +- docs/latex/wx/pagedlg.tex | 30 ++--- docs/latex/wx/palette.tex | 6 +- docs/latex/wx/pantabv.tex | 6 +- docs/latex/wx/pathlist.tex | 2 +- docs/latex/wx/pen.tex | 4 +- docs/latex/wx/plotwindow.tex | 4 +- docs/latex/wx/porting.tex | 2 +- docs/latex/wx/postscpt.tex | 4 +- docs/latex/wx/prevwin.tex | 2 +- docs/latex/wx/print.tex | 60 +++++----- docs/latex/wx/process.tex | 8 +- docs/latex/wx/progdlg.tex | 6 +- docs/latex/wx/propford.tex | 2 +- docs/latex/wx/propfovi.tex | 2 +- docs/latex/wx/proplisd.tex | 2 +- docs/latex/wx/proplist.tex | 22 ++-- docs/latex/wx/propliva.tex | 4 +- docs/latex/wx/proplstv.tex | 2 +- docs/latex/wx/propval.tex | 2 +- docs/latex/wx/propview.tex | 4 +- docs/latex/wx/protocol.tex | 4 +- docs/latex/wx/query.tex | 10 +- docs/latex/wx/radiobox.tex | 8 +- docs/latex/wx/radiobut.tex | 4 +- docs/latex/wx/recrdset.tex | 20 ++-- docs/latex/wx/rect.tex | 8 +- docs/latex/wx/regex.tex | 8 +- docs/latex/wx/region.tex | 16 +-- docs/latex/wx/sashwin.tex | 8 +- docs/latex/wx/scrolbar.tex | 4 +- docs/latex/wx/scrolwin.tex | 10 +- docs/latex/wx/sizer.tex | 10 +- docs/latex/wx/snglinst.tex | 12 +- docs/latex/wx/socket.tex | 68 +++++------ docs/latex/wx/socksrv.tex | 18 +-- docs/latex/wx/splitter.tex | 18 +-- docs/latex/wx/statline.tex | 2 +- docs/latex/wx/statusbr.tex | 2 +- docs/latex/wx/stream.tex | 4 +- docs/latex/wx/strlist.tex | 6 +- docs/latex/wx/strmbase.tex | 2 +- docs/latex/wx/sysopt.tex | 2 +- docs/latex/wx/tab.tex | 2 +- docs/latex/wx/tabctrl.tex | 2 +- docs/latex/wx/tabview.tex | 18 +-- docs/latex/wx/tapp.tex | 6 +- docs/latex/wx/taskbar.tex | 4 +- docs/latex/wx/tclipbrd.tex | 4 +- docs/latex/wx/tcommdlg.tex | 2 +- docs/latex/wx/tcpclint.tex | 2 +- docs/latex/wx/tcpconn.tex | 16 +-- docs/latex/wx/tcpservr.tex | 2 +- docs/latex/wx/tdb.tex | 24 ++-- docs/latex/wx/tdelwin.tex | 6 +- docs/latex/wx/tdnd.tex | 2 +- docs/latex/wx/tempfile.tex | 10 +- docs/latex/wx/tevent.tex | 4 +- docs/latex/wx/text.tex | 44 ++++---- docs/latex/wx/textfile.tex | 8 +- docs/latex/wx/tfont.tex | 2 +- docs/latex/wx/tglbtn.tex | 4 +- docs/latex/wx/thread.tex | 14 +-- docs/latex/wx/time.tex | 6 +- docs/latex/wx/timer.tex | 14 +-- docs/latex/wx/timespan.tex | 12 +- docs/latex/wx/tnoneng.tex | 2 +- docs/latex/wx/tokenizr.tex | 4 +- docs/latex/wx/toolbar.tex | 16 +-- docs/latex/wx/tprint.tex | 8 +- docs/latex/wx/treectrl.tex | 28 ++--- docs/latex/wx/treeevt.tex | 2 +- docs/latex/wx/treelay.tex | 4 +- docs/latex/wx/tresourc.tex | 2 +- docs/latex/wx/tsizer.tex | 4 +- docs/latex/wx/tsplittr.tex | 10 +- docs/latex/wx/tstring.tex | 2 +- docs/latex/wx/ttab.tex | 2 +- docs/latex/wx/ttoolbar.tex | 24 ++-- docs/latex/wx/tvalidat.tex | 6 +- docs/latex/wx/txrc.tex | 8 +- docs/latex/wx/txtdrptg.tex | 2 +- docs/latex/wx/upduievt.tex | 20 ++-- docs/latex/wx/validatr.tex | 8 +- docs/latex/wx/valtext.tex | 2 +- docs/latex/wx/variant.tex | 8 +- docs/latex/wx/view.tex | 8 +- docs/latex/wx/wave.tex | 14 +-- docs/latex/wx/window.tex | 112 +++++++++--------- docs/latex/wx/wizard.tex | 8 +- docs/latex/wx/wizevt.tex | 8 +- docs/latex/wx/wxstring.tex | 58 +++++----- docs/latex/wx/xmlres.tex | 2 +- docs/latex/wx/xmlresh.tex | 10 +- 220 files changed, 1448 insertions(+), 1448 deletions(-) diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex index fab1e2b05f..f557b8371b 100644 --- a/docs/latex/wx/accel.tex +++ b/docs/latex/wx/accel.tex @@ -155,7 +155,7 @@ Destroys the wxAcceleratorTable object. \constfunc{bool}{Ok}{\void} -Returns TRUE if the accelerator table is valid. +Returns true if the accelerator table is valid. \membersection{wxAcceleratorTable::operator $=$} @@ -186,7 +186,7 @@ equal (a fast test). \wxheading{Return value} -Returns TRUE if the accelerator tables were effectively equal, FALSE otherwise. +Returns true if the accelerator tables were effectively equal, false otherwise. \membersection{wxAcceleratorTable::operator $!=$} @@ -201,6 +201,6 @@ unequal (a fast test). \wxheading{Return value} -Returns TRUE if the accelerator tables were unequal, FALSE otherwise. +Returns true if the accelerator tables were unequal, false otherwise. diff --git a/docs/latex/wx/activevt.tex b/docs/latex/wx/activevt.tex index 5d9c5ff4dc..5f2794ad29 100644 --- a/docs/latex/wx/activevt.tex +++ b/docs/latex/wx/activevt.tex @@ -43,7 +43,7 @@ or a frame becomes inactivate resulting in all application frames being inactive \membersection{wxActivateEvent::wxActivateEvent} -\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{int }{id = 0}} +\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{int }{id = 0}} Constructor. @@ -51,11 +51,11 @@ Constructor. \member{bool}{m\_active} -TRUE if the window or application was activated. +true if the window or application was activated. \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive} \constfunc{bool}{GetActive}{\void} -Returns TRUE if the application or window is being activated, FALSE otherwise. +Returns true if the application or window is being activated, false otherwise. diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index 080164f33c..e54aa88be9 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -91,7 +91,7 @@ This can be used for programming event loops, e.g. This function is called before processing any event and allows the application to preempt the processing of some events. If this method returns $-1$ the event -is processed normally, otherwise either {\tt TRUE} or {\tt FALSE} should be +is processed normally, otherwise either {\tt true} or {\tt false} should be returned and the event processing stops immediately considering that the event had been already processed (for the former return value) or that it is not going to be processed at all (for the latter one). @@ -111,7 +111,7 @@ calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it a \constfunc{bool}{GetAuto3D}{\void} -Returns TRUE if 3D control mode is on, FALSE otherwise. +Returns true if 3D control mode is on, false otherwise. \wxheading{See also} @@ -132,7 +132,7 @@ manner to refer to the application. \constfunc{bool}{GetExitFrameOnDelete}{\void} -Returns TRUE if the application will exit when the top-level window is deleted, FALSE +Returns true if the application will exit when the top-level window is deleted, false otherwise. \wxheading{See also} @@ -159,8 +159,8 @@ function will find the first top-level window (frame or dialog) and return that. \constfunc{bool}{GetUseBestVisual}{\void} -Returns TRUE if the application will use the best visual on systems that support -different visuals, FALSE otherwise. +Returns true if the application will use the best visual on systems that support +different visuals, false otherwise. \wxheading{See also} @@ -184,7 +184,7 @@ the top window. \func{bool}{Initialized}{\void} -Returns TRUE if the application has been initialized (i.e. if\rtfsp +Returns true if the application has been initialized (i.e. if\rtfsp \helpref{wxApp::OnInit}{wxapponinit} has returned successfully). This can be useful for error message routines to determine which method of output is best for the current state of the program (some windowing systems may not like @@ -242,7 +242,7 @@ Returns 0 under X, and the wParam of the WM\_QUIT message under Windows. \func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*cond}, \param{const wxChar }{*msg}} This function is called when an assert failure occurs, i.e. the condition -specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt FALSE}. +specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}. It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as asserts are not left in the release code at all. @@ -279,8 +279,8 @@ Called when command line parsing fails (i.e. an incorrect command line option was specified by the user). The default behaviour is to show the program usage text and abort the program. -Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return -{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program. +Return {\tt true} to continue normal execution or {\tt false} to return +{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program. \wxheading{See also} @@ -293,8 +293,8 @@ Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return Called when the help option ({\tt --help}) was specified on the command line. The default behaviour is to show the program usage text and abort the program. -Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return -{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program. +Return {\tt true} to continue normal execution or {\tt false} to return +{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program. \wxheading{See also} @@ -311,8 +311,8 @@ set from the command line. Don't forget to call the base class version unless you want to suppress processing of the standard command line options. -Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return -{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program. +Return {\tt true} to continue normal execution or {\tt false} to return +{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program. \wxheading{See also} @@ -370,7 +370,7 @@ work and, in fact, probably won't. %% %%Use the EVT\_END\_SESSION event table macro to handle query end session events. %% -%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE argument +%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a true argument %%(forcing the application to close itself silently). %% %%\wxheading{Remarks} @@ -398,7 +398,7 @@ Notice that if you want to to use the command line processing provided by wxWindows you have to call the base class version in the derived class OnInit(). -Return TRUE to continue processing, FALSE to exit the application. +Return true to continue processing, false to exit the application. \membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline} @@ -416,7 +416,7 @@ This is an event handler function called when the operating system or GUI sessio about to close down. Typically, an application will try to save unsaved documents at this point. -If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns TRUE, the application +If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns true, the application is allowed to veto the shutdown by calling \helpref{wxCloseEvent::Veto}{wxcloseeventveto}. The application might veto the shutdown after prompting for documents to be saved, and the user has cancelled the save. @@ -424,12 +424,12 @@ user has cancelled the save. Use the EVT\_QUERY\_END\_SESSION event table macro to handle query end session events. You should check whether the application is forcing the deletion of the window -using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE, +using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is true, destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. If not, it is up to you whether you respond by destroying the window. The default handler calls \helpref{wxWindow::Close}{wxwindowclose} on the top-level window, -and vetoes the shutdown if Close returns FALSE. This will be sufficient for many applications. +and vetoes the shutdown if Close returns false. This will be sufficient for many applications. \wxheading{Remarks} @@ -450,8 +450,8 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO Windows-only function for processing a message. This function is called from the main message loop, checking for windows that -may wish to process it. The function returns TRUE if the message -was processed, FALSE otherwise. If you use wxWindows with another class +may wish to process it. The function returns true if the message +was processed, false otherwise. If you use wxWindows with another class library with its own message loop, you should make sure that this function is called to allow wxWindows to receive messages. For example, to allow co-existence with the Microsoft Foundation Classes, override @@ -462,7 +462,7 @@ the PreTranslateMessage function: BOOL CTheApp::PreTranslateMessage(MSG *msg) { if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg)) - return TRUE; + return true; else return CWinApp::PreTranslateMessage(msg); } @@ -472,7 +472,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg) \func{bool}{Pending}{\void} -Returns TRUE if unprocessed events are in the window system event queue. +Returns true if unprocessed events are in the window system event queue. \wxheading{See also} @@ -491,7 +491,7 @@ Sends idle events to a window and its children. \wxheading{Remarks} These functions poll the top-level windows, and their children, for idle event processing. -If TRUE is returned, more OnIdle processing is requested by one or more window. +If true is returned, more OnIdle processing is requested by one or more window. \wxheading{See also} @@ -519,8 +519,8 @@ Switches automatic 3D controls on or off. \wxheading{Parameters} -\docparam{auto3D}{If TRUE, all controls will be created with 3D appearances unless -overridden for a control or dialog. The default is TRUE} +\docparam{auto3D}{If true, all controls will be created with 3D appearances unless +overridden for a control or dialog. The default is true} \wxheading{Remarks} @@ -550,8 +550,8 @@ top-level frame is deleted. \wxheading{Parameters} -\docparam{flag}{If TRUE (the default), the application will exit when the top-level frame is -deleted. If FALSE, the application will continue to run.} +\docparam{flag}{If true (the default), the application will exit when the top-level frame is +deleted. If false, the application will continue to run.} \wxheading{See also} @@ -606,11 +606,11 @@ This function currently only has effect under GTK. \wxheading{Parameters} -\docparam{flag}{If TRUE, the app will use the best visual.} +\docparam{flag}{If true, the app will use the best visual.} \membersection{wxApp::Yield}\label{wxappyield} -\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = FALSE}} +\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = false}} Yields control to pending messages in the windowing system. This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional @@ -631,6 +631,6 @@ iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}. Calling Yield() recursively is normally an error and an assert failure is raised in debug build if such situation is detected. However if the the -{\it onlyIfNeeded} parameter is {\tt TRUE}, the method will just silently -return {\tt FALSE} instead. +{\it onlyIfNeeded} parameter is {\tt true}, the method will just silently +return {\tt false} instead. diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex index 7c10633888..c493cd1fb7 100644 --- a/docs/latex/wx/array.tex +++ b/docs/latex/wx/array.tex @@ -485,7 +485,7 @@ Return the number of items in the array. \membersection{wxArray::Index}\label{wxarrayindex} -\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = FALSE}} +\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}} \func{int}{Index}{\param{T\& }{item}} @@ -526,7 +526,7 @@ between the overloaded versions of this function. \constfunc{bool}{IsEmpty}{\void} -Returns TRUE if the array is empty, FALSE otherwise. +Returns true if the array is empty, false otherwise. \membersection{wxArray::Item}\label{wxarrayitem} diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 1b706a26af..ea7fec9540 100644 --- a/docs/latex/wx/arrstrng.tex +++ b/docs/latex/wx/arrstrng.tex @@ -84,14 +84,14 @@ Assignment operator. \constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}} -Compares 2 arrays respecting the case. Returns TRUE only if the arrays have +Compares 2 arrays respecting the case. Returns true only if the arrays have the same number of elements and the same strings in the same order. \membersection{wxArrayString::operator!=}\label{wxarraystringoperatornotequal} \constfunc{bool}{operator $!=$}{\param{const wxArrayString\&}{ array}} -Compares 2 arrays respecting the case. Returns TRUE if the arrays have +Compares 2 arrays respecting the case. Returns true if the arrays have different number of elements or if the elements don't match pairwise. \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex} @@ -163,10 +163,10 @@ Returns the number of items in the array. \membersection{wxArrayString::Index}\label{wxarraystringindex} -\func{int}{Index}{\param{const char *}{ sz}, \param{bool}{ bCase = TRUE}, \param{bool}{ bFromEnd = FALSE}} +\func{int}{Index}{\param{const char *}{ sz}, \param{bool}{ bCase = true}, \param{bool}{ bFromEnd = false}} Search the element in the array, starting from the beginning if -{\it bFromEnd} is FALSE or from end otherwise. If {\it bCase}, comparison is +{\it bFromEnd} is false or from end otherwise. If {\it bCase}, comparison is case sensitive (default), otherwise the case is ignored. This function uses linear search for wxArrayString and binary search for @@ -197,7 +197,7 @@ could break the order of items and, for example, subsequent calls to \func{}{IsEmpty}{} -Returns TRUE if the array is empty, FALSE otherwise. This function returns the +Returns true if the array is empty, false otherwise. This function returns the same result as {\it GetCount() == 0} but is probably easier to read. \membersection{wxArrayString::Item}\label{wxarraystringitem} @@ -243,10 +243,10 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man \membersection{wxArrayString::Sort}\label{wxarraystringsort} -\func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}} +\func{void}{Sort}{\param{bool}{ reverseOrder = false}} Sorts the array in alphabetical order or in reverse alphabetical order if -{\it reverseOrder} is TRUE. +{\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 diff --git a/docs/latex/wx/autoobj.tex b/docs/latex/wx/autoobj.tex index 526e05873c..1240c3d49b 100644 --- a/docs/latex/wx/autoobj.tex +++ b/docs/latex/wx/autoobj.tex @@ -12,7 +12,7 @@ gets the current Excel instance, and if it exists, makes the active cell bold. \begin{verbatim} wxAutomationObject excelObject; if (excelObject.GetInstance("Excel.Application")) - excelObject.PutProperty("ActiveCell.Font.Bold", TRUE); + excelObject.PutProperty("ActiveCell.Font.Bold", true); \end{verbatim} } @@ -78,8 +78,8 @@ needing to call GetProperty several times using several temporary objects. For e \constfunc{bool}{CreateInstance}{\param{const wxString\&}{ classId}} -Creates a new object based on the class id, returning TRUE if the object was successfully created, -or FALSE if not. +Creates a new object based on the class id, returning true if the object was successfully created, +or false if not. \membersection{wxAutomationObject::GetDispatchPtr}\label{wxautomationobjectgetdispatchptr} @@ -92,7 +92,7 @@ Gets the IDispatch pointer. \constfunc{bool}{GetInstance}{\param{const wxString\&}{ classId}} Retrieves the current object associated with a class id, and attaches the IDispatch pointer -to this object. Returns TRUE if a pointer was successfully retrieved, FALSE otherwise. +to this object. Returns true if a pointer was successfully retrieved, false otherwise. Note that this cannot cope with two instances of a given OLE object being active simultaneously, such as two copies of Excel running. Which object is referenced cannot currently be specified. @@ -162,7 +162,7 @@ DISPATCH\_METHOD.} \wxheading{Return value} -TRUE if the operation was successful, FALSE otherwise. +true if the operation was successful, false otherwise. \wxheading{Remarks} diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index b5082e5dd8..71e1d47759 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -264,7 +264,7 @@ of possible values.} \wxheading{Return value} -TRUE if the call succeeded, FALSE otherwise. +true if the call succeeded, false otherwise. \wxheading{Remarks} @@ -421,7 +421,7 @@ In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -437,7 +437,7 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me \constfunc{bool}{Ok}{\void} -Returns TRUE if bitmap data is present. +Returns true if bitmap data is present. \membersection{wxBitmap::RemoveHandler} @@ -450,7 +450,7 @@ is not deleted. \wxheading{Return value} -TRUE if the handler was found and removed, FALSE otherwise. +true if the handler was found and removed, false otherwise. \wxheading{See also} @@ -488,7 +488,7 @@ In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -596,7 +596,7 @@ equal (a fast test). \wxheading{Return value} -Returns TRUE if the bitmaps were effectively equal, FALSE otherwise. +Returns true if the bitmaps were effectively equal, false otherwise. \membersection{wxBitmap::operator $!=$} @@ -611,5 +611,5 @@ unequal (a fast test). \wxheading{Return value} -Returns TRUE if the bitmaps were unequal, FALSE otherwise. +Returns true if the bitmaps were unequal, false otherwise. diff --git a/docs/latex/wx/bmphand.tex b/docs/latex/wx/bmphand.tex index 3ba255350b..d8330122bd 100644 --- a/docs/latex/wx/bmphand.tex +++ b/docs/latex/wx/bmphand.tex @@ -60,7 +60,7 @@ of possible values.} \wxheading{Return value} -TRUE if the call succeeded, FALSE otherwise (the default). +true if the call succeeded, false otherwise (the default). \membersection{wxBitmapHandler::GetName} @@ -97,7 +97,7 @@ The meaning of {\it name} is determined by the {\it type} parameter.} \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -123,7 +123,7 @@ Saves a bitmap in the named file. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex index f11d4f97da..74c74cf6c3 100644 --- a/docs/latex/wx/brush.tex +++ b/docs/latex/wx/brush.tex @@ -67,7 +67,7 @@ data using the reference counting, are not affected. \func{}{wxBrush}{\void} Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will -return FALSE. +return false. \func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style}} @@ -147,7 +147,7 @@ Returns a reference to the brush colour. \constfunc{wxBitmap *}{GetStipple}{\void} Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE style, -this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap::Ok}{wxbitmapok} returns FALSE). +this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap::Ok}{wxbitmapok} returns false). \wxheading{See also} @@ -181,7 +181,7 @@ Returns the brush style, one of: \constfunc{bool}{Ok}{\void} -Returns TRUE if the brush is initialised. It will return FALSE if the default +Returns true if the brush is initialised. It will return false if the default constructor has been used (for example, the brush is a member of a class, or NULL has been assigned to it). diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex index a2a6ab8293..068282a468 100644 --- a/docs/latex/wx/calctrl.tex +++ b/docs/latex/wx/calctrl.tex @@ -145,7 +145,7 @@ Gets the currently selected date. \membersection{wxCalendarCtrl::EnableYearChange}\label{wxcalendarctrlenableyearchange} -\func{void}{EnableYearChange}{\param{bool }{enable = TRUE}} +\func{void}{EnableYearChange}{\param{bool }{enable = true}} This function should be used instead of changing {\tt wxCAL\_NO\_YEAR\_CHANGE} style bit directly. It allows or disallows the user to change the year @@ -153,7 +153,7 @@ interactively. \membersection{wxCalendarCtrl::EnableMonthChange}\label{wxcalendarctrlenablemonthchange} -\func{void}{EnableMonthChange}{\param{bool }{enable = TRUE}} +\func{void}{EnableMonthChange}{\param{bool }{enable = true}} This function should be used instead of changing {\tt wxCAL\_NO\_MONTH\_CHANGE} style bit. It allows or disallows the user to @@ -162,7 +162,7 @@ year can not be changed neither. \membersection{wxCalendarCtrl::EnableHolidayDisplay}\label{wxcalendarctrlenableholidaydisplay} -\func{void}{EnableHolidayDisplay}{\param{bool }{display = TRUE}} +\func{void}{EnableHolidayDisplay}{\param{bool }{display = true}} This function should be used instead of changing {\tt wxCAL\_SHOW\_HOLIDAYS} style bit directly. It enables or disables the special highlighting of the @@ -362,37 +362,37 @@ Display the date with this attribute as a holiday. \constfunc{bool}{HasTextColour}{\void} -Returns {\tt TRUE} if this item has a non default text foreground colour. +Returns {\tt true} if this item has a non default text foreground colour. \membersection{wxCalendarDateAttr::HasBackgroundColour}\label{wxcalendardateattrhasbackgroundcolour} \constfunc{bool}{HasBackgroundColour}{\void} -Returns {\tt TRUE} if this attribute specifies a non default text background colour. +Returns {\tt true} if this attribute specifies a non default text background colour. \membersection{wxCalendarDateAttr::HasBorderColour}\label{wxcalendardateattrhasbordercolour} \constfunc{bool}{HasBorderColour}{\void} -Returns {\tt TRUE} if this attribute specifies a non default border colour. +Returns {\tt true} if this attribute specifies a non default border colour. \membersection{wxCalendarDateAttr::HasFont}\label{wxcalendardateattrhasfont} \constfunc{bool}{HasFont}{\void} -Returns {\tt TRUE} if this attribute specifies a non default font. +Returns {\tt true} if this attribute specifies a non default font. \membersection{wxCalendarDateAttr::HasBorder}\label{wxcalendardateattrhasborder} \constfunc{bool}{HasBorder}{\void} -Returns {\tt TRUE} if this attribute specifies a non default (i.e. any) border. +Returns {\tt true} if this attribute specifies a non default (i.e. any) border. \membersection{wxCalendarDateAttr::IsHoliday}\label{wxcalendardateattrisholiday} \constfunc{bool}{IsHoliday}{\void} -Returns {\tt TRUE} if this attribute specifies that this item should be +Returns {\tt true} if this attribute specifies that this item should be displayed as a holiday. \membersection{wxCalendarDateAttr::GetTextColour}\label{wxcalendardateattrgettextcolour} diff --git a/docs/latex/wx/caret.tex b/docs/latex/wx/caret.tex index 9252196b3a..451741f38a 100644 --- a/docs/latex/wx/caret.tex +++ b/docs/latex/wx/caret.tex @@ -108,21 +108,21 @@ Get the window the caret is associated with. \func{void}{Hide}{\void} -Same as \helpref{wxCaret::Show(FALSE)}{wxcaretshow}. +Same as \helpref{wxCaret::Show(false)}{wxcaretshow}. \membersection{wxCaret::IsOk}\label{wxcaretisok} \constfunc{bool}{IsOk}{\void} -Returns TRUE if the caret was created successfully. +Returns true if the caret was created successfully. \membersection{wxCaret::IsVisible}\label{wxcaretisvisible} \constfunc{bool}{IsVisible}{\void} -Returns TRUE if the caret is visible and FALSE if it is permanently +Returns true if the caret is visible and false if it is permanently hidden (if it is is blinking and not shown currently but will be after the -next blink, this method still returns TRUE). +next blink, this method still returns true). \membersection{wxCaret::Move}\label{wxcaretmove} @@ -158,7 +158,7 @@ Changes the size of the caret. \membersection{wxCaret::Show}\label{wxcaretshow} -\func{void}{Show}{\param{bool }{show = TRUE}} +\func{void}{Show}{\param{bool }{show = true}} Shows or hides the caret. Notice that if the caret was hidden $N$ times, it must be shown $N$ times as well to reappear on the screen. diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex index e84881d0fa..b8d77fdc5e 100644 --- a/docs/latex/wx/checkbox.tex +++ b/docs/latex/wx/checkbox.tex @@ -93,7 +93,7 @@ Gets the state of the checkbox. \wxheading{Return value} -Returns {\tt TRUE} if it is checked, {\tt FALSE} otherwise. +Returns {\tt true} if it is checked, {\tt false} otherwise. \membersection{wxCheckBox::IsChecked}\label{wxcheckboxischecked} @@ -101,7 +101,7 @@ Returns {\tt TRUE} if it is checked, {\tt FALSE} otherwise. This is just a maybe more readable synonym for \helpref{GetValue}{wxcheckboxgetvalue}: just as the latter, it returns -{\tt TRUE} if the checkbox is checked and {\tt FALSE} otherwise. +{\tt true} if the checkbox is checked and {\tt false} otherwise. \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue} @@ -112,5 +112,5 @@ wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted. \wxheading{Parameters} -\docparam{state}{If {\tt TRUE}, the check is on, otherwise it is off.} +\docparam{state}{If {\tt true}, the check is on, otherwise it is off.} diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex index a66f7c944d..c88c7c0641 100644 --- a/docs/latex/wx/checklst.tex +++ b/docs/latex/wx/checklst.tex @@ -87,7 +87,7 @@ Destructor, destroying the list box. \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck} -\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}} +\func{void}{Check}{\param{int }{item}, \param{bool}{ check = true}} Checks the given item. Note that calling this method doesn't result in wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted. @@ -96,13 +96,13 @@ wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted. \docparam{item}{Index of item to check.} -\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.} +\docparam{check}{true if the item is to be checked, false otherwise.} \membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked} \constfunc{bool}{IsChecked}{\param{int}{ item}} -Returns TRUE if the given item is checked, FALSE otherwise. +Returns true if the given item is checked, false otherwise. \wxheading{Parameters} diff --git a/docs/latex/wx/clasinfo.tex b/docs/latex/wx/clasinfo.tex index 66a1bd1f63..daaf95423e 100644 --- a/docs/latex/wx/clasinfo.tex +++ b/docs/latex/wx/clasinfo.tex @@ -74,6 +74,6 @@ of IsKindOf. Called in base wxWindows library initialization. \func{bool}{IsKindOf}{\param{wxClassInfo* }{info}} -Returns TRUE if this class is a kind of (inherits from) the given class. +Returns true if this class is a kind of (inherits from) the given class. diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex index f7799f706a..7789b64788 100644 --- a/docs/latex/wx/clipbrd.tex +++ b/docs/latex/wx/clipbrd.tex @@ -7,7 +7,7 @@ To use the clipboard, you call member functions of the global {\bf wxTheClipboar See also the \helpref{wxDataObject overview}{wxdataobjectoverview} for further information. -Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns TRUE, you +Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns true, you now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data on the clipboard, or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close @@ -97,26 +97,26 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip Flushes the clipboard: this means that the data which is currently on clipboard will stay available even after the application exits (possibly eating memory), otherwise the clipboard will be emptied on exit. -Returns FALSE if the operation is unsuccesful for any reason. +Returns false if the operation is unsuccesful for any reason. \membersection{wxClipboard::GetData}\label{wxclipboardgetdata} \func{bool}{GetData}{\param{wxDataObject\&}{ data}} Call this function to fill {\it data} with data on the clipboard, if available in the required -format. Returns TRUE on success. +format. Returns true on success. \membersection{wxClipboard::IsOpened}\label{wxclipboardisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the clipboard has been opened. +Returns true if the clipboard has been opened. \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported} \func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}} -Returns TRUE if the format of the given data object is available on the clipboard. +Returns true if the format of the given data object is available on the clipboard. \membersection{wxClipboard::Open}\label{wxclipboardopen} @@ -128,7 +128,7 @@ and \helpref{wxClipboard::GetData}{wxclipboardgetdata}. Call \helpref{wxClipboard::Close}{wxclipboardclose} when you have finished with the clipboard. You should keep the clipboard open for only a very short time. -Returns TRUE on success. This should be tested (as in the sample shown above). +Returns true on success. This should be tested (as in the sample shown above). \membersection{wxClipboard::SetData}\label{wxclipboardsetdata} @@ -147,10 +147,10 @@ the data explicitly. \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary} -\func{void}{UsePrimarySelection}{\param{bool}{ primary = TRUE}} +\func{void}{UsePrimarySelection}{\param{bool}{ primary = true}} On platforms supporting it (currently only GTK), selects the so called PRIMARY SELECTION as the clipboard as opposed to the normal clipboard, -if {\it primary} is TRUE. +if {\it primary} is true. diff --git a/docs/latex/wx/closeevt.tex b/docs/latex/wx/closeevt.tex index ee993ebcc2..4a70a1707d 100644 --- a/docs/latex/wx/closeevt.tex +++ b/docs/latex/wx/closeevt.tex @@ -8,13 +8,13 @@ also be invoked by the application itself programmatically, for example by calling the \helpref{wxWindow::Close}{wxwindowclose} function. You should check whether the application is forcing the deletion of the window -using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}. If this is {\tt FALSE}, +using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}. If this is {\tt false}, you {\it must} destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. -If the return value is TRUE, it is up to you whether you respond by destroying the window. +If the return value is true, it is up to you whether you respond by destroying the window. If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function -to return {\tt TRUE} or {\tt FALSE} depending on whether the close instruction was honoured or not. +to return {\tt true} or {\tt false} depending on whether the close instruction was honoured or not. \wxheading{Derived from} @@ -59,7 +59,7 @@ Constructor. \func{bool}{CanVeto}{\void} -Returns TRUE if you can veto a system shutdown or a window close event. +Returns true if you can veto a system shutdown or a window close event. Vetoing a window close event is not possible if the calling code wishes to force the application to exit, and so this function must be called to check this. @@ -67,19 +67,19 @@ force the application to exit, and so this function must be called to check this \constfunc{bool}{GetLoggingOff}{\void} -Returns TRUE if the user is logging off. +Returns true if the user is logging off. \membersection{wxCloseEvent::GetSessionEnding}\label{wxcloseeventgetsessionending} \constfunc{bool}{GetSessionEnding}{\void} -Returns TRUE if the session is ending. +Returns true if the session is ending. \membersection{wxCloseEvent::GetForce}\label{wxcloseeventgetforce} \constfunc{bool}{GetForce}{\void} -Returns TRUE if the application wishes to force the window to close. +Returns true if the application wishes to force the window to close. This will shortly be obsolete, replaced by CanVeto. \membersection{wxCloseEvent::SetCanVeto}\label{wxcloseeventsetcanveto} @@ -102,12 +102,12 @@ Sets the 'logging off' flag. \membersection{wxCloseEvent::Veto}\label{wxcloseeventveto} -\func{void}{Veto}{\param{bool}{ veto = TRUE}} +\func{void}{Veto}{\param{bool}{ veto = true}} Call this from your event handler to veto a system shutdown or to signal to the calling application that a window close did not happen. You can only veto a shutdown if \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns -TRUE. +true. diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex index 68a25f736a..dfba91d860 100644 --- a/docs/latex/wx/cmdevent.tex +++ b/docs/latex/wx/cmdevent.tex @@ -113,8 +113,8 @@ Contains a string corresponding to a listbox or choice selection. \member{long}{m\_extraLong} Extra information. If the event comes from a listbox selection, it is -a boolean determining whether the event was a selection (TRUE) or a -deselection (FALSE). A listbox deselection only occurs for +a boolean determining whether the event was a selection (true) or a +deselection (false). A listbox deselection only occurs for multiple-selection boxes, and in this case the index and string values are indeterminate and the listbox must be examined by the application. @@ -168,7 +168,7 @@ a deselection). \constfunc{bool}{IsChecked}{\void} This method can be used with checkbox and menu events: for the checkboxes, the -method returns {\tt TRUE} for a selection event and {\tt FALSE} for a +method returns {\tt true} for a selection event and {\tt false} for a deselection one. For the menu events, this method indicates if the menu item just has become checked or unchecked (and thus only makes sense for checkable menu items). @@ -177,7 +177,7 @@ menu items). \func{bool}{IsSelection}{\void} -For a listbox or choice event, returns TRUE if it is a selection, FALSE if it +For a listbox or choice event, returns true if it is a selection, false if it is a deselection. \membersection{wxCommandEvent::SetClientData} diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index 89b3ce8057..8cbd7ccd89 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -227,8 +227,8 @@ For a simple switch, you will simply call \helpref{Found}{wxcmdlineparserfoundswitch} to determine if the switch was given or not, for an option or a parameter, you will call a version of {\tt Found()} which also returns the associated value in the provided variable. All -{\tt Found()} functions return TRUE if the switch or option were found in the -command line or FALSE if they were not specified. +{\tt Found()} functions return true if the switch or option were found in the +command line or false if they were not specified. %%%%%%%%%%%%% Methods in alphabetic order %%%%%%%%%%%%% \helponly{\insertatlevel{2}{ @@ -326,7 +326,7 @@ start. Default is {\tt "-"} for Unix, {\tt "-/"} for Windows. \membersection{wxCmdLineParser::EnableLongOptions}\label{wxcmdlineparserenablelongoptions} -\func{void}{EnableLongOptions}{\param{bool }{enable = TRUE}} +\func{void}{EnableLongOptions}{\param{bool }{enable = true}} Enable or disable support for the long options. @@ -341,13 +341,13 @@ them. \func{void}{DisableLongOptions}{\void} -Identical to \helpref{EnableLongOptions(FALSE)}{wxcmdlineparserenablelongoptions}. +Identical to \helpref{EnableLongOptions(false)}{wxcmdlineparserenablelongoptions}. \membersection{wxCmdLineParser::AreLongOptionsEnabled}\label{wxcmdlineparserarelongoptionsenabled} \func{bool}{AreLongOptionsEnabled}{\void} -Returns TRUE if long options are enabled, otherwise FALSE. +Returns true if long options are enabled, otherwise false. \wxheading{See also} @@ -415,7 +415,7 @@ Add a parameter of the given {\it type} to the command line description. \membersection{wxCmdLineParser::Parse}\label{wxcmdlineparserparse} -\func{int}{Parse}{\param{bool }{giveUsage = {\tt TRUE}}} +\func{int}{Parse}{\param{bool }{giveUsage = {\tt true}}} Parse the command line, return $0$ if ok, $-1$ if {\tt "-h"} or {\tt "--help"} option was encountered and the help message was given or a positive value if a @@ -423,9 +423,9 @@ syntax error occured. \wxheading{Parameters} -\docparam{giveUsage}{If {\tt TRUE} (default), the usage message is given if a +\docparam{giveUsage}{If {\tt true} (default), the usage message is given if a syntax error was encountered while parsing the command line or if help was -requested. If {\tt FALSE}, only error messages about possible syntax errors +requested. If {\tt false}, only error messages about possible syntax errors are given, use \helpref{Usage}{wxcmdlineparserusage} to show the usage message from the caller if needed.} @@ -445,27 +445,27 @@ will not be helpful to the user unless the descriptions were indeed specified. \constfunc{bool}{Found}{\param{const wxString\& }{name}} -Returns TRUE if the given switch was found, FALSE otherwise. +Returns true if the given switch was found, false otherwise. \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundstringoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{wxString* }{value}} -Returns TRUE if an option taking a string value was found and stores the +Returns true if an option taking a string value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundintoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{long* }{value}} -Returns TRUE if an option taking an integer value was found and stores +Returns true if an option taking an integer value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfounddateoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{wxDateTime* }{value}} -Returns TRUE if an option taking a date value was found and stores the +Returns true if an option taking a date value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::GetParamCount}\label{wxcmdlineparsergetparamcount} diff --git a/docs/latex/wx/cmdproc.tex b/docs/latex/wx/cmdproc.tex index 3dbce86100..e9509feab4 100644 --- a/docs/latex/wx/cmdproc.tex +++ b/docs/latex/wx/cmdproc.tex @@ -38,7 +38,7 @@ Destructor. \func{virtual bool}{CanUndo}{\void} -Returns TRUE if the currently-active command can be undone, FALSE otherwise. +Returns true if the currently-active command can be undone, false otherwise. \membersection{wxCommandProcessor::ClearCommands} @@ -132,7 +132,7 @@ Sets the string that will be appended to the Undo menu item. \membersection{wxCommandProcessor::Submit} -\func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = TRUE}} +\func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = true}} Submits a new command to the command processor. The command processor calls wxCommand::Do to execute the command; if it succeeds, the command diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 06171474d8..6e52405916 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -106,7 +106,7 @@ Returns the green intensity. \constfunc{bool}{Ok}{\void} -Returns TRUE if the colour object is valid (the colour has been initialised with RGB values). +Returns true if the colour object is valid (the colour has been initialised with RGB values). \membersection{wxColour::Red}\label{wxcolourred} @@ -169,7 +169,7 @@ This class holds a variety of information related to colour dialogs. \func{}{wxColourData}{\void} Constructor. Initializes the custom colours to white, the {\it data colour} setting -to black, and the {\it choose full} setting to TRUE. +to black, and the {\it choose full} setting to true. \membersection{wxColourData::\destruct{wxColourData}} @@ -184,7 +184,7 @@ Destructor. Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. Has no meaning under other platforms. -The default value is TRUE. +The default value is true. \membersection{wxColourData::GetColour}\label{wxcolourdatagetcolour} @@ -210,7 +210,7 @@ The default custom colours are all white. Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. Under other platforms, has no effect. -The default value is TRUE. +The default value is true. \membersection{wxColourData::SetColour}\label{wxcolourdatasetcolour} diff --git a/docs/latex/wx/command.tex b/docs/latex/wx/command.tex index 1514c1da2c..9c1f7bddd4 100644 --- a/docs/latex/wx/command.tex +++ b/docs/latex/wx/command.tex @@ -21,7 +21,7 @@ change the data or view. \membersection{wxCommand::wxCommand} -\func{}{wxCommand}{\param{bool}{ canUndo = FALSE}, \param{const wxString\& }{name = NULL}} +\func{}{wxCommand}{\param{bool}{ canUndo = false}, \param{const wxString\& }{name = NULL}} Constructor. wxCommand is an abstract class, so you will need to derive a new class and call this constructor from your own constructor. @@ -43,15 +43,15 @@ Destructor. \func{bool}{CanUndo}{\void} -Returns TRUE if the command can be undone, FALSE otherwise. +Returns true if the command can be undone, false otherwise. \membersection{wxCommand::Do} \func{bool}{Do}{\void} Override this member function to execute the appropriate action when called. -Return TRUE to indicate that the action has taken place, FALSE otherwise. -Returning FALSE will indicate to the command processor that the action is +Return true to indicate that the action has taken place, false otherwise. +Returning false will indicate to the command processor that the action is not undoable and should not be added to the command history. \membersection{wxCommand::GetName} @@ -65,8 +65,8 @@ Returns the command name. \func{bool}{Undo}{\void} Override this member function to un-execute a previous Do. -Return TRUE to indicate that the action has taken place, FALSE otherwise. -Returning FALSE will indicate to the command processor that the action is +Return true to indicate that the action has taken place, false otherwise. +Returning false will indicate to the command processor that the action is not redoable and no change should be made to the command history. How you implement this command is totally application dependent, but typical diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex index d21d31e55b..426e551d7d 100644 --- a/docs/latex/wx/conditn.tex +++ b/docs/latex/wx/conditn.tex @@ -156,7 +156,7 @@ the thread before calling this method. \wxheading{Return value} -The second form returns {\tt TRUE} if the condition has been signalled, or -{\tt FALSE} if it returned because the timeout has elapsed. +The second form returns {\tt true} if the condition has been signalled, or +{\tt false} if it returned because the timeout has elapsed. diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index b00e4624c6..dd1c906ac2 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -183,7 +183,7 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under \membersection{Enumeration} The functions in this section allow to enumerate all entries and groups in the -config file. All functions here return FALSE when there are no more items. +config file. All functions here return false when there are no more items. You must pass the same index to GetNext and GetFirst (don't modify it). Please note that it is {\bf not} the index of the current item (you will have @@ -276,7 +276,7 @@ arbitrary path (either relative or absolute), not just the key name. \membersection{Rename entries/groups} The functions in this section allow to rename entries or subgroups of the -current group. They will return FALSE on error. typically because either the +current group. They will return false on error. typically because either the entry/group with the original name doesn't exist, because the entry/group with the new name already exists or because the function is not supported in this wxConfig implementation. @@ -315,8 +315,8 @@ the call to {\tt config->Read("UserData")} will return something like Although this feature is very useful, it may be annoying if you read a value which containts '\$' or '\%' symbols (\% is used for environment variables expansion under Windows) which are not used for environment variable -expansion. In this situation you may call SetExpandEnvVars(FALSE) just before -reading this value and SetExpandEnvVars(TRUE) just after. Another solution +expansion. In this situation you may call SetExpandEnvVars(false) just before +reading this value and SetExpandEnvVars(true) just after. Another solution would be to prefix the offending symbols with a backslash. The following functions control this option: @@ -419,7 +419,7 @@ for use by desinstallation routine. \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry} -\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = TRUE}} +\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = true}} Deletes the specified entry and the group it belongs to if it was the last key in it and the second parameter is true. @@ -434,21 +434,21 @@ Delete the group (with all subgroups) \constfunc{bool}{Exists}{\param{wxString\& }{strName}} -returns TRUE if either a group or an entry with a given name exists +returns true if either a group or an entry with a given name exists \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush} -\func{bool}{Flush}{\param{bool }{bCurrentOnly = FALSE}} +\func{bool}{Flush}{\param{bool }{bCurrentOnly = false}} permanently writes all changes (otherwise, they're only written from object's destructor) \membersection{wxConfigBase::Get}\label{wxconfigbaseget} -\func{static wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = TRUE}} +\func{static wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = true}} Get the current config object. If there is no current object and -{\it CreateOnDemand} is TRUE, creates one +{\it CreateOnDemand} is true, creates one (using {\it Create}) unless DontCreateOnDemand was called previously. \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname} @@ -534,11 +534,11 @@ and returns a 3-element list {\tt ( continue, str, index )}.} \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries} -\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}} +\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = false}} \membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups} -\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}} +\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = false}} Get number of entries/subgroups in the current group, with or without its subgroups. @@ -559,31 +559,31 @@ Returns the vendor name. \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}} -returns TRUE if the entry by this name exists +returns true if the entry by this name exists \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup} \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}} -returns TRUE if the group by this name exists +returns true if the group by this name exists \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars} \constfunc{bool}{IsExpandingEnvVars}{\void} -Returns TRUE if we are expanding environment variables in key values. +Returns true if we are expanding environment variables in key values. \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults} \constfunc{bool}{IsRecordingDefaults}{\void} -Returns TRUE if we are writing defaults back to the config file. +Returns true if we are writing defaults back to the config file. \membersection{wxConfigBase::Read}\label{wxconfigbaseread} \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}} -Read a string from the key, returning TRUE if the value was read. If the key +Read a string from the key, returning true if the value was read. If the key was not found, {\it str} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}} @@ -591,7 +591,7 @@ was not found, {\it str} is not changed. Read a string from the key. The default value is returned if the key was not found. -Returns TRUE if value was really read, FALSE if the default was used. +Returns true if value was really read, false if the default was used. \constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const wxString\& }{defaultVal}} @@ -600,13 +600,13 @@ Another version of {\it Read()}, returning the string value directly. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}} -Reads a long value, returning TRUE if the value was found. If the value was +Reads a long value, returning true if the value was found. If the value was not found, {\it l} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}, \param{long}{ defaultVal}} -Reads a long value, returning TRUE if the value was found. If the value was +Reads a long value, returning true if the value was found. If the value was not found, {\it defaultVal} is used instead. \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}} @@ -633,24 +633,24 @@ won't work because the call is ambiguous: compiler can not choose between two \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}} -Reads a double value, returning TRUE if the value was found. If the value was +Reads a double value, returning true if the value was found. If the value was not found, {\it d} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}, \param{double}{ defaultVal}} -Reads a double value, returning TRUE if the value was found. If the value was +Reads a double value, returning true if the value was found. If the value was not found, {\it defaultVal} is used instead. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}} -Reads a bool value, returning TRUE if the value was found. If the value was +Reads a bool value, returning true if the value was found. If the value was not found, {\it b} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d}, \param{bool}{ defaultVal}} -Reads a bool value, returning TRUE if the value was found. If the value was +Reads a bool value, returning true if the value was found. If the value was not found, {\it defaultVal} is used instead. \pythonnote{In place of a single overloaded method name, wxPython @@ -679,7 +679,7 @@ Renames an entry in the current group. The entries names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. -Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already +Returns false if the {\it oldName} doesn't exist or if {\it newName} already exists. \membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup} @@ -690,7 +690,7 @@ Renames a subgroup of the current group. The subgroup names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. -Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already +Returns false if the {\it oldName} doesn't exist or if {\it newName} already exists. \membersection{wxConfigBase::Set}\label{wxconfigbaseset} @@ -702,7 +702,7 @@ current object (both the parameter and returned value may be NULL) \membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars} -\func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}} +\func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = true}} Determine whether we wish to expand environment variables in key values. @@ -716,7 +716,7 @@ exist it is created. \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults} -\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}} +\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}} Sets whether defaults are recorded to the config file whenever an attempt to read read the value which is not present in it is done. @@ -749,7 +749,7 @@ value}} \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}} -These functions write the specified value to the config file and return TRUE +These functions write the specified value to the config file and return true on success. \pythonnote{In place of a single overloaded method name, wxPython diff --git a/docs/latex/wx/cshelp.tex b/docs/latex/wx/cshelp.tex index 296585a022..485d69f858 100644 --- a/docs/latex/wx/cshelp.tex +++ b/docs/latex/wx/cshelp.tex @@ -39,10 +39,10 @@ Normally you will write your application so that this button is only added to a \membersection{wxContextHelp::wxContextHelp} -\func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = TRUE}} +\func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = true}} Constructs a context help object, calling \helpref{BeginContextHelp}{wxcontexthelpbegincontexthelp} if\rtfsp -{\it doNow} is TRUE (the default). +{\it doNow} is true (the default). If {\it window} is NULL, the top window is used. @@ -59,7 +59,7 @@ Destroys the context help object. Puts the application into context-sensitive help mode. {\it window} is the window which will be used to catch events; if NULL, the top window will be used. -Returns TRUE if the application was successfully put into context-sensitive help mode. +Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished. \membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp} diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex index 06a4f57ba9..55d6c1ac36 100644 --- a/docs/latex/wx/ctrlsub.tex +++ b/docs/latex/wx/ctrlsub.tex @@ -222,7 +222,7 @@ selected. \constfunc{bool}{IsEmpty}{\void} -Returns {\tt TRUE} if the control is empty or {\tt FALSE} if it has some items. +Returns {\tt true} if the control is empty or {\tt false} if it has some items. \wxheading{See also} diff --git a/docs/latex/wx/cursor.tex b/docs/latex/wx/cursor.tex index cbcf7afe04..2fa3d65d47 100644 --- a/docs/latex/wx/cursor.tex +++ b/docs/latex/wx/cursor.tex @@ -187,7 +187,7 @@ it is best to clean them up explicitly. \constfunc{bool}{Ok}{\void} -Returns TRUE if cursor data is present. +Returns true if cursor data is present. \membersection{wxCursor::operator $=$}\label{wxcursorassignment} diff --git a/docs/latex/wx/database.tex b/docs/latex/wx/database.tex index 2f860c64d1..ebbc51279a 100644 --- a/docs/latex/wx/database.tex +++ b/docs/latex/wx/database.tex @@ -81,7 +81,7 @@ Commits previous transactions. Not implemented. \func{bool}{ErrorOccured}{\void} -Returns TRUE if the last action caused an error. +Returns true if the last action caused an error. \membersection{wxDatabase::ErrorSnapshot} @@ -159,7 +159,7 @@ Returns the ODBC environment handle. \func{bool}{GetInfo}{\param{long}{ infoType}, \param{const wxString\& }{buf}, \param{int}{ bufSize=-1}} -Returns requested information. The return value is TRUE if successful, FALSE otherwise. +Returns requested information. The return value is true if successful, false otherwise. {\it infoType} is an ODBC identifier specifying the type of information to be returned. @@ -183,11 +183,11 @@ Returns the current username. \membersection{wxDatabase::GetODBCVersionFloat} -\func{float}{GetODBCVersionFloat}{\param{bool}{ implementation=TRUE}} +\func{float}{GetODBCVersionFloat}{\param{bool}{ implementation=true}} Returns the version of ODBC in floating point format, e.g. 2.50. -{\it implementation} should be TRUE to get the DLL version, or FALSE to get the +{\it implementation} should be true to get the DLL version, or false to get the version defined in the {\tt sql.h} header file. This function can return the value 0.0 if the header version number is not defined (for early @@ -195,11 +195,11 @@ versions of ODBC). \membersection{wxDatabase::GetODBCVersionString} -\func{wxString}{GetODBCVersionString}{\param{bool}{ implementation=TRUE}} +\func{wxString}{GetODBCVersionString}{\param{bool}{ implementation=true}} Returns the version of ODBC in string format, e.g. ``02.50". -{\it implementation} should be TRUE to get the DLL version, or FALSE to get the +{\it implementation} should be true to get the DLL version, or false to get the version defined in the {\tt sql.h} header file. This function can return the value ``00.00" if the header version number is not defined (for early @@ -215,11 +215,11 @@ Not implemented. \func{bool}{IsOpen}{\void} -Returns TRUE if a connection is open. +Returns true if a connection is open. \membersection{wxDatabase::Open}\label{wxdatabaseopen} -\func{bool}{Open}{\param{const wxString\& }{datasource}, \param{bool}{ exclusive = FALSE}, \param{bool }{readOnly = TRUE}, +\func{bool}{Open}{\param{const wxString\& }{datasource}, \param{bool}{ exclusive = false}, \param{bool }{readOnly = true}, \param{const wxString\& }{username = ``ODBC"}, \param{const wxString\& }{password = ``"}} Connect to a data source. {\it datasource} contains the name of the ODBC data diff --git a/docs/latex/wx/dataform.tex b/docs/latex/wx/dataform.tex index bf80cd95d0..e21c34b4bd 100644 --- a/docs/latex/wx/dataform.tex +++ b/docs/latex/wx/dataform.tex @@ -87,13 +87,13 @@ Constructs a data format object for a custom format identified by its name \constfunc{bool}{operator $==$}{\param{const wxDataFormat\&}{ format}} -Returns TRUE if the formats are equal. +Returns true if the formats are equal. \membersection{wxDataFormat::operator $!=$}\label{wxdataformatoperatorneq} \constfunc{bool}{operator $!=$}{\param{const wxDataFormat\&}{ format}} -Returns TRUE if the formats are different. +Returns true if the formats are different. \membersection{wxDataFormat::GetId}\label{wxdataformatgetid} diff --git a/docs/latex/wx/dataobj.tex b/docs/latex/wx/dataobj.tex index 3366463cbf..066447ba1b 100644 --- a/docs/latex/wx/dataobj.tex +++ b/docs/latex/wx/dataobj.tex @@ -167,7 +167,7 @@ in list context it returns a list containing all the supported formats.} \constfunc{virtual bool}{GetDataHere}{\param{const wxDataFormat\&}{ format}, \param{void }{*buf} } The method will write the data of the format {\it format} in the buffer {\it -buf} and return TRUE on success, FALSE on failure. +buf} and return true on success, false on failure. \membersection{wxDataObject::GetDataSize}\label{wxdataobjectgetdatasize} @@ -196,5 +196,5 @@ native format of the wxDataObject. Set the data in the format {\it format} of the length {\it len} provided in the buffer {\it buf}. -Returns TRUE on success, FALSE on failure. +Returns true on success, false on failure. diff --git a/docs/latex/wx/date.tex b/docs/latex/wx/date.tex index c09e0d66da..bd01fbf511 100644 --- a/docs/latex/wx/date.tex +++ b/docs/latex/wx/date.tex @@ -202,7 +202,7 @@ Returns the date representing the first day of the year. \constfunc{bool}{IsLeapYear}{\void} -Returns TRUE if the year of this date is a leap year. +Returns true if the year of this date is a leap year. \membersection{wxDate::Set}\label{wxdateset} @@ -245,7 +245,7 @@ Sets the current format type. \membersection{wxDate::SetOption}\label{wxdatesetoption} -\func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=TRUE}} +\func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=true}} Enables or disables an option for formatting. @@ -315,37 +315,37 @@ Decrements the date (postfix or prefix). \func{friend bool}{operator $<$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is earlier than {\it date2}. +Function to compare two dates, returning true if {\it date1} is earlier than {\it date2}. \membersection{wxDate::operator $<=$}\label{wxdatelessthaneq} \func{friend bool}{operator $<=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is earlier than or equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is earlier than or equal to {\it date2}. \membersection{wxDate::operator $>$}\label{wxdategreaterthan} \func{friend bool}{operator $>$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is later than {\it date2}. +Function to compare two dates, returning true if {\it date1} is later than {\it date2}. \membersection{wxDate::operator $>=$}\label{wxdategreaterthaneq} \func{friend bool}{operator $>=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is later than or equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is later than or equal to {\it date2}. \membersection{wxDate::operator $==$}\label{wxdateequals} \func{friend bool}{operator $==$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is equal to {\it date2}. \membersection{wxDate::operator $!=$}\label{wxdatenotequals} \func{friend bool}{operator $!=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is not equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is not equal to {\it date2}. \membersection{wxDate::operator \cinsert}\label{wxdateinsert} diff --git a/docs/latex/wx/datespan.tex b/docs/latex/wx/datespan.tex index 2258fad9a3..6fba885f1f 100644 --- a/docs/latex/wx/datespan.tex +++ b/docs/latex/wx/datespan.tex @@ -307,7 +307,7 @@ Returns a date span object corresponding to the given number of years. \constfunc{bool}{operator$==$}{\param{wxDateSpan\&}{ other}} -Returns {\tt TRUE} if this date span is equal to the other one. Two date spans +Returns {\tt true} if this date span is equal to the other one. Two date spans are considered equal if and only if they have the same number of years and months and the same total number of days (counting both days and weeks). @@ -316,7 +316,7 @@ months and the same total number of days (counting both days and weeks). \constfunc{bool}{operator$!=$}{\param{wxDateSpan\&}{ other}} -Returns {\tt TRUE} if this date span is different from the other one. +Returns {\tt true} if this date span is different from the other one. \wxheading{See also} diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex index 9de18864b2..c68991c7ab 100644 --- a/docs/latex/wx/datetime.tex +++ b/docs/latex/wx/datetime.tex @@ -533,7 +533,7 @@ given week day. \func{static bool}{IsLeapYear}{\param{int }{year = Inv\_Year}, \param{Calendar }{cal = Gregorian}} -Returns {\tt TRUE} if the {\it year} is a leap one in the specified calendar. +Returns {\tt true} if the {\it year} is a leap one in the specified calendar. This functions supports Gregorian and Julian calendars. @@ -541,7 +541,7 @@ This functions supports Gregorian and Julian calendars. \func{static bool}{IsWestEuropeanCountry}{\param{Country }{country = Country\_Default}} -This function returns {\tt TRUE} if the specified (or default) country is one +This function returns {\tt true} if the specified (or default) country is one of Western European ones. It is used internally by wxDateTime to determine the DST convention and date and time formatting rules. @@ -549,7 +549,7 @@ DST convention and date and time formatting rules. \func{static bool}{IsDSTApplicable}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}} -Returns {\tt TRUE} if DST was used n the given year (the current one by +Returns {\tt true} if DST was used n the given year (the current one by default) in the given country. \membersection{wxDateTime::Now}\label{wxdatetimenow} @@ -779,7 +779,7 @@ Same as \helpref{Set}{wxdatetimesettm}. \constfunc{bool}{IsValid}{\void} -Returns {\tt TRUE} if the object represents a valid time moment. +Returns {\tt true} if the object represents a valid time moment. \membersection{wxDateTime::GetTm}\label{wxdatetimegettm} @@ -874,13 +874,13 @@ both conventions for the week start. See the description of these \constfunc{bool}{IsWorkDay}{\param{Country }{country = Country\_Default}} -Returns {\tt TRUE} is this day is not a holiday in the given country. +Returns {\tt true} is this day is not a holiday in the given country. \membersection{wxDateTime::IsGregorianDate}\label{wxdatetimeisgregoriandate} \constfunc{bool}{IsGregorianDate}{\param{GregorianAdoption }{country = Gr\_Standard}} -Returns {\tt TRUE} if the given date os later than the date of adoption of the +Returns {\tt true} if the given date os later than the date of adoption of the Gregorian calendar in the given country (and hence the Gregorian calendar calculations make sense for it). @@ -908,25 +908,25 @@ format. \constfunc{bool}{IsEqualTo}{\param{const wxDateTime\& }{datetime}} -Returns {\tt TRUE} if the two dates are strictly identical. +Returns {\tt true} if the two dates are strictly identical. \membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan} \constfunc{bool}{IsEarlierThan}{\param{const wxDateTime\& }{datetime}} -Returns {\tt TRUE} if this date precedes the given one. +Returns {\tt true} if this date precedes the given one. \membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan} \constfunc{bool}{IsLaterThan}{\param{const wxDateTime\& }{datetime}} -Returns {\tt TRUE} if this date is later than the given one. +Returns {\tt true} if this date is later than the given one. \membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween} \constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}} -Returns {\tt TRUE} if this date lies strictly between the two others, +Returns {\tt true} if this date lies strictly between the two others, \wxheading{See also} @@ -936,8 +936,8 @@ Returns {\tt TRUE} if this date lies strictly between the two others, \constfunc{bool}{IsBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}} -Returns {\tt TRUE} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween} -is {\tt TRUE} or if the date is equal to one of the limit values. +Returns {\tt true} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween} +is {\tt true} or if the date is equal to one of the limit values. \wxheading{See also} @@ -947,19 +947,19 @@ is {\tt TRUE} or if the date is equal to one of the limit values. \constfunc{bool}{IsSameDate}{\param{const wxDateTime\& }{dt}} -Returns {\tt TRUE} if the date is the same without comparing the time parts. +Returns {\tt true} if the date is the same without comparing the time parts. \membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime} \constfunc{bool}{IsSameTime}{\param{const wxDateTime\& }{dt}} -Returns {\tt TRUE} if the time is the same (although dates may differ). +Returns {\tt true} if the time is the same (although dates may differ). \membersection{wxDateTime::IsEqualUpTo}\label{wxdatetimeisequalupto} \constfunc{bool}{IsEqualUpTo}{\param{const wxDateTime\& }{dt}, \param{const wxTimeSpan\& }{ts}} -Returns {\tt TRUE} if the date is equal to another one up to the given time +Returns {\tt true} if the date is equal to another one up to the given time interval, i.e. if the absolute difference between the two dates is less than this interval. @@ -1207,7 +1207,7 @@ For example, {\tt SetToWeekDay(2, wxDateTime::Wed)} will set the date to the second Wednesday in the current month and {\tt SetToWeekDay(-1, wxDateTime::Sun)} -- to the last Sunday in it. -Returns {\tt TRUE} if the date was modified successfully, {\tt FALSE} +Returns {\tt true} if the date was modified successfully, {\tt false} otherwise meaning that the specified date doesn't exist. \membersection{wxDateTime::GetWeekDay}\label{wxdatetimegetweekday2} @@ -1225,7 +1225,7 @@ The effect of calling this function is the same as of calling {\tt SetToWeekDay(-1, weekday, month, year)}. The date will be set to the last {\it weekday} in the given month and year (the current ones by default). -Always returns {\tt TRUE}. +Always returns {\tt true}. \membersection{wxDateTime::GetLastWeekDay}\label{wxdatetimegetlastweekday} @@ -1239,8 +1239,8 @@ Returns the copy of this object to which \func{bool}{SetToTheWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}, \param{WeekFlags}{flags = {\tt Monday\_First}}} Set the date to the given {\it weekday} in the week with given number -{\it numWeek}. The number should be in range $1\ldots53$ and {\tt FALSE} will -be returned if the specified date doesn't exist. {\tt TRUE} is returned if the +{\it numWeek}. The number should be in range $1\ldots53$ and {\tt false} will +be returned if the specified date doesn't exist. {\tt true} is returned if the date was changed successfully. \membersection{wxDateTime::GetWeek}\label{wxdatetimegetweek} @@ -1332,30 +1332,30 @@ year 1 is Rata Die day 1. \membersection{wxDateTime::ToTimezone}\label{wxdatetimetotimezone} -\constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = FALSE}} +\constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}} -Transform the date to the given time zone. If {\it noDST} is {\tt TRUE}, no +Transform the date to the given time zone. If {\it noDST} is {\tt true}, no DST adjustments will be made. Returns the date in the new time zone. \membersection{wxDateTime::MakeTimezone}\label{wxdatetimemaketimezone} -\func{wxDateTime\&}{MakeTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = FALSE}} +\func{wxDateTime\&}{MakeTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}} Modifies the object in place to represent the date in another time zone. If -{\it noDST} is {\tt TRUE}, no DST adjustments will be made. +{\it noDST} is {\tt true}, no DST adjustments will be made. \membersection{wxDateTime::ToGMT}\label{wxdatetimetogmt} -\constfunc{wxDateTime}{ToGMT}{\param{bool }{noDST = FALSE}} +\constfunc{wxDateTime}{ToGMT}{\param{bool }{noDST = false}} This is the same as calling \helpref{ToTimezone}{wxdatetimetotimezone} with the argument {\tt GMT0}. \membersection{wxDateTime::MakeGMT}\label{wxdatetimemakegmt} -\func{wxDateTime\&}{MakeGMT}{\param{bool }{noDST = FALSE}} +\func{wxDateTime\&}{MakeGMT}{\param{bool }{noDST = false}} This is the same as calling \helpref{MakeTimezone}{wxdatetimemaketimezone} with the argument {\tt GMT0}. @@ -1364,7 +1364,7 @@ the argument {\tt GMT0}. \constfunc{int}{IsDST}{\param{Country }{country = Country\_Default}} -Returns {\tt TRUE} if the DST is applied for this date in the given country. +Returns {\tt true} if the DST is applied for this date in the given country. \wxheading{See also} diff --git a/docs/latex/wx/datistrm.tex b/docs/latex/wx/datistrm.tex index 2bff0f65e6..158ffffb2e 100644 --- a/docs/latex/wx/datistrm.tex +++ b/docs/latex/wx/datistrm.tex @@ -67,7 +67,7 @@ Destroys the wxDataInputStream object. \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be\_order} is TRUE, all data will be read in big-endian +If {\it be\_order} is true, all data will be read in big-endian order, such as written by programs on a big endian architecture (e.g. Sparc) or written by Java-Streams (which always use big-endian order). diff --git a/docs/latex/wx/datostrm.tex b/docs/latex/wx/datostrm.tex index 53616ac33d..5cb53a3467 100644 --- a/docs/latex/wx/datostrm.tex +++ b/docs/latex/wx/datostrm.tex @@ -49,7 +49,7 @@ Destroys the wxDataOutputStream object. \func{void}{BigEndianOrdered}{\param{bool}{ be\_order}} -If {\it be\_order} is TRUE, all data will be written in big-endian +If {\it be\_order} is true, all data will be written in big-endian order, e.g. for reading on a Sparc or from Java-Streams (which always use big-endian order), otherwise data will be written in little-endian order. diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 674c06d845..2910dd5f26 100644 --- a/docs/latex/wx/db.tex +++ b/docs/latex/wx/db.tex @@ -256,7 +256,7 @@ ODBC errors.} Default cursor scrolling is defined by wxODBC\_FWD\_ONLY\_CURSORS in setup.h when the wxWindows library is built. This behavior can be overridden when an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}). -Default setting of this value TRUE, as not all databases/drivers support +Default setting of this value true, as not all databases/drivers support both types of cursors. \wxheading{See also} @@ -440,7 +440,7 @@ the DB catalog to. Default is SQL\_CATALOG\_FILENAME.} \wxheading{Return value} -Returns TRUE if the catalog request was successful, or FALSE if there was some +Returns true if the catalog request was successful, or false if there was some reason that the catalog could not be generated. \wxheading{Example} @@ -494,7 +494,7 @@ Permanently "commits" changes (insertions/deletions/updates) to the database. \wxheading{Return value} -Returns TRUE if the commit was successful, or FALSE if the commit failed. +Returns true if the commit was successful, or false if the commit failed. \wxheading{Remarks} @@ -635,7 +635,7 @@ ODBC functions directly (i.e. SQLFreeEnv()). \wxheading{Return value} -The function always returns FALSE, so a call to this function can be made +The function always returns false, so a call to this function can be made in the return statement of a code block in the event of a failure to perform an action (see the example below). @@ -686,7 +686,7 @@ one in context and displaying the ones you choose. pDb->DispAllErrors(henv, hdbc, hstmt); // Display all other errors, if any pDb->RollbackTrans(); // Rollback the transaction CloseCursor(); // Close the cursor - return(FALSE); // Return Failure + return(false); // Return Failure } } \end{verbatim} @@ -704,7 +704,7 @@ Drops the data table view named in 'viewName'. \wxheading{Remarks} -If the view does not exist, this function will return TRUE. Note that views are not supported with all datasources. +If the view does not exist, this function will return true. Note that views are not supported with all datasources. \membersection{wxDb::ExecSql}\label{wxdbexecsql} @@ -955,7 +955,7 @@ This function is primarily for use by the \helpref{wxDb::GetColumns}{wxdbgetcolu \wxheading{Return value} -Currently always returns TRUE. +Currently always returns true. \wxheading{See also} @@ -1087,8 +1087,8 @@ when the wxDb connection is initially created (see \wxheading{Return value} -Returns TRUE if this datasource connection is defined as using only forward -scrolling cursors, or FALSE if the connection is defined as being allowed to +Returns true if this datasource connection is defined as using only forward +scrolling cursors, or false if the connection is defined as being allowed to use backward scrolling cursors and their associated functions (see note above). \wxheading{Remarks} @@ -1118,7 +1118,7 @@ This function may indicate that the database connection is open, even if the call to \helpref{wxDb::Open}{wxdbopen} may have failed to fully initialize the connection correctly. The connection to the database {\it is} open and can be used via the direct SQL commands, if this -function returns TRUE. Other functions which depend on the +function returns true. Other functions which depend on the \helpref{wxDb::Open}{wxdbopen} to have completed correctly may not function as expected. The return result from \helpref{wxDb::Open}{wxdbopen} is the only way to know if complete initialization of this wxDb connection was @@ -1239,14 +1239,14 @@ It is possible to have connections to multiple datasources open at the same time to support distributed database connections by having separate instances of wxDb objects that use either the same or different Dsn/Uid/AuthStr settings. -If this function returns a value of FALSE, it does not necessarily mean that +If this function returns a value of false, it does not necessarily mean that the connection to the datasource was not opened. It may mean that some portion of the initialization of the connection failed (such as a datatype not being able to be determined how the datasource represents it). To determine if the connection to the database failed, use the \helpref{wxDb::IsOpen}{wxdbisopen} -function after receiving a FALSE result back from this function to determine if -the connection was opened or not. If this function returns FALSE, but \helpref{wxDb::IsOpen}{wxdbisopen} -returns TRUE, then direct SQL commands may be passed to the database +function after receiving a false result back from this function to determine if +the connection was opened or not. If this function returns false, but \helpref{wxDb::IsOpen}{wxdbisopen} +returns true, then direct SQL commands may be passed to the database connection and can be successfully executed, but use of the datatypes (such as by a wxDbTable instance) that are normally determined during open will not be possible. @@ -1299,14 +1299,14 @@ use this connection.} \func{void}{SetDebugErrorMessages}{\param{bool }{state}} -\docparam{state}{Either TRUE (debug messages are logged) or FALSE (debug +\docparam{state}{Either true (debug messages are logged) or false (debug messages are not logged).} \wxheading{Remarks} Turns on/off debug error messages from the ODBC class library. When -this function is passed TRUE, errors are reported to the user/logged automatically -in a text or pop-up dialog when an ODBC error occurs. When passed FALSE, +this function is passed true, errors are reported to the user/logged automatically +in a text or pop-up dialog when an ODBC error occurs. When passed false, errors are silently handled. When compiled in release mode (FINAL=1), this setting has no affect. @@ -1317,13 +1317,13 @@ When compiled in release mode (FINAL=1), this setting has no affect. \membersection{wxDb::SetSqlLogging}\label{wxdbsetsqllogging} -\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = FALSE}} +\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = false}} \wxheading{Parameters} \docparam{state}{Either sqlLogOFF or sqlLogON (see \helpref{enum wxDbSqlLogState}{wxdbcolfor}). Turns logging of SQL commands sent to the datasource OFF or ON.} \docparam{filename}{{\it OPTIONAL}. Name of the file to which the log text is to be written. Default is SQL\_LOG\_FILENAME.} -\docparam{append}{{\it OPTIONAL}. Whether the file is appended to or overwritten. Default is FALSE.} +\docparam{append}{{\it OPTIONAL}. Whether the file is appended to or overwritten. Default is false.} \wxheading{Remarks} @@ -1516,7 +1516,7 @@ a log file if SQL logging is turned on. If SQL logging is off when a call to WriteSqlLog() is made, or there is a failure to write the log message to the log file, the function returns -FALSE without performing the requested log, otherwise TRUE is returned. +false without performing the requested log, otherwise true is returned. \wxheading{See also} @@ -1786,7 +1786,7 @@ Frees the SQL environment handle being managed by the instance of this class. If the SQL environment handle was created using the long form of the \helpref{wxDbConnectInf}{wxdbconnectinf} constructor, then the flag indicating that the HENV should be destroyed when the classes destructor is called -is reset to be FALSE, so that any future handles created using the +is reset to be false, so that any future handles created using the \helpref{wxDbConnectInf::AllocHenv}{wxdbconnectinfallochenv} function must be manually released with a call to this function. @@ -2179,7 +2179,7 @@ this function. \func{void}{BuildSelectStmt}{\param{wxString \&}{pWhereClause}, \param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""}, -\param{bool }{useLikeComparison=FALSE}} +\param{bool }{useLikeComparison=false}} Constructs the portion of a SQL statement which would follow the word 'WHERE' in a SQL statement to be passed to the datasource. The returned string @@ -2197,8 +2197,8 @@ column names. For use when a FROM clause has been specified with the \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}, to clarify which table a column name reference belongs to. Default is "".} \docparam{useLikeComparison}{{\it OPTIONAL}. Should the constructed WHERE -clause utilize the LIKE comparison operator. If FALSE, then the '=' -operator is used. Default is FALSE.} +clause utilize the LIKE comparison operator. If false, then the '=' +operator is used. Default is false.} \wxheading{Remarks} @@ -2227,8 +2227,8 @@ member function to determine if the datasource currently connected to supports this behavior or not before trying to select using "FOR UPDATE". If the wxDbTable instance was created with the parameter wxDB\_QUERY\_ONLY, then -this function will return FALSE. For all known databases which do not support -the FOR UPDATE clause, this function will return FALSE also. +this function will return false. For all known databases which do not support +the FOR UPDATE clause, this function will return false also. \membersection{wxDbTable::CanUpdateByROWID}\label{wxdbtablecanupdatebyrowid} @@ -2276,7 +2276,7 @@ to an Oracle datasource or not. \membersection{wxDbTable::ClearMemberVar}\label{wxdbtableclearmembervar} -\func{void}{ClearMemberVar}{\param{UWORD }{colNo}, \param{bool }{setToNull=FALSE}} +\func{void}{ClearMemberVar}{\param{UWORD }{colNo}, \param{bool }{setToNull=false}} Same as \helpref{wxDbTable::ClearMemberVars}{wxdbtableclearmembervars} except that this function clears only the specified column of its values, and @@ -2286,21 +2286,21 @@ optionally sets the column to be a NULL column. and (noCols-1)) is the index of the column definition created using the \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} function.} \docparam{setToNull}{{\it OPTIONAL}. Indicates whether the column should be -flagged as being a NULL value stored in the bound memory variable. If TRUE, +flagged as being a NULL value stored in the bound memory variable. If true, then any value stored in the bound member variable is cleared. Default is -FALSE.} +false.} \membersection{wxDbTable::ClearMemberVars}\label{wxdbtableclearmembervars} -\func{void}{ClearMemberVars}{\param{bool }{setToNull=FALSE}} +\func{void}{ClearMemberVars}{\param{bool }{setToNull=false}} Initializes all bound columns of the wxDbTable instance to zero. In the case of a string, zero is copied to the first byte of the string. \docparam{setToNull}{{\it OPTIONAL}. Indicates whether all columns should be -flagged as having a NULL value stored in the bound memory variable. If TRUE, +flagged as having a NULL value stored in the bound memory variable. If true, then any value stored in the bound member variable is cleared. Default is -FALSE.} +false.} \wxheading{Remarks} @@ -2392,7 +2392,7 @@ this function. \func{bool}{CreateIndex}{\param{const wxString \&}{idxName}, \param{bool }{unique}, \param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs}, -\param{bool }{attemptDrop=TRUE}} +\param{bool }{attemptDrop=true}} This member function allows you to create secondary (non primary) indexes on your tables. You first create your table, normally specifying a primary @@ -2413,7 +2413,7 @@ space of the datasource.} \docparam{pIdxDefs}{A pointer to an array wxDbIdxDef structures. } \docparam{attemptDrop}{{\it OPTIONAL}. Indicates if the function should try to execute a \helpref{wxDbTable::DropIndex}{wxdbtabledropindex} on the index -name provided before trying to create the index name. Default is TRUE.} +name provided before trying to create the index name. Default is true.} \wxheading{Remarks} @@ -2462,20 +2462,20 @@ after executing this function. wxDbIdxDef idxDef[2]; // 2 columns make up the index wxStrcpy(idxDef[0].ColName, "PART_DESC"); // Column 1 - idxDef[0].Ascending = TRUE; + idxDef[0].Ascending = true; wxStrcpy(idxDef[1].ColName, "SERIAL_NO"); // Column 2 - idxDef[1].Ascending = FALSE; + idxDef[1].Ascending = false; // Create a name for the index based on the table's name wxString indexName; indexName.Printf("%s_IDX1",parts->GetTableName()); - parts->CreateIndex(indexName, TRUE, 2, idxDef); + parts->CreateIndex(indexName, true, 2, idxDef); \end{verbatim} \membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable} -\func{bool}{CreateTable}{\param{bool }{attemptDrop=TRUE}} +\func{bool}{CreateTable}{\param{bool }{attemptDrop=true}} Creates a table based on the definitions previously defined for this wxDbTable instance. @@ -2485,7 +2485,7 @@ wxDbTable instance. \docparam{attemptDrop}{{\it OPTIONAL}. Indicates whether the driver should attempt to drop the table before trying to create it. Some datasources will not allow creation of a table if the table already exists in the table space -being used. Default is TRUE.} +being used. Default is true.} \wxheading{Remarks} @@ -2680,7 +2680,7 @@ login has sufficient privileges to do so. \wxheading{Remarks} If the index specified in the 'idxName' parameter does not exist, an error -will be logged, and the function will return a result of FALSE. +will be logged, and the function will return a result of false. It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans} after executing this function. @@ -2693,10 +2693,10 @@ Deletes the associated table if the user has sufficient privileges to do so. \wxheading{Remarks} -This function returns TRUE if the table does not exist, but only for +This function returns true if the table does not exist, but only for supported databases (see \helpref{wxDb::Dbms}{wxdbdbms}). If a datasource is not specifically supported, and this function is called, the function -will return FALSE. +will return false. Most datasources/ODBC drivers will delete any indexes associated with the table automatically, and others may not. Check the documentation for your @@ -2794,9 +2794,9 @@ Before retrieving records, a query must be performed using \wxheading{Remarks} This function can only be used if the datasource connection used by the -wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the +wxDbTable instance was created with FwdOnlyCursors set to false. If the connection does not allow backward scrolling cursors, this function will -return FALSE, and the data contained in the bound columns will be undefined. +return false, and the data contained in the bound columns will be undefined. \wxheading{See also} @@ -2827,9 +2827,9 @@ Before retrieving records, a query must be performed using \wxheading{Remarks} This function can only be used if the datasource connection used by the -wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the +wxDbTable instance was created with FwdOnlyCursors set to false. If the connection does not allow backward scrolling cursors, this function will -return FALSE, and the data contained in the bound columns will be undefined. +return false, and the data contained in the bound columns will be undefined. \wxheading{See also} @@ -2837,8 +2837,8 @@ return FALSE, and the data contained in the bound columns will be undefined. \membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor} -\func{HSTMT *}{GetNewCursor}{\param{bool }{setCursor=FALSE}, -\param{bool }{bindColumns=TRUE}} +\func{HSTMT *}{GetNewCursor}{\param{bool }{setCursor=false}, +\param{bool }{bindColumns=true}} This function will create a new cursor that can be used to access the table being referenced by this wxDbTable instance, or to execute direct SQL commands @@ -2848,9 +2848,9 @@ positioned. \wxheading{Parameters} \docparam{setCursor}{{\it OPTIONAL}. Should this new cursor be set to be the -current cursor after successfully creating the new cursor. Default is FALSE.} +current cursor after successfully creating the new cursor. Default is false.} \docparam{bindColumns}{{\it OPTIONAL}. Should this new cursor be bound to all -the memory variables that the default cursor is bound to. Default is TRUE.} +the memory variables that the default cursor is bound to. Default is true.} \wxheading{Remarks} @@ -2872,8 +2872,8 @@ performed using \helpref{wxDbTable::Query}{wxdbtablequery}, \wxheading{Return value} -This function returns FALSE when the current cursor has reached the end of -the result set. When FALSE is returned, data in the bound columns is +This function returns false when the current cursor has reached the end of +the result set. When false is returned, data in the bound columns is undefined. \wxheading{Remarks} @@ -2914,16 +2914,16 @@ query must be performed using \helpref{wxDbTable::Query}{wxdbtablequery}, \wxheading{Return value} -This function returns FALSE when the current cursor has reached the beginning +This function returns false when the current cursor has reached the beginning of the result set and there are now other rows prior to the cursors current -position. When FALSE is returned, data in the bound columns is undefined. +position. When false is returned, data in the bound columns is undefined. \wxheading{Remarks} This function can only be used if the datasource connection used by the -wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the +wxDbTable instance was created with FwdOnlyCursors set to false. If the connection does not allow backward scrolling cursors, this function will -return FALSE, and the data contained in the bound columns will be undefined. +return false, and the data contained in the bound columns will be undefined. \wxheading{See also} @@ -3025,16 +3025,16 @@ this function to commit or rollback the insertion. { case DB_SUCCESS: parts->GetDb()->CommitTrans(); - return(TRUE); + return(true); case DB_ERR_INTEGRITY_CONSTRAINT_VIOL: // Current data would result in a duplicate key // on one or more indexes that do not allow duplicates parts->GetDb()->RollbackTrans(); - return(FALSE); + return(false); default: // Insert failed for some unexpected reason parts->GetDb()->RollbackTrans(); - return(FALSE); + return(false); } \end{verbatim} @@ -3066,14 +3066,14 @@ done after a commit on the database connection. \wxheading{Return value} -Returns TRUE if the cursor associated with this wxDbTable object is closed -after a commit or rollback operation. Returns FALSE otherwise. +Returns true if the cursor associated with this wxDbTable object is closed +after a commit or rollback operation. Returns false otherwise. \wxheading{Remarks} If more than one wxDbTable instance used the same database connection, all cursors which use the database connection are closed on the commit if this function -indicates TRUE. +indicates true. \membersection{wxDbTable::IsQueryOnly}\label{wxdbtableisqueryonly} @@ -3081,12 +3081,12 @@ indicates TRUE. Accessor function that returns a value indicating if this wxDbTable instance was created to allow only queries to be performed on the bound columns. If -this function returns TRUE, then no actions may be performed using this +this function returns true, then no actions may be performed using this wxDbTable instance that would modify (insert/delete/update) the table's data. \membersection{wxDbTable::Open}\label{wxdbtableopen} -\func{bool }{Open}{\param{bool }{checkPrivileges=FALSE}, \param{bool }{checkTableExists=TRUE}} +\func{bool }{Open}{\param{bool }{checkPrivileges=false}, \param{bool }{checkTableExists=true}} Every wxDbTable instance must be opened before it can be used. This function checks for the existence of the requested table, binds columns, creates required @@ -3098,14 +3098,14 @@ row in the datasource. \docparam{checkPrivileges}{Indicates whether the Open() function should check whether the current connected user has at least SELECT privileges to access the -table to which they are trying to open. Default is FALSE.} +table to which they are trying to open. Default is false.} \docparam{checkTableExists}{Indicates whether the Open() function should check -whether the table exists in the database or not before opening it. Default is TRUE.} +whether the table exists in the database or not before opening it. Default is true.} \wxheading{Remarks} -If the function returns a FALSE value due to the table not existing, a log +If the function returns a false value due to the table not existing, a log entry is recorded for the datasource connection indicating the problem that was detected when checking for table existence. Note that it is usually best for the calling routine to check for the existence of the table and for @@ -3163,7 +3163,7 @@ The second form of the function has no return value. \membersection{wxDbTable::Query}\label{wxdbtablequery} -\func{virtual bool }{Query}{\param{bool }{forUpdate=FALSE}, \param{bool }{distinct=FALSE}} +\func{virtual bool }{Query}{\param{bool }{forUpdate=false}, \param{bool }{distinct=false}} \wxheading{Parameters} @@ -3171,11 +3171,11 @@ The second form of the function has no return value. as they are retrieved. If the RDBMS is not capable of the FOR UPDATE clause, this argument is ignored. See \helpref{wxDbTable::CanSelectForUpdate}{wxdbtablecanselectforupdate} for -additional information regarding this argument. Default is FALSE.} +additional information regarding this argument. Default is false.} \docparam{distinct}{{\it OPTIONAL}. Allows selection of only distinct values from the query (SELECT DISTINCT ... FROM ...). The notion of DISTINCT applies to all columns returned in the result set, not individual columns. -Default is FALSE.} +Default is false.} \wxheading{Remarks} @@ -3346,8 +3346,8 @@ either \helpref{wxDbTable::GetFirst}{wxdbtablegetfirst} or \membersection{wxDbTable::QueryMatching}\label{wxdbtablequerymatching} -\func{virtual bool }{QueryMatching}{\param{bool }{forUpdate=FALSE}, -\param{bool }{distinct=FALSE}} +\func{virtual bool }{QueryMatching}{\param{bool }{forUpdate=false}, +\param{bool }{distinct=false}} QueryMatching allows querying of records from the table associated with the wxDbTable object by matching "columns" to values. @@ -3363,11 +3363,11 @@ object to "32", and then call wxDbTable::QueryMatching(). as they are queried (SELECT ... FOR UPDATE). If the RDBMS is not capable of the FOR UPDATE clause, this argument is ignored. See \helpref{wxDbTable::CanSelectForUpdate}{wxdbtablecanselectforupdate} for -additional information regarding this argument. Default is FALSE.} +additional information regarding this argument. Default is false.} \docparam{distinct}{{\it OPTIONAL}. Allows selection of only distinct values from the query (SELECT DISTINCT ... FROM ...). The notion of DISTINCT applies to all columns returned in the result set, not individual columns. -Default is FALSE.} +Default is false.} \wxheading{Remarks} @@ -3401,7 +3401,7 @@ this function. // Incomplete code sample parts->ClearMemberVars(); // Set all columns to zero wxStrcpy(parts->PartNumber,"32"); // Set columns to query on - parts->OnHold = TRUE; + parts->OnHold = true; parts->QueryMatching(); // Query // Display all records queried while(parts->GetNext()) @@ -3410,8 +3410,8 @@ this function. \membersection{wxDbTable::QueryOnKeyFields}\label{wxdbtablequeryonkeyfields} -\func{bool }{QueryOnKeyFields}{\param{bool }{forUpdate=FALSE}, -\param{bool }{distinct=FALSE}} +\func{bool }{QueryOnKeyFields}{\param{bool }{forUpdate=false}, +\param{bool }{distinct=false}} QueryOnKeyFields provides an easy mechanism to query records in the table associated with the wxDbTable object by the primary index column(s). Simply @@ -3429,11 +3429,11 @@ is non-null. as they are queried (SELECT ... FOR UPDATE). If the RDBMS is not capable of the FOR UPDATE clause, this argument is ignored. See \helpref{wxDbTable::CanSelectForUpdate}{wxdbtablecanselectforupdate} for -additional information regarding this argument. Default is FALSE.} +additional information regarding this argument. Default is false.} \docparam{distinct}{{\it OPTIONAL}. Allows selection of only distinct values from the query (SELECT DISTINCT ... FROM ...). The notion of DISTINCT applies to all columns returned in the result set, not individual columns. -Default is FALSE.} +Default is false.} \wxheading{Remarks} @@ -3483,8 +3483,8 @@ table's columns are refreshed to reflect the current data in the database. \func{void}{SetColDefs}{\param{UWORD }{index}, \param{const wxString \&}{fieldName}, \param{int }{dataType}, \param{void *}{pData}, \param{SWORD }{cType}, -\param{int }{size}, \param{bool }{keyField = FALSE}, \param{bool }{upd = TRUE}, -\param{bool }{insAllow = TRUE}, \param{bool }{derivedCol = FALSE}} +\param{int }{size}, \param{bool }{keyField = false}, \param{bool }{upd = true}, +\param{bool }{insAllow = true}, \param{bool }{derivedCol = false}} \func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{UWORD }{numCols}} @@ -3526,13 +3526,13 @@ Other valid types are available also, but these are the most common ones:} \docparam{size}{Maximum size in bytes of the {\it pData} object.} \docparam{keyField}{{\it OPTIONAL}. Indicates if this column is part of the -primary index. Default is FALSE.} +primary index. Default is false.} \docparam{upd}{{\it OPTIONAL}. Are updates allowed on this column? -Default is TRUE.} +Default is true.} \docparam{insAllow}{{\it OPTIONAL}. Inserts allowed on this column? -Default is TRUE.} +Default is true.} \docparam{derivedCol}{{\it OPTIONAL}. Is this a derived column (non-base -table column for query only)? Default is FALSE.} +table column for query only)? Default is false.} \docparam{colInfs}{Pointer to an array of wxDbColInf instances which contains all the information necessary to create {\it numCols} column definitions.} @@ -3565,14 +3565,14 @@ were to be copied over to another datasource or table. colDefs[0].PtrDataObj = PartNumber; colDefs[0].SqlCtype = SQL_C_CHAR; colDefs[0].SzDataObj = PART_NUMBER_LEN; - colDefs[0].KeyField = TRUE; - colDefs[0].Updateable = FALSE; - colDefs[0].InsertAllowed= TRUE; - colDefs[0].DerivedCol = FALSE; + colDefs[0].KeyField = true; + colDefs[0].Updateable = false; + colDefs[0].InsertAllowed= true; + colDefs[0].DerivedCol = false; // Shortcut using this function SetColDefs(0, "PART_NUMBER", DB_DATA_TYPE_VARCHAR, PartNumber, - SQL_C_CHAR, PART_NUMBER_LEN, TRUE, FALSE,TRUE,FALSE); + SQL_C_CHAR, PART_NUMBER_LEN, true, false,true,false); \end{verbatim} \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor} @@ -3655,10 +3655,10 @@ the datasource knows on which column values the tables should be joined on. \membersection{wxDbTable::SetColNull}\label{wxdbtablesetcolnull} -\func{bool}{SetColNull}{\param{UWORD }{colNo}, \param{bool }{set=TRUE}} +\func{bool}{SetColNull}{\param{UWORD }{colNo}, \param{bool }{set=true}} \func{bool}{SetColNull}{\param{const wxString \&}{colName}, -\param{bool }{set=TRUE}} +\param{bool }{set=true}} Both forms of this function allow a member variable representing a column in the table associated with this wxDbTable object to be set to NULL. @@ -3672,9 +3672,9 @@ the actual column name to be specified. \docparam{colNo}{Index into the column definitions used when first defining this wxDbTable object.} \docparam{colName}{Actual data table column name that is to be set to NULL.} -\docparam{set}{Whether the column is set to NULL or not. Passing TRUE sets -the column to NULL, passing FALSE sets the column to be non-NULL. Default is -TRUE.} +\docparam{set}{Whether the column is set to NULL or not. Passing true sets +the column to NULL, passing false sets the column to be non-NULL. Default is +true.} \wxheading{Remarks} @@ -3835,7 +3835,7 @@ Performs updates to the base table of the wxDbTable object, updating only the rows which match the criteria specified in the {\it pWhereClause}. All columns that are bound to member variables for this wxDbTable instance -that were defined with the "updateable" parameter set to TRUE will be updated +that were defined with the "updateable" parameter set to true will be updated with the information currently held in the memory variable. \wxheading{Parameters} @@ -4032,9 +4032,9 @@ that the client keeps ownership. int int_var; wxChar string_name[255]; table->SetColDef (0, "column 0", DB_DATA_TYPE_INTEGER, &int_var, - SQL_C_LONG, sizeof(int_var), TRUE); + SQL_C_LONG, sizeof(int_var), true); table->SetColDef (1, "column 1", DB_DATA_TYPE_VARCHAR, &string_name, - SQL_C_LONG, sizeof(string_name), FALSE); + SQL_C_LONG, sizeof(string_name), false); // now let's define columns in the grid @@ -4060,10 +4060,10 @@ that the client keeps ownership. // in the grid we will see only the rows of the result query m_dbTable->Query(); - wxDbGridTableBase *dbgrid = new wxDbGridTableBase(table, columns, wxUSE_QUERY, TRUE); + wxDbGridTableBase *dbgrid = new wxDbGridTableBase(table, columns, wxUSE_QUERY, true); delete columns; // not needed anymore wxGrid *grid = new wxGrid ( ... ); - grid->SetTable(dbgrid, TRUE); + grid->SetTable(dbgrid, true); grid->Fit(); \end{verbatim} @@ -4077,7 +4077,7 @@ that the client keeps ownership. \membersection{wxDbGridTableBase::wxDbGridTableBase}\label{wxdbgridtablebaseconstr} \func{}{wxDbGridTableBase}{\param{wxDbTable *}{tab}, \param{wxDbGridColInfo *}{ColInfo}, - \param{int }{count = wxUSE\_QUERY}, \param{bool }{takeOwnership = TRUE}} + \param{int }{count = wxUSE\_QUERY}, \param{bool }{takeOwnership = true}} Constructor. @@ -4089,8 +4089,8 @@ See the example \helpref{above}{wxdbgridtablebase}.} \docparam{count}{You can use a query result set (wxUSE\_QUERY, to use wxDbTable::Count(wxDbTable::Count() or you can fix the total number of rows (count >= 0) to display, or specify it if you already know the size in avoid calling } -\docparam{takeOwnership}{ If TRUE, this class deletes wxDbTable when it stops -referring to it, if FALSE application must +\docparam{takeOwnership}{ If true, this class deletes wxDbTable when it stops +referring to it, if false application must take care of deleting it. } \membersection{wxDbGridTableBase::ValidateRow}\label{wxdbgridtablebasevalidate} @@ -4119,7 +4119,7 @@ function is currently unsupported. \membersection{wxDbGridTableBase::AssignDbTable}\label{wxdbgridtablebaseassigndbtable} \func{bool}{AssignDbTable}{\param{wxDbTable *}{tab},\param{int }{count = wxUSE\_QUERY}, -\param{bool }{takeOwnership = TRUE}} +\param{bool }{takeOwnership = true}} Resets the grid for using with a new database table, but using the same columns definition. This can be useful when re-querying the database and want to see the changes. @@ -4128,6 +4128,6 @@ This can be useful when re-querying the database and want to see the changes. \docparam{tab}{ Database table you want to assign to the grid. } \docparam{count}{ Number of rows you want to show or wxUSE\_QUERY for using a query. } -\docparam{takeOwnership}{ If FALSE, user must take care of deleting tab after deleting -the wxDbGridTableBase. If TRUE, deletion is made by destructor class. } +\docparam{takeOwnership}{ If false, user must take care of deleting tab after deleting +the wxDbGridTableBase. If true, deletion is made by destructor class. } diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index f2f55be06f..ed4f54fcc9 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -61,7 +61,7 @@ released for each drawing operation. \func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY}, - \param{bool }{useMask = FALSE}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}} + \param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}} Copy from a source DC to this DC, specifying the destination coordinates, size of area to copy, source DC, source coordinates, @@ -85,7 +85,7 @@ logical function, whether to use a bitmap mask, and mask source position. \docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.} -\docparam{useMask}{If TRUE, Blit does a transparent blit using the mask that is associated with the bitmap +\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used: \begin{enumerate} @@ -133,7 +133,7 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. \func{static bool}{CacheEnabled}{\void} -On supported platforms (currently only Windows), returns TRUE +On supported platforms (currently only Windows), returns true if the DC cache is enabled. The DC cache can speed up the \helpref{Blit}{wxdcblit} operation when drawing a large number of masked bitmaps. @@ -243,7 +243,7 @@ The arc is drawn in an anticlockwise direction from the start point to the end p \func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}} -Draw a bitmap on the device context at the specified point. If {\it transparent} is TRUE and the bitmap has +Draw a bitmap on the device context at the specified point. If {\it transparent} is true and the bitmap has 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 @@ -497,11 +497,11 @@ the {\it current brush colour}, and using a style: \item wxFLOOD\_BORDER: the area to be flooded is bounded by the given colour. \end{itemize} -Returns FALSE if the operation failed. +Returns false if the operation failed. {\it Note:} The present implementation for non-Windows platforms may fail to find colour borders if the pixels do not match the colour exactly. However the -function will still return TRUE. +function will still return true. \membersection{wxDC::GetBackground}\label{wxdcgetbackground} @@ -577,7 +577,7 @@ Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMod \func{bool}{GetOptimization}{\void} -Returns TRUE if device context optimization is on. +Returns true if device context optimization is on. See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. \membersection{wxDC::GetPen}\label{wxdcgetpen} @@ -755,7 +755,7 @@ Gets the minimum vertical extent used in drawing commands so far. \func{bool}{Ok}{\void} -Returns TRUE if the DC is ok to use. +Returns true if the DC is ok to use. \membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox} @@ -938,7 +938,7 @@ The mapping mode can be one of the following: \func{void}{SetOptimization}{\param{bool }{optimize}} -If {\it optimize} is TRUE (the default), this function sets optimization mode on. +If {\it optimize} is true (the default), this function sets optimization mode on. This currently means that under X, the device context will not try to set a pen or brush property if it is known to be set already. This approach can fall down if non-wxWindows code is using the same device context or window, for example diff --git a/docs/latex/wx/ddeclint.tex b/docs/latex/wx/ddeclint.tex index 81f7508d3d..6df0f6e3b5 100644 --- a/docs/latex/wx/ddeclint.tex +++ b/docs/latex/wx/ddeclint.tex @@ -66,6 +66,6 @@ store application-specific data in instances of the new class. \func{bool}{ValidHost}{\param{const wxString\& }{host}} -Returns TRUE if this is a valid host name, FALSE otherwise. This always -returns TRUE under MS Windows. +Returns true if this is a valid host name, false otherwise. This always +returns true under MS Windows. diff --git a/docs/latex/wx/ddeconn.tex b/docs/latex/wx/ddeconn.tex index 1436df1220..ba4d6d2763 100644 --- a/docs/latex/wx/ddeconn.tex +++ b/docs/latex/wx/ddeconn.tex @@ -84,7 +84,7 @@ transactions. Called by the server application to advise the client of a change in the data associated with the given item. Causes the client connection's \helpref{wxDDEConnection::OnAdvise}{wxddeconnectiononadvise} -member to be called. Returns TRUE if successful. +member to be called. Returns true if successful. \membersection{wxDDEConnection::Execute} @@ -94,7 +94,7 @@ Called by the client application to execute a command on the server. Can also be used to transfer arbitrary data to the server (similar to \helpref{wxDDEConnection::Poke}{wxddeconnectionpoke} in that respect). Causes the server connection's \helpref{wxDDEConnection::OnExecute}{wxddeconnectiononexecute} member to be -called. Returns TRUE if successful. +called. Returns true if successful. \membersection{wxDDEConnection::Disconnect} @@ -105,7 +105,7 @@ program; it causes the \helpref{wxDDEConnection::OnDisconnect}{wxddeconnectionon to be sent to the corresponding connection object in the other program. The default behaviour of {\bf OnDisconnect} is to delete the connection, but the calling application must explicitly delete its -side of the connection having called {\bf Disconnect}. Returns TRUE if +side of the connection having called {\bf Disconnect}. Returns true if successful. \membersection{wxDDEConnection::OnAdvise}\label{wxddeconnectiononadvise} @@ -153,7 +153,7 @@ or NULL to indicate no data. Message sent to the server application by the client, when the client wishes to start an `advise loop' for the given topic and item. The -server can refuse to participate by returning FALSE. +server can refuse to participate by returning false. \membersection{wxDDEConnection::OnStopAdvise}\label{wxddeconnectiononstopadvise} @@ -161,7 +161,7 @@ server can refuse to participate by returning FALSE. Message sent to the server application by the client, when the client wishes to stop an `advise loop' for the given topic and item. The -server can refuse to stop the advise loop by returning FALSE, although +server can refuse to stop the advise loop by returning false, although this doesn't have much meaning in practice. \membersection{wxDDEConnection::Poke}\label{wxddeconnectionpoke} @@ -171,7 +171,7 @@ this doesn't have much meaning in practice. Called by the client application to poke data into the server. Can be used to transfer arbitrary data to the server. Causes the server connection's \helpref{wxDDEConnection::OnPoke}{wxddeconnectiononpoke} member -to be called. Returns TRUE if successful. +to be called. Returns true if successful. \membersection{wxDDEConnection::Request}\label{wxddeconnectionrequest} @@ -188,7 +188,7 @@ successful, NULL otherwise. Called by the client application to ask if an advise loop can be started with the server. Causes the server connection's \helpref{wxDDEConnection::OnStartAdvise}{wxddeconnectiononstartadvise}\rtfsp -member to be called. Returns TRUE if the server okays it, FALSE +member to be called. Returns true if the server okays it, false otherwise. \membersection{wxDDEConnection::StopAdvise}\label{wxddeconnectionstopadvise} @@ -197,5 +197,5 @@ otherwise. Called by the client application to ask if an advise loop can be stopped. Causes the server connection's \helpref{wxDDEConnection::OnStopAdvise}{wxddeconnectiononstopadvise} member -to be called. Returns TRUE if the server okays it, FALSE otherwise. +to be called. Returns true if the server okays it, false otherwise. diff --git a/docs/latex/wx/ddeservr.tex b/docs/latex/wx/ddeservr.tex index 73aefdf50a..44ae694b29 100644 --- a/docs/latex/wx/ddeservr.tex +++ b/docs/latex/wx/ddeservr.tex @@ -33,7 +33,7 @@ Constructs a server object. Registers the server using the given service name. Under UNIX, the string must contain an integer id which is used as an Internet port -number. FALSE is returned if the call failed (for example, the port +number. false is returned if the call failed (for example, the port number is already in use). \membersection{wxDDEServer::OnAcceptConnection}\label{wxddeserveronacceptconnection} diff --git a/docs/latex/wx/debugcxt.tex b/docs/latex/wx/debugcxt.tex index 6e34ed172e..26d07359b7 100644 --- a/docs/latex/wx/debugcxt.tex +++ b/docs/latex/wx/debugcxt.tex @@ -44,14 +44,14 @@ derived instance. \wxheading{Return value} -TRUE if the function succeeded, FALSE otherwise. +true if the function succeeded, false otherwise. \membersection{wxDebugContext::GetCheckPrevious}\label{wxdebugcontextgetcheckprevious} \func{bool}{GetCheckPrevious}{\void} -Returns TRUE if the memory allocator checks all previous memory blocks for errors. -By default, this is FALSE since it slows down execution considerably. +Returns true if the memory allocator checks all previous memory blocks for errors. +By default, this is false since it slows down execution considerably. \wxheading{See also} @@ -61,7 +61,7 @@ By default, this is FALSE since it slows down execution considerably. \func{bool}{GetDebugMode}{\void} -Returns TRUE if debug mode is on. If debug mode is on, the wxObject new and delete +Returns true if debug mode is on. If debug mode is on, the wxObject new and delete operators store or use information about memory allocation. Otherwise, a straight malloc and free will be performed by these operators. @@ -110,7 +110,7 @@ This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality. \func{bool}{HasStream}{\void} -Returns TRUE if there is a stream currently associated +Returns true if there is a stream currently associated with the debug context. This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality. @@ -132,7 +132,7 @@ and whether instances of this class can be dynamically created. \membersection{wxDebugContext::PrintStatistics}\label{wxdebugcontextprintstatistics} -\func{bool}{PrintStatistics}{\param{bool}{ detailed = TRUE}} +\func{bool}{PrintStatistics}{\param{bool}{ detailed = true}} Performs a statistics analysis from the currently set checkpoint, writing to the current debug stream. The number of object and non-object @@ -140,7 +140,7 @@ allocations is printed, together with the total size. \wxheading{Parameters} -\docparam{detailed}{If TRUE, the function will also print how many +\docparam{detailed}{If true, the function will also print how many objects of each class have been allocated, and the space taken by these class instances.} @@ -150,7 +150,7 @@ these class instances.} \membersection{wxDebugContext::SetCheckpoint}\label{wxdebugcontextsetcheckpoint} -\func{void}{SetCheckpoint}{\param{bool}{ all = FALSE}} +\func{void}{SetCheckpoint}{\param{bool}{ all = false}} Sets the current checkpoint: Dump and PrintStatistics operations will be performed from this point on. This allows you to ignore allocations @@ -158,7 +158,7 @@ that have been performed up to this point. \wxheading{Parameters} -\docparam{all}{If TRUE, the checkpoint is reset to include all +\docparam{all}{If true, the checkpoint is reset to include all memory allocations since the program started.} \membersection{wxDebugContext::SetCheckPrevious}\label{wxdebugcontextsetcheckprevious} @@ -166,7 +166,7 @@ memory allocations since the program started.} \func{void}{SetCheckPrevious}{\param{bool}{ check}} Tells the memory allocator to check all previous memory blocks for errors. -By default, this is FALSE since it slows down execution considerably. +By default, this is false since it slows down execution considerably. \wxheading{See also} diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index 4262dbd4d1..9dfeb472a4 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -210,31 +210,31 @@ Iconizes or restores the dialog. Windows only. \wxheading{Parameters} -\docparam{iconize}{If TRUE, iconizes the dialog box; if FALSE, shows and restores it.} +\docparam{iconize}{If true, iconizes the dialog box; if false, shows and restores it.} \wxheading{Remarks} Note that in Windows, iconization has no effect since dialog boxes cannot be iconized. However, applications may need to explicitly restore dialog boxes under Motif which have user-iconizable frames, and under Windows -calling {\tt Iconize(FALSE)} will bring the window to the front, as does -\rtfsp{\tt Show(TRUE)}. +calling {\tt Iconize(false)} will bring the window to the front, as does +\rtfsp{\tt Show(true)}. \membersection{wxDialog::IsIconized}\label{wxdialogisiconized} \constfunc{bool}{IsIconized}{\void} -Returns TRUE if the dialog box is iconized. Windows only. +Returns true if the dialog box is iconized. Windows only. \wxheading{Remarks} -Always returns FALSE under Windows since dialogs cannot be iconized. +Always returns false under Windows since dialogs cannot be iconized. \membersection{wxDialog::IsModal}\label{wxdialogismodal} \constfunc{bool}{IsModal}{\void} -Returns TRUE if the dialog box is modal, FALSE otherwise. +Returns true if the dialog box is modal, false otherwise. \membersection{wxDialog::OnCharHook}\label{wxdialogoncharhook} @@ -273,7 +273,7 @@ The default handler for the wxID\_CANCEL identifier. \wxheading{Remarks} The function either calls {\bf EndModal(wxID\_CANCEL)} if the dialog is modal, or -sets the return value to wxID\_CANCEL and calls {\bf Show(FALSE)} if the dialog is modeless. +sets the return value to wxID\_CANCEL and calls {\bf Show(false)} if the dialog is modeless. \wxheading{See also} @@ -289,8 +289,8 @@ The default handler for the wxID\_OK identifier. The function calls \rtfsp\helpref{wxWindow::Validate}{wxwindowvalidate}, then \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow}. -If this returns TRUE, the function either calls {\bf EndModal(wxID\_OK)} if the dialog is modal, or -sets the return value to wxID\_OK and calls {\bf Show(FALSE)} if the dialog is modeless. +If this returns true, the function either calls {\bf EndModal(wxID\_OK)} if the dialog is modal, or +sets the return value to wxID\_OK and calls {\bf Show(false)} if the dialog is modeless. \wxheading{See also} @@ -354,7 +354,7 @@ until the dialog is hidden) or modeless (control returns immediately). \wxheading{Parameters} -\docparam{flag}{If TRUE, the dialog will be modal, otherwise it will be modeless.} +\docparam{flag}{If true, the dialog will be modal, otherwise it will be modeless.} \membersection{wxDialog::SetReturnCode}\label{wxdialogsetreturncode} @@ -394,8 +394,8 @@ Hides or shows the dialog. \wxheading{Parameters} -\docparam{show}{If TRUE, the dialog box is shown and brought to the front; -otherwise the box is hidden. If FALSE and the dialog is +\docparam{show}{If true, the dialog box is shown and brought to the front; +otherwise the box is hidden. If false and the dialog is modal, control is returned to the calling program.} \wxheading{Remarks} diff --git a/docs/latex/wx/dialup.tex b/docs/latex/wx/dialup.tex index 02b305cae8..7a46fa6f00 100644 --- a/docs/latex/wx/dialup.tex +++ b/docs/latex/wx/dialup.tex @@ -66,8 +66,8 @@ done with it. \constfunc{bool}{IsOk}{\void} -Returns {\tt TRUE} if the dialup manager was initialized correctly. If this -function returns {\tt FALSE}, no other functions will work neither, so it is a +Returns {\tt true} if the dialup manager was initialized correctly. If this +function returns {\tt false}, no other functions will work neither, so it is a good idea to call this function and check its result before calling any other wxDialUpManager methods @@ -89,7 +89,7 @@ their number (may be $0$). \membersection{wxDialUpManager::Dial}\label{wxdialupmanagerdial} -\func{bool}{Dial}{\param{const wxString\& }{nameOfISP = wxEmptyString}, \param{const wxString\& }{username = wxEmptyString}, \param{const wxString\& }{password = wxEmptyString}, \param{bool }{async = TRUE}} +\func{bool}{Dial}{\param{const wxString\& }{nameOfISP = wxEmptyString}, \param{const wxString\& }{username = wxEmptyString}, \param{const wxString\& }{password = wxEmptyString}, \param{bool }{async = true}} Dial the given ISP, use {\it username} and {\it password} to authenticate. @@ -102,10 +102,10 @@ If no {\it nameOfISP} is given, the function will select the default one and if no username and/or password are given, the function will try to do without them, but will ask the user if really needed. -If {\it async} parameter is {\tt FALSE}, the function waits until the end of dialing -and returns {\tt TRUE} upon successful completion. +If {\it async} parameter is {\tt false}, the function waits until the end of dialing +and returns {\tt true} upon successful completion. -If {\it async} is {\tt TRUE}, the function only initiates the connection and +If {\it async} is {\tt true}, the function only initiates the connection and returns immediately - the result is reported via events (an event is sent anyhow, but if dialing failed it will be a DISCONNECTED one). @@ -113,7 +113,7 @@ anyhow, but if dialing failed it will be a DISCONNECTED one). \constfunc{bool}{IsDialing}{\void} -Returns TRUE if (async) dialing is in progress. +Returns true if (async) dialing is in progress. \wxheading{See also} @@ -124,7 +124,7 @@ Returns TRUE if (async) dialing is in progress. \func{bool}{CancelDialing}{\void} Cancel dialing the number initiated with \helpref{Dial}{wxdialupmanagerdial} -with async parameter equal to {\tt TRUE}. +with async parameter equal to {\tt true}. Note that this won't result in DISCONNECTED event being sent. @@ -142,7 +142,7 @@ Hang up the currently active dial up connection. \constfunc{bool}{IsAlwaysOnline}{\void} -Returns {\tt TRUE} if the computer has a permanent network connection (i.e. is +Returns {\tt true} if the computer has a permanent network connection (i.e. is on a LAN) and so there is no need to use Dial() function to go online. {\bf NB:} this functions tries to guess the result and it is not always @@ -153,14 +153,14 @@ confirmation or give him a possibility to override it. \constfunc{bool}{IsOnline}{\void} -Returns {\tt TRUE} if the computer is connected to the network: under Windows, +Returns {\tt true} if the computer is connected to the network: under Windows, this just means that a RAS connection exists, under Unix we check that the "well-known host" (as specified by \helpref{SetWellKnownHost}{wxdialupmanagersetwellknownhost}) is reachable. \membersection{wxDialUpManager::SetOnlineStatus}\label{wxdialupmanagersetonlinestatus} -\func{void}{SetOnlineStatus}{\param{bool }{isOnline = TRUE}} +\func{void}{SetOnlineStatus}{\param{bool }{isOnline = true}} Sometimes the built-in logic for determining the online status may fail, so, in general, the user should be allowed to override it. This function @@ -182,7 +182,7 @@ often should we repeat the check (each minute by default). Under Windows, the notification about the change of connection status is sent by the system and so we don't do any polling and this parameter is ignored. -Returns {\tt FALSE} if couldn't set up automatic check for online status. +Returns {\tt false} if couldn't set up automatic check for online status. \membersection{wxDialUpManager::DisableAutoCheckOnlineStatus}\label{wxdialupmanagerdisableautocheckonlinestatus} diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex index 96144d5fa9..48c550fccf 100644 --- a/docs/latex/wx/dir.tex +++ b/docs/latex/wx/dir.tex @@ -102,14 +102,14 @@ class is not meant to be used polymorphically. \func{bool}{Open}{\param{const wxString\& }{dir}} -Open the directory for enumerating, returns TRUE on success or FALSE if an +Open the directory for enumerating, returns true on success or false if an error occurred. \membersection{wxDir::IsOpened}\label{wxdirisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the directory was successfully opened by a previous call to +Returns true if the directory was successfully opened by a previous call to \helpref{Open}{wxdiropen}. \membersection{wxDir::GetFirst}\label{wxdirgetfirst} @@ -117,7 +117,7 @@ Returns TRUE if the directory was successfully opened by a previous call to \constfunc{bool}{GetFirst}{\param{wxString* }{filename}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}} Start enumerating all files matching {\it filespec} (or all files if it is -empty) and flags, return TRUE on success. +empty) and flags, return true on success. \membersection{wxDir::GetNext}\label{wxdirgetnext} @@ -130,7 +130,7 @@ to \helpref{GetFirst}{wxdirgetfirst}. \func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}} -Returns {\tt TRUE} if the directory contains any files matching the given +Returns {\tt true} if the directory contains any files matching the given {\it filespec}. If {\it filespec} is empty, look for any files at all. In any case, even hidden files are taken into account. @@ -138,7 +138,7 @@ case, even hidden files are taken into account. \func{bool}{HasSubDirs}{\param{const wxString\& }{dirspec = wxEmptyString}} -Returns {\tt TRUE} if the directory contains any subdirectories (if a non +Returns {\tt true} if the directory contains any subdirectories (if a non empty {\it filespec} is given, only check for directories matching it). The hidden subdirectories are taken into account as well. diff --git a/docs/latex/wx/dllload.tex b/docs/latex/wx/dllload.tex index 05dfd62573..4c54aae8e6 100644 --- a/docs/latex/wx/dllload.tex +++ b/docs/latex/wx/dllload.tex @@ -135,8 +135,8 @@ is valid. If the handle is valid, the library must be unloaded later with \docparam{libname}{Name of the shared object to load.} -\docparam{success}{May point to a bool variable which will be set to TRUE or -FALSE; may also be {\tt NULL}.} +\docparam{success}{May point to a bool variable which will be set to true or +false; may also be {\tt NULL}.} \membersection{wxDllLoader::UnloadLibrary}\label{wxdllloaderunloadlibrary} diff --git a/docs/latex/wx/dobjcomp.tex b/docs/latex/wx/dobjcomp.tex index fbdc1c5ac4..a98c2f1e79 100644 --- a/docs/latex/wx/dobjcomp.tex +++ b/docs/latex/wx/dobjcomp.tex @@ -57,9 +57,9 @@ The default constructor. \func{void}{Add}{ \param{wxDataObjectSimple }{*dataObject}, - \param{bool }{preferred = FALSE}} + \param{bool }{preferred = false}} Adds the {\it dataObject} to the list of supported objects and it becomes the -preferred object if {\it preferred} is TRUE. +preferred object if {\it preferred} is true. diff --git a/docs/latex/wx/dobjsmpl.tex b/docs/latex/wx/dobjsmpl.tex index 2d5f2bc477..8c3d8fcd0a 100644 --- a/docs/latex/wx/dobjsmpl.tex +++ b/docs/latex/wx/dobjsmpl.tex @@ -85,7 +85,7 @@ object supports rendering its data. \constfunc{virtual bool}{GetDataHere}{\param{void }{*buf}} -Copy the data to the buffer, return TRUE on success. Must be implemented in the +Copy the data to the buffer, return true on success. Must be implemented in the derived class if the object supports rendering its data. \pythonnote{When implementing this method in wxPython, no additional @@ -96,7 +96,7 @@ method as a string.} \func{virtual bool}{SetData}{\param{size\_t }{len}, \param{const void }{*buf}} -Copy the data from the buffer, return TRUE on success. Must be implemented in +Copy the data from the buffer, return true on success. Must be implemented in the derived class if the object supports setting its data. \pythonnote{When implementing this method in wxPython, the data comes diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex index dab5d749b2..50b9e0da96 100644 --- a/docs/latex/wx/docmanag.tex +++ b/docs/latex/wx/docmanag.tex @@ -72,16 +72,16 @@ A list of all document templates. \membersection{wxDocManager::wxDocManager} -\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = TRUE}} +\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}} Constructor. Create a document manager instance dynamically near the start of your application before doing any document or view operations. {\it flags} is currently unused. -If {\it initialize} is TRUE, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called +If {\it initialize} is true, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called to create a default history list object. If you derive from wxDocManager, you may wish to call the -base constructor with FALSE, and then call Initialize in your own constructor, to allow +base constructor with false, and then call Initialize in your own constructor, to allow your own Initialize or OnCreateFileHistory functions to be called. \membersection{wxDocManager::\destruct{wxDocManager}} @@ -116,7 +116,7 @@ Adds the template to the document manager's template list. \membersection{wxDocManager::CloseDocuments} -\func{bool}{CloseDocuments}{\param{bool }{force = TRUE}} +\func{bool}{CloseDocuments}{\param{bool }{force = true}} Closes all currently opened documents. @@ -262,7 +262,7 @@ the opportunity to override functionality. If OnCreateFileHistory was called from the constructor, an overridden virtual OnCreateFileHistory would not be called due to C++'s `interesting' constructor semantics. In fact Initialize \rtfsp{\it is} called from the wxDocManager constructor, but this can be -vetoed by passing FALSE to the second argument, allowing the derived class's +vetoed by passing false to the second argument, allowing the derived class's constructor to call Initialize, possibly calling a different OnCreateFileHistory from the default. @@ -367,7 +367,7 @@ two values, eg:\par \membersection{wxDocManager::SelectDocumentType} \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates}, - \param{int}{ noTemplates}, \param{bool}{ sort=FALSE}} + \param{int}{ noTemplates}, \param{bool}{ sort=false}} Returns a document template by asking the user (if there is more than one template). This function is used in wxDocManager::CreateDocument. @@ -379,14 +379,14 @@ This function is used in wxDocManager::CreateDocument. \docparam{sort}{If more than one template is passed in in {\it templates}, then this parameter indicates whether the list of templates that the user will have to choose from is sorted or not when shown the choice box dialog. -Default is FALSE.} +Default is false.} \perlnote{In wxPerl {\tt templates} is a reference to a list of templates.} \membersection{wxDocManager::SelectViewType} \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates}, - \param{int}{ noTemplates}, \param{bool}{ sort=FALSE}} + \param{int}{ noTemplates}, \param{bool}{ sort=false}} Returns a document template by asking the user (if there is more than one template), displaying a list of valid views. This function is used in wxDocManager::CreateView. @@ -400,7 +400,7 @@ those relevant to the document in question, and often there will only be one suc \docparam{sort}{If more than one template is passed in in {\it templates}, then this parameter indicates whether the list of templates that the user will have to choose from is sorted or not when shown the choice box dialog. -Default is FALSE.} +Default is false.} \perlnote{In wxPerl {\tt templates} is a reference to a list of templates.} diff --git a/docs/latex/wx/doctempl.tex b/docs/latex/wx/doctempl.tex index 8d817852db..8ce5e943a8 100644 --- a/docs/latex/wx/doctempl.tex +++ b/docs/latex/wx/doctempl.tex @@ -213,7 +213,7 @@ Returns the view type name, as passed to the document template constructor. \func{bool}{IsVisible}{\void} -Returns TRUE if the document template can be shown in user dialogs, FALSE otherwise. +Returns true if the document template can be shown in user dialogs, false otherwise. \membersection{wxDocTemplate::SetDefaultExtension} diff --git a/docs/latex/wx/document.tex b/docs/latex/wx/document.tex index 03b3b82240..bb02ed455c 100644 --- a/docs/latex/wx/document.tex +++ b/docs/latex/wx/document.tex @@ -37,7 +37,7 @@ Filename associated with this document (``" if none). \member{bool}{m\_documentModified} -TRUE if the document has been modified, FALSE otherwise. +true if the document has been modified, false otherwise. \membersection{wxDocument::m\_documentTemplate} @@ -92,7 +92,7 @@ If the view is not already in the list of views, adds the view and calls OnChang \func{virtual bool}{Close}{\void} -Closes the document, by calling OnSaveModified and then (if this returned TRUE) OnCloseDocument. +Closes the document, by calling OnSaveModified and then (if this returned true) OnCloseDocument. This does not normally delete the document object: use DeleteAllViews to do this implicitly. \membersection{wxDocument::DeleteAllViews} @@ -181,7 +181,7 @@ See also: \helpref{GetFirstView}{wxdocumentgetfirstview} \constfunc{virtual bool}{IsModified}{\void} -Returns TRUE if the document has been modified since the last save, FALSE otherwise. +Returns true if the document has been modified since the last save, false otherwise. You may need to override this if your document view maintains its own record of being modified (for example if using wxTextWindow to view and edit the document). @@ -204,7 +204,7 @@ was configured. \func{virtual void}{Modify}{\param{bool}{ modify}} -Call with TRUE to mark the document as modified since the last save, FALSE otherwise. +Call with true to mark the document as modified since the last save, false otherwise. You may need to override this if your document view maintains its own record of being modified (for example if using wxTextWindow to view and edit the document). @@ -223,7 +223,7 @@ one has just been removed). \func{virtual bool}{OnCloseDocument}{\void} The default implementation calls DeleteContents (an empty implementation) -sets the modified flag to FALSE. Override this to +sets the modified flag to false. Override this to supply additional behaviour when the document is closed with Close. \membersection{wxDocument::OnCreate} @@ -233,7 +233,7 @@ supply additional behaviour when the document is closed with Close. Called just after the document object is created to give it a chance to initialize itself. The default implementation uses the template associated with the document to create an initial view. -If this function returns FALSE, the document is deleted. +If this function returns false, the document is deleted. \membersection{wxDocument::OnCreateCommandProcessor} @@ -257,7 +257,7 @@ document, and notifies the views that the filename (in fact, the title) has chan \func{virtual bool}{OnOpenDocument}{\param{const wxString\& }{filename}} Constructs an input file stream for the given filename (which must not be empty), -and calls LoadObject. If LoadObject returns TRUE, the document is set to +and calls LoadObject. If LoadObject returns true, the document is set to unmodified; otherwise, an error message box is displayed. The document's views are notified that the filename has changed, to give windows an opportunity to update their titles. All of the document's views are then updated. @@ -267,7 +267,7 @@ to update their titles. All of the document's views are then updated. \func{virtual bool}{OnSaveDocument}{\param{const wxString\& }{filename}} Constructs an output file stream for the given filename (which must not be empty), -and calls SaveObject. If SaveObject returns TRUE, the document is set to +and calls SaveObject. If SaveObject returns true, the document is set to unmodified; otherwise, an error message box is displayed. \membersection{wxDocument::OnSaveModified} @@ -336,11 +336,11 @@ framework. \membersection{wxDocument::SetFilename} -\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = FALSE}} +\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = false}} Sets the filename for this document. Usually called by the framework. -If {\it notifyViews} is TRUE, wxView::OnChangeFilename is called for all views. +If {\it notifyViews} is true, wxView::OnChangeFilename is called for all views. \membersection{wxDocument::SetTitle} diff --git a/docs/latex/wx/dragimag.tex b/docs/latex/wx/dragimag.tex index 42eab1e207..e74b6db01d 100644 --- a/docs/latex/wx/dragimag.tex +++ b/docs/latex/wx/dragimag.tex @@ -110,7 +110,7 @@ have a mask.} \membersection{wxDragImage::BeginDrag}\label{wxdragimagebegindrag} -\func{bool}{BeginDrag}{\param{const wxPoint\& }{hotspot}, \param{wxWindow* }{window}, \param{bool}{ fullScreen = FALSE}, \param{wxRect*}{ rect = NULL}} +\func{bool}{BeginDrag}{\param{const wxPoint\& }{hotspot}, \param{wxWindow* }{window}, \param{bool}{ fullScreen = false}, \param{wxRect*}{ rect = NULL}} Start dragging the image, in a window or full screen. @@ -133,12 +133,12 @@ Note that this call automatically calls CaptureMouse. of the image.} \docparam{window}{The window that captures the mouse, and within which the dragging -is limited unless {\it fullScreen} is TRUE.} +is limited unless {\it fullScreen} is true.} \docparam{boundingWindow}{In the second form of the function, specifies the area within which the drag occurs.} -\docparam{fullScreen}{If TRUE, specifies that the drag will be visible over the full +\docparam{fullScreen}{If true, specifies that the drag will be visible over the full screen, or over as much of the screen as is specified by {\it rect}. Note that the mouse will still be captured in {\it window}.} diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex index 6223ea5e88..041c31c227 100644 --- a/docs/latex/wx/dropsrc.tex +++ b/docs/latex/wx/dropsrc.tex @@ -106,10 +106,10 @@ slow. \docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. } -\docparam{scrolling}{TRUE if the window is scrolling. MSW only. } +\docparam{scrolling}{true if the window is scrolling. MSW only. } \wxheading{Return value} -Return FALSE if you want default feedback, or TRUE if you implement your own +Return false if you want default feedback, or true if you implement your own feedback. The return values is ignored under GTK. diff --git a/docs/latex/wx/droptrgt.tex b/docs/latex/wx/droptrgt.tex index eb9ca1eed6..413dae6f1b 100644 --- a/docs/latex/wx/droptrgt.tex +++ b/docs/latex/wx/droptrgt.tex @@ -70,7 +70,7 @@ calling its \helpref{wxDataObject::SetData}{wxdataobjectsetdata} method. \func{virtual wxDragResult}{OnData}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxDragResult}{ def}} -Called after \helpref{OnDrop}{wxdroptargetondrop} returns TRUE. By default this +Called after \helpref{OnDrop}{wxdroptargetondrop} returns true. By default this will usually \helpref{GetData}{wxdroptargetgetdata} and will return the suggested default value {\it def}. @@ -78,7 +78,7 @@ default value {\it def}. \func{virtual bool}{OnDrop}{\param{wxCoord }{x}, \param{wxCoord }{y}} -Called when the user drops a data object on the target. Return FALSE to veto the operation. +Called when the user drops a data object on the target. Return false to veto the operation. \wxheading{Parameters} @@ -88,7 +88,7 @@ Called when the user drops a data object on the target. Return FALSE to veto the \wxheading{Return value} -Return TRUE to accept the data, FALSE to veto the operation. +Return true to accept the data, false to veto the operation. \membersection{wxDropTarget::OnEnter}\label{wxdroptargetonenter} diff --git a/docs/latex/wx/dynlib.tex b/docs/latex/wx/dynlib.tex index 8693f8ae88..44bdb0972f 100644 --- a/docs/latex/wx/dynlib.tex +++ b/docs/latex/wx/dynlib.tex @@ -31,7 +31,7 @@ Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}. \constfunc{bool}{IsLoaded}{\void} -Returns TRUE if the library was successfully loaded, FALSE otherwise. +Returns true if the library was successfully loaded, false otherwise. \membersection{wxDynamicLibrary::Load}\label{wxdynamiclibraryload} @@ -39,7 +39,7 @@ Returns TRUE if the library was successfully loaded, FALSE otherwise. Loads DLL into memory. -Returns TRUE if the library was successfully loaded, FALSE otherwise. +Returns true if the library was successfully loaded, false otherwise. \membersection{wxDynamicLibrary::Unload}\label{wxdynamiclibraryunload} diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex index 39e14fbfd9..1af81823d9 100644 --- a/docs/latex/wx/encconv.tex +++ b/docs/latex/wx/encconv.tex @@ -61,7 +61,7 @@ as input string. \wxheading{Return value} -FALSE if given conversion is impossible, TRUE otherwise +false if given conversion is impossible, true otherwise (conversion may be impossible either if you try to convert to Unicode with non-Unicode build of wxWindows or if input or output encoding is not supported.) diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index d6099d0c7b..9e542c58c9 100644 --- a/docs/latex/wx/event.tex +++ b/docs/latex/wx/event.tex @@ -48,7 +48,7 @@ Identifier for the window. \member{bool}{m\_skipped} -Set to TRUE by {\bf Skip} if this event should be skipped. +Set to true by {\bf Skip} if this event should be skipped. \membersection{wxEvent::m\_timeStamp} @@ -100,7 +100,7 @@ Returns the identifier associated with this event, such as a button command id. \func{bool}{GetSkipped}{\void} -Returns TRUE if the event handler should be skipped, FALSE otherwise. +Returns true if the event handler should be skipped, false otherwise. \membersection{wxEvent::GetTimestamp} @@ -136,7 +136,7 @@ Sets the originating object. \membersection{wxEvent::Skip}\label{wxeventskip} -\func{void}{Skip}{\param{bool}{ skip = TRUE}} +\func{void}{Skip}{\param{bool}{ skip = true}} Called by an event handler to tell the event system that the event handler should be skipped, and the next valid handler used diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex index 45ae21f81b..ad4daf7f71 100644 --- a/docs/latex/wx/evthand.tex +++ b/docs/latex/wx/evthand.tex @@ -110,7 +110,7 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo \param{wxObject*}{ userData = NULL}} Disconnects the given function dynamically from the event handler, using the specified -parameters as search criteria and returning TRUE if a matching function has been +parameters as search criteria and returning true if a matching function has been found and removed. This method can only disconnect functions which have been added using the \helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. There is no way to disconnect functions connected using the (static) event tables. @@ -157,7 +157,7 @@ Get a pointer to the user-supplied client data object. \func{bool}{GetEvtHandlerEnabled}{\void} -Returns TRUE if the event handler is enabled, FALSE otherwise. +Returns true if the event handler is enabled, false otherwise. \wxheading{See also} @@ -203,7 +203,7 @@ Processes an event, searching event tables and calling zero or more suitable eve \wxheading{Return value} -TRUE if a suitable event handler function was found and executed, and the function did not +true if a suitable event handler function was found and executed, and the function did not call \helpref{wxEvent::Skip}{wxeventskip}. \wxheading{Remarks} @@ -227,14 +227,14 @@ The normal order of event table searching is as follows: \item If the object is disabled (via a call to \helpref{wxEvtHandler::SetEvtHandlerEnabled}{wxevthandlersetevthandlerenabled}) the function skips to step (6). \item If the object is a wxWindow, {\bf ProcessEvent} is recursively called on the window's\rtfsp -\helpref{wxValidator}{wxvalidator}. If this returns TRUE, the function exits. +\helpref{wxValidator}{wxvalidator}. If this returns true, the function exits. \item {\bf SearchEventTable} is called for this event handler. If this fails, the base class table is tried, and so on until no more tables exist or an appropriate function was found, in which case the function exits. \item The search is applied down the entire chain of event handlers (usually the chain has a length of one). If this succeeds, the function exits. \item If the object is a wxWindow and the event is a wxCommandEvent, {\bf ProcessEvent} is -recursively applied to the parent window's event handler. If this returns TRUE, the function exits. +recursively applied to the parent window's event handler. If this returns true, the function exits. \item Finally, {\bf ProcessEvent} is called on the wxApp object. \end{enumerate} @@ -257,7 +257,7 @@ is found. \wxheading{Return value} -TRUE if a suitable event handler function was found and executed, and the function did not +true if a suitable event handler function was found and executed, and the function did not call \helpref{wxEvent::Skip}{wxeventskip}. \wxheading{Remarks} @@ -320,7 +320,7 @@ Enables or disables the event handler. \wxheading{Parameters} -\docparam{enabled}{TRUE if the event handler is to be enabled, FALSE if it is to be disabled.} +\docparam{enabled}{true if the event handler is to be enabled, false if it is to be disabled.} \wxheading{Remarks} diff --git a/docs/latex/wx/expr.tex b/docs/latex/wx/expr.tex index 5bb30904b6..83381dfdde 100644 --- a/docs/latex/wx/expr.tex +++ b/docs/latex/wx/expr.tex @@ -352,13 +352,13 @@ Construct a new, unhashed database, with an optional error handler. The error handler must be a function returning a bool and taking an integer and a string argument. When an error occurs when reading or writing a database, this function is called. The error is given as the first argument (currently one of WXEXPR\_ERROR\_GENERAL, -WXEXPR\_ERROR\_SYNTAX) and an error message is given as the second argument. If FALSE +WXEXPR\_ERROR\_SYNTAX) and an error message is given as the second argument. If false is returned by the error handler, processing of the wxExpr operation stops. Another way of handling errors is simply to call \helpref{wxExprDatabase::GetErrorCount}{wxexprdatabasegeterrorcount} after the operation, to check whether errors have occurred, instead of installing an error handler. If the error count is more than zero, \helpref{wxExprDatabase::Write}{wxexprdatabasewrite} and -\rtfsp\helpref{wxExprDatabase::Read}{wxexprdatabaseread} will return FALSE to +\rtfsp\helpref{wxExprDatabase::Read}{wxexprdatabaseread} will return false to the application. For example: @@ -370,7 +370,7 @@ bool myErrorHandler(int err, chat *msg) { wxMessageBox(msg, "Syntax error"); } - return FALSE; + return false; } wxExprDatabase database(myErrorHandler); @@ -476,13 +476,13 @@ in the database constructor having the given string value. \func{bool}{Read}{\param{const wxString\&}{ filename}} -Reads in the given file, returning TRUE if successful. +Reads in the given file, returning true if successful. \membersection{wxExprDatabase::ReadFromString}\label{wxexprdatabasereadfromstring} \func{bool}{ReadFromString}{\param{const wxString\&}{ buffer}} -Reads a Prolog database from the given string buffer, returning TRUE if +Reads a Prolog database from the given string buffer, returning true if successful. \membersection{wxExprDatabase::Write}\label{wxexprdatabasewrite} diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex index fd49d497bb..c6f9ebabc0 100644 --- a/docs/latex/wx/ffile.tex +++ b/docs/latex/wx/ffile.tex @@ -83,14 +83,14 @@ object. \func{bool}{Close}{\void} -Closes the file and returns TRUE on success. +Closes the file and returns true on success. \membersection{wxFFile::Detach}\label{wxffiledetach} \func{void}{Detach}{\void} Get back a file pointer from wxFFile object - the caller is responsible for closing the file if this -descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return FALSE after call to Detach(). +descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return false after call to Detach(). \membersection{wxFFile::fp}\label{wxffilefp} @@ -102,25 +102,25 @@ Returns the file pointer associated with the file. \constfunc{bool}{Eof}{\void} -Returns TRUE if the an attempt has been made to read {\it past} +Returns true if the an attempt has been made to read {\it past} the end of the file. Note that the behaviour of the file descriptor based class \helpref{wxFile}{wxfile} is different as \helpref{wxFile::Eof}{wxfileeof} -will return TRUE here as soon as the last byte of the file has been +will return true here as soon as the last byte of the file has been read. \membersection{wxFFile::Flush}\label{wxffileflush} \func{bool}{Flush}{\void} -Flushes the file and returns TRUE on success. +Flushes the file and returns true on success. \membersection{wxFFile::IsOpened}\label{wxffileisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file has been opened. +Returns true if the file has been opened. \membersection{wxFFile::Length}\label{wxffilelength} @@ -132,7 +132,7 @@ Returns the length of the file. \func{bool}{Open}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}} -Opens the file, returning TRUE if successful. +Opens the file, returning true if successful. \wxheading{Parameters} @@ -160,7 +160,7 @@ The number of bytes read. \func{bool}{Seek}{\param{long }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} -Seeks to the specified position and returns TRUE on success. +Seeks to the specified position and returns true on success. \wxheading{Parameters} @@ -173,7 +173,7 @@ Seeks to the specified position and returns TRUE on success. \func{bool}{SeekEnd}{\param{long }{ofs = 0}} Moves the file pointer to the specified number of bytes before the end of the file -and returns TRUE on success. +and returns true on success. \wxheading{Parameters} @@ -205,7 +205,7 @@ Number of bytes written. \func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}} -Writes the contents of the string to the file, returns TRUE on success. +Writes the contents of the string to the file, returns true on success. The second argument is only meaningful in Unicode build of wxWindows when {\it conv} is used to convert {\it s} to multibyte representation. diff --git a/docs/latex/wx/ffilestr.tex b/docs/latex/wx/ffilestr.tex index 4068e779d6..d686281db8 100644 --- a/docs/latex/wx/ffilestr.tex +++ b/docs/latex/wx/ffilestr.tex @@ -57,7 +57,7 @@ Destructor. \constfunc{bool}{Ok}{\void} -Returns TRUE if the stream is initialized and ready. +Returns true if the stream is initialized and ready. % ----------------------------------------------------------------------------- % wxFFileOutputStream @@ -119,7 +119,7 @@ Destructor. \constfunc{bool}{Ok}{\void} -Returns TRUE if the stream is initialized and ready. +Returns true if the stream is initialized and ready. % ----------------------------------------------------------------------------- % wxFFileStream diff --git a/docs/latex/wx/fildrptg.tex b/docs/latex/wx/fildrptg.tex index b24dbd8adf..6bf2a9d2e6 100644 --- a/docs/latex/wx/fildrptg.tex +++ b/docs/latex/wx/fildrptg.tex @@ -47,7 +47,7 @@ Override this function to receive dropped files. \wxheading{Return value} -Return TRUE to accept the data, FALSE to veto the operation. +Return true to accept the data, false to veto the operation. % VZ: this clarification is probably not needed any longer? %\perlnote{In wxPerl there is just an array reference in place of {\tt nFiles} diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index d4c5f0aaa9..d8885f878d 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -141,9 +141,9 @@ Closes the file. \membersection{wxFile::Create}\label{wxfilecreate} -\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = FALSE}, \param{int }{access = wxS\_DEFAULT}} +\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}} -Creates a file for writing. If the file already exists, setting {\bf overwrite} to TRUE +Creates a file for writing. If the file already exists, setting {\bf overwrite} to true will ensure it is overwritten. \membersection{wxFile::Detach}\label{wxfiledetach} @@ -151,7 +151,7 @@ will ensure it is overwritten. \func{void}{Detach}{\void} Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this -descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return FALSE after call to Detach(). +descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return false after call to Detach(). \membersection{wxFile::fd}\label{wxfilefd} @@ -163,12 +163,12 @@ Returns the file descriptor associated with the file. \constfunc{bool}{Eof}{\void} -Returns TRUE if the end of the file has been reached. +Returns true if the end of the file has been reached. Note that the behaviour of the file pointer based class \helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof} -will return TRUE here only if an attempt has been made to read -{\it past} the last byte of the file, while wxFile::Eof() will return TRUE +will return true here only if an attempt has been made to read +{\it past} the last byte of the file, while wxFile::Eof() will return true even before such attempt is made if the file pointer is at the last position in the file. @@ -183,7 +183,7 @@ of using Eof() as this will not work for special files under Unix. \func{static bool}{Exists}{\param{const char*}{ filename}} -Returns TRUE if the given name specifies an existing regular file (not a +Returns true if the given name specifies an existing regular file (not a directory or a link) \membersection{wxFile::Flush}\label{wxfileflush} @@ -200,7 +200,7 @@ due to a missing fsync function, which reduces the usefulness of this function \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file has been opened. +Returns true if the file has been opened. \membersection{wxFile::Length}\label{wxfilelength} @@ -212,7 +212,7 @@ Returns the length of the file. \func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} -Opens the file, returning TRUE if successful. +Opens the file, returning true if successful. \wxheading{Parameters} @@ -293,7 +293,7 @@ the number of bytes actually written \func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}} -Writes the contents of the string to the file, returns TRUE on success. +Writes the contents of the string to the file, returns true on success. The second argument is only meaningful in Unicode build of wxWindows when {\it conv} is used to convert {\it s} to multibyte representation. diff --git a/docs/latex/wx/fileistr.tex b/docs/latex/wx/fileistr.tex index b1b1cfb3e6..865320a1a6 100644 --- a/docs/latex/wx/fileistr.tex +++ b/docs/latex/wx/fileistr.tex @@ -54,5 +54,5 @@ Destructor. \constfunc{bool}{Ok}{\void} -Returns TRUE if the stream is initialized and ready. +Returns true if the stream is initialized and ready. diff --git a/docs/latex/wx/fileostr.tex b/docs/latex/wx/fileostr.tex index 4e49bb3d17..c22c8b6114 100644 --- a/docs/latex/wx/fileostr.tex +++ b/docs/latex/wx/fileostr.tex @@ -58,5 +58,5 @@ Destructor. \constfunc{bool}{Ok}{\void} -Returns TRUE if the stream is initialized and ready. +Returns true if the stream is initialized and ready. diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 10a5c6e082..c1e3e01e46 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -53,33 +53,33 @@ care about it. \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto} -\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}} +\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = false}} Sets the current location. {\it location} parameter passed to \helpref{OpenFile}{wxfilesystemopenfile} is relative to this path. -{\bf Caution! } Unless {\it is\_dir} is TRUE the {\it location} parameter +{\bf Caution! } Unless {\it is\_dir} is true the {\it location} parameter is not the directory name but the name of the file in this directory. All these commands change the path to "dir/subdir/": \begin{verbatim} ChangePathTo("dir/subdir/xh.htm"); - ChangePathTo("dir/subdir", TRUE); -C hangePathTo("dir/subdir/", TRUE); + ChangePathTo("dir/subdir", true); +C hangePathTo("dir/subdir/", true); \end{verbatim} \wxheading{Parameters} \docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}} -\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default) +\docparam{is\_dir}{if true {\it location} is new directory. If false (default) {\it location} is {\bf file in} the new directory.} \wxheading{Example} \begin{verbatim} f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm' - fs -> ChangePathTo("subdir/folder", TRUE); + fs -> ChangePathTo("subdir/folder", true); f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !! \end{verbatim} diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index dec6e31d8d..34ca77ed22 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -57,7 +57,7 @@ Constructor. \func{virtual bool}{CanOpen}{\param{const wxString\& }{location}} -Returns TRUE if the handler is able to open this file. This function doesn't +Returns true if the handler is able to open this file. This function doesn't check whether the file exists or not, it only checks if it knows the protocol. Example: @@ -122,7 +122,7 @@ Works like \helpref{wxFindFirstFile}{wxfindfirstfile}. Returns name of the first filename (within filesystem's current path) that matches {\it wildcard}. {\it flags} may be one of wxFILE (only files), wxDIR (only directories) or 0 (both). -This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns TRUE. +This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns true. \membersection{wxFileSystemHandler::FindNext}\label{wxfilesystemhandlerfindnext} @@ -130,7 +130,7 @@ This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} retu Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}. -This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns TRUE and FindFirst +This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns true and FindFirst returned a non-empty string. \membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile} diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index 9c9db0fcc8..22673a5a2f 100644 --- a/docs/latex/wx/filetype.tex +++ b/docs/latex/wx/filetype.tex @@ -7,7 +7,7 @@ object may be created in several different ways: the program might know the file extension and wish to find out the corresponding MIME type or, conversely, it might want to find the right extension for the file to which it writes the contents of given MIME type. Depending on how it was created some fields may be -unknown so the return value of all the accessors {\bf must} be checked: {\tt FALSE} +unknown so the return value of all the accessors {\bf must} be checked: {\tt false} will be returned if the corresponding information couldn't be found. The objects of this class are never created by the application code but are @@ -122,7 +122,7 @@ The destructor of this class is not virtual, so it should not be derived from. \func{bool}{GetMimeType}{\param{wxString*}{ mimeType}} -If the function returns {\tt TRUE}, the string pointed to by {\it mimeType} is filled +If the function returns {\tt true}, the string pointed to by {\it mimeType} is filled with full MIME type specification for this file type: for example, "text/plain". \membersection{wxFileType::GetMimeTypes}\label{wxfiletypegetmimetypes} @@ -139,14 +139,14 @@ mime.types. \func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}} -If the function returns {\tt TRUE}, the array {\it extensions} is filled +If the function returns {\tt true}, the array {\it extensions} is filled with all extensions associated with this file type: for example, it may contain the following two elements for the MIME type "text/html" (notice the absence of the leading dot): "html" and "htm". {\bf Windows:} This function is currently not implemented: there is no (efficient) way to retrieve associated extensions from the given MIME type on -this platform, so it will only return {\tt TRUE} if the wxFileType object was created +this platform, so it will only return {\tt true} if the wxFileType object was created by \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} function in the first place. @@ -154,7 +154,7 @@ function in the first place. \func{bool}{GetIcon}{\param{wxIcon*}{ icon}} -If the function returns {\tt TRUE}, the icon associated with this file type will be +If the function returns {\tt true}, the icon associated with this file type will be created and assigned to the {\it icon} parameter. {\bf Unix:} MIME manager gathers information about icons from GNOME @@ -165,7 +165,7 @@ of these desktop environments. \func{bool}{GetDescription}{\param{wxString*}{ desc}} -If the function returns {\tt TRUE}, the string pointed to by {\it desc} is filled +If the function returns {\tt true}, the string pointed to by {\it desc} is filled with a brief description for this file type: for example, "text document" for the "text/plain" MIME type. @@ -175,7 +175,7 @@ the "text/plain" MIME type. \func{wxString}{GetOpenCommand}{\param{const wxString\&}{ filename}} -With the first version of this method, if the {\tt TRUE} is returned, the +With the first version of this method, if the {\tt true} is returned, the string pointed to by {\it command} is filled with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in order to open the file of the given type. In this case, the name of the file as well as any other parameters @@ -191,7 +191,7 @@ to open this kind of files). \func{bool}{GetPrintCommand}{\param{wxString*}{ command},\param{MessageParameters\&}{ params}} -If the function returns {\tt TRUE}, the string pointed to by {\it command} is filled +If the function returns {\tt true}, the string pointed to by {\it command} is filled with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in order to print the file of the given type. The name of the file is retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class. diff --git a/docs/latex/wx/font.tex b/docs/latex/wx/font.tex index 7053109138..098f9ae29d 100644 --- a/docs/latex/wx/font.tex +++ b/docs/latex/wx/font.tex @@ -129,7 +129,7 @@ wxSWISS\_FONT} Default constructor. \func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, - \param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""}, + \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}} Creates a font object (see \helpref{font encoding @@ -155,7 +155,7 @@ overview}{wxfontencodingoverview} for the meaning of the last parameter). \docparam{weight}{One of {\bf wxNORMAL}, {\bf wxLIGHT} and {\bf wxBOLD}.} -\docparam{underline}{The value can be TRUE or FALSE. At present this has an effect on Windows only.} +\docparam{underline}{The value can be true or false. At present this has an effect on Windows only.} \docparam{faceName}{An optional string specifying the actual typeface to be used. If the empty string, a default typeface will chosen based on the family.} @@ -204,8 +204,8 @@ application data structure, and there is a risk of double deletion. \constfunc{bool}{IsFixedWidth}{\void} -Returns {\tt TRUE} if the font is a fixed width (or monospaced) font, -{\tt FALSE} if it is a proportional one or font is invalid. +Returns {\tt true} if the font is a fixed width (or monospaced) font, +{\tt false} if it is a proportional one or font is invalid. \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding} @@ -276,7 +276,7 @@ styles. \constfunc{bool}{GetUnderlined}{\void} -Returns TRUE if the font is underlined, FALSE otherwise. +Returns true if the font is underlined, false otherwise. \wxheading{See also} @@ -297,7 +297,7 @@ weight identifiers. \constfunc{bool}{Ok}{\void} -Returns {\tt TRUE} if this object is a valid font, {\tt FALSE} otherwise. +Returns {\tt true} if this object is a valid font, {\tt false} otherwise. \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding} @@ -400,7 +400,7 @@ Sets underlining. \wxheading{Parameters} -\docparam{underlining}{TRUE to underline, FALSE otherwise.} +\docparam{underlining}{true to underline, false otherwise.} \wxheading{See also} diff --git a/docs/latex/wx/fontdlg.tex b/docs/latex/wx/fontdlg.tex index 749e327b06..93e83bf0e6 100644 --- a/docs/latex/wx/fontdlg.tex +++ b/docs/latex/wx/fontdlg.tex @@ -23,7 +23,7 @@ This class holds a variety of information related to font dialogs. \func{}{wxFontData}{\void} Constructor. Initializes {\it fontColour} to black, {\it showHelp} to black, -\rtfsp{\it allowSymbols} to TRUE, {\it enableEffects} to TRUE, +\rtfsp{\it allowSymbols} to true, {\it enableEffects} to true, \rtfsp{\it minSize} to 0 and {\it maxSize} to 0. \membersection{wxFontData::\destruct{wxFontData}} @@ -39,7 +39,7 @@ Destructor. Enables or disables `effects' under MS Windows only. This refers to the controls for manipulating colour, strikeout and underline properties. -The default value is TRUE. +The default value is true. \membersection{wxFontData::GetAllowSymbols} @@ -48,7 +48,7 @@ The default value is TRUE. Under MS Windows, returns a flag determining whether symbol fonts can be selected. Has no effect on other platforms. -The default value is TRUE. +The default value is true. \membersection{wxFontData::GetColour} @@ -62,9 +62,9 @@ The default value is black. \func{wxFont}{GetChosenFont}{\void} -Gets the font chosen by the user. If the user pressed OK (wxFontDialog::Show returned TRUE), this returns +Gets the font chosen by the user. If the user pressed OK (wxFontDialog::Show returned true), this returns a new font which is now `owned' by the application, and should be deleted -if not required. If the user pressed Cancel (wxFontDialog::Show returned FALSE) or +if not required. If the user pressed Cancel (wxFontDialog::Show returned false) or the colour dialog has not been invoked yet, this will return NULL. \membersection{wxFontData::GetEnableEffects} @@ -74,7 +74,7 @@ the colour dialog has not been invoked yet, this will return NULL. Determines whether `effects' are enabled under Windows. This refers to the controls for manipulating colour, strikeout and underline properties. -The default value is TRUE. +The default value is true. \membersection{wxFontData::GetInitialFont} @@ -87,9 +87,9 @@ previously been set by the application. \func{bool}{GetShowHelp}{\void} -Returns TRUE if the Help button will be shown (Windows only). +Returns true if the Help button will be shown (Windows only). -The default value is FALSE. +The default value is false. \membersection{wxFontData::SetAllowSymbols} @@ -98,7 +98,7 @@ The default value is FALSE. Under MS Windows, determines whether symbol fonts can be selected. Has no effect on other platforms. -The default value is TRUE. +The default value is true. \membersection{wxFontData::SetChosenFont} @@ -134,7 +134,7 @@ The default is 0, 0 (unrestricted range). Determines whether the Help button will be displayed in the font dialog (Windows only). -The default value is FALSE. +The default value is false. \membersection{wxFontData::operator $=$} @@ -188,7 +188,7 @@ shown. \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}} Creates the dialog if it the wxFontDialog object had been initialized using the -default constructor. Returns {\tt TRUE} on success and {\tt FALSE} if an error +default constructor. Returns {\tt true} on success and {\tt false} if an error occured. \membersection{wxFontDialog::\destruct{wxFontDialog}} diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex index f60c0f5c8b..b697b74ec9 100644 --- a/docs/latex/wx/fontenum.tex +++ b/docs/latex/wx/fontenum.tex @@ -22,7 +22,7 @@ To do this, you just have to call one of EnumerateXXX() functions - either corresponding callback (\helpref{OnFacename}{wxfontenumeratoronfacename} or \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called repeatedly until either all fonts satisfying the specified criteria are -exhausted or the callback returns FALSE. +exhausted or the callback returns false. \wxheading{Virtual functions to override} @@ -54,11 +54,11 @@ None \func{virtual bool}{EnumerateFacenames}{ \param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM}, - \param{bool }{fixedWidthOnly = FALSE}} + \param{bool }{fixedWidthOnly = false}} Call \helpref{OnFacename}{wxfontenumeratoronfacename} for each font which supports given encoding (only if it is not wxFONTENCODING\_SYSTEM) and is of -fixed width (if {\it fixedWidthOnly} is TRUE). +fixed width (if {\it fixedWidthOnly} is true). Calling this function with default arguments will result in enumerating all fonts available on the system. @@ -96,7 +96,7 @@ it to work if you overwrite that method. \func{virtual bool}{OnFacename}{\param{const wxString\& }{font}} Called by \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} for -each match. Return TRUE to continue enumeration or FALSE to stop it. +each match. Return true to continue enumeration or false to stop it. \membersection{wxFontEnumerator::OnFontEncoding}\label{wxfontenumeratoronfontencoding} @@ -106,5 +106,5 @@ each match. Return TRUE to continue enumeration or FALSE to stop it. } Called by \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} for -each match. Return TRUE to continue enumeration or FALSE to stop it. +each match. Return true to continue enumeration or false to stop it. diff --git a/docs/latex/wx/fontlist.tex b/docs/latex/wx/fontlist.tex index f46812756e..d280119e4a 100644 --- a/docs/latex/wx/fontlist.tex +++ b/docs/latex/wx/fontlist.tex @@ -37,7 +37,7 @@ Used by wxWindows to add a font to the list, called in the font constructor. \membersection{wxFontList::FindOrCreateFont}\label{findorcreatefont} -\func{wxFont *}{FindOrCreateFont}{\param{int}{ point\_size}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, \param{bool}{ underline = FALSE}, +\func{wxFont *}{FindOrCreateFont}{\param{int}{ point\_size}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, \param{bool}{ underline = false}, \param{const wxString\& }{facename = NULL}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}{}} Finds a font of the given specification, or creates one and adds it to the list. See the \helpref{wxFont constructor}{wxfontconstr} for diff --git a/docs/latex/wx/fontmap.tex b/docs/latex/wx/fontmap.tex index fe252bc35c..b6b8836154 100644 --- a/docs/latex/wx/fontmap.tex +++ b/docs/latex/wx/fontmap.tex @@ -11,15 +11,15 @@ names and the fonts present on the machine. The default implementations of all functions will ask the user if they are not capable of finding the answer themselves and store the answer in a config file (configurable via SetConfigXXX functions). This behaviour may -be disabled by giving the value of FALSE to "interactive" parameter. +be disabled by giving the value of false to "interactive" parameter. However, the functions will always consult the config file to allow the user-defined values override the default logic and there is no way to disable this - which shouldn't be ever needed because if "interactive" was -never TRUE, the config file is never created anyhow. +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), +and "interactive" is false or user denied to choose any replacement), the class queries \helpref{wxEncodingConverter}{wxencodingconverter} for "equivalent" encodings (e.g. iso8859-2 and cp1250) and tries them. @@ -39,7 +39,7 @@ if (!wxFontMapper::Get()->IsEncodingAvailable(enc, facename)) { wxFontEncoding alternative; if (wxFontMapper::Get()->GetAltForEncoding(enc, &alternative, - facename, FALSE)) + facename, false)) { wxEncodingConverter encconv; if (!encconv.Init(enc, alternative)) @@ -99,14 +99,14 @@ one. \membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding} -\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}} +\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = true}} -\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxFontEncoding* }{alt\_encoding}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}} +\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxFontEncoding* }{alt\_encoding}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = true}} Find an alternative for the given encoding (which is supposed to not be -available on this system). If successful, return TRUE and fill info +available on this system). If successful, return true and fill info structure with the parameters required to create the font, otherwise -return FALSE. +return false. The first form is for wxWindows' internal use while the second one is better suitable for general use -- it returns wxFontEncoding which @@ -121,7 +121,7 @@ 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}} +\func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = true}} Returns the encoding for the given charset (in the form of RFC 2046) or wxFONTENCODING\_SYSTEM if couldn't decode it. diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index d7a6ce08f8..306e3a81fc 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -313,7 +313,7 @@ Iconizes or restores the frame. \wxheading{Parameters} -\docparam{iconize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.} +\docparam{iconize}{If true, iconizes the frame; if false, shows and restores it.} \wxheading{See also} @@ -323,7 +323,7 @@ Iconizes or restores the frame. \func{bool}{IsFullScreen}{\void} -Returns TRUE if the frame is in fullscreen mode. +Returns true if the frame is in fullscreen mode. \wxheading{See also} @@ -333,13 +333,13 @@ Returns TRUE if the frame is in fullscreen mode. \constfunc{bool}{IsIconized}{\void} -Returns TRUE if the frame is iconized. +Returns true if the frame is iconized. \membersection{wxFrame::IsMaximized}\label{wxframeismaximized} \constfunc{bool}{IsMaximized}{\void} -Returns TRUE if the frame is maximized. +Returns true if the frame is maximized. \membersection{wxFrame::Maximize}\label{wxframemaximize} @@ -349,7 +349,7 @@ 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} @@ -611,7 +611,7 @@ Sets the frame title. \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}} -Passing TRUE to {\it shows} shows the frame full-screen, and passing FALSE restores the frame +Passing true to {\it shows} shows the frame full-screen, and passing false restores the frame again. {\it style} is a bit list containing some or all of the following values, which indicate what elements of the frame to hide in full-screen mode: diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index def46870b0..c8a7156205 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -119,7 +119,7 @@ Destructor will close the connection if connected. \func{bool}{Abort}{\void} -Aborts the download currently in process, returns {\tt TRUE} if ok, {\tt FALSE} +Aborts the download currently in process, returns {\tt true} if ok, {\tt false} if an error occured. \membersection{wxFTP::CheckCommand} @@ -131,7 +131,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. \membersection{wxFTP::SendCommand}\label{wxftpsendcommand} @@ -154,21 +154,21 @@ command. \func{bool}{ChDir}{\param{const wxString\&}{ dir}} Change the current FTP working directory. -Returns TRUE if successful. +Returns true if successful. \membersection{wxFTP::MkDir} \func{bool}{MkDir}{\param{const wxString\&}{ dir}} Create the specified directory in the current FTP working directory. -Returns TRUE if successful. +Returns true if successful. \membersection{wxFTP::RmDir} \func{bool}{RmDir}{\param{const wxString\&}{ dir}} Remove the specified directory from the current FTP working directory. -Returns TRUE if successful. +Returns true if successful. \membersection{wxFTP::Pwd} @@ -182,7 +182,7 @@ Returns the current FTP working directory. \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}} -Rename the specified {\it src} element to {\it dst}. Returns TRUE if successful. +Rename the specified {\it src} element to {\it dst}. Returns true if successful. % ---------------------------------------------------------------------------- @@ -190,7 +190,7 @@ Rename the specified {\it src} element to {\it dst}. Returns TRUE if successful. \func{bool}{RmFile}{\param{const wxString\&}{ path}} -Delete the file specified by {\it path}. Returns TRUE if successful. +Delete the file specified by {\it path}. Returns true if successful. % ---------------------------------------------------------------------------- @@ -257,7 +257,7 @@ to specify a user and a password. \func{bool}{FileExists}{\param{const wxString\&}{ filename}} -Returns {\tt TRUE} if the given remote file exists, {\tt FALSE} otherwise. +Returns {\tt true} if the given remote file exists, {\tt false} otherwise. \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize} @@ -295,7 +295,7 @@ winamp~1 exe 520196 02-25-1999 19:28 winamp204.exe 1 file(s) 520 196 bytes \end{verbatim} -Return value: TRUE if the file list was successfully retrieved, FALSE +Return value: true if the file list was successfully retrieved, false otherwise. \wxheading{See also} @@ -311,7 +311,7 @@ directory (optionally only of the files matching the {\it wildcard}, all files by default). This list always has the same format and contains one full (including the directory path) file name per line. -Return value: TRUE if the file list was successfully retrieved, FALSE +Return value: true if the file list was successfully retrieved, false otherwise. % ---------------------------------------------------------------------------- diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 3a137b085c..9d855cb5aa 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -305,9 +305,9 @@ you can initialize wxWindows from an Microsoft Foundation Classes application us this function. \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, - \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}} + \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}} -wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the +wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows message loop will be entered. @@ -342,14 +342,14 @@ int CTheApp::ExitInstance() \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions} -\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}} +\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}} -If {\it doIt} is TRUE, the fatal exceptions (also known as general protection +If {\it doIt} is true, the fatal exceptions (also known as general protection faults under Windows or segmentation violations in the Unix world) will be caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}. By default, i.e. before this function is called, they will be handled in the normal way which usually just means that the application will be terminated. -Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore +Calling wxHandleFatalExceptions() with {\it doIt} equal to false will restore this default behaviour. \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers} @@ -375,7 +375,7 @@ This function is used in wxBase only and only if you don't create \helpref{wxApp}{wxapp} object at all. In this case you must call it from your {\tt main()} function before calling any other wxWindows functions. -If the function returns {\tt FALSE} the initialization could not be performed, +If the function returns {\tt false} the initialization could not be performed, in this case the library cannot be used and \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither. @@ -390,7 +390,7 @@ call to this function. \membersection{::wxSafeYield}\label{wxsafeyield} \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{ - onlyIfNeeded = FALSE}} + onlyIfNeeded = false}} This function is similar to wxYield, except that it disables the user input to all program windows before calling wxYield and re-enables it again @@ -485,7 +485,7 @@ $-1$ if the process couldn't be started and typically 0 if the process terminated successfully. Also, while waiting for the process to terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller should ensure that this can cause no recursion, in the simplest case by -calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}. +calling \helpref{wxEnableTopLevelWindows(false)}{wxenabletoplevelwindows}. For asynchronous execution, however, the return value is the process id and zero value indicates that the command could not be executed. As an added @@ -647,7 +647,7 @@ and that this function is only implemented under Unix and Win32. \wxheading{Returns} -{\tt TRUE} on success, {\tt FALSE} if an error occured. +{\tt true} on success, {\tt false} if an error occured. \wxheading{Include files} @@ -722,7 +722,7 @@ threads. \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} -Returns TRUE if the directory exists. +Returns true if the directory exists. \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename} @@ -735,7 +735,7 @@ slashes. \func{bool}{wxFileExists}{\param{const wxString\& }{filename}} -Returns TRUE if the file exists. It also returns TRUE if the file is +Returns true if the file exists. It also returns true if the file is a directory. \membersection{::wxFileModificationTime}\label{wxfilemodificationtime} @@ -799,7 +799,7 @@ information is not needed. \wxheading{Returns} -{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the +{\tt true} on success, {\tt false} if an error occured (for example, the directory doesn't exist). \wxheading{Portability} @@ -819,7 +819,7 @@ Returns the Windows directory under Windows; on other platforms returns the empt \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}} -Returns TRUE if the argument is an absolute filename, i.e. with a slash +Returns true if the argument is an absolute filename, i.e. with a slash or drive name at the beginning. \membersection{::wxPathOnly}\label{wxpathonly} @@ -841,15 +841,15 @@ slashes with backslashes. \param{const wxString\& }{file3}} Concatenates {\it file1} and {\it file2} to {\it file3}, returning -TRUE if successful. +true if successful. \membersection{::wxCopyFile}\label{wxcopyfile} -\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}} +\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}} -Copies {\it file1} to {\it file2}, returning TRUE if successful. If -{\it overwrite} parameter is TRUE (default), the destination file is overwritten -if it exists, but if {\it overwrite} is FALSE, the functions fails in this +Copies {\it file1} to {\it file2}, returning true if successful. If +{\it overwrite} parameter is true (default), the destination file is overwritten +if it exists, but if {\it overwrite} is false, the functions fails in this case. \membersection{::wxGetCwd}\label{wxgetcwd} @@ -894,21 +894,21 @@ instead. \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}} -Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}. +Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}. \membersection{::wxMatchWild}\label{wxmatchwild} \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}} -Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it -dot\_special}\/ is TRUE, filenames beginning with a dot are not matched +Returns true if the {\it pattern}\/ matches the {\it text}\/; if {\it +dot\_special}\/ is true, filenames beginning with a dot are not matched with wildcard characters. See \helpref{wxIsWild}{wxiswild}. \membersection{::wxMkdir}\label{wxmkdir} \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}} -Makes the directory {\it dir}, returning TRUE if successful. +Makes the directory {\it dir}, returning true if successful. {\it perm} is the access mask for the directory for the systems on which it is supported (Unix) and doesn't have effect for the other ones. @@ -917,19 +917,19 @@ supported (Unix) and doesn't have effect for the other ones. \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}} -Removes {\it file}, returning TRUE if successful. +Removes {\it file}, returning true if successful. \membersection{::wxRenameFile}\label{wxrenamefile} \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}} -Renames {\it file1} to {\it file2}, returning TRUE if successful. +Renames {\it file1} to {\it file2}, returning true if successful. \membersection{::wxRmdir}\label{wxrmdir} \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}} -Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS. +Removes the directory {\it dir}, returning true if successful. Does not work under VMS. The {\it flags} parameter is reserved for future use. @@ -937,7 +937,7 @@ The {\it flags} parameter is reserved for future use. \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}} -Sets the current working directory, returning TRUE if the operation succeeded. +Sets the current working directory, returning true if the operation succeeded. Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification. \membersection{::wxSplitPath}\label{wxsplitfunction} @@ -1026,7 +1026,7 @@ Copies the user's email address into the supplied buffer, by concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp and \helpref{wxGetUserId}{wxgetuserid}. -Returns TRUE if successful, FALSE otherwise. +Returns true if successful, false otherwise. \wxheading{Include files} @@ -1061,8 +1061,8 @@ variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp in the {\bf wxWindows} section of the WIN.INI file is tried. The first variant of this function returns the hostname if successful or an -empty string otherwise. The second (deprecated) function returns TRUE -if successful, FALSE otherwise. +empty string otherwise. The second (deprecated) function returns true +if successful, false otherwise. \wxheading{See also} @@ -1086,8 +1086,8 @@ variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId} in the {\bf wxWindows} section of the WIN.INI file is tried. The first variant of this function returns the login name if successful or an -empty string otherwise. The second (deprecated) function returns TRUE -if successful, FALSE otherwise. +empty string otherwise. The second (deprecated) function returns true +if successful, false otherwise. \wxheading{See also} @@ -1167,8 +1167,8 @@ is running, the entry {\bf Current} in the section {\bf User} of the PENWIN.INI file is used. The first variant of this function returns the user name if successful or an -empty string otherwise. The second (deprecated) function returns {\tt TRUE} -if successful, {\tt FALSE} otherwise. +empty string otherwise. The second (deprecated) function returns {\tt true} +if successful, {\tt false} otherwise. \wxheading{See also} @@ -1193,8 +1193,8 @@ This function is deprecated, use \helpref{wxString}{wxstring} class instead. \func{bool}{wxIsEmpty}{\param{const char *}{ p}} -Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty -string, {\tt FALSE} otherwise. +Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty +string, {\tt false} otherwise. \membersection{::wxStricmp}\label{wxstricmp} @@ -1209,12 +1209,12 @@ case-sensitive comparison. \membersection{::wxStringMatch}\label{wxstringmatch} \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\ - \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}} + \param{bool}{ subString = true}, \param{bool}{ exact = false}} {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead. -Returns {\tt TRUE} if the substring {\it s1} is found within {\it s2}, -ignoring case if {\it exact} is FALSE. If {\it subString} is {\tt FALSE}, +Returns {\tt true} if the substring {\it s1} is found within {\it s2}, +ignoring case if {\it exact} is false. If {\it subString} is {\tt false}, no substring matching is done. \membersection{::wxStringEq}\label{wxstringeq} @@ -1479,7 +1479,7 @@ is valid) if the dialog was cancelled. \param{const wxArrayString\& }{aChoices},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE},\\ + \param{bool}{ centre = true},\\ \param{int }{width=150}, \param{int }{height=200}} \func{size\_t}{wxGetMultipleChoices}{\\ @@ -1489,7 +1489,7 @@ is valid) if the dialog was cancelled. \param{int}{ n}, \param{const wxString\& }{choices[]},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE},\\ + \param{bool}{ centre = true},\\ \param{int }{width=150}, \param{int }{height=200}} Pops up a dialog box containing a message, OK/Cancel buttons and a @@ -1502,8 +1502,8 @@ You may pass the list of strings to choose from either using {\it choices} which is an array of {\it n} strings for the listbox or by using a single {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}. -If {\it centre} is TRUE, the message text (which may include new line -characters) is centred; if FALSE, the message is left-justified. +If {\it centre} is true, the message text (which may include new line +characters) is centred; if false, the message is left-justified. \wxheading{Include files} @@ -1557,14 +1557,14 @@ to be used for entering passwords as the function name implies. \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\ - \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}} + \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}} Pop up a dialog box with title set to {\it caption}, {\it message}, and a \rtfsp{\it default\_value}. The user may type in text and press OK to return this text, or press Cancel to return the empty string. -If {\it centre} is TRUE, the message text (which may include new line characters) -is centred; if FALSE, the message is left-justified. +If {\it centre} is true, the message text (which may include new line characters) +is centred; if false, the message is left-justified. \wxheading{Include files} @@ -1575,7 +1575,7 @@ is centred; if FALSE, the message is left-justified. \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ \param{int }{nsel}, \param{int *}{selection}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} + \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection listbox. The user may choose one or more item(s) and press OK or Cancel. @@ -1589,8 +1589,8 @@ If Cancel is pressed, -1 is returned. {\it choices} is an array of {\it n} strings for the listbox. -If {\it centre} is TRUE, the message text (which may include new line characters) -is centred; if FALSE, the message is left-justified. +If {\it centre} is true, the message text (which may include new line characters) +is centred; if false, the message is left-justified. \wxheading{Include files} @@ -1603,7 +1603,7 @@ is centred; if FALSE, the message is left-justified. \param{const wxArrayString\& }{aChoices},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE},\\ + \param{bool}{ centre = true},\\ \param{int }{width=150}, \param{int }{height=200}} \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\ @@ -1611,7 +1611,7 @@ is centred; if FALSE, the message is left-justified. \param{int}{ n}, \param{const wxString\& }{choices[]},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE},\\ + \param{bool}{ centre = true},\\ \param{int }{width=150}, \param{int }{height=200}} Pops up a dialog box containing a message, OK/Cancel buttons and a @@ -1624,8 +1624,8 @@ You may pass the list of strings to choose from either using {\it choices} which is an array of {\it n} strings for the listbox or by using a single {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}. -If {\it centre} is TRUE, the message text (which may include new line -characters) is centred; if FALSE, the message is left-justified. +If {\it centre} is true, the message text (which may include new line +characters) is centred; if false, the message is left-justified. \wxheading{Include files} @@ -1640,13 +1640,13 @@ and {\tt choices}.} \param{const wxString\& }{caption},\\ \param{const wxArrayString\& }{aChoices},\\ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} + \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\ \param{const wxString\& }{caption},\\ \param{int}{ n}, \param{const wxString\& }{choices[]},\\ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} + \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} As {\bf wxGetSingleChoice} but returns the index representing the selected string. If the user pressed cancel, -1 is returned. @@ -1666,7 +1666,7 @@ and {\tt choices}.} \param{const wxString\& }{client\_data[]},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} + \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\ \param{const wxString\& }{caption},\\ @@ -1674,7 +1674,7 @@ and {\tt choices}.} \param{const wxString\& }{client\_data[]},\\ \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} + \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} As {\bf wxGetSingleChoice} but takes an array of client data pointers corresponding to the strings, and returns one of these pointers or NULL if @@ -1693,7 +1693,7 @@ same length as the choices array.} \func{bool}{wxIsBusy}{\void} -Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp +Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp \helpref{wxEndBusyCursor}{wxendbusycursor} calls. See also \helpref{wxBusyCursor}{wxbusycursor}. @@ -1753,7 +1753,7 @@ The symbols are not shown when the generic function is used. \func{bool}{wxShowTip}{\param{wxWindow *}{parent}, \param{wxTipProvider *}{tipProvider}, - \param{bool }{showAtStartup = TRUE}} + \param{bool }{showAtStartup = true}} This function shows a "startup tip" to the user. The return value is the state of the ``Show tips at startup'' checkbox. @@ -1763,7 +1763,7 @@ state of the ``Show tips at startup'' checkbox. \docparam{tipProvider}{An object which is used to get the text of the tips. It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.} -\docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE +\docparam{showAtStartup}{Should be true if startup tips are shown, false otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog.} @@ -1816,7 +1816,7 @@ provide this info for all window managers, etc. \func{bool}{wxColourDisplay}{\void} -Returns TRUE if the display is colour, FALSE otherwise. +Returns true if the display is colour, false otherwise. \membersection{::wxDisplayDepth}\label{wxdisplaydepth} @@ -2030,7 +2030,7 @@ class instead. \func{bool}{wxClipboardOpen}{\void} -Returns TRUE if this application has already opened the clipboard. +Returns true if this application has already opened the clipboard. \membersection{::wxCloseClipboard}\label{wxcloseclipboard} @@ -2090,7 +2090,7 @@ length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}} -Returns TRUE if the given data format is available on the clipboard. +Returns true if the given data format is available on the clipboard. \membersection{::wxOpenClipboard}\label{wxopenclipboard} @@ -2220,7 +2220,7 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} -\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} +\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}} This function enables or disables all top level windows. It is used by \helpref{::wxSafeYield}{wxsafeyield}. @@ -3388,11 +3388,11 @@ should be used instead. For retrieving the current time, you may also use \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime} -\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}} +\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}} Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}. -If {\it resetTimer} is TRUE (the default), the timer is reset to zero +If {\it resetTimer} is true (the default), the timer is reset to zero by this call. See also \helpref{wxTimer}{wxtimer}. @@ -3521,7 +3521,7 @@ the global application object exists. \func{}{wxASSERT}{\param{}{condition}} -Assert macro. An error message will be generated if the condition is FALSE in +Assert macro. An error message will be generated if the condition is false in debug mode, but nothing will be done in the release build. Please note that the condition in wxASSERT() should have no side effects @@ -3554,7 +3554,7 @@ You may use it like this, for example: \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}} -Assert macro with message. An error message will be generated if the condition is FALSE. +Assert macro with message. An error message will be generated if the condition is false. \wxheading{See also} @@ -3707,7 +3707,7 @@ Returns the current value of the environment variable {\it var} in {\it value}. {\it value} may be {\tt NULL} if you just want to know if the variable exists and are not interested in its value. -Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise. +Returns {\tt true} if the variable exists, {\tt false} otherwise. \membersection{wxSetEnv}\label{wxsetenv} @@ -3716,7 +3716,7 @@ Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise. Sets the value of the environment variable {\it var} (adding it if necessary) to {\it value}. -Returns {\tt TRUE} on success. +Returns {\tt true} on success. \membersection{wxUnsetEnv}\label{wxunsetenv} @@ -3726,5 +3726,5 @@ Removes the variable {\it var} from the environment. \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this function. -Returns {\tt TRUE} on success. +Returns {\tt true} on success. diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index 99971585be..02c787d465 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -117,9 +117,9 @@ table (see \helpref{wxGrid::SetTable}{wxgridsettable}). \membersection{wxGrid::AppendCols}\label{wxgridappendcols} -\func{bool}{AppendCols}{\param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{AppendCols}{\param{int }{numCols = 1}, \param{bool }{updateLabels = true}} -Appends one or more new columns to the right of the grid and returns TRUE if +Appends one or more new columns to the right of the grid and returns true if successful. The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override @@ -128,9 +128,9 @@ If you are using a derived grid table class you will need to override \membersection{wxGrid::AppendRows}\label{wxgridappendrows} -\func{bool}{AppendRows}{\param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{AppendRows}{\param{int }{numRows = 1}, \param{bool }{updateLabels = true}} -Appends one or more new rows to the bottom of the grid and returns TRUE if +Appends one or more new rows to the bottom of the grid and returns true if successful. The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override @@ -149,9 +149,9 @@ The memory requirements for this could become prohibitive if your grid is very l \membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn} -\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = TRUE}} +\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = true}} -Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will +Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will also be set as the minimal width for the column. \wxheading{Note}\\ @@ -160,9 +160,9 @@ The memory requirements for this could become prohibitive if your grid is very l \membersection{wxGrid::AutoSizeColumns}\label{wxgridautosizecolumns} -\func{void}{AutoSizeColumns}{\param{bool }{setAsMin = TRUE}} +\func{void}{AutoSizeColumns}{\param{bool }{setAsMin = true}} -Automatically sizes all columns to fit their contents. If setAsMin is TRUE the calculated widths will +Automatically sizes all columns to fit their contents. If setAsMin is true the calculated widths will also be set as the minimal widths for the columns. \wxheading{Note}\\ @@ -171,9 +171,9 @@ The memory requirements for this could become prohibitive if your grid is very l \membersection{wxGrid::AutoSizeRow}\label{wxgridautosizerow} -\func{void}{AutoSizeRow}{\param{int }{row}, \param{bool }{setAsMin = TRUE}} +\func{void}{AutoSizeRow}{\param{int }{row}, \param{bool }{setAsMin = true}} -Automatically sizes the row to fit its contents. If setAsMin is TRUE the calculated height will +Automatically sizes the row to fit its contents. If setAsMin is true the calculated height will also be set as the minimal height for the row. \wxheading{Note}\\ @@ -182,9 +182,9 @@ The memory requirements for this could become prohibitive if your grid is very l \membersection{wxGrid::AutoSizeRows}\label{wxgridautosizerows} -\func{void}{AutoSizeRows}{\param{bool }{setAsMin = TRUE}} +\func{void}{AutoSizeRows}{\param{bool }{setAsMin = true}} -Automatically sizes all rows to fit their contents. If setAsMin is TRUE the calculated heights will +Automatically sizes all rows to fit their contents. If setAsMin is true the calculated heights will also be set as the minimal heights for the rows. \wxheading{Note}\\ @@ -205,7 +205,7 @@ screen flicker. The final EndBatch will cause the grid to be repainted. \func{bool}{CanDragColSize}{\void} -Returns TRUE if columns can be resized by dragging with the mouse. Columns can be resized +Returns true if columns can be resized by dragging with the mouse. Columns can be resized by dragging the edges of their labels. If grid line dragging is enabled they can also be resized by dragging the right edge of the column in the grid cell area (see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}). @@ -214,7 +214,7 @@ resized by dragging the right edge of the column in the grid cell area \func{bool}{CanDragRowSize}{\void} -Returns TRUE if rows can be resized by dragging with the mouse. Rows can be resized +Returns true if rows can be resized by dragging with the mouse. Rows can be resized by dragging the edges of their labels. If grid line dragging is enabled they can also be resized by dragging the lower edge of the row in the grid cell area (see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}). @@ -223,14 +223,14 @@ resized by dragging the lower edge of the row in the grid cell area \func{bool}{CanDragGridSize}{\void} -Return TRUE if the dragging of grid lines to resize rows and columns is enabled or FALSE otherwise. +Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise. \membersection{wxGrid::CanEnableCellControl}\label{wxgridcanenablecellcontrol} \constfunc{bool}{CanEnableCellControl}{\void} -Returns TRUE if the in-place edit control for the current grid cell can be used and -FALSE otherwise (e.g. if the current cell is read-only). +Returns true if the in-place edit control for the current grid cell can be used and +false otherwise (e.g. if the current cell is read-only). \membersection{wxGrid::CellToRect}\label{wxgridcelltorect} @@ -270,10 +270,10 @@ class and pass a table object to the grid with \helpref{wxGrid::SetTable}{wxgrid \membersection{wxGrid::DeleteCols}\label{wxgriddeletecols} -\func{bool}{DeleteCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{DeleteCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}} Deletes one or more columns from a grid starting at the specified position and returns -TRUE if successful. The updateLabels argument is not used at present. +true if successful. The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override \helpref{wxGridTableBase::DeleteCols}{wxgridtablebasedeletecols}. See @@ -281,10 +281,10 @@ If you are using a derived grid table class you will need to override \membersection{wxGrid::DeleteRows}\label{wxgriddeleterows} -\func{bool}{DeleteRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{DeleteRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}} Deletes one or more rows from a grid starting at the specified position and returns -TRUE if successful. The updateLabels argument is not used at present. +true if successful. The updateLabels argument is not used at present. If you are using a derived grid table class you will need to override \helpref{wxGridTableBase::DeleteRows}{wxgridtablebasedeleterows}. See @@ -295,13 +295,13 @@ If you are using a derived grid table class you will need to override \func{void}{DisableCellEditControl}{\void} Disables in-place editing of grid cells. -Equivalent to calling EnableCellEditControl(FALSE). +Equivalent to calling EnableCellEditControl(false). \membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize} \func{void}{DisableDragColSize}{\void} -Disables column sizing by dragging with the mouse. Equivalent to passing FALSE to +Disables column sizing by dragging with the mouse. Equivalent to passing false to \helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}. \membersection{wxGrid::DisableDragGridSize}\label{wxgriddisabledraggridsize} @@ -309,37 +309,37 @@ Disables column sizing by dragging with the mouse. Equivalent to passing FALSE t \func{void}{DisableDragGridSize}{\void} Disable mouse dragging of grid lines to resize rows and columns. Equivalent to passing -FALSE to \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize} +false to \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize} \membersection{wxGrid::DisableDragRowSize}\label{wxgriddisabledragrowsize} \func{void}{DisableDragRowSize}{\void} -Disables row sizing by dragging with the mouse. Equivalent to passing FALSE to +Disables row sizing by dragging with the mouse. Equivalent to passing false to \helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}. \membersection{wxGrid::EnableCellEditControl}\label{wxgridenablecelleditcontrol} -\func{void}{EnableCellEditControl}{\param{bool }{enable = TRUE}} +\func{void}{EnableCellEditControl}{\param{bool }{enable = true}} Enables or disables in-place editing of grid cell data. The grid will issue either a wxEVT\_GRID\_EDITOR\_SHOWN or wxEVT\_GRID\_EDITOR\_HIDDEN event. \membersection{wxGrid::EnableDragColSize}\label{wxgridenabledragcolsize} -\func{void}{EnableDragColSize}{\param{bool }{enable = TRUE}} +\func{void}{EnableDragColSize}{\param{bool }{enable = true}} Enables or disables column sizing by dragging with the mouse. \membersection{wxGrid::EnableDragGridSize}\label{wxgridenabledraggridsize} -\func{void}{EnableDragGridSize}{\param{bool }{enable = TRUE}} +\func{void}{EnableDragGridSize}{\param{bool }{enable = true}} Enables or disables row and column resizing by dragging gridlines with the mouse. \membersection{wxGrid::EnableDragRowSize}\label{wxgridenabledragrowsize} -\func{void}{EnableDragRowSize}{\param{bool }{enable = TRUE}} +\func{void}{EnableDragRowSize}{\param{bool }{enable = true}} Enables or disables row sizing by dragging with the mouse. @@ -347,8 +347,8 @@ Enables or disables row sizing by dragging with the mouse. \func{void}{EnableEditing}{\param{bool }{edit}} -If the edit argument is FALSE this function sets the whole grid as read-only. If the -argument is TRUE the grid is set to the default state where cells may be editable. In the +If the edit argument is false this function sets the whole grid as read-only. If the +argument is true the grid is set to the default state where cells may be editable. In the default state you can set single grid cells and whole rows and columns to be editable or read-only via \helpref{wxGridCellAttribute::SetReadOnly}{wxgridcellattrsetreadonly}. For single @@ -361,7 +361,7 @@ For more information about controlling grid cell attributes see the \membersection{wxGrid::EnableGridLines}\label{wxgridenablegridlines} -\func{void}{EnableGridLines}{\param{bool }{enable = TRUE}} +\func{void}{EnableGridLines}{\param{bool }{enable = true}} Turns the drawing of grid lines on or off. @@ -581,7 +581,7 @@ Returns the colour used for grid lines. \func{bool}{GridLinesEnabled}{\void} -Returns TRUE if drawing of grid lines is turned on, FALSE otherwise. +Returns true if drawing of grid lines is turned on, false otherwise. \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour} @@ -699,10 +699,10 @@ Hides the in-place cell edit control. \membersection{wxGrid::InsertCols}\label{wxgridinsertcols} -\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}} Inserts one or more new columns into a grid with the first new column at the -specified position and returns TRUE if successful. The updateLabels argument is not +specified position and returns true if successful. The updateLabels argument is not used at present. The sequence of actions begins with the grid object requesting the underlying grid @@ -716,10 +716,10 @@ table class. \membersection{wxGrid::InsertRows}\label{wxgridinsertrows} -\func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}} +\func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}} Inserts one or more new rows into a grid with the first new row at the specified -position and returns TRUE if successful. The updateLabels argument is not used at +position and returns true if successful. The updateLabels argument is not used at present. The sequence of actions begins with the grid object requesting the underlying grid @@ -735,20 +735,20 @@ table class. \constfunc{bool}{IsCellEditControlEnabled}{\void} -Returns TRUE if the in-place edit control is currently enabled. +Returns true if the in-place edit control is currently enabled. \membersection{wxGrid::IsCurrentCellReadOnly}\label{wxgridiscurrentcellreadonly} \constfunc{bool}{IsCurrentCellReadOnly}{\void} -Returns TRUE if the current cell has been set to read-only +Returns true if the current cell has been set to read-only (see \helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}). \membersection{wxGrid::IsEditable}\label{wxgridiseditable} \func{bool}{IsEditable}{\void} -Returns FALSE if the whole grid has been set as read-only or TRUE otherwise. +Returns false if the whole grid has been set as read-only or true otherwise. See \helpref{wxGrid::EnableEditing}{wxgridenableediting} for more information about controlling the editing status of grid cells. @@ -764,22 +764,22 @@ Is this cell currently selected. \constfunc{bool}{IsReadOnly}{\param{int }{row}, \param{int }{col}} -Returns TRUE if the cell at the specified location can't be edited. +Returns true if the cell at the specified location can't be edited. See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}. \membersection{wxGrid::IsSelection}\label{wxgridisselection} \func{bool}{IsSelection}{\void} -Returns TRUE if there are currently rows, columns or blocks of cells selected. +Returns true if there are currently rows, columns or blocks of cells selected. \membersection{wxGrid::IsVisible}\label{wxgridisvisible} -\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = TRUE}} +\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}} -\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = TRUE}} +\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}} -Returns TRUE if a cell is either wholly visible (the default) or at least partially +Returns true if a cell is either wholly visible (the default) or at least partially visible in the grid window. \membersection{wxGrid::MakeCellVisible}\label{wxgridmakecellvisible} @@ -796,7 +796,7 @@ nothing if the cell is already visible. \func{bool}{MoveCursorDown}{\param{bool }{expandSelection}} Moves the grid cursor down by one row. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for Down cursor key presses or Shift+Down to expand a selection. @@ -806,7 +806,7 @@ This function is called for Down cursor key presses or Shift+Down to expand a se \func{bool}{MoveCursorLeft}{\param{bool }{expandSelection}} Moves the grid cursor left by one column. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for Left cursor key presses or Shift+Left to expand a selection. @@ -816,7 +816,7 @@ This function is called for Left cursor key presses or Shift+Left to expand a se \func{bool}{MoveCursorRight}{\param{bool }{expandSelection}} Moves the grid cursor right by one column. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for Right cursor key presses or Shift+Right to expand a selection. @@ -826,7 +826,7 @@ This function is called for Right cursor key presses or Shift+Right to expand a \func{bool}{MoveCursorUp}{\param{bool }{expandSelection}} Moves the grid cursor up by one row. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for Up cursor key presses or Shift+Up to expand a selection. @@ -837,7 +837,7 @@ This function is called for Up cursor key presses or Shift+Up to expand a select Moves the grid cursor down in the current column such that it skips to the beginning or end of a block of non-empty cells. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expands a selection. @@ -848,7 +848,7 @@ This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expan Moves the grid cursor left in the current row such that it skips to the beginning or end of a block of non-empty cells. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expands a selection. @@ -859,7 +859,7 @@ This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expan Moves the grid cursor right in the current row such that it skips to the beginning or end of a block of non-empty cells. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right expands a selection. @@ -870,7 +870,7 @@ This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right exp Moves the grid cursor up in the current column such that it skips to the beginning or end of a block of non-empty cells. If a block of cells was previously selected it -will expand if the argument is TRUE or be cleared if the argument is FALSE. +will expand if the argument is true or be cleared if the argument is false. \wxheading{Keyboard}\\ This function is called for the Ctrl+Up key combination. Shift+Ctrl+Up expands a selection. @@ -913,27 +913,27 @@ Selects all cells in the grid. \membersection{wxGrid::SelectBlock}\label{wxgridselectblock} \func{void}{SelectBlock}{\param{int }{topRow}, \param{int }{leftCol}, -\param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = FALSE}} +\param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = false}} \func{void}{SelectBlock}{\param{const wxGridCellCoords\& }{topLeft}, -\param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{addToSelected = FALSE}} +\param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{addToSelected = false}} -Selects a rectangular block of cells. If addToSelected is FALSE then any existing selection will be -deselected; if TRUE the column will be added to the existing selection. +Selects a rectangular block of cells. If addToSelected is false then any existing selection will be +deselected; if true the column will be added to the existing selection. \membersection{wxGrid::SelectCol}\label{wxgridselectcol} -\func{void}{SelectCol}{\param{int }{col}, \param{bool }{addToSelected = FALSE}} +\func{void}{SelectCol}{\param{int }{col}, \param{bool }{addToSelected = false}} -Selects the specified column. If addToSelected is FALSE then any existing selection will be -deselected; if TRUE the column will be added to the existing selection. +Selects the specified column. If addToSelected is false then any existing selection will be +deselected; if true the column will be added to the existing selection. \membersection{wxGrid::SelectRow}\label{wxgridselectrow} -\func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = FALSE}} +\func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = false}} -Selects the specified row. If addToSelected is FALSE then any existing selection will be -deselected; if TRUE the row will be added to the existing selection. +Selects the specified row. If addToSelected is false then any existing selection will be +deselected; if true the row will be added to the existing selection. \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment} @@ -1081,7 +1081,7 @@ Sets the width of the specified column. This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes. -Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will +Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will also be set as the minimal width for the column. \wxheading{Note}\\ @@ -1130,17 +1130,17 @@ the \helpref{wxGrid overview}{gridoverview} for more information about cell edit \membersection{wxGrid::SetDefaultColSize}\label{wxgridsetdefaultcolsize} -\func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = FALSE}} +\func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = false}} Sets the default width for columns in the grid. This will only affect columns subsequently added to -the grid unless resizeExistingCols is TRUE. +the grid unless resizeExistingCols is true. \membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize} -\func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = FALSE}} +\func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = false}} Sets the default height for rows in the grid. This will only affect rows subsequently added -to the grid unless resizeExistingRows is TRUE. +to the grid unless resizeExistingRows is true. \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor} @@ -1175,7 +1175,7 @@ Sets the colour for row and column label text. \membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly} -\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = TRUE}} +\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = true}} Makes the cell at the specified location read-only or editable. See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}. @@ -1228,7 +1228,7 @@ Sets the height of the specified row. This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes. -Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will +Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will also be set as the minimal width for the column. \wxheading{Note} @@ -1252,11 +1252,11 @@ Set the selection behaviour of the grid. \membersection{wxGrid::SetTable}\label{wxgridsettable} -\func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = FALSE}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}} +\func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = false}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}} Passes a pointer to a custom grid table to be used by the grid. This should be called after the grid constructor and before using the grid object. If takeOwnership is set to -TRUE then the table will be deleted by the wxGrid destructor. +true then the table will be deleted by the wxGrid destructor. Use this function instead of \helpref{wxGrid::CreateGrid}{wxgridcreategrid} when your application involves complex or non-string data or data sets that are too large to fit @@ -1521,7 +1521,7 @@ Returned number of whole cols visible. \membersection{wxGrid::SetEditable}\label{wxgridseteditable} -\func{void}{SetEditable}{\param{bool }{edit = TRUE}} +\func{void}{SetEditable}{\param{bool }{edit = true}} \membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace} @@ -1531,7 +1531,7 @@ Returned number of whole cols visible. \membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace} -\func{void}{SetEditInPlace}{\param{bool }{edit = TRUE}} +\func{void}{SetEditInPlace}{\param{bool }{edit = true}} \membersection{wxGrid::SetCellBitmap}\label{wxgridsetcellbitmap} @@ -1614,13 +1614,13 @@ This function must be public for compatibility. \membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes} -\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}} +\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}} Common part of AutoSizeColumn/Row() and GetBestSize() \membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes} -\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}} +\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}} \membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow} diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex index 0ad74b1840..0cb367494c 100644 --- a/docs/latex/wx/gridattr.tex +++ b/docs/latex/wx/gridattr.tex @@ -72,7 +72,7 @@ Sets the alignment. \membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly} -\func{void}{SetReadOnly}{\param{bool }{isReadOnly = TRUE}} +\func{void}{SetReadOnly}{\param{bool }{isReadOnly = true}} \membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer} diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex index 1ece7cec6b..01bbf9db1d 100644 --- a/docs/latex/wx/gridedit.tex +++ b/docs/latex/wx/gridedit.tex @@ -51,11 +51,11 @@ The editor for string data allowing to choose from a list of strings. \membersection{wxGridCellChoiceEditor::wxGridCellChoiceEditor}\label{wxgridcellchoiceeditorconstr} -\func{}{wxGridCellChoiceEditor}{\param{size\_t }{count = 0}, \param{const wxString }{choices[] = NULL}, \param{bool }{allowOthers = FALSE}} +\func{}{wxGridCellChoiceEditor}{\param{size\_t }{count = 0}, \param{const wxString }{choices[] = NULL}, \param{bool }{allowOthers = false}} \docparam{count}{Number of strings from which the user can choose.} \docparam{choices}{An array of strings from which the user can choose.} -\docparam{allowOthers}{If allowOthers if TRUE, the user can type a string not in choices array.} +\docparam{allowOthers}{If allowOthers if true, the user can type a string not in choices array.} \membersection{wxGridCellChoiceEditor::SetParameters}\label{wxgridcellchoiceeditorsetparameters} diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex index cc92ca3774..bbab71e4ed 100644 --- a/docs/latex/wx/gridevt.tex +++ b/docs/latex/wx/gridevt.tex @@ -92,8 +92,8 @@ Default constructor. \func{}{wxGridEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj}, \param{int }{row = -1}, \param{int }{col = -1}, \param{int }{x = -1}, \param{int }{y = -1}, - \param{bool }{sel = TRUE}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE}, - \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}} + \param{bool }{sel = true}, \param{bool }{control = false}, \param{bool }{shift = false}, + \param{bool }{alt = false}, \param{bool }{meta = false}} \wxheading{Parameters} @@ -101,13 +101,13 @@ Default constructor. \func{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the event. +Returns true if the Alt key was down at the time of the event. \membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown} \func{bool}{ControlDown}{\void} -Returns TRUE if the Control key was down at the time of the event. +Returns true if the Control key was down at the time of the event. \membersection{wxGridEvent::GetCol}\label{wxgrideventgetcol} @@ -131,20 +131,20 @@ Row at which the event occurred. \func{bool}{MetaDown}{\void} -Returns TRUE if the Meta key was down at the time of the event. +Returns true if the Meta key was down at the time of the event. \membersection{wxGridEvent::Selecting}\label{wxgrideventselecting} \func{bool}{Selecting}{\void} -Returns TRUE if the user deselected a cell, FALSE if the user +Returns true if the user deselected a cell, false if the user deselected a cell. \membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown} \func{bool}{ShiftDown}{\void} -Returns TRUE if the Shift key was down at the time of the event. +Returns true if the Shift key was down at the time of the event. \section{\class{wxGridRangeSelectEvent}}\label{wxgridrangeselectevent} @@ -175,21 +175,21 @@ Default constructor. \func{}{wxGridRangeSelectEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj}, \param{const wxGridCellCoords\& }{topLeft}, - \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = TRUE}, - \param{bool }{control = FALSE}, \param{bool }{shift = FALSE}, \param{bool }{alt = FALSE}, - \param{bool }{meta = FALSE}} + \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = true}, + \param{bool }{control = false}, \param{bool }{shift = false}, \param{bool }{alt = false}, + \param{bool }{meta = false}} \membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown} \func{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the event. +Returns true if the Alt key was down at the time of the event. \membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown} \func{bool}{ControlDown}{\void} -Returns TRUE if the Control key was down at the time of the event. +Returns true if the Control key was down at the time of the event. \membersection{wxGridRangeSelectEvent::GetBottomRightCoords}\label{wxgridrangeselecteventgetbottomrightcoords} @@ -231,19 +231,19 @@ Top row of the rectangular area that was (de)selected. \func{bool}{MetaDown}{\void} -Returns TRUE if the Meta key was down at the time of the event. +Returns true if the Meta key was down at the time of the event. \membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting} \func{bool}{Selecting}{\void} -Returns TRUE if the area was selected, FALSE otherwise. +Returns true if the area was selected, false otherwise. \membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown} \func{bool}{ShiftDown}{\void} -Returns TRUE if the Shift key was down at the time of the event. +Returns true if the Shift key was down at the time of the event. \section{\class{wxGridSizeEvent}}\label{wxgridsizeevent} @@ -281,20 +281,20 @@ Default constructor. \func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1}, - \param{int }{y = -1}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE}, - \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}} + \param{int }{y = -1}, \param{bool }{control = false}, \param{bool }{shift = false}, + \param{bool }{alt = false}, \param{bool }{meta = false}} \membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown} \func{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the event. +Returns true if the Alt key was down at the time of the event. \membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown} \func{bool}{ControlDown}{\void} -Returns TRUE if the Control key was down at the time of the event. +Returns true if the Control key was down at the time of the event. \membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition} @@ -312,11 +312,11 @@ Row or column at that was resized. \func{bool}{MetaDown}{\void} -Returns TRUE if the Meta key was down at the time of the event. +Returns true if the Meta key was down at the time of the event. \membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown} \func{bool}{ShiftDown}{\void} -Returns TRUE if the Shift key was down at the time of the event. +Returns true if the Shift key was down at the time of the event. diff --git a/docs/latex/wx/hash.tex b/docs/latex/wx/hash.tex index 3609e1c5f5..afd8c0a635 100644 --- a/docs/latex/wx/hash.tex +++ b/docs/latex/wx/hash.tex @@ -90,7 +90,7 @@ Deletes entry in hash table and returns the user's data (if found). \func{void}{DeleteContents}{\param{bool}{ flag}} -If set to TRUE data stored in hash table will be deleted when hash table object +If set to true data stored in hash table will be deleted when hash table object is destroyed. diff --git a/docs/latex/wx/hashmap.tex b/docs/latex/wx/hashmap.tex index ce05912dd7..1a48cf60b3 100644 --- a/docs/latex/wx/hashmap.tex +++ b/docs/latex/wx/hashmap.tex @@ -155,7 +155,7 @@ This function can actually return 0 or 1. \constfunc{bool}{empty}{} -Returns TRUE if the hash map does not contain any element, FALSE otherwise. +Returns true if the hash map does not contain any element, false otherwise. \membersection{wxHashMap::end} diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex index ed8f7836ed..253ab1b66e 100644 --- a/docs/latex/wx/helpevt.tex +++ b/docs/latex/wx/helpevt.tex @@ -45,7 +45,7 @@ function that takes a wxHelpEvent argument. \membersection{wxHelpEvent::wxHelpEvent} -\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{wxWindowID }{id = 0}, +\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{wxWindowID }{id = 0}, \param{const wxPoint\& }{point}} Constructor. diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex index 43a266c295..d550dcad41 100644 --- a/docs/latex/wx/helpinst.tex +++ b/docs/latex/wx/helpinst.tex @@ -125,7 +125,7 @@ contents. Displays the section as a popup window using a context id. -Returns FALSE if unsuccessful or not implemented. +Returns false if unsuccessful or not implemented. \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection} @@ -163,7 +163,7 @@ See also the help sample for notes on how to specify section numbers for various Displays the text in a popup window, if possible. -Returns FALSE if unsuccessful or not implemented. +Returns false if unsuccessful or not implemented. \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters} @@ -222,7 +222,7 @@ This does not work for all help controllers. \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title}, \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition}, - \param{bool }{newFrameEachTime = FALSE}} + \param{bool }{newFrameEachTime = false}} For wxHtmlHelpController, the title is set (again with \%s indicating the page title) and also the size and position of the frame if the frame is already diff --git a/docs/latex/wx/helpprov.tex b/docs/latex/wx/helpprov.tex index 43b26022e1..93f7d9c0e0 100644 --- a/docs/latex/wx/helpprov.tex +++ b/docs/latex/wx/helpprov.tex @@ -57,7 +57,7 @@ the window. Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if applicable. -Returns TRUE if it was done, or FALSE if no help was available +Returns true if it was done, or false if no help was available for this window. \membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp} diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index 6733cfabc5..bb10e8d0c7 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -45,7 +45,7 @@ should not be crossed by words, images etc.). If this cell cannot be divided into two pieces (each one on another page) then it moves the pagebreak few pixels up. -Returns TRUE if pagebreak was modified, FALSE otherwise +Returns true if pagebreak was modified, false otherwise Usage: \begin{verbatim} @@ -224,8 +224,8 @@ you should use wxHtmlBinderCell instead. \docparam{x, y}{coordinates of mouse click (this is relative to cell's origin} -\docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right -button is pressed, FALSE otherwise} +\docparam{left, middle, right}{boolean flags for mouse buttons. true if the left/middle/right +button is pressed, false otherwise} \membersection{wxHtmlCell::SetId}\label{wxhtmlcellsetid} diff --git a/docs/latex/wx/htdcrend.tex b/docs/latex/wx/htdcrend.tex index 2ecfad889a..f36de1860d 100644 --- a/docs/latex/wx/htdcrend.tex +++ b/docs/latex/wx/htdcrend.tex @@ -56,7 +56,7 @@ width of the rectangle between calls to \helpref{Render}{wxhtmldcrendererrender} \membersection{wxHtmlDCRenderer::SetHtmlText}\label{wxhtmldcrenderersethtmltext} -\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}} +\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}} Assign text to the renderer. \helpref{Render}{wxhtmldcrendererrender} then draws the text onto DC. @@ -68,12 +68,12 @@ the text onto DC. \docparam{basepath}{base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.} -\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name +\docparam{isdir}{false if basepath is filename, true if it is directory name (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} \membersection{wxHtmlDCRenderer::Render}\label{wxhtmldcrendererrender} -\func{int}{Render}{\param{int }{x}, \param{int }{y}, \param{int }{from = 0}, \param{int }{dont\_render = FALSE}} +\func{int}{Render}{\param{int }{x}, \param{int }{y}, \param{int }{from = 0}, \param{int }{dont\_render = false}} Renders HTML text to the DC. @@ -83,7 +83,7 @@ Renders HTML text to the DC. \docparam{from}{y-coordinate of the very first visible cell} -\docparam{dont\_render}{if TRUE then this method only returns y coordinate of the next page +\docparam{dont\_render}{if true then this method only returns y coordinate of the next page and does not output anything} Returned value is y coordinate of first cell than didn't fit onto page. diff --git a/docs/latex/wx/hteasypr.tex b/docs/latex/wx/hteasypr.tex index ec4b0d337d..9a27dc6a96 100644 --- a/docs/latex/wx/hteasypr.tex +++ b/docs/latex/wx/hteasypr.tex @@ -45,7 +45,7 @@ Constructor. Preview HTML file. -Returns FALSE in case of error -- call +Returns false in case of error -- call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. @@ -56,7 +56,7 @@ information about the kind of the error. Preview HTML text (not file!). -Returns FALSE in case of error -- call +Returns false in case of error -- call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. @@ -73,7 +73,7 @@ file). It is used to determine path for loading images, for example.} Print HTML file. -Returns FALSE in case of error -- call +Returns false in case of error -- call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. @@ -83,7 +83,7 @@ information about the kind of the error. Print HTML text (not file!). -Returns FALSE in case of error -- call +Returns false in case of error -- call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. diff --git a/docs/latex/wx/htfilter.tex b/docs/latex/wx/htfilter.tex index dc80e9618d..22caf024b2 100644 --- a/docs/latex/wx/htfilter.tex +++ b/docs/latex/wx/htfilter.tex @@ -33,7 +33,7 @@ Constructor. \func{bool}{CanRead}{\param{const wxFSFile\& }{file}} -Returns TRUE if this filter is capable of reading file {\it file}. +Returns true if this filter is capable of reading file {\it file}. Example: diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index acb5cbfe7e..e7230bb8e2 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -97,7 +97,7 @@ is possible and, in fact, recommended way. \wxheading{Parameters} -\docparam{show\_wait\_msg}{If TRUE then a decoration-less window with progress message is displayed.} +\docparam{show\_wait\_msg}{If true then a decoration-less window with progress message is displayed.} \docparam{book\_file}{Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.} \docparam{book\_url}{Help book URL (note that syntax of filename and URL is @@ -166,7 +166,7 @@ Displays help window and focuses index panel. \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}} Displays help window, focuses search panel and starts searching. -Returns TRUE if the keyword was found. +Returns true if the keyword was found. {\bf Important:} KeywordSearch searches only pages listed in .hhc file(s). You should list all pages in the contents file. diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex index 1e4f412867..324264b8a8 100644 --- a/docs/latex/wx/hthlpfrm.tex +++ b/docs/latex/wx/hthlpfrm.tex @@ -62,13 +62,13 @@ for parameters description. \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents} -\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}} +\func{void}{CreateContents}{\param{bool }{show\_progress = false}} Creates contents panel. (May take some time.) \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex} -\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}} +\func{void}{CreateIndex}{\param{bool }{show\_progress = false}} Creates index panel. (May take some time.) @@ -133,7 +133,7 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists} -\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}} +\func{void}{RefreshLists}{\param{bool }{show\_progress = false}} Refresh all panels. This is necessary if a new book was added. diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex index b7693ca40e..7375979b4a 100644 --- a/docs/latex/wx/htprint.tex +++ b/docs/latex/wx/htprint.tex @@ -75,7 +75,7 @@ any virtual file system or it may be normal file. \membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext} -\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}} +\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}} Prepare the class for printing this HTML text. @@ -86,7 +86,7 @@ Prepare the class for printing this HTML text. \docparam{basepath}{base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.} -\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name +\docparam{isdir}{false if basepath is filename, true if it is directory name (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex index f349b9906b..6f4297fba3 100644 --- a/docs/latex/wx/httag.tex +++ b/docs/latex/wx/httag.tex @@ -88,7 +88,7 @@ and name of {\tt } is "TABLE") \membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam} -\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}} +\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = false}} Returns the value of the parameter. You should check whether the parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. @@ -97,7 +97,7 @@ parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. \docparam{par}{The parameter's name.} -\docparam{with\_commas}{TRUE if you want to get commas as well. See example.} +\docparam{with\_commas}{true if you want to get commas as well. See example.} \wxheading{Example} @@ -109,7 +109,7 @@ dummy = tag.GetParam("SIZE"); // dummy == "+2" dummy = tag.GetParam("COLOR"); // dummy == "#0000FF" -dummy = tag.GetParam("COLOR", TRUE); +dummy = tag.GetParam("COLOR", true); // dummy == "\"#0000FF\"" -- see the difference!! \end{verbatim} @@ -120,7 +120,7 @@ dummy = tag.GetParam("COLOR", TRUE); Interprets tag parameter {\it par} as colour specification and saves its value into wxColour variable pointed by {\it clr}. -Returns TRUE on success and FALSE if {\it par} is not colour specification or +Returns true on success and false if {\it par} is not colour specification or if the tag has no such parameter. \membersection{wxHtmlTag::GetParamAsInt}\label{wxhtmltaggetparamasint} @@ -130,14 +130,14 @@ if the tag has no such parameter. Interprets tag parameter {\it par} as an integer and saves its value into int variable pointed by {\it value}. -Returns TRUE on success and FALSE if {\it par} is not an integer or +Returns true on success and false if {\it par} is not an integer or if the tag has no such parameter. \membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending} \constfunc{bool}{HasEnding}{\void} -Returns TRUE if this tag is paired with ending tag, FALSE otherwise. +Returns true if this tag is paired with ending tag, false otherwise. See the example of HTML document: @@ -158,7 +158,7 @@ is ending itself) of course doesn't have ending tag. \constfunc{bool}{HasParam}{\param{const wxString\& }{par}} -Returns TRUE if the tag has a parameter of the given name. +Returns true if the tag has a parameter of the given name. Example : {\tt } has two parameters named "SIZE" and "COLOR". @@ -170,7 +170,7 @@ Example : {\tt } has two parameters named \constfunc{bool}{IsEnding}{\void} -Returns TRUE if this tag is ending one. +Returns true if this tag is ending one. ({\tt } is ending tag, {\tt } is not) \membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam} diff --git a/docs/latex/wx/httaghnd.tex b/docs/latex/wx/httaghnd.tex index a5d6879bab..0056d355a6 100644 --- a/docs/latex/wx/httaghnd.tex +++ b/docs/latex/wx/httaghnd.tex @@ -50,8 +50,8 @@ info (see \helpref{wxHtmlTag}{wxhtmltag} for details). \wxheading{Return value} -TRUE if \helpref{ParseInner}{wxhtmltaghandlerparseinner} was called, -FALSE otherwise. +true if \helpref{ParseInner}{wxhtmltaghandlerparseinner} was called, +false otherwise. \wxheading{Example} diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index cbedbca677..a9465449c2 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -72,7 +72,7 @@ Appends HTML fragment to currently displayed text and refreshes the window. \wxheading{Return value} -FALSE if an error occurred, TRUE otherwise. +false if an error occurred, true otherwise. \membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} @@ -163,7 +163,7 @@ htmlwin -> SetPage("help/myproject/index.htm"); \wxheading{Return value} -FALSE if an error occurred, TRUE otherwise +false if an error occurred, true otherwise \membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked} @@ -332,7 +332,7 @@ If you want to load a document from some location use \wxheading{Return value} -FALSE if an error occurred, TRUE otherwise. +false if an error occurred, true otherwise. \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex index 9e2424ff7b..2b63d822ea 100644 --- a/docs/latex/wx/htwinprs.tex +++ b/docs/latex/wx/htwinprs.tex @@ -123,7 +123,7 @@ and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}. \constfunc{int}{GetFontBold}{\void} -Returns TRUE if actual font is bold, FALSE otherwise. +Returns true if actual font is bold, false otherwise. \membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface} @@ -135,13 +135,13 @@ Returns actual font face name. \constfunc{int}{GetFontFixed}{\void} -Returns TRUE if actual font is fixed face, FALSE otherwise. +Returns true if actual font is fixed face, false otherwise. \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic} \constfunc{int}{GetFontItalic}{\void} -Returns TRUE if actual font is italic, FALSE otherwise. +Returns true if actual font is italic, false otherwise. \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize} @@ -153,7 +153,7 @@ Returns actual font size (HTML size varies from -2 to +4) \constfunc{int}{GetFontUnderlined}{\void} -Returns TRUE if actual font is underlined, FALSE otherwise. +Returns true if actual font is underlined, false otherwise. \membersection{wxHtmlWinParser::GetInputEncoding}\label{wxhtmlwinparsergetinputencoding} @@ -233,7 +233,7 @@ inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.) \func{void}{SetFontBold}{\param{int }{x}} -Sets bold flag of actualfont. {\it x} is either TRUE of FALSE. +Sets bold flag of actualfont. {\it x} is either true of false. \membersection{wxHtmlWinParser::SetFontFace}\label{wxhtmlwinparsersetfontface} @@ -247,13 +247,13 @@ inside {\tt } tag or not). \func{void}{SetFontFixed}{\param{int }{x}} -Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE. +Sets fixed face flag of actualfont. {\it x} is either true of false. \membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic} \func{void}{SetFontItalic}{\param{int }{x}} -Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. +Sets italic flag of actualfont. {\it x} is either true of false. \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} @@ -265,7 +265,7 @@ Sets actual font size (HTML size varies from 1 to 7) \func{void}{SetFontUnderlined}{\param{int }{x}} -Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE. +Sets underlined flag of actualfont. {\it x} is either true of false. \membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts} diff --git a/docs/latex/wx/hworld.tex b/docs/latex/wx/hworld.tex index 8a821f1e21..2d52211ecb 100644 --- a/docs/latex/wx/hworld.tex +++ b/docs/latex/wx/hworld.tex @@ -105,15 +105,15 @@ As mentioned above, wxApp::OnInit() is called upon startup and should be used to initialize the program, maybe showing a "splash screen" and creating the main window (or several). The frame should get a title bar text ("Hello World") and a position and start-up size. One frame can also be declared to be the -top window. Returning TRUE indicates a successful initialization. +top window. Returning true indicates a successful initialization. \begin{verbatim} bool MyApp::OnInit() { MyFrame *frame = new MyFrame( "Hello World", wxPoint(50,50), wxSize(450,340) ); - frame->Show( TRUE ); + frame->Show( true ); SetTopWindow( frame ); - return TRUE; + return true; } \end{verbatim} @@ -142,14 +142,14 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) \end{verbatim} Here are the actual event handlers. MyFrame::OnQuit() closes the main window -by calling Close(). The parameter TRUE indicates that other windows have no veto +by calling Close(). The parameter true indicates that other windows have no veto power such as after asking "Do you really want to close?". If there is no other main window left, the application will quit. \begin{verbatim} void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) { - Close( TRUE ); + Close( true ); } \end{verbatim} diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index 29cfd76ac8..7d2ca62537 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -264,7 +264,7 @@ The validity of these flags depends on the platform and wxWindows configuration. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -274,7 +274,7 @@ TRUE if the operation succeeded, FALSE otherwise. \constfunc{bool}{Ok}{\void} -Returns TRUE if icon data is present. +Returns true if icon data is present. \begin{comment} \membersection{wxIcon::SaveFile}\label{wxiconsavefile} @@ -303,7 +303,7 @@ The validity of these flags depends on the platform and wxWindows configuration. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -383,7 +383,7 @@ equal (a fast test). \wxheading{Return value} -Returns TRUE if the icons were effectively equal, FALSE otherwise. +Returns true if the icons were effectively equal, false otherwise. \membersection{wxIcon::operator $!=$} @@ -398,6 +398,6 @@ unequal (a fast test). \wxheading{Return value} -Returns TRUE if the icons were unequal, FALSE otherwise. +Returns true if the icons were unequal, false otherwise. diff --git a/docs/latex/wx/iconevt.tex b/docs/latex/wx/iconevt.tex index 5a02b8f1da..ac11d82eaa 100644 --- a/docs/latex/wx/iconevt.tex +++ b/docs/latex/wx/iconevt.tex @@ -44,7 +44,7 @@ member function that takes a wxIconizeEvent argument. \membersection{wxIconizeEvent::wxIconizeEvent}\label{wxiconizeeventctor} -\func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = TRUE}} +\func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = true}} Constructor. @@ -52,6 +52,6 @@ Constructor. \constfunc{bool}{Iconized}{\void} -Returns {\tt TRUE} if the frame has been iconized, {\tt FALSE} if it has been +Returns {\tt true} if the frame has been iconized, {\tt false} if it has been restored. diff --git a/docs/latex/wx/idleevt.tex b/docs/latex/wx/idleevt.tex index edba768343..5ba984e481 100644 --- a/docs/latex/wx/idleevt.tex +++ b/docs/latex/wx/idleevt.tex @@ -39,7 +39,7 @@ Constructor. \membersection{wxIdleEvent::RequestMore}\label{wxidleeventrequestmore} -\func{void}{RequestMore}{\param{bool}{ needMore = TRUE}} +\func{void}{RequestMore}{\param{bool}{ needMore = true}} Tells wxWindows that more processing is required. This function can be called by an OnIdle handler for a window or window event handler to indicate that wxApp::OnIdle should @@ -55,7 +55,7 @@ new event is posted to the application by the windowing system. \constfunc{bool}{MoreRequested}{\void} -Returns TRUE if the OnIdle function processing this event requested more processing time. +Returns true if the OnIdle function processing this event requested more processing time. \wxheading{See also} diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 5f2dd48af5..2de5f97266 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -81,10 +81,10 @@ and forth without loss in that respect. Creates an image with the given width and height. -\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=FALSE}} +\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=false}} Creates an image from given data with the given width and height. If -{\it static\_data} is TRUE, then wxImage will not delete the actual +{\it static\_data} is true, then wxImage will not delete the actual image data in its destructor, otherwise it will free it by calling {\it free()}. @@ -199,7 +199,7 @@ of a given handler class in an application session.} \func{bool}{CanRead}{\param{const wxString\&}{ filename}} -returns TRUE if the current image handlers can read this file +returns true if the current image handlers can read this file \pythonnote{In wxPython this static method is named {\tt wxImage\_AddHandler}.} \membersection{wxImage::CleanUpHandlers} @@ -271,7 +271,7 @@ Creates a fresh image. \wxheading{Return value} -TRUE if the call succeeded, FALSE otherwise. +true if the call succeeded, false otherwise. \membersection{wxImage::Destroy}\label{wximagedestroy} @@ -296,7 +296,7 @@ order) by 1 until an unused colour is found or the colour space exhausted. \wxheading{Return value} -Returns FALSE if there is no unused colour left, TRUE on success. +Returns false if there is no unused colour left, true on success. \wxheading{Notes} @@ -467,7 +467,7 @@ Gets the width of the image in pixels. \constfunc{bool}{HasMask}{\void} -Returns TRUE if there is a mask active, FALSE otherwise. +Returns true if there is a mask active, false otherwise. \membersection{wxImage::GetOption}\label{wximagegetoption} @@ -500,7 +500,7 @@ Gets a user-defined option as an integer. The function is case-insensitive to {\ \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}} -Returns TRUE if the given option is present. The function is case-insensitive to {\it name}. +Returns true if the given option is present. The function is case-insensitive to {\it name}. \wxheading{See also} @@ -596,8 +596,8 @@ hotspot for loaded cursor file: \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. If the optional index parameter is out of range, -FALSE is returned and a call to wxLogError() takes place. +true if the operation succeeded, false otherwise. If the optional index parameter is out of range, +false is returned and a call to wxLogError() takes place. \wxheading{See also} @@ -625,7 +625,7 @@ mimetype from a file} \constfunc{bool}{Ok}{\void} -Returns TRUE if image data is present. +Returns true if image data is present. \membersection{wxImage::RemoveHandler} @@ -638,7 +638,7 @@ is not deleted. \wxheading{Return value} -TRUE if the handler was found and removed, FALSE otherwise. +true if the handler was found and removed, false otherwise. \wxheading{See also} @@ -689,7 +689,7 @@ Saves an image in the given stream. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -727,7 +727,7 @@ mimetype to the named file} \membersection{wxImage::Mirror}\label{wximagemirror} -\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = TRUE}} +\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = true}} Returns a mirrored copy of the image. The parameter {\it horizontally} indicates the orientation. @@ -755,9 +755,9 @@ Returns the (modified) image itself. \membersection{wxImage::Rotate}\label{wximagerotate} \func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre}, - \param{bool}{ interpolating = TRUE}, \param{wxPoint*}{ offsetAfterRotation = NULL}} + \param{bool}{ interpolating = true}, \param{wxPoint*}{ offsetAfterRotation = NULL}} -Rotates the image about the given point, by {\it angle} radians. Passing TRUE +Rotates the image about the given point, by {\it angle} radians. Passing true to {\it interpolating} results in better image quality, but is slower. If the image has a mask, then the mask colour is used for the uncovered pixels in the rotated image background. Else, black (rgb 0, 0, 0) will be used. @@ -766,7 +766,7 @@ Returns the rotated image, leaving this image intact. \membersection{wxImage::Rotate90}\label{wximagerotate90} -\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = TRUE}} +\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = true}} Returns a copy of the image rotated 90 degrees in the direction indicated by {\it clockwise}. @@ -822,7 +822,7 @@ Do not pass to this function a pointer obtained through \membersection{wxImage::SetMask}\label{wximagesetmask} -\func{void}{SetMask}{\param{bool}{ hasMask = TRUE}} +\func{void}{SetMask}{\param{bool}{ hasMask = true}} Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour. @@ -850,8 +850,8 @@ in {\it mask} has given RGB value. \wxheading{Return value} -Returns FALSE if {\it mask} does not have same dimensions as the image or if -there is no unused colour left. Returns TRUE if the mask was successfully +Returns false if {\it mask} does not have same dimensions as the image or if +there is no unused colour left. Returns true if the mask was successfully applied. \wxheading{Notes} @@ -922,7 +922,7 @@ equal (a fast test). \wxheading{Return value} -Returns TRUE if the images were effectively equal, FALSE otherwise. +Returns true if the images were effectively equal, false otherwise. \membersection{wxImage::operator $!=$} @@ -937,7 +937,7 @@ unequal (a fast test). \wxheading{Return value} -Returns TRUE if the images were unequal, FALSE otherwise. +Returns true if the images were unequal, false otherwise. \section{\class{wxImageHandler}}\label{wximagehandler} @@ -1024,7 +1024,7 @@ Gets the MIME type associated with this handler. \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile} -\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=TRUE}, \param{int}{ index=0}} +\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=true}, \param{int}{ index=0}} Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains more than one image and the image handler is capable of retrieving these individually, {\it index} @@ -1036,13 +1036,13 @@ indicates which image to read from the stream. \docparam{stream}{Opened input stream for reading image data.} -\docparam{verbose}{If set to TRUE, errors reported by the image handler will produce wxLogMessages.} +\docparam{verbose}{If set to true, errors reported by the image handler will produce wxLogMessages.} \docparam{index}{The index of the image in the file (starting from zero).} \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -1064,7 +1064,7 @@ Saves a image in the output stream. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 8ae464ae15..9fcf045a69 100644 --- a/docs/latex/wx/imaglist.tex +++ b/docs/latex/wx/imaglist.tex @@ -28,7 +28,7 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec Default constructor. -\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp +\func{}{wxImageList}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp \param{int }{initialCount = 1}} Constructor specifying the image size, whether image masks should be created, and the initial size of the list. @@ -39,7 +39,7 @@ Constructor specifying the image size, whether image masks should be created, an \docparam{height}{Height of the images in the list.} -\docparam{mask}{TRUE if masks should be created for all images.} +\docparam{mask}{true if masks should be created for all images.} \docparam{initialCount}{The initial size of the list.} @@ -89,7 +89,7 @@ implements the following methods:\par } \membersection{wxImageList::Create}\label{wximagelistcreate} -\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = TRUE},\rtfsp +\func{bool}{Create}{\param{int }{width}, \param{int }{height}, \param{const bool }{mask = true},\rtfsp \param{int }{initialCount = 1}} Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} for details. @@ -98,7 +98,7 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp \param{int }{x}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp -\param{const bool }{solidBackground = FALSE}} +\param{const bool }{solidBackground = false}} Draws a specified image onto a device context. @@ -148,7 +148,7 @@ parameter is ignored as all images in the list have the same size. \wxheading{Return value} -TRUE if the function succeeded, FALSE if it failed (for example, if the image +true if the function succeeded, false if it failed (for example, if the image list was not yet initialized). \membersection{wxImageList::Remove}\label{wximagelistremove} @@ -183,7 +183,7 @@ Replaces the existing image with the new image. \wxheading{Return value} -TRUE if the replacement was successful, FALSE otherwise. +true if the replacement was successful, false otherwise. \wxheading{Remarks} diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index 9c3d8adec6..a46d41fa39 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -40,7 +40,7 @@ Returns the first character in the input queue and removes it. \constfunc{wxInputStream}{Eof}{\void} -Returns TRUE if the end of stream has been reached. +Returns true if the end of stream has been reached. \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread} diff --git a/docs/latex/wx/ipcclint.tex b/docs/latex/wx/ipcclint.tex index 8aeda255fe..cf1c9c6826 100644 --- a/docs/latex/wx/ipcclint.tex +++ b/docs/latex/wx/ipcclint.tex @@ -81,6 +81,6 @@ the new class. \func{bool}{ValidHost}{\param{const wxString\& }{host}} -Returns TRUE if this is a valid host name, FALSE otherwise. This always -returns TRUE under MS Windows. +Returns true if this is a valid host name, false otherwise. This always +returns true under MS Windows. diff --git a/docs/latex/wx/ipcconn.tex b/docs/latex/wx/ipcconn.tex index a369c052d9..44e2fb6d7c 100644 --- a/docs/latex/wx/ipcconn.tex +++ b/docs/latex/wx/ipcconn.tex @@ -89,7 +89,7 @@ mainly for backwards compatibility. Called by the server application to advise the client of a change in the data associated with the given item. Causes the client connection's \helpref{wxConnection::OnAdvise}{wxddeconnectiononadvise} member -to be called. Returns TRUE if successful. +to be called. Returns true if successful. \membersection{wxConnection::Execute}\label{wxddeconnectionexecute} @@ -99,7 +99,7 @@ Called by the client application to execute a command on the server. Can also be used to transfer arbitrary data to the server (similar to \helpref{wxConnection::Poke}{wxddeconnectionpoke} in that respect). Causes the server connection's \helpref{wxConnection::OnExecute}{wxddeconnectiononexecute} -member to be called. Returns TRUE if successful. +member to be called. Returns true if successful. \membersection{wxConnection::Disconnect} @@ -108,7 +108,7 @@ member to be called. Returns TRUE if successful. Called by the client or server application to disconnect from the other program; it causes the \helpref{wxConnection::OnDisconnect}{wxddeconnectionondisconnect} message to be sent to the corresponding connection object in the -other program. Returns TRUE if successful or already disconnected. +other program. Returns true if successful or already disconnected. The application that calls {\bf Disconnect} must explicitly delete its side of the connection. @@ -163,7 +163,7 @@ course persist after the call returns. Message sent to the server application by the client, when the client wishes to start an `advise loop' for the given topic and item. The -server can refuse to participate by returning FALSE. +server can refuse to participate by returning false. \membersection{wxConnection::OnStopAdvise}\label{wxddeconnectiononstopadvise} @@ -171,7 +171,7 @@ server can refuse to participate by returning FALSE. Message sent to the server application by the client, when the client wishes to stop an `advise loop' for the given topic and item. The -server can refuse to stop the advise loop by returning FALSE, although +server can refuse to stop the advise loop by returning false, although this doesn't have much meaning in practice. \membersection{wxConnection::Poke}\label{wxddeconnectionpoke} @@ -184,7 +184,7 @@ server connection's \helpref{wxConnection::OnPoke}{wxddeconnectiononpoke} member be called. If size is -1 the size is computed from the string length of data. -Returns TRUE if successful. +Returns true if successful. \membersection{wxConnection::Request}\label{wxddeconnectionrequest} @@ -206,7 +206,7 @@ does not need to be deleted. Called by the client application to ask if an advise loop can be started with the server. Causes the server connection's \helpref{wxConnection::OnStartAdvise}{wxddeconnectiononstartadvise}\rtfsp -member to be called. Returns TRUE if the server okays it, FALSE +member to be called. Returns true if the server okays it, false otherwise. \membersection{wxConnection::StopAdvise}\label{wxddeconnectionstopadvise} @@ -215,6 +215,6 @@ otherwise. Called by the client application to ask if an advise loop can be stopped. Causes the server connection's \helpref{wxConnection::OnStopAdvise}{wxddeconnectiononstopadvise} -member to be called. Returns TRUE if the server okays it, FALSE +member to be called. Returns true if the server okays it, false otherwise. diff --git a/docs/latex/wx/ipcservr.tex b/docs/latex/wx/ipcservr.tex index 6657e20ea8..98a4d7bd96 100644 --- a/docs/latex/wx/ipcservr.tex +++ b/docs/latex/wx/ipcservr.tex @@ -46,7 +46,7 @@ the service name may be either an integer port identifier in which case an Internet domain socket will be used for the communications, or a valid file name (which shouldn't exist and will be deleted afterwards) in which case a Unix domain socket is -created. FALSE is returned if the call failed (for example, the +created. false is returned if the call failed (for example, the port number is already in use). \membersection{wxServer::OnAcceptConnection}\label{wxddeserveronacceptconnection} diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex index 1e2fddfdb5..b561a33bb6 100644 --- a/docs/latex/wx/ipvaddr.tex +++ b/docs/latex/wx/ipvaddr.tex @@ -29,7 +29,7 @@ or an IP-style address in dot notation (a.b.c.d) \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +Returns true on success, false if something goes wrong (invalid hostname or invalid IP address). % @@ -54,7 +54,7 @@ Set the port to that corresponding to the specified {\it service}. \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +Returns true on success, false if something goes wrong (invalid service). % @@ -69,7 +69,7 @@ Set the port to that corresponding to the specified {\it service}. \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +Returns true on success, false if something goes wrong (invalid service). % @@ -98,7 +98,7 @@ to {\bf INADDR\_ANY}. \wxheading{Return value} -Returns TRUE on success, FALSE if something went wrong. +Returns true on success, false if something went wrong. % % LocalHost @@ -115,5 +115,5 @@ hosts and avoid other small problems. \wxheading{Return value} -Returns TRUE on success, FALSE if something went wrong. +Returns true on success, false if something went wrong. diff --git a/docs/latex/wx/joyevent.tex b/docs/latex/wx/joyevent.tex index 8f2e8b3ced..fc67dd7de0 100644 --- a/docs/latex/wx/joyevent.tex +++ b/docs/latex/wx/joyevent.tex @@ -41,7 +41,7 @@ Constructor. \constfunc{bool}{ButtonDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the event was a down event from the specified button (or any button). +Returns true if the event was a down event from the specified button (or any button). \wxheading{Parameters} @@ -52,7 +52,7 @@ indicate any button down event.} \constfunc{bool}{ButtonIsDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the specified button (or any button) was in a down state. +Returns true if the specified button (or any button) was in a down state. \wxheading{Parameters} @@ -63,7 +63,7 @@ indicate any button down event.} \constfunc{bool}{ButtonUp}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the event was an up event from the specified button (or any button). +Returns true if the event was an up event from the specified button (or any button). \wxheading{Parameters} @@ -106,17 +106,17 @@ Returns the z position of the joystick event. \constfunc{bool}{IsButton}{\void} -Returns TRUE if this was a button up or down event ({\it not} 'is any button down?'). +Returns true if this was a button up or down event ({\it not} 'is any button down?'). \membersection{wxJoystickEvent::IsMove}\label{wxjoystickeventismove} \constfunc{bool}{IsMove}{\void} -Returns TRUE if this was an x, y move event. +Returns true if this was an x, y move event. \membersection{wxJoystickEvent::IsZMove}\label{wxjoystickeventiszmove} \constfunc{bool}{IsZMove}{\void} -Returns TRUE if this was a z move event. +Returns true if this was a z move event. diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex index 7520b28603..72c473017f 100644 --- a/docs/latex/wx/joystick.tex +++ b/docs/latex/wx/joystick.tex @@ -215,49 +215,49 @@ Returns the z position of the joystick. \constfunc{bool}{HasPOV}{\void} -Returns TRUE if the joystick has a point of view control. +Returns true if the joystick has a point of view control. \membersection{wxJoystick::HasPOV4Dir}\label{wxjoystickhaspovfdir} \constfunc{bool}{HasPOV4Dir}{\void} -Returns TRUE if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right). +Returns true if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right). \membersection{wxJoystick::HasPOVCTS}\label{wxjoystickhaspovcts} \constfunc{bool}{HasPOVCTS}{\void} -Returns TRUE if the joystick point-of-view supports continuous degree bearings. +Returns true if the joystick point-of-view supports continuous degree bearings. \membersection{wxJoystick::HasRudder}\label{wxjoystickhasrudder} \constfunc{bool}{HasRudder}{\void} -Returns TRUE if there is a rudder attached to the computer. +Returns true if there is a rudder attached to the computer. \membersection{wxJoystick::HasU}\label{wxjoystickhasu} \constfunc{bool}{HasU}{\void} -Returns TRUE if the joystick has a U axis. +Returns true if the joystick has a U axis. \membersection{wxJoystick::HasV}\label{wxjoystickhasv} \constfunc{bool}{HasV}{\void} -Returns TRUE if the joystick has a V axis. +Returns true if the joystick has a V axis. \membersection{wxJoystick::HasZ}\label{wxjoystickhasz} \constfunc{bool}{HasZ}{\void} -Returns TRUE if the joystick has a Z axis. +Returns true if the joystick has a Z axis. \membersection{wxJoystick::IsOk}\label{wxjoystickisok} \constfunc{bool}{IsOk}{\void} -Returns TRUE if the joystick is functioning. +Returns true if the joystick is functioning. \membersection{wxJoystick::ReleaseCapture}\label{wxjoystickreleasecapture} @@ -267,7 +267,7 @@ Releases the capture set by {\bf SetCapture}. \wxheading{Return value} -TRUE if the capture release succeeded. +true if the capture release succeeded. \wxheading{See also} @@ -288,7 +288,7 @@ threshold. If greater than zero, events are received every {\it pollingFreq} mil \wxheading{Return value} -TRUE if the capture succeeded. +true if the capture succeeded. \wxheading{See also} diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex index d6dbea27fb..daaafb0258 100644 --- a/docs/latex/wx/keyevent.tex +++ b/docs/latex/wx/keyevent.tex @@ -82,13 +82,13 @@ functions that take a wxKeyEvent argument. \member{bool}{m\_altDown} -TRUE if the Alt key is pressed down. +true if the Alt key is pressed down. \membersection{wxKeyEvent::m\_controlDown} \member{bool}{m\_controlDown} -TRUE if control is pressed down. +true if control is pressed down. \membersection{wxKeyEvent::m\_keyCode} @@ -100,13 +100,13 @@ Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers. \member{bool}{m\_metaDown} -TRUE if the Meta key is pressed down. +true if the Meta key is pressed down. \membersection{wxKeyEvent::m\_shiftDown} \member{bool}{m\_shiftDown} -TRUE if shift is pressed down. +true if shift is pressed down. \membersection{wxKeyEvent::m\_x} @@ -130,13 +130,13 @@ Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CH \constfunc{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the key event. +Returns true if the Alt key was down at the time of the key event. \membersection{wxKeyEvent::ControlDown} \constfunc{bool}{ControlDown}{\void} -Returns TRUE if the control key was down at the time of the key event. +Returns true if the control key was down at the time of the key event. \membersection{wxKeyEvent::GetKeyCode} @@ -182,7 +182,7 @@ Returns the Y position of the event. \constfunc{bool}{MetaDown}{\void} -Returns TRUE if the Meta key was down at the time of the key event. +Returns true if the Meta key was down at the time of the key event. \membersection{wxKeyEvent::GetPosition} @@ -196,7 +196,7 @@ Obtains the position at which the key was pressed. \constfunc{bool}{HasModifiers}{\void} -Returns TRUE if either {\sc Ctrl} or {\sc Alt} keys was down +Returns true if either {\sc Ctrl} or {\sc Alt} keys was down at the time of the key event. Note that this function does not take into account neither {\sc Shift} nor {\sc Meta} key states (the reason for ignoring the latter is that it is common for {\sc NumLock} key to be configured as @@ -207,5 +207,5 @@ be still processed normally). \constfunc{bool}{ShiftDown}{\void} -Returns TRUE if the shift key was down at the time of the key event. +Returns true if the shift key was down at the time of the key event. diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex index 7a1a8ec9d1..6073e3a2ef 100644 --- a/docs/latex/wx/list.tex +++ b/docs/latex/wx/list.tex @@ -179,27 +179,27 @@ The key string is copied and stored by the list implementation. \func{void}{Clear}{\void} Clears the list (but does not delete the client data stored with each node -unless you called DeleteContents({\tt TRUE}), in which case it deletes data). +unless you called DeleteContents({\tt true}), in which case it deletes data). \membersection{wxList::DeleteContents}\label{wxlistdeletecontents} \func{void}{DeleteContents}{\param{bool}{ destroy}} -If {\it destroy} is {\tt TRUE}, instructs the list to call {\it delete} on the client contents of -a node whenever the node is destroyed. The default is {\tt FALSE}. +If {\it destroy} is {\tt true}, instructs the list to call {\it delete} on the client contents of +a node whenever the node is destroyed. The default is {\tt false}. \membersection{wxList::DeleteNode}\label{wxlistdeletenode} \func{bool}{DeleteNode}{\param{wxNode *}{node}} -Deletes the given node from the list, returning {\tt TRUE} if successful. +Deletes the given node from the list, returning {\tt true} if successful. \membersection{wxList::DeleteObject}\label{wxlistdeleteobject} \func{bool}{DeleteObject}{\param{T *}{object}} Finds the given client {\it object} and deletes the appropriate node from the list, returning -{\tt TRUE} if successful. The application must delete the actual object separately. +{\tt true} if successful. The application must delete the actual object separately. \membersection{wxList::Find}\label{wxlistfind} @@ -259,7 +259,7 @@ Inserts the object before the given {\it node}. \constfunc{bool}{IsEmpty}{\void} -Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise. +Returns {\tt true} if the list is empty, {\tt false} otherwise. % Use different label name to avoid clashing with wxListItem label \membersection{wxList::Item}\label{wxlistitemfunc} diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index 86fabd5ba6..fe981c44f2 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -201,7 +201,7 @@ Determines whether an item is selected. \wxheading{Return value} -TRUE if the given item is selected, FALSE otherwise. +true if the given item is selected, false otherwise. \membersection{wxListBox::Set}\label{wxlistboxset} diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index b6b620cc78..9bf5f1d1f5 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -228,7 +228,7 @@ Ensures this item is visible. \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem} -\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}} +\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = false}} Find an item whose label matches this string, starting from the item after {\it start} or the beginning if {\it start} is -1. @@ -246,7 +246,7 @@ the item after {\it start} or the beginning if {\it start} is -1. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{{\bf FindItem(start, str, partial=FALSE)}}{} +\twocolitem{{\bf FindItem(start, str, partial=false)}}{} \twocolitem{{\bf FindItemData(start, data)}}{} \twocolitem{{\bf FindItemAtPos(start, point, direction)}}{} \end{twocollist}} @@ -255,7 +255,7 @@ implements the following methods:\par \perlnote{In wxPerl there are three methods instead of a single overloaded method:\par \indented{2cm}{\begin{twocollist} -\twocolitem{{\bf FindItem( start, str, partial = FALSE ) }}{} +\twocolitem{{\bf FindItem( start, str, partial = false ) }}{} \twocolitem{{\bf FindItemData( start, data ) }}{} \twocolitem{{\bf FindItemAtPos( start, point, direction )}}{} \end{twocollist} @@ -374,7 +374,7 @@ returns a Wx::Rect ( or undef ).} \constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}} Retrieves the spacing between icons in pixels. -If {\it small} is TRUE, gets the spacing for the small icon +If {\it small} is true, gets the spacing for the small icon view, otherwise the large icon view. \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} @@ -774,7 +774,7 @@ Sets the item text for this item. \membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle} -\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = TRUE}} +\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = true}} Adds or removes a single window style. diff --git a/docs/latex/wx/listevt.tex b/docs/latex/wx/listevt.tex index 317fd28922..40febdeb1f 100644 --- a/docs/latex/wx/listevt.tex +++ b/docs/latex/wx/listevt.tex @@ -95,7 +95,7 @@ header outside any column. \constfunc{bool}{Cancelled}{\void} -TRUE if this event is an end edit event and the user cancelled the edit. +true if this event is an end edit event and the user cancelled the edit. \membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint} diff --git a/docs/latex/wx/listview.tex b/docs/latex/wx/listview.tex index 76138d5310..3fe47b70d5 100644 --- a/docs/latex/wx/listview.tex +++ b/docs/latex/wx/listview.tex @@ -99,8 +99,8 @@ Returns the next selected item or $-1$ if there are no more of them. \func{bool}{IsSelected}{\param{long }{index}} -Returns {\tt TRUE} if the item with the given {\it index} is selected, -{\tt FALSE} otherwise. +Returns {\tt true} if the item with the given {\it index} is selected, +{\tt false} otherwise. \wxheading{See also} @@ -110,7 +110,7 @@ Returns {\tt TRUE} if the item with the given {\it index} is selected, \membersection{wxListView::Select}\label{wxlistviewselect} -\func{void}{Select}{long n, \param{bool }{on = TRUE}} +\func{void}{Select}{long n, \param{bool }{on = true}} Selects or unselects the given item. @@ -118,7 +118,7 @@ Selects or unselects the given item. \docparam{n}{the item to select or unselect} -\docparam{on}{if {\tt TRUE} (default), selects the item, otherwise unselects it} +\docparam{on}{if {\tt true} (default), selects the item, otherwise unselects it} \wxheading{See also} diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex index fe0dc4deb2..fe59e6e09e 100644 --- a/docs/latex/wx/locale.tex +++ b/docs/latex/wx/locale.tex @@ -321,7 +321,7 @@ This is the default constructor and it does nothing to initialize the object: See \helpref{Init()}{wxlocaleinit} for parameters description. -\func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}, \param{bool }{bConvertEncoding = FALSE}} +\func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}} See \helpref{Init()}{wxlocaleinit} for parameters description. @@ -353,7 +353,7 @@ additional directories to the search path with All loaded catalogs will be used for message lookup by GetString() for the current locale. -Returns TRUE if catalog was successfully loaded, FALSE otherwise (which might +Returns true if catalog was successfully loaded, false otherwise (which might mean that the catalog is not found or that it isn't in the correct format). \membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix} @@ -507,7 +507,7 @@ Returns \helpref{wxLanguage}{wxlanguage} value or \func{bool}{Init}{\param{int }{language = wxLANGUAGE\_DEFAULT}, \param{int }{flags = wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}} -\func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}, \param{bool }{bConvertEncoding = FALSE}} +\func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}} The second form is deprecated, use the first one unless you know what you are doing. @@ -540,11 +540,11 @@ directory prefix when looking for the message catalog files.} \docparam{szLocale}{The parameter for the call to setlocale(). Note that it is platform-specific.} -\docparam{bLoadDefault}{May be set to FALSE to prevent loading of the message catalog +\docparam{bLoadDefault}{May be set to false to prevent loading of the message catalog for the given locale containing the translations of standard wxWindows messages. This parameter would be rarely used in normal circumstances.} -\docparam{bConvertEncoding}{May be set to TRUE to do automatic conversion of message +\docparam{bConvertEncoding}{May be set to true to do automatic conversion of message catalogs to platform's native encoding. Note that it will do only basic conversion between well-known pair like iso8859-1 and windows-1252 or iso8859-2 and windows-1250. @@ -559,13 +559,13 @@ Second, this wxLocale object becomes the new current global locale for the application and so all subsequent calls to wxGetTranslation() will try to translate the messages using the message catalogs for this locale. -Returns TRUE on success or FALSE if the given locale couldn't be set. +Returns true on success or false if the given locale couldn't be set. \membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded} \constfunc{bool}{IsLoaded}{\param{const char* }{domain}} -Check if the given catalog is loaded, and returns TRUE if it is. +Check if the given catalog is loaded, and returns true if it is. According to GNU gettext tradition, each catalog normally corresponds to 'domain' which is more or less the application name. @@ -576,5 +576,5 @@ See also: \helpref{AddCatalog}{wxlocaleaddcatalog} \constfunc{bool}{IsOk}{\void} -Returns TRUE if the locale could be set successfully. +Returns true if the locale could be set successfully. diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index fa31caabb9..ce5acdf4df 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -293,7 +293,7 @@ See also: \membersection{wxLog::SetVerbose}\label{wxlogsetverbose} -\func{static void}{SetVerbose}{\param{bool }{ verbose = TRUE}} +\func{static void}{SetVerbose}{\param{bool }{ verbose = true}} Activates or deactivates verbose mode in which the verbose messages are logged as the normal ones instead of being silently dropped. @@ -348,7 +348,7 @@ for details. \func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}} -Returns TRUE if the {\it mask} is one of allowed masks for +Returns true if the {\it mask} is one of allowed masks for \helpref{wxLogTrace}{wxlogtrace}. See also: \helpref{AddTraceMask}{wxlogaddtracemask}, @@ -423,8 +423,8 @@ NULL}). \constfunc{bool}{IsPassingMessages}{\void} -Returns {\tt TRUE} if the messages are passed to the previously active log -target (default) or {\tt FALSE} if \helpref{PassMessages}{wxlogchainpassmessages} +Returns {\tt true} if the messages are passed to the previously active log +target (default) or {\tt false} if \helpref{PassMessages}{wxlogchainpassmessages} had been called. \membersection{wxLogChain::PassMessages}\label{wxlogchainpassmessages} @@ -432,10 +432,10 @@ had been called. \func{void}{PassMessages}{\param{bool }{passMessages}} By default, the log messages are passed to the previously active log target. -Calling this function with {\tt FALSE} parameter disables this behaviour +Calling this function with {\tt false} parameter disables this behaviour (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and it can be reenabled by calling it again with {\it passMessages} set to {\tt -TRUE}. +true}. \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog} @@ -685,7 +685,7 @@ them normally by showing the standard log dialog. \membersection{wxLogWindow::wxLogWindow} -\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt TRUE}}, \param{bool }{passToOld = {\tt TRUE}}} +\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt true}}, \param{bool }{passToOld = {\tt true}}} Creates the log frame window and starts collecting the messages in it. @@ -695,16 +695,16 @@ Creates the log frame window and starts collecting the messages in it. \docparam{title}{The title for the log frame} -\docparam{show}{{\tt TRUE} to show the frame initially (default), otherwise +\docparam{show}{{\tt true} to show the frame initially (default), otherwise \helpref{wxLogWindow::Show}{wxlogwindowshow} must be called later.} -\docparam{passToOld}{{\tt TRUE} to process the log messages normally in addition to -logging them in the log frame (default), {\tt FALSE} to only log them in the +\docparam{passToOld}{{\tt true} to process the log messages normally in addition to +logging them in the log frame (default), {\tt false} to only log them in the log frame.} \membersection{wxLogWindow::Show}\label{wxlogwindowshow} -\func{void}{Show}{\param{bool }{show = {\tt TRUE}}} +\func{void}{Show}{\param{bool }{show = {\tt true}}} Shows or hides the frame. @@ -730,7 +730,7 @@ Called if the user closes the window interactively, will not be called if it is destroyed for another reason (such as when program exits). -Return {\tt TRUE} from here to allow the frame to close, {\tt FALSE} to +Return {\tt true} from here to allow the frame to close, {\tt false} to prevent this from happening. \wxheading{See also} diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index d22f10b309..cf33986ac3 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -157,7 +157,7 @@ creation of a menu or menubar. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{{\bf Append(id, string, helpStr="", checkable=FALSE)}}{} +\twocolitem{{\bf Append(id, string, helpStr="", checkable=false)}}{} \twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{} \twocolitem{{\bf AppendItem(aMenuItem)}}{} \end{twocollist}} @@ -219,7 +219,7 @@ Checks or unchecks the menu item. \docparam{id}{The menu item identifier.} -\docparam{check}{If TRUE, the item will be checked, otherwise it will be unchecked.} +\docparam{check}{If true, the item will be checked, otherwise it will be unchecked.} \wxheading{See also} @@ -279,7 +279,7 @@ Enables or disables (greys out) a menu item. \docparam{id}{The menu item identifier.} -\docparam{enable}{TRUE to enable the menu item, FALSE to disable it.} +\docparam{enable}{true to enable the menu item, false to disable it.} \wxheading{See also} @@ -453,7 +453,7 @@ Determines whether a menu item is checked. \wxheading{Return value} -TRUE if the menu item is checked, FALSE otherwise. +true if the menu item is checked, false otherwise. \wxheading{See also} @@ -471,7 +471,7 @@ Determines whether a menu item is enabled. \wxheading{Return value} -TRUE if the menu item is enabled, FALSE otherwise. +true if the menu item is enabled, false otherwise. \wxheading{See also} @@ -696,7 +696,7 @@ Adds the item to the end of the menu bar. \wxheading{Return value} -TRUE on success, FALSE if an error occurred. +true on success, false if an error occurred. \wxheading{See also} @@ -712,7 +712,7 @@ Checks or unchecks a menu item. \docparam{id}{The menu item identifier.} -\docparam{check}{If TRUE, checks the menu item, otherwise the item is unchecked.} +\docparam{check}{If true, checks the menu item, otherwise the item is unchecked.} \wxheading{Remarks} @@ -729,7 +729,7 @@ Enables or disables (greys out) a menu item. \docparam{id}{The menu item identifier.} -\docparam{enable}{TRUE to enable the item, FALSE to disable it.} +\docparam{enable}{true to enable the item, false to disable it.} \wxheading{Remarks} @@ -746,7 +746,7 @@ Enables or disables a whole menu. \docparam{pos}{The position of the menu, starting from zero.} -\docparam{enable}{TRUE to enable the menu, FALSE to disable it.} +\docparam{enable}{true to enable the menu, false to disable it.} \wxheading{Remarks} @@ -891,7 +891,7 @@ position $0$ will insert it in the very beginning of it, inserting at position \wxheading{Return value} -TRUE on success, FALSE if an error occurred. +true on success, false if an error occurred. \wxheading{See also} @@ -909,7 +909,7 @@ Determines whether an item is checked. \wxheading{Return value} -TRUE if the item was found and is checked, FALSE otherwise. +true if the item was found and is checked, false otherwise. \membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled} @@ -923,7 +923,7 @@ Determines whether an item is enabled. \wxheading{Return value} -TRUE if the item was found and is enabled, FALSE otherwise. +true if the item was found and is enabled, false otherwise. \membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh} diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index d5a7f29a39..d6cab4486b 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -62,8 +62,8 @@ only used with the {\tt HIGHLIGHT} events. \constfunc{bool}{IsPopup}{\void} -Returns {\tt TRUE} if the menu which is being opened or closed is a popup menu, -{\tt FALSE} if it is a normal one. +Returns {\tt true} if the menu which is being opened or closed is a popup menu, +{\tt false} if it is a normal one. This method should be only used with the {\tt OPEN} and {\tt CLOSE} events. diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index e371fda96d..9e2e331f48 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -79,7 +79,7 @@ Returns the background colour associated with the menu item (Windows only). \membersection{wxMenuItem::GetBitmap}\label{wxmenuitemgetbitmap} -\constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = TRUE}} +\constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = true}} Returns the checked or unchecked bitmap (Windows only). @@ -182,25 +182,25 @@ Returns the text colour associated with the menu item (Windows only). \constfunc{bool}{IsCheckable}{\void} -Returns TRUE if the item is checkable. +Returns true if the item is checkable. \membersection{wxMenuItem::IsChecked}\label{wxmenuitemischecked} \constfunc{bool}{IsChecked}{\void} -Returns TRUE if the item is checked. +Returns true if the item is checked. \membersection{wxMenuItem::IsEnabled}\label{wxmenuitemisenabled} \constfunc{bool}{IsEnabled}{\void} -Returns TRUE if the item is enabled. +Returns true if the item is enabled. \membersection{wxMenuItem::IsSeparator}\label{wxmenuitemisseparator} \constfunc{bool}{IsSeparator}{\void} -Returns TRUE if the item is a separator. +Returns true if the item is a separator. \membersection{wxMenuItem::SetBackgroundColour}\label{wxmenuitemsetbackgroundcolour} diff --git a/docs/latex/wx/metafile.tex b/docs/latex/wx/metafile.tex index ebea0188ec..0b8601c58e 100644 --- a/docs/latex/wx/metafile.tex +++ b/docs/latex/wx/metafile.tex @@ -38,14 +38,14 @@ Destructor. \func{bool}{Ok}{\void} -Returns TRUE if the metafile is valid. +Returns true if the metafile is valid. \membersection{wxMetafile::Play}\label{wxmetafileplay} \func{bool}{Play}{\param{wxDC *}{dc}} Plays the metafile into the given device context, returning -TRUE if successful. +true if successful. \membersection{wxMetafile::SetClipboard} @@ -64,7 +64,7 @@ to keep track of the maximum extent of drawing commands. wxMetafileDC dc; if (dc.Ok()) { - Draw(dc, FALSE); + Draw(dc, false); wxMetafile *mf = dc.Close(); if (mf) { diff --git a/docs/latex/wx/mimetype.tex b/docs/latex/wx/mimetype.tex index 08278a980c..a2c2ddf775 100644 --- a/docs/latex/wx/mimetype.tex +++ b/docs/latex/wx/mimetype.tex @@ -140,7 +140,7 @@ is unknown. \func{bool}{IsOfType}{\param{const wxString\&}{ mimeType}, \param{const wxString\&}{ wildcard}} -This function returns TRUE if either the given {\it mimeType} is exactly the +This function returns true if either the given {\it mimeType} is exactly the same as {\it wildcard} or if it has the same category and the subtype of {\it wildcard} is '*'. Note that the '*' wildcard is not allowed in {\it mimeType} itself. @@ -150,7 +150,7 @@ necessary to convert the strings to the same case before calling it. \membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap} -\func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = FALSE}} +\func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = false}} Load additional file containing information about MIME types and associated information in mailcap format. See metamail(1) and mailcap(5) for more @@ -160,9 +160,9 @@ information. overriding the settings found in the standard files: normally, entries from files loaded with ReadMailcap will override the entries from files loaded previously (and the standard ones are loaded in the very beginning), but this -will not happen if this parameter is set to TRUE (default is FALSE). +will not happen if this parameter is set to true (default is false). -The return value is TRUE if there were no errors in the file or FALSE +The return value is true if there were no errors in the file or false otherwise. \membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes} @@ -173,6 +173,6 @@ Load additional file containing information about MIME types and associated information in mime.types file format. See metamail(1) and mailcap(5) for more information. -The return value is TRUE if there were no errors in the file or FALSE +The return value is true if there were no errors in the file or false otherwise. diff --git a/docs/latex/wx/module.tex b/docs/latex/wx/module.tex index bb515828dc..7d5e62dad0 100644 --- a/docs/latex/wx/module.tex +++ b/docs/latex/wx/module.tex @@ -24,7 +24,7 @@ For example: DECLARE_DYNAMIC_CLASS(wxDDEModule) public: wxDDEModule() {} - bool OnInit() { wxDDEInitialize(); return TRUE; }; + bool OnInit() { wxDDEInitialize(); return true; }; void OnExit() { wxDDECleanUp(); }; }; @@ -92,7 +92,7 @@ Provide this function with appropriate cleanup for your module. \func{virtual bool}{OnInit}{\void} Provide this function with appropriate initialization for your module. If the function -returns FALSE, wxWindows will exit immediately. +returns false, wxWindows will exit immediately. \membersection{wxModule::RegisterModule}\label{wxmoduleregistermodule} diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex index ee5dc36b93..49553b9502 100644 --- a/docs/latex/wx/mouseevt.tex +++ b/docs/latex/wx/mouseevt.tex @@ -16,14 +16,14 @@ time. {\bf NB:} Note the difference between methods like \helpref{LeftDown}{wxmouseeventleftdown} and -\helpref{LeftIsDown}{wxmouseeventleftisdown}: the former returns {\tt TRUE} +\helpref{LeftIsDown}{wxmouseeventleftisdown}: the former returns {\tt true} when the event corresponds to the left mouse button click while the latter -returns {\tt TRUE} if the left mouse button is currently being pressed. For +returns {\tt true} if the left mouse button is currently being pressed. For example, when the user is dragging the mouse you can use \helpref{LeftIsDown}{wxmouseeventleftisdown} to test whether the left mouse button is (still) depressed. Also, by convention, if -\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE}, -\helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt TRUE} in +\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt true}, +\helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt true} in wxWindows whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as well. @@ -65,43 +65,43 @@ functions that take a wxMouseEvent argument. \member{bool}{m\_altDown} -TRUE if the Alt key is pressed down. +true if the Alt key is pressed down. \membersection{wxMouseEvent::m\_controlDown} \member{bool}{m\_controlDown} -TRUE if control key is pressed down. +true if control key is pressed down. \membersection{wxMouseEvent::m\_leftDown} \member{bool}{m\_leftDown} -TRUE if the left mouse button is currently pressed down. +true if the left mouse button is currently pressed down. \membersection{wxMouseEvent::m\_middleDown} \member{bool}{m\_middleDown} -TRUE if the middle mouse button is currently pressed down. +true if the middle mouse button is currently pressed down. \membersection{wxMouseEvent::m\_rightDown} \member{bool}{m\_rightDown} -TRUE if the right mouse button is currently pressed down. +true if the right mouse button is currently pressed down. \membersection{wxMouseEvent::m\_metaDown} \member{bool}{m\_metaDown} -TRUE if the Meta key is pressed down. +true if the Meta key is pressed down. \membersection{wxMouseEvent::m\_shiftDown} \member{bool}{m\_shiftDown} -TRUE if shift is pressed down. +true if shift is pressed down. \membersection{wxMouseEvent::m\_x} @@ -162,13 +162,13 @@ Constructor. Valid event types are: \func{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the event. +Returns true if the Alt key was down at the time of the event. \membersection{wxMouseEvent::Button} \func{bool}{Button}{\param{int}{ button}} -Returns TRUE if the identified mouse button is changing state. Valid +Returns true if the identified mouse button is changing state. Valid values of {\it button} are 1, 2 or 3 for left, middle and right buttons respectively. @@ -176,7 +176,7 @@ buttons respectively. \func{bool}{ButtonDClick}{\param{int}{ but = -1}} -If the argument is omitted, this returns TRUE if the event was a mouse +If the argument is omitted, this returns true if the event was a mouse double click event. Otherwise the argument specifies which double click event was generated (1, 2 or 3 for left, middle and right buttons respectively). @@ -184,7 +184,7 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively). \func{bool}{ButtonDown}{\param{int}{ but = -1}} -If the argument is omitted, this returns TRUE if the event was a mouse +If the argument is omitted, this returns true if the event was a mouse button down event. Otherwise the argument specifies which button-down event was generated (1, 2 or 3 for left, middle and right buttons respectively). @@ -192,7 +192,7 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively). \func{bool}{ButtonUp}{\param{int}{ but = -1}} -If the argument is omitted, this returns TRUE if the event was a mouse +If the argument is omitted, this returns true if the event was a mouse button up event. Otherwise the argument specifies which button-up event was generated (1, 2 or 3 for left, middle and right buttons respectively). @@ -200,19 +200,19 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively). \func{bool}{ControlDown}{\void} -Returns TRUE if the control key was down at the time of the event. +Returns true if the control key was down at the time of the event. \membersection{wxMouseEvent::Dragging} \func{bool}{Dragging}{\void} -Returns TRUE if this was a dragging event (motion while a button is depressed). +Returns true if this was a dragging event (motion while a button is depressed). \membersection{wxMouseEvent::Entering}\label{wxmouseevententering} \func{bool}{Entering}{\void} -Returns TRUE if the mouse was entering the window. +Returns true if the mouse was entering the window. See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}. @@ -288,21 +288,21 @@ Returns Y coordinate of the physical mouse event position. \constfunc{bool}{IsButton}{\void} -Returns TRUE if the event was a mouse button event (not necessarily a button down event - +Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using {\it ButtonDown}). \membersection{wxMouseEvent::IsPageScroll} \constfunc{bool}{IsPageScroll}{\void} -Returns TRUE if the system has been setup to do page scrolling with +Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling. \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving} \constfunc{bool}{Leaving}{\void} -Returns TRUE if the mouse was leaving the window. +Returns true if the mouse was leaving the window. See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}. @@ -310,23 +310,23 @@ See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}. \constfunc{bool}{LeftDClick}{\void} -Returns TRUE if the event was a left double click. +Returns true if the event was a left double click. \membersection{wxMouseEvent::LeftDown}\label{wxmouseeventleftdown} \constfunc{bool}{LeftDown}{\void} -Returns TRUE if the left mouse button changed to down. +Returns true if the left mouse button changed to down. \membersection{wxMouseEvent::LeftIsDown}\label{wxmouseeventleftisdown} \constfunc{bool}{LeftIsDown}{\void} -Returns TRUE if the left mouse button is currently down, independent +Returns true if the left mouse button is currently down, independent of the current event type. Please notice that it is {\bf not} the same as -\helpref{LeftDown}{wxmouseeventleftdown} which returns TRUE if the left mouse +\helpref{LeftDown}{wxmouseeventleftdown} which returns true if the left mouse button was just pressed. Rather, it describes the state of the mouse button before the event happened. @@ -337,73 +337,73 @@ mouse" messages to determine whether the user is (still) dragging the mouse. \constfunc{bool}{LeftUp}{\void} -Returns TRUE if the left mouse button changed to up. +Returns true if the left mouse button changed to up. \membersection{wxMouseEvent::MetaDown} \constfunc{bool}{MetaDown}{\void} -Returns TRUE if the Meta key was down at the time of the event. +Returns true if the Meta key was down at the time of the event. \membersection{wxMouseEvent::MiddleDClick} \constfunc{bool}{MiddleDClick}{\void} -Returns TRUE if the event was a middle double click. +Returns true if the event was a middle double click. \membersection{wxMouseEvent::MiddleDown} \constfunc{bool}{MiddleDown}{\void} -Returns TRUE if the middle mouse button changed to down. +Returns true if the middle mouse button changed to down. \membersection{wxMouseEvent::MiddleIsDown}\label{wxmouseeventmiddleisdown} \constfunc{bool}{MiddleIsDown}{\void} -Returns TRUE if the middle mouse button is currently down, independent +Returns true if the middle mouse button is currently down, independent of the current event type. \membersection{wxMouseEvent::MiddleUp} \constfunc{bool}{MiddleUp}{\void} -Returns TRUE if the middle mouse button changed to up. +Returns true if the middle mouse button changed to up. \membersection{wxMouseEvent::Moving} \constfunc{bool}{Moving}{\void} -Returns TRUE if this was a motion event (no buttons depressed). +Returns true if this was a motion event (no buttons depressed). \membersection{wxMouseEvent::RightDClick} \constfunc{bool}{RightDClick}{\void} -Returns TRUE if the event was a right double click. +Returns true if the event was a right double click. \membersection{wxMouseEvent::RightDown} \constfunc{bool}{RightDown}{\void} -Returns TRUE if the right mouse button changed to down. +Returns true if the right mouse button changed to down. \membersection{wxMouseEvent::RightIsDown}\label{wxmouseeventrightisdown} \constfunc{bool}{RightIsDown}{\void} -Returns TRUE if the right mouse button is currently down, independent +Returns true if the right mouse button is currently down, independent of the current event type. \membersection{wxMouseEvent::RightUp} \constfunc{bool}{RightUp}{\void} -Returns TRUE if the right mouse button changed to up. +Returns true if the right mouse button changed to up. \membersection{wxMouseEvent::ShiftDown} \constfunc{bool}{ShiftDown}{\void} -Returns TRUE if the shift key was down at the time of the event. +Returns true if the shift key was down at the time of the event. diff --git a/docs/latex/wx/mutex.tex b/docs/latex/wx/mutex.tex index b4347bd1de..fd3058b666 100644 --- a/docs/latex/wx/mutex.tex +++ b/docs/latex/wx/mutex.tex @@ -37,7 +37,7 @@ because during a new node addition the list integrity is temporarily broken s_mutexProtectingTheGlobalList->Unlock(); } - // return TRUE the given number is greater than all array elements + // return true the given number is greater than all array elements bool MyThread::IsGreater(int num) { // before using the list we must acquire the mutex @@ -47,16 +47,16 @@ because during a new node addition the list integrity is temporarily broken for ( size_t n = 0; n < count; n++ ) { if ( s_data[n] > num ) - return FALSE; + return false; } - return TRUE; + return true; } \end{verbatim} } Notice how wxMutexLocker was used in the second function to ensure that the -mutex is unlocked in any case: whether the function returns TRUE or FALSE +mutex is unlocked in any case: whether the function returns true or false (because the destructor of the local object {\it lock} is always called). Using this class instead of directly using wxMutex is, in general safer and is even more so if your program uses C++ exceptions. diff --git a/docs/latex/wx/mutexlck.tex b/docs/latex/wx/mutexlck.tex index 9afd4af634..7dae1bb64e 100644 --- a/docs/latex/wx/mutexlck.tex +++ b/docs/latex/wx/mutexlck.tex @@ -39,5 +39,5 @@ Destructor releases the mutex if it was successfully acquired in the ctor. \constfunc{bool}{IsOk}{\void} -Returns TRUE if mutex was acquired in the constructor, FALSE otherwise. +Returns true if mutex was acquired in the constructor, false otherwise. diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index f0d414855a..5ffbfa5ad9 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -80,7 +80,7 @@ Destroys the wxNotebook object. \func{bool}{AddPage}{\param{wxNotebookPage*}{ page}, \param{const wxString\&}{ text}, - \param{bool}{ select = FALSE}, + \param{bool}{ select = false}, \param{int}{ imageId = -1}} Adds a new page. @@ -97,7 +97,7 @@ Adds a new page. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} @@ -109,7 +109,7 @@ Do not delete the page, it will be deleted by the notebook. \membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection} -\func{void}{AdvanceSelection}{\param{bool}{ forward = TRUE}} +\func{void}{AdvanceSelection}{\param{bool}{ forward = true}} Cycles through the tabs. @@ -201,7 +201,7 @@ used instead in this case. \func{bool}{InsertPage}{\param{int}{ index}, \param{wxNotebookPage*}{ page}, \param{const wxString\&}{ text}, - \param{bool}{ select = FALSE}, + \param{bool}{ select = false}, \param{int}{ imageId = -1}} Inserts a new page at the specified position. @@ -220,7 +220,7 @@ Inserts a new page at the specified position. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} diff --git a/docs/latex/wx/notifevt.tex b/docs/latex/wx/notifevt.tex index 1f48b5a78d..74c694ff0d 100644 --- a/docs/latex/wx/notifevt.tex +++ b/docs/latex/wx/notifevt.tex @@ -47,8 +47,8 @@ this method as the events are allowed anyhow but some are forbidden by default \constfunc{bool}{IsAllowed}{\void} -Returns TRUE if the change is allowed (\helpref{Veto()}{wxnotifyeventveto} -hasn't been called) or FALSE otherwise (if it was). +Returns true if the change is allowed (\helpref{Veto()}{wxnotifyeventveto} +hasn't been called) or false otherwise (if it was). \membersection{wxNotifyEvent::Veto}\label{wxnotifyeventveto} diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex index d5b0550ef2..7c27d7a304 100644 --- a/docs/latex/wx/object.tex +++ b/docs/latex/wx/object.tex @@ -107,7 +107,7 @@ by using the CLASSINFO macro.} \wxheading{Return value} -TRUE if the class represented by {\it info} is the same class as +true if the class represented by {\it info} is the same class as this one or is derived from it. \wxheading{Example} diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex index b68a9ffeb6..26c79a4df1 100644 --- a/docs/latex/wx/pagedlg.tex +++ b/docs/latex/wx/pagedlg.tex @@ -54,9 +54,9 @@ Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the \constfunc{bool}{Ok}{\void} -Returns TRUE if the print data associated with the dialog data is valid. -This can return FALSE on Windows if the current printer is not set, for example. -On all other platforms, it returns TRUE. +Returns true if the print data associated with the dialog data is valid. +This can return false on Windows if the current printer is not set, for example. +On all other platforms, it returns true. \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal} @@ -140,44 +140,44 @@ Enables or disables the {\bf Printer} button, which invokes a printer setup dial \constfunc{bool}{GetDefaultMinMargins}{\void} -Returns TRUE if the page setup dialog will take its minimum margin values from the currently +Returns true if the page setup dialog will take its minimum margin values from the currently selected printer properties. Windows only. \membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins} \constfunc{bool}{GetEnableMargins}{\void} -Returns TRUE if the margin controls are enabled (Windows only). +Returns true if the margin controls are enabled (Windows only). \membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation} \constfunc{bool}{GetEnableOrientation}{\void} -Returns TRUE if the orientation control is enabled (Windows only). +Returns true if the orientation control is enabled (Windows only). \membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper} \constfunc{bool}{GetEnablePaper}{\void} -Returns TRUE if the paper size control is enabled (Windows only). +Returns true if the paper size control is enabled (Windows only). \membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter} \constfunc{bool}{GetEnablePrinter}{\void} -Returns TRUE if the printer setup button is enabled. +Returns true if the printer setup button is enabled. \membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp} \constfunc{bool}{GetEnableHelp}{\void} -Returns TRUE if the printer setup button is enabled. +Returns true if the printer setup button is enabled. \membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo} \constfunc{bool}{GetDefaultInfo}{\void} -Returns TRUE if the dialog will simply return default printer information (such as orientation) +Returns true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog. Windows only. \membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft} @@ -230,22 +230,22 @@ Returns a reference to the \helpref{print data}{wxprintdata} associated with thi \constfunc{bool}{Ok}{\void} -Returns TRUE if the print data associated with the dialog data is valid. -This can return FALSE on Windows if the current printer is not set, for example. -On all other platforms, it returns TRUE. +Returns true if the print data associated with the dialog data is valid. +This can return false on Windows if the current printer is not set, for example. +On all other platforms, it returns true. \membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo} \func{void}{SetDefaultInfo}{\param{bool}{ flag}} -Pass TRUE if the dialog will simply return default printer information (such as orientation) +Pass true if the dialog will simply return default printer information (such as orientation) instead of showing a dialog. Windows only. \membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins} \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}} -Pass TRUE if the page setup dialog will take its minimum margin values from the currently +Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties. Windows only. Units are in millimetres \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft} diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex index 7f8c2cc6f0..f2192f5efe 100644 --- a/docs/latex/wx/palette.tex +++ b/docs/latex/wx/palette.tex @@ -86,7 +86,7 @@ red, blue or green component. \wxheading{Return value} -TRUE if the creation was successful, FALSE otherwise. +true if the creation was successful, false otherwise. \wxheading{See also} @@ -134,7 +134,7 @@ Returns RGB values for a given palette index. \wxheading{Return value} -TRUE if the operation was successful. +true if the operation was successful. \wxheading{See also} @@ -147,7 +147,7 @@ TRUE if the operation was successful. \constfunc{bool}{Ok}{\void} -Returns TRUE if palette data is present. +Returns true if palette data is present. \membersection{wxPalette::operator $=$}\label{wxpaletteassignment} diff --git a/docs/latex/wx/pantabv.tex b/docs/latex/wx/pantabv.tex index 8fbe4a7a01..276592cef8 100644 --- a/docs/latex/wx/pantabv.tex +++ b/docs/latex/wx/pantabv.tex @@ -36,7 +36,7 @@ will ensure that the tab background matches the dialog background.} \func{void}{\destruct{wxPanelTabView}}{\void} Destructor. This destructor deletes all the panels associated with the view. -If you do not wish this to happen, call ClearWindows with argument FALSE before the +If you do not wish this to happen, call ClearWindows with argument false before the view is likely to be destroyed. This will clear the list of windows, without deleting them. \membersection{wxPanelTabView::AddTabWindow}\label{wxpaneltabviewaddtabwindow} @@ -48,9 +48,9 @@ is selected or deselected. \membersection{wxPanelTabView::ClearWindows} -\func{void}{ClearWindows}{\param{bool}{ deleteWindows = TRUE}} +\func{void}{ClearWindows}{\param{bool}{ deleteWindows = true}} -Removes the child windows from the view. If {\it deleteWindows} is TRUE, the windows will be deleted. +Removes the child windows from the view. If {\it deleteWindows} is true, the windows will be deleted. \membersection{wxPanelTabView::GetCurrentWindow} diff --git a/docs/latex/wx/pathlist.tex b/docs/latex/wx/pathlist.tex index 82fdc7c662..0a2729f0e4 100644 --- a/docs/latex/wx/pathlist.tex +++ b/docs/latex/wx/pathlist.tex @@ -75,5 +75,5 @@ working directory. \func{bool}{Member}{\param{const wxString\& }{file}} -TRUE if the path is in the path list (ignoring case). +true if the path is in the path list (ignoring case). diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 5a79e8f523..86516c0081 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -66,7 +66,7 @@ data using the reference counting, are not affected. \func{}{wxPen}{\void} Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will -return FALSE. +return false. \func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width}, \param{int}{ style}} @@ -232,7 +232,7 @@ Returns the pen width. \constfunc{bool}{Ok}{\void} -Returns TRUE if the pen is initialised. +Returns true if the pen is initialised. \membersection{wxPen::SetCap}\label{wxpensetcap} diff --git a/docs/latex/wx/plotwindow.tex b/docs/latex/wx/plotwindow.tex index 4ce6f92464..f8c08655c0 100644 --- a/docs/latex/wx/plotwindow.tex +++ b/docs/latex/wx/plotwindow.tex @@ -158,7 +158,7 @@ Helper function which redraws the Y axis. \membersection{wxPlotWindow::SetScrollOnThumbRelease}\label{wxplotwindowsetscrollonthumbrelease} -\func{void}{SetScrollOnThumbRelease}{\param{bool}{ onrelease = TRUE}} +\func{void}{SetScrollOnThumbRelease}{\param{bool}{ onrelease = true}} This function controls if the plot area will get scrolled only if the scrollbar thumb has been release or also if the thumb is being dragged. When displaying large amounts @@ -167,7 +167,7 @@ scrolling and then this function should be called. \membersection{wxPlotWindow::SetEnlargeAroundWindowCentre}\label{wxplotwindowsetenlargearoundwindowcentre} -\func{void}{SetEnlargeAroundWindowCentre}{\param{bool}{ aroundwindow = TRUE}} +\func{void}{SetEnlargeAroundWindowCentre}{\param{bool}{ aroundwindow = true}} Depending on the kind of data you display, enlarging the individual curves might have different desired effects. Sometimes, the data will be supposed to get enlarged diff --git a/docs/latex/wx/porting.tex b/docs/latex/wx/porting.tex index 14aac3ca3b..bc15b659c2 100644 --- a/docs/latex/wx/porting.tex +++ b/docs/latex/wx/porting.tex @@ -189,7 +189,7 @@ is now {\bf wxDialog:ShowModal}. This is part of a more fundamental change in wh control may tell the dialog that it caused the dismissal of a dialog, by calling {\bf wxDialog::EndModal} or {\bf wxWindow::SetReturnCode}. Using this information, {\bf ShowModal} now returns the id of the control that caused dismissal, -giving greater feedback to the application than just TRUE or FALSE. +giving greater feedback to the application than just true or false. If you overrode or called {\bf wxDialog::Show}, use {\bf ShowModal} and test for a returned identifier, commonly wxID\_OK or wxID\_CANCEL. diff --git a/docs/latex/wx/postscpt.tex b/docs/latex/wx/postscpt.tex index c901a61772..d3db575c0c 100644 --- a/docs/latex/wx/postscpt.tex +++ b/docs/latex/wx/postscpt.tex @@ -19,11 +19,11 @@ descriptions of the member functions. Constructs a PostScript printer device context from a \helpref{wxPrintData}{wxprintdata} object. -\func{}{wxPostScriptDC}{\param{const wxString\& }{output}, \param{bool }{interactive = TRUE},\\ +\func{}{wxPostScriptDC}{\param{const wxString\& }{output}, \param{bool }{interactive = true},\\ \param{wxWindow *}{parent}} Constructor. {\it output} is an optional file for printing to, and if -\rtfsp{\it interactive} is TRUE a dialog box will be displayed for adjusting +\rtfsp{\it interactive} is true a dialog box will be displayed for adjusting various parameters. {\it parent} is the parent of the printer dialog box. Use the {\it Ok} member to test whether the constructor was successful diff --git a/docs/latex/wx/prevwin.tex b/docs/latex/wx/prevwin.tex index 93681025de..3f6d6ce28d 100644 --- a/docs/latex/wx/prevwin.tex +++ b/docs/latex/wx/prevwin.tex @@ -172,7 +172,7 @@ a user-defined preview canvas object to be created. \func{void}{Initialize}{\void} Creates the preview canvas and control bar, and calls -wxWindow::MakeModal(TRUE) to disable other top-level windows +wxWindow::MakeModal(true) to disable other top-level windows in the application. This function should be called by the application prior to diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex index 063ee8dfe6..6d88f898ae 100644 --- a/docs/latex/wx/print.tex +++ b/docs/latex/wx/print.tex @@ -78,13 +78,13 @@ Destructor. \constfunc{bool}{GetCollate}{\void} -Returns TRUE if collation is on. +Returns true if collation is on. \membersection{wxPrintData::GetColour}\label{wxprintdatagetcolour} \constfunc{bool}{GetColour}{\void} -Returns TRUE if colour printing is on. +Returns true if colour printing is on. \membersection{wxPrintData::GetDuplex}\label{wxprintdatagetduplex} @@ -138,9 +138,9 @@ indicating the current resolution setting. \constfunc{bool}{Ok}{\void} -Returns TRUE if the print data is valid for using in print dialogs. -This can return FALSE on Windows if the current printer is not set, for example. -On all other platforms, it returns TRUE. +Returns true if the print data is valid for using in print dialogs. +This can return false on Windows if the current printer is not set, for example. +On all other platforms, it returns true. \membersection{wxPrintData::SetCollate}\label{wxprintdatasetcollate} @@ -350,9 +350,9 @@ explicitly. \constfunc{bool}{Ok}{\void} -Returns TRUE if the print data associated with the dialog is valid. -This can return FALSE on Windows if the current printer is not set, for example. -On all other platforms, it returns TRUE. +Returns true if the print data associated with the dialog is valid. +This can return false on Windows if the current printer is not set, for example. +On all other platforms, it returns true. \membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal} @@ -429,13 +429,13 @@ Enables or disables the `Selection' radio button. \constfunc{bool}{GetAllPages}{\void} -Returns TRUE if the user requested that all pages be printed. +Returns true if the user requested that all pages be printed. \membersection{wxPrintDialogData::GetCollate}\label{wxprintdialogdatagetcollate} \constfunc{bool}{GetCollate}{\void} -Returns TRUE if the user requested that the document(s) be collated. +Returns true if the user requested that the document(s) be collated. \membersection{wxPrintDialogData::GetFromPage}\label{wxprintdialogdatagetfrompage} @@ -471,13 +471,13 @@ Returns a reference to the internal wxPrintData object. \constfunc{bool}{GetPrintToFile}{\void} -Returns TRUE if the user has selected printing to a file. +Returns true if the user has selected printing to a file. \membersection{wxPrintDialogData::GetSelection}\label{wxprintdialogdatagetselection} \constfunc{bool}{GetSelection}{\void} -Returns TRUE if the user requested that the selection be printed (where 'selection' is +Returns true if the user requested that the selection be printed (where 'selection' is a concept specific to the application). \membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage} @@ -490,15 +490,15 @@ Returns the {\it to} page number, as entered by the user. \constfunc{bool}{Ok}{\void} -Returns TRUE if the print data is valid for using in print dialogs. -This can return FALSE on Windows if the current printer is not set, for example. -On all other platforms, it returns TRUE. +Returns true if the print data is valid for using in print dialogs. +This can return false on Windows if the current printer is not set, for example. +On all other platforms, it returns true. \membersection{wxPrintDialogData::SetCollate}\label{wxprintdialogdatasetcollate} \func{void}{SetCollate}{\param{bool }{flag}} -Sets the 'Collate' checkbox to TRUE or FALSE. +Sets the 'Collate' checkbox to true or false. \membersection{wxPrintDialogData::SetFromPage}\label{wxprintdialogdatasetfrompage} @@ -534,7 +534,7 @@ Sets the internal wxPrintData. \func{void}{SetPrintToFile}{\param{bool }{flag}} -Sets the 'Print to file' checkbox to TRUE or FALSE. +Sets the 'Print to file' checkbox to true or false. \membersection{wxPrintDialogData::SetSelection}\label{wxprintdialogdatasetselection} @@ -548,7 +548,7 @@ implements this command, if at all. \func{void}{SetSetupDialog}{\param{bool }{flag}} Determines whether the dialog to be shown will be the Print dialog -(pass FALSE) or Print Setup dialog (pass TRUE). +(pass false) or Print Setup dialog (pass true). Note that the setup dialog is (according to Microsoft) obsolete from Windows 95, though retained for backward compatibility. @@ -614,7 +614,7 @@ Destructor. \func{bool}{Abort}{\void} -Returns TRUE if the user has aborted the print job. +Returns true if the user has aborted the print job. \membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow} @@ -650,12 +650,12 @@ Returns the \helpref{print data}{wxprintdata} associated with the printer object \membersection{wxPrinter::Print}\label{wxprinterprint} -\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=TRUE}} +\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=true}} Starts the printing process. Provide a parent window, a user-defined wxPrintout object which controls the printing of a document, and whether the print dialog should be invoked first. -Print could return FALSE if there was a problem initializing the printer device context +Print could return false if there was a problem initializing the printer device context (current printer not set, for example) or the user cancelled printing. Call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. @@ -716,7 +716,7 @@ necessary for setting up a suitable printer device context. This is the recommended way to construct a wxPrinterDC. \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output}, - \param{const bool }{interactive = TRUE}, \param{int }{orientation = wxPORTRAIT}} + \param{const bool }{interactive = true}, \param{int }{orientation = wxPORTRAIT}} Constructor. With empty strings for the first three arguments, the default printer dialog is displayed. {\it device} indicates the type of printer and {\it output} @@ -854,21 +854,21 @@ Returns the title of the printout \func{bool}{HasPage}{\param{int}{ pageNum}} -Should be overridden to return TRUE if the document has this page, or FALSE -if not. Returning FALSE signifies the end of the document. By default, +Should be overridden to return true if the document has this page, or false +if not. Returning false signifies the end of the document. By default, HasPage behaves as if the document has only one page. \membersection{wxPrintout::IsPreview}\label{wxprintoutispreview} \func{bool}{IsPreview}{\void} -Returns TRUE if the printout is currently being used for previewing. +Returns true if the printout is currently being used for previewing. \membersection{wxPrintout::OnBeginDocument}\label{wxprintoutonbegindocument} \func{bool}{OnBeginDocument}{\param{int}{ startPage}, \param{int}{ endPage}} -Called by the framework at the start of document printing. Return FALSE from +Called by the framework at the start of document printing. Return false from this function cancels the print job. OnBeginDocument is called once for every copy printed. @@ -915,7 +915,7 @@ number of pages in the document, for example. \func{bool}{OnPrintPage}{\param{int}{ pageNum}} -Called by the framework when a page should be printed. Returning FALSE cancels +Called by the framework when a page should be printed. Returning false cancels the print job. The application can use wxPrintout::GetDC to obtain a device context to draw on. @@ -962,7 +962,7 @@ called, since they will be deleted in the wxPrintPreview constructor. The same does not apply to the {\it data} argument. Test the Ok member to check whether the wxPrintPreview object was created correctly. -Ok could return FALSE if there was a problem initializing the printer device context +Ok could return false if there was a problem initializing the printer device context (current printer not set, for example). \membersection{wxPrintPreview::\destruct{wxPrintPreview}} @@ -1033,7 +1033,7 @@ or NULL if none exists. \func{bool}{Ok}{\void} -Returns TRUE if the wxPrintPreview is valid, FALSE otherwise. It could return FALSE if there was a +Returns true if the wxPrintPreview is valid, false otherwise. It could return false if there was a problem initializing the printer device context (current printer not set, for example). \membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage} @@ -1055,7 +1055,7 @@ supplied in the wxPrintPreview constructor. Will normally be called by the {\bf Print...} panel item on the preview frame's control bar. -Returns FALSE in case of error -- call +Returns false in case of error -- call \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed information about the kind of the error. diff --git a/docs/latex/wx/process.tex b/docs/latex/wx/process.tex index e3ced73249..6a9f9d0dc9 100644 --- a/docs/latex/wx/process.tex +++ b/docs/latex/wx/process.tex @@ -125,7 +125,7 @@ See \helpref{wxProcess::Redirect}{wxprocessredirect}. \constfunc{bool}{IsErrorAvailable}{\void} -Returns {\tt TRUE} if there is data to be read on the child process standard +Returns {\tt true} if there is data to be read on the child process standard error stream. \wxheading{See also} @@ -136,7 +136,7 @@ error stream. \constfunc{bool}{IsInputAvailable}{\void} -Returns {\tt TRUE} if there is data to be read on the child process standard +Returns {\tt true} if there is data to be read on the child process standard output stream. This allows to write simple (and extremely inefficient) polling-based code waiting for a better mechanism in future wxWindows versions. @@ -151,7 +151,7 @@ function. \constfunc{bool}{IsInputOpened}{\void} -Returns {\tt TRUE} if the child process standard output stream is opened. +Returns {\tt true} if the child process standard output stream is opened. \membersection{wxProcess::Kill}\label{wxprocesskill} @@ -208,7 +208,7 @@ enum wxKillError \func{static bool}{Exists}{\param{int}{ pid}} -Returns {\tt TRUE} if the given process exists in the system. +Returns {\tt true} if the given process exists in the system. \wxheading{See also} diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index 5cf893f2be..fc7f5a5fe5 100644 --- a/docs/latex/wx/progdlg.tex +++ b/docs/latex/wx/progdlg.tex @@ -53,7 +53,7 @@ from screen as soon as the maximum value of the progress meter has been reached.} \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.} + \helpref{Update()}{wxprogressdialogupdate} will return false.} \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.} @@ -75,10 +75,10 @@ Destructor. Deletes the dialog and enables all top level windows. \param{const char * }{newmsg = NULL}, } Updates the dialog, setting the progress bar to the new value and, if -given changes the message above it. Returns TRUE if the ABORT button +given changes the message above it. Returns true if the ABORT button has \emph{not} been pressed. -If FALSE is returned, the application can either immediately destroy the dialog +If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation and if the abort is not confirmed the dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function. diff --git a/docs/latex/wx/propford.tex b/docs/latex/wx/propford.tex index dbd0899576..64ce5f11e3 100644 --- a/docs/latex/wx/propford.tex +++ b/docs/latex/wx/propford.tex @@ -10,7 +10,7 @@ processing. \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. diff --git a/docs/latex/wx/propfovi.tex b/docs/latex/wx/propfovi.tex index c252c940eb..281cd58425 100644 --- a/docs/latex/wx/propfovi.tex +++ b/docs/latex/wx/propfovi.tex @@ -34,7 +34,7 @@ association manually. \func{bool}{Check}{\void} -Checks all properties by calling the appropriate validators; returns FALSE if a validation failed. +Checks all properties by calling the appropriate validators; returns false if a validation failed. \membersection{wxPropertyFormView::GetPanel}\label{wxpropertyformviewgetpanel} diff --git a/docs/latex/wx/proplisd.tex b/docs/latex/wx/proplisd.tex index 8a6a673754..8ea7f4c8ce 100644 --- a/docs/latex/wx/proplisd.tex +++ b/docs/latex/wx/proplisd.tex @@ -10,7 +10,7 @@ processing. \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. diff --git a/docs/latex/wx/proplist.tex b/docs/latex/wx/proplist.tex index f9ce7a77a2..ee6a7147a7 100644 --- a/docs/latex/wx/proplist.tex +++ b/docs/latex/wx/proplist.tex @@ -55,9 +55,9 @@ Behaviour alters depending on the kind of property being edited. For example, a the following behaviour: \begin{itemize}\itemsep=0pt -\item Double-clicking on the item toggles between TRUE and FALSE. -\item Showing the value list enables the user to select TRUE or FALSE. -\item The user may be able to type in the word TRUE or FALSE, or the edit control +\item Double-clicking on the item toggles between true and false. +\item Showing the value list enables the user to select true or false. +\item The user may be able to type in the word true or false, or the edit control may be read-only to disallow this since it is error-prone. \end{itemize} @@ -180,7 +180,7 @@ void PropertyListTest(Bool useDialog) wxPropertySheet *sheet = new wxPropertySheet; sheet->AddProperty(new wxProperty("fred", 1.0, "real")); - sheet->AddProperty(new wxProperty("tough choice", (Bool)TRUE, "bool")); + sheet->AddProperty(new wxProperty("tough choice", (Bool)true, "bool")); sheet->AddProperty(new wxProperty("ian", (long)45, "integer", new wxIntegerListValidator(-50, 50))); sheet->AddProperty(new wxProperty("bill", 25.0, "real", new wxRealListValidator(0.0, 100.0))); sheet->AddProperty(new wxProperty("julian", "one", "string")); @@ -196,7 +196,7 @@ void PropertyListTest(Bool useDialog) wxPropertyListFrame *propFrame = NULL; if (useDialog) { - propDialog = new wxPropertyListDialog(view, NULL, "Property Sheet Test", TRUE, -1, -1, 400, 500); + propDialog = new wxPropertyListDialog(view, NULL, "Property Sheet Test", true, -1, -1, 400, 500); } else { @@ -209,14 +209,14 @@ void PropertyListTest(Bool useDialog) { view->ShowView(sheet, propDialog); propDialog->Centre(wxBOTH); - propDialog->Show(TRUE); + propDialog->Show(true); } else { propFrame->Initialize(); view->ShowView(sheet, propFrame->GetPropertyPanel()); propFrame->Centre(wxBOTH); - propFrame->Show(TRUE); + propFrame->Show(true); } } \end{verbatim} @@ -240,7 +240,7 @@ void PropertyFormTest(Bool useDialog) wxPropertySheet *sheet = new wxPropertySheet; sheet->AddProperty(new wxProperty("fred", 25.0, "real", new wxRealFormValidator(0.0, 100.0))); - sheet->AddProperty(new wxProperty("tough choice", (Bool)TRUE, "bool")); + sheet->AddProperty(new wxProperty("tough choice", (Bool)true, "bool")); sheet->AddProperty(new wxProperty("ian", (long)45, "integer", new wxIntegerFormValidator(-50, 50))); sheet->AddProperty(new wxProperty("julian", "one", "string")); wxStringList *strings = new wxStringList("one", "two", "three", NULL); @@ -252,7 +252,7 @@ void PropertyFormTest(Bool useDialog) wxPropertyFormFrame *propFrame = NULL; if (useDialog) { - propDialog = new wxPropertyFormDialog(view, NULL, "Property Form Test", TRUE, -1, -1, 400, 300); + propDialog = new wxPropertyFormDialog(view, NULL, "Property Form Test", true, -1, -1, 400, 300); } else { @@ -286,7 +286,7 @@ void PropertyFormTest(Bool useDialog) view->AssociateNames(); view->TransferToDialog(); propDialog->Centre(wxBOTH); - propDialog->Show(TRUE); + propDialog->Show(true); } else { @@ -294,7 +294,7 @@ void PropertyFormTest(Bool useDialog) view->AssociateNames(); view->TransferToDialog(); propFrame->Centre(wxBOTH); - propFrame->Show(TRUE); + propFrame->Show(true); } } \end{verbatim} diff --git a/docs/latex/wx/propliva.tex b/docs/latex/wx/propliva.tex index 021c44f967..b75dfc782b 100644 --- a/docs/latex/wx/propliva.tex +++ b/docs/latex/wx/propliva.tex @@ -26,8 +26,8 @@ Destructor. \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 -was invalid, which is a signal restores the old value. Return TRUE if the value was valid. +Called when the Tick (Confirm) button is pressed or focus is list. Return false if the value +was invalid, which is a signal restores the old value. Return true if the value was valid. \membersection{wxPropertyListValidator::OnClearControls} diff --git a/docs/latex/wx/proplstv.tex b/docs/latex/wx/proplstv.tex index 9f978de448..a59fb2578a 100644 --- a/docs/latex/wx/proplstv.tex +++ b/docs/latex/wx/proplstv.tex @@ -105,7 +105,7 @@ 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/propval.tex b/docs/latex/wx/propval.tex index 1abe60958e..c1c2fd412b 100644 --- a/docs/latex/wx/propval.tex +++ b/docs/latex/wx/propval.tex @@ -137,7 +137,7 @@ Gets the last value in the list. \func{bool}{GetModified}{\void} -Returns TRUE if the value was modified since being created +Returns true if the value was modified since being created (or since SetModified was called). \membersection{wxPropertyValue::GetNext} diff --git a/docs/latex/wx/propview.tex b/docs/latex/wx/propview.tex index 4d21ae041d..ad74d1ab1a 100644 --- a/docs/latex/wx/propview.tex +++ b/docs/latex/wx/propview.tex @@ -74,7 +74,7 @@ Virtual function that will be called when the Cancel button on the physical wind \func{bool}{OnClose}{\void} -Virtual function that will be called when the physical window is closed. The default implementation returns FALSE. +Virtual function that will be called when the physical window is closed. The default implementation returns false. \membersection{wxPropertyView::OnHelp}\label{wxpropertyviewonhelp} @@ -95,7 +95,7 @@ to respond immediately to property value changes. \func{bool}{OnUpdateView}{\void} Called by the viewed object to update the view. The default implementation just returns -FALSE. +false. \membersection{wxPropertyView::SetPropertySheet}\label{wxpropertyviewsetpropertysheet} diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index e3cfe359d2..fc02dd57f2 100644 --- a/docs/latex/wx/protocol.tex +++ b/docs/latex/wx/protocol.tex @@ -26,7 +26,7 @@ Tries to reestablish a previous opened connection (close and renegotiate connect \wxheading{Return value} -TRUE, if the connection is established, else FALSE. +true, if the connection is established, else false. % ---------------------------------------------------------------------------- \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} @@ -61,7 +61,7 @@ It is advised to destroy the input stream instead of aborting the stream this wa \wxheading{Return value} -Returns TRUE, if successful, else FALSE. +Returns true, if successful, else false. % ---------------------------------------------------------------------------- \membersection{wxProtocol::GetError} diff --git a/docs/latex/wx/query.tex b/docs/latex/wx/query.tex index 923ed46348..2893956e76 100644 --- a/docs/latex/wx/query.tex +++ b/docs/latex/wx/query.tex @@ -71,13 +71,13 @@ Return the size of the data of the field field. \func{bool}{IsRowDirty}{\param{int}{ field}} -Returns TRUE if the given field has been changed, but not saved. +Returns true if the given field has been changed, but not saved. \membersection{wxQueryCol::IsNullable} \func{bool}{IsNullable}{\void} -Returns TRUE if a column may contain no data. +Returns true if a column may contain no data. \membersection{wxQueryCol::AppendField} @@ -109,7 +109,7 @@ appending columns. \membersection{wxQueryCol::SetFieldDirty} -\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool }{dirty = TRUE}} +\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool }{dirty = true}} Sets the dirty tag of a given field. @@ -180,7 +180,7 @@ Returns the type of the field (currently SQL\_CHAR, SQL\_VARCHAR or SQL\_INTEGER \func{bool}{IsDirty}{\void} -Returns TRUE if the data of a field has been changed, but not saved. +Returns true if the data of a field has been changed, but not saved. \membersection{wxQueryField::SetData} @@ -191,7 +191,7 @@ field buffer. \membersection{wxQueryField::SetDirty} -\func{void}{SetDirty}{\param{bool}{ dirty = TRUE}} +\func{void}{SetDirty}{\param{bool}{ dirty = true}} Sets the dirty tag of a field. diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 72f27204b6..7aaf5c0bd7 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -113,17 +113,17 @@ for further details. \membersection{wxRadioBox::Enable}\label{wxradioboxenable} -\func{void}{Enable}{\param{bool}{ enable = {\tt TRUE}}} +\func{void}{Enable}{\param{bool}{ enable = {\tt true}}} Enables or disables the entire radiobox. -\func{void}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt TRUE}}} +\func{void}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}} Enables or disables an individual button in the radiobox. \wxheading{Parameters} -\docparam{enable}{TRUE to enable, FALSE to disable.} +\docparam{enable}{true to enable, false to disable.} \docparam{n}{The zero-based button to enable or disable.} @@ -263,7 +263,7 @@ Shows or hides individual buttons. \wxheading{Parameters} -\docparam{show}{TRUE to show, FALSE to hide.} +\docparam{show}{true to show, false to hide.} \docparam{item}{The zero-based position of the button to show or hide.} diff --git a/docs/latex/wx/radiobut.tex b/docs/latex/wx/radiobut.tex index c9b5f647ed..58c0e04030 100644 --- a/docs/latex/wx/radiobut.tex +++ b/docs/latex/wx/radiobut.tex @@ -98,7 +98,7 @@ further details. \constfunc{bool}{GetValue}{\void} -Returns TRUE if the radio button is depressed, FALSE otherwise. +Returns true if the radio button is depressed, false otherwise. \membersection{wxRadioButton::SetValue}\label{wxradiobuttonsetvalue} @@ -109,6 +109,6 @@ wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event to get emitted. \wxheading{Parameters} -\docparam{value}{TRUE to select, FALSE to deselect.} +\docparam{value}{true to select, false to deselect.} diff --git a/docs/latex/wx/recrdset.tex b/docs/latex/wx/recrdset.tex index 9d2faa1917..7fedfe70ac 100644 --- a/docs/latex/wx/recrdset.tex +++ b/docs/latex/wx/recrdset.tex @@ -270,7 +270,7 @@ obtained from the ODBC manager.} Copies the current data of the column at position {\it col} into the buffer \rtfsp{\it dataPtr}. To be sure to get the right type of data, the user has to pass the -correct data type. The function returns FALSE if {\it col} does not +correct data type. The function returns false if {\it col} does not exist or the wrong data type was given. \func{bool}{GetFieldData}{\param{const wxString\& }{name}, \param{int}{ dataType}, \param{void *}{dataPtr}} @@ -456,14 +456,14 @@ has the number 0. \func{bool}{IsBOF}{\void} -Returns TRUE if the user tried to move the cursor before the first record +Returns true if the user tried to move the cursor before the first record in the set. \membersection{wxRecordSet::IsFieldDirty} \func{bool}{IsFieldDirty}{\param{int}{ field}} -Returns TRUE if the given field has been changed but not saved yet. +Returns true if the given field has been changed but not saved yet. \func{bool}{IsFieldDirty}{\param{const wxString\& }{name}} @@ -473,7 +473,7 @@ Same as above, but uses the column name as the identifier. \func{bool}{IsFieldNull}{\param{int}{ field}} -Returns TRUE if the given field has no data. +Returns true if the given field has no data. \func{bool}{IsFieldNull}{\param{const wxString\& }{ name}} @@ -483,7 +483,7 @@ Same as above, but uses the column name as the identifier. \func{bool}{IsColNullable}{\param{int}{ col}} -Returns TRUE if the given column may contain no data. +Returns true if the given column may contain no data. \func{bool}{IsColNullable}{\param{const wxString\& }{name}} @@ -493,7 +493,7 @@ Same as above, but uses the column name as the identifier. \func{bool}{IsEOF}{\void} -Returns TRUE if the user tried to move the cursor behind the last record +Returns true if the user tried to move the cursor behind the last record in the set. \membersection{wxRecordSet::IsDeleted} @@ -506,7 +506,7 @@ Not implemented. \func{bool}{IsOpen}{\void} -Returns TRUE if the parent database is open. +Returns true if the parent database is open. \membersection{wxRecordSet::Move} @@ -559,11 +559,11 @@ Re-executes the last query. Not implemented. \membersection{wxRecordSet::SetFieldDirty} -\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool}{ dirty = TRUE}} +\func{void}{SetFieldDirty}{\param{int}{ field}, \param{bool}{ dirty = true}} Sets the dirty tag of the field field. Not implemented. -\func{void}{SetFieldDirty}{\param{const wxString\& }{name}, \param{bool}{ dirty = TRUE}} +\func{void}{SetFieldDirty}{\param{const wxString\& }{name}, \param{bool}{ dirty = true}} Same as above, but uses the column name as the identifier. @@ -575,7 +575,7 @@ Not implemented. \membersection{wxRecordSet::SetFieldNull} -\func{void}{SetFieldNull}{\param{void *}{p}, \param{bool }{isNull = TRUE}} +\func{void}{SetFieldNull}{\param{void *}{p}, \param{bool }{isNull = true}} Not implemented. diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index b011d5a08e..63216a5bbf 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -166,15 +166,15 @@ new rectangle leaving this one unchanged. \constfunc{bool}{Inside}{\param{const wxPoint\& }{pt}} -Returns {\tt TRUE} if the given point is inside the rectangle (or on its -boundary) and {\tt FALSE} otherwise. +Returns {\tt true} if the given point is inside the rectangle (or on its +boundary) and {\tt false} otherwise. \membersection{wxRect:Intersects}\label{wxrectintersects} \constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}} -Returns {\tt TRUE} if this rectangle has a non empty intersection with the -rectangle {\it rect} and {\tt FALSE} otherwise. +Returns {\tt true} if this rectangle has a non empty intersection with the +rectangle {\it rect} and {\tt false} otherwise. \membersection{wxRect::Offset}\label{wxrectoffset} diff --git a/docs/latex/wx/regex.tex b/docs/latex/wx/regex.tex index 0c9adcbbfa..6473168c15 100644 --- a/docs/latex/wx/regex.tex +++ b/docs/latex/wx/regex.tex @@ -141,14 +141,14 @@ dtor not virtual, don't derive from this class \func{bool}{Compile}{\param{const wxString\& }{pattern}, \param{int }{flags = wxRE\_DEFAULT}} -Compile the string into regular expression, return {\tt TRUE} if ok or {\tt FALSE} +Compile the string into regular expression, return {\tt true} if ok or {\tt false} if string has a syntax error. \membersection{wxRegEx::IsValid}\label{wxregexisvalid} \constfunc{bool}{IsValid}{\void} -Return {\tt TRUE} if this is a valid compiled regular expression, {\tt FALSE} +Return {\tt true} if this is a valid compiled regular expression, {\tt false} otherwise. \membersection{wxRegEx::GetMatch}\label{wxregexgetmatch} @@ -163,7 +163,7 @@ May only be called after successful call to \helpref{Matches()}{wxregexmatches} and only if {\tt wxRE\_NOSUB} was {\bf not} used in \helpref{Compile()}{wxregexcompile}. -Returns {\tt FALSE} if no match or if an error occured. +Returns {\tt false} if no match or if an error occured. \constfunc{wxString}{GetMatch}{\param{const wxString\& }{text}, \param{size\_t }{index = 0}} @@ -179,7 +179,7 @@ and only if {\tt wxRE\_NOSUB} was {\bf not} used in \constfunc{bool}{Matches}{\param{const wxChar* }{text}, \param{int }{flags = 0}} Matches the precompiled regular expression against the string {\it text}, -returns {\tt TRUE} if matches and {\tt FALSE} otherwise. +returns {\tt true} if matches and {\tt false} otherwise. Flags may be combination of {\tt wxRE\_NOTBOL} and {\tt wxRE\_NOTEOL}. diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 0ca8231cdf..d9dd27d181 100644 --- a/docs/latex/wx/region.tex +++ b/docs/latex/wx/region.tex @@ -111,7 +111,7 @@ Finds the intersection of this region and another region. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise. +{\tt true} if successful, {\tt false} otherwise. \wxheading{Remarks} @@ -122,7 +122,7 @@ is stored in this region. \constfunc{bool}{IsEmpty}{\void} -Returns {\tt TRUE} if the region is empty, {\tt FALSE} otherwise. +Returns {\tt true} if the region is empty, {\tt false} otherwise. \membersection{wxRegion::Subtract}\label{wxregionsubstract} @@ -136,7 +136,7 @@ Subtracts a region from this region. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise. +{\tt true} if successful, {\tt false} otherwise. \wxheading{Remarks} @@ -152,7 +152,7 @@ directions. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise (the region is unchanged then). +{\tt true} if successful, {\tt false} otherwise (the region is unchanged then). \membersection{wxRegion::Union}\label{wxregionunion} @@ -170,7 +170,7 @@ Finds the union of this region and another region. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise. +{\tt true} if successful, {\tt false} otherwise. \wxheading{Remarks} @@ -193,7 +193,7 @@ Finds the Xor of this region and another region. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise. +{\tt true} if successful, {\tt false} otherwise. \wxheading{Remarks} @@ -286,7 +286,7 @@ Returns the current rectangle. \constfunc{bool}{HaveRects}{\void} -Returns {\tt TRUE} if there are still some rectangles; otherwise returns {\tt FALSE}. +Returns {\tt true} if there are still some rectangles; otherwise returns {\tt false}. \membersection{wxRegionIterator::Reset} @@ -310,7 +310,7 @@ Increment operator. Increments the iterator to the next region. \constfunc{}{operator bool}{\void} -Returns {\tt TRUE} if there are still some rectangles; otherwise returns {\tt FALSE}. +Returns {\tt true} if there are still some rectangles; otherwise returns {\tt false}. You can use this to test the iterator object as if it were of type bool. diff --git a/docs/latex/wx/sashwin.tex b/docs/latex/wx/sashwin.tex index e577f20225..dc25937b60 100644 --- a/docs/latex/wx/sashwin.tex +++ b/docs/latex/wx/sashwin.tex @@ -101,7 +101,7 @@ Destructor. \constfunc{bool}{GetSashVisible}{\param{wxSashEdgePosition }{edge}} -Returns TRUE if a sash is visible on the given edge, FALSE otherwise. +Returns true if a sash is visible on the given edge, false otherwise. \wxheading{Parameters} @@ -139,7 +139,7 @@ Gets the minimum window size in the y direction. \constfunc{bool}{HasBorder}{\param{wxSashEdgePosition }{edge}} -Returns TRUE if the sash has a border, FALSE otherwise. +Returns true if the sash has a border, false otherwise. \wxheading{Parameters} @@ -183,7 +183,7 @@ Call this function to make a sash visible or invisible on a particular edge. \docparam{edge}{Edge to change. One of wxSASH\_TOP, wxSASH\_RIGHT, wxSASH\_BOTTOM, wxSASH\_LEFT.} -\docparam{visible}{TRUE to make the sash visible, FALSE to make it invisible.} +\docparam{visible}{true to make the sash visible, false to make it invisible.} \wxheading{See also} @@ -199,7 +199,7 @@ Call this function to give the sash a border, or remove the border. \docparam{edge}{Edge to change. One of wxSASH\_TOP, wxSASH\_RIGHT, wxSASH\_BOTTOM, wxSASH\_LEFT.} -\docparam{hasBorder}{TRUE to give the sash a border visible, FALSE to remove it.} +\docparam{hasBorder}{true to give the sash a border visible, false to remove it.} \wxheading{See also} diff --git a/docs/latex/wx/scrolbar.tex b/docs/latex/wx/scrolbar.tex index a9fba5aa2a..955134b7bc 100644 --- a/docs/latex/wx/scrolbar.tex +++ b/docs/latex/wx/scrolbar.tex @@ -215,7 +215,7 @@ Sets the position of the scrollbar. \func{virtual void}{SetScrollbar}{\param{int }{position},\rtfsp \param{int }{thumbSize}, \param{int }{range},\rtfsp \param{int }{pageSize},\rtfsp -\param{const bool }{refresh = TRUE}} +\param{const bool }{refresh = true}} Sets the scrollbar properties. @@ -231,7 +231,7 @@ Sets the scrollbar properties. the scrollbar will scroll when it is paged up or down. Often it is the same as the thumb size.} -\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.} +\docparam{refresh}{true to redraw the scrollbar, false otherwise.} \wxheading{Remarks} diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex index f7f83b0677..52ccf938eb 100644 --- a/docs/latex/wx/scrolwin.tex +++ b/docs/latex/wx/scrolwin.tex @@ -211,9 +211,9 @@ is disabled. \wxheading{Parameters} -\docparam{xScrolling}{If TRUE, enables physical scrolling in the x direction.} +\docparam{xScrolling}{If true, enables physical scrolling in the x direction.} -\docparam{yScrolling}{If TRUE, enables physical scrolling in the y direction.} +\docparam{yScrolling}{If true, enables physical scrolling in the y direction.} \wxheading{Remarks} @@ -310,7 +310,7 @@ parameters and returns a tuple of values for x and y.} \constfunc{bool}{IsRetained}{\void} -Motif only: TRUE if the window has a backing bitmap. +Motif only: true if the window has a backing bitmap. \membersection{wxScrolledWindow::PrepareDC}\label{wxscrolledwindowpreparedc} @@ -384,7 +384,7 @@ that direction). \func{void}{SetScrollbars}{\param{int}{ pixelsPerUnitX}, \param{int}{ pixelsPerUnitY},\rtfsp \param{int}{ noUnitsX}, \param{int}{ noUnitsY},\rtfsp \param{int }{xPos = 0}, \param{int}{ yPos = 0},\rtfsp -\param{bool }{noRefresh = FALSE}} +\param{bool }{noRefresh = false}} Sets up vertical and/or horizontal scrollbars. @@ -402,7 +402,7 @@ Sets up vertical and/or horizontal scrollbars. \docparam{yPos}{Position to initialize the scrollbars in the vertical direction, in scroll units.} -\docparam{noRefresh}{Will not refresh window if TRUE.} +\docparam{noRefresh}{Will not refresh window if true.} \wxheading{Remarks} diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex index 84fce8519a..4cd49b5708 100644 --- a/docs/latex/wx/sizer.tex +++ b/docs/latex/wx/sizer.tex @@ -136,7 +136,7 @@ the child in the sizer, typically 0 for the first item. This method does not cause any layout or resizing to take place, call \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after detaching a child from the sizer. -Returns TRUE if the child item was found and detached, FALSE otherwise. +Returns true if the child item was found and detached, false otherwise. \wxheading{See also} @@ -244,7 +244,7 @@ it does not destroy the window as would usually be expected from Remove. You sh \helpref{wxSizer::Detach}{wxsizerdetach} in new code instead. There is currently no wxSizer method that will both detach and destroy a wxWindow item. -Returns TRUE if the child item was found and removed, FALSE otherwise. +Returns true if the child item was found and removed, false otherwise. \membersection{wxSizer::SetDimension}\label{wxsizersetdimension} @@ -300,11 +300,11 @@ minimal size. For windows with managed scrollbars this will set them appropriate \membersection{wxSizer::Show}\label{wxsizershow} -\func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = TRUE}} +\func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}} -\func{void}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = TRUE}} +\func{void}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = true}} -\func{void}{Show}{\param{size\_t }{index}, \param{bool }{show = TRUE}} +\func{void}{Show}{\param{size\_t }{index}, \param{bool }{show = true}} Shows or hides the {\it window}, {\it sizer}, or item at {\it index}. To make a sizer item disappear or reappear, use Show() followed by Layout(). diff --git a/docs/latex/wx/snglinst.tex b/docs/latex/wx/snglinst.tex index cab6ba0d4e..b655dd94b1 100644 --- a/docs/latex/wx/snglinst.tex +++ b/docs/latex/wx/snglinst.tex @@ -15,7 +15,7 @@ wxSingleInstanceChecker class allows to check that only a single instance of a program is running. To do it, you should create an object of this class. As long as this object is alive, calls to \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} from -other processes will return {\tt TRUE}. +other processes will return {\tt true}. As the object should have the life span as big as possible, it makes sense to create it either as a global or in \helpref{wxApp::OnInit}{wxapponinit}. For @@ -30,12 +30,12 @@ bool MyApp::OnInit() { wxLogError(_("Another program instance is already running, aborting.")); - return FALSE; + return false; } ... more initializations ... - return TRUE; + return true; } int MyApp::OnExit() @@ -99,7 +99,7 @@ create the lock file in under Unix (default is \wxheading{Return value} -Returns {\tt FALSE} if initialization failed, it doesn't mean that another +Returns {\tt false} if initialization failed, it doesn't mean that another instance is running - use \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} to check for it. @@ -108,8 +108,8 @@ for it. \constfunc{bool}{IsAnotherRunning}{\void} -Returns {\tt TRUE} if another copy of this program is already running, {\tt -FALSE} otherwise. +Returns {\tt true} if another copy of this program is already running, {\tt +false} otherwise. \membersection{wxSingleInstanceChecker::\destruct{wxSingleInstanceChecker}}\label{wxsingleinstancecheckerdtor} diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 33a9ae651d..9bede77f47 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -302,7 +302,7 @@ Destroy calls \helpref{Close}{wxsocketbaseclose} automatically. \wxheading{Return value} -Always TRUE. +Always true. % % Discard @@ -316,7 +316,7 @@ always returns immediately and its operation is not affected by IO flags. Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually discarded. -If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE. +If you use \helpref{Error}{wxsocketbaseerror}, it will always return false. % % Error @@ -325,7 +325,7 @@ If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE. \constfunc{bool}{Error}{\void} -Returns TRUE if an error occurred in the last IO operation. +Returns true if an error occurred in the last IO operation. Use this function to check for an error condition after one of the following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg. @@ -353,7 +353,7 @@ address, local port, ...). \wxheading{Return value} -TRUE if no error happened, FALSE otherwise. +true if no error happened, false otherwise. % % GetFlags @@ -377,7 +377,7 @@ address field contains the complete peer host address of the socket \wxheading{Return value} -TRUE if no error happened, FALSE otherwise. +true if no error happened, false otherwise. % % InterruptWait @@ -408,7 +408,7 @@ socket destruction), so you don't need to use it in these cases. \constfunc{bool}{IsConnected}{\void} -Returns TRUE if the socket is connected. +Returns true if the socket is connected. % % IsData @@ -430,7 +430,7 @@ is set, in which case the operation might still block). % \constfunc{bool}{IsDisconnected}{\void} -Returns TRUE if the socket is not connected. +Returns true if the socket is not connected. \membersection{wxSocketBase::LastCount}\label{wxsocketbaselastcount} @@ -458,7 +458,7 @@ Please note that this function merely returns the last error code, but it should not be used to determine if an error has occurred (this is because successful operations do not change the LastError value). Use \helpref{Error}{wxsocketbaseerror} first, in order to determine -if the last IO call failed. If this returns TRUE, use LastError +if the last IO call failed. If this returns true, use LastError to discover the cause of the error. % @@ -469,9 +469,9 @@ to discover the cause of the error. \func{void}{Notify}{\param{bool}{ notify}} According to the {\it notify} value, this function enables -or disables socket events. If {\it notify} is TRUE, the events +or disables socket events. If {\it notify} is true, the events configured with \helpref{SetNotify}{wxsocketbasesetnotify} will -be sent to the application. If {\it notify} is FALSE; no events +be sent to the application. If {\it notify} is false; no events will be sent. % @@ -481,15 +481,15 @@ will be sent. \constfunc{bool}{Ok}{\void} -Returns TRUE if the socket is initialized and ready and FALSE in other +Returns true if the socket is initialized and ready and false in other cases. \wxheading{Remark/Warning} -For \helpref{wxSocketClient}{wxsocketclient}, Ok won't return TRUE unless +For \helpref{wxSocketClient}{wxsocketclient}, Ok won't return true unless the client is connected to a server. -For \helpref{wxSocketServer}{wxsocketserver}, Ok will return TRUE if the +For \helpref{wxSocketServer}{wxsocketserver}, Ok will return true if the server could bind to the specified address and is already listening for new connections. @@ -655,7 +655,7 @@ For example: \begin{verbatim} sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG); - sock.Notify(TRUE); + sock.Notify(true); \end{verbatim} In this example, the user will be notified about incoming socket data and @@ -799,7 +799,7 @@ in the incoming queue. This function is not affected by wxSocket flags. If you use \helpref{LastCount}{wxsocketbaselastcount}, it will always return {\it nbytes}. -If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE. +If you use \helpref{Error}{wxsocketbaseerror}, it will always return false. \wxheading{Parameters} @@ -824,7 +824,7 @@ Returns a reference to the current object. \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}} -This function waits until any of the following conditions is TRUE: +This function waits until any of the following conditions is true: \begin{itemize} \item The socket becomes readable. @@ -847,8 +847,8 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -Returns TRUE when any of the above conditions is satisfied, -FALSE if the timeout was reached. +Returns true when any of the above conditions is satisfied, +false if the timeout was reached. \wxheading{See also} @@ -879,7 +879,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -Returns TRUE if the connection was lost, FALSE if the timeout was reached. +Returns true if the connection was lost, false if the timeout was reached. \wxheading{See also} @@ -909,7 +909,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -Returns TRUE if the socket becomes readable, FALSE on timeout. +Returns true if the socket becomes readable, false on timeout. \wxheading{See also} @@ -939,7 +939,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -Returns TRUE if the socket becomes writable, FALSE on timeout. +Returns true if the socket becomes writable, false on timeout. \wxheading{See also} @@ -1070,16 +1070,16 @@ Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}. % \membersection{wxSocketClient::Connect}\label{wxsocketclientconnect} -\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}} +\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = true}} Connects to a server using the specified address. -If {\it wait} is TRUE, Connect will wait until the connection +If {\it wait} is true, Connect will wait until the connection completes. {\bf Warning:} This will block the GUI. -If {\it wait} is FALSE, Connect will try to establish the connection and +If {\it wait} is false, Connect will try to establish the connection and return immediately, without blocking the GUI. When used this way, even if -Connect returns FALSE, the connection request can be completed later. +Connect returns false, the connection request can be completed later. To detect this, use \helpref{WaitOnConnect}{wxsocketclientwaitonconnect}, or catch {\bf wxSOCKET\_CONNECTION} events (for successful establishment) and {\bf wxSOCKET\_LOST} events (for connection failure). @@ -1088,16 +1088,16 @@ and {\bf wxSOCKET\_LOST} events (for connection failure). \docparam{address}{Address of the server.} -\docparam{wait}{If TRUE, waits for the connection to complete.} +\docparam{wait}{If true, waits for the connection to complete.} \wxheading{Return value} -Returns TRUE if the connection is established and no error occurs. +Returns true if the connection is established and no error occurs. -If {\it wait} was TRUE, and Connect returns FALSE, an error occurred +If {\it wait} was true, and Connect returns false, an error occurred and the connection failed. -If {\it wait} was FALSE, and Connect returns FALSE, you should still +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 {\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events. @@ -1117,7 +1117,7 @@ watching {\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events. Wait until a connection request completes, or until the specified timeout elapses. Use this function after issuing a call -to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to FALSE. +to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to false. \wxheading{Parameters} @@ -1129,22 +1129,22 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -WaitOnConnect returns TRUE if the connection request completes. This +WaitOnConnect returns true if the connection request completes. This does not necessarily mean that the connection was successfully established; it might also happen that the connection was refused by the peer. Use \helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between these two situations. -If the timeout elapses, WaitOnConnect returns FALSE. +If the timeout elapses, WaitOnConnect returns false. These semantics allow code like this: \begin{verbatim} // Issue the connection request -client->Connect(addr, FALSE); +client->Connect(addr, false); // Wait until the request completes or until we decide to give up -bool waitmore = TRUE; +bool waitmore = true; while ( !client->WaitOnConnect(seconds, millis) && waitmore ) { // possibly give some feedback to the user, diff --git a/docs/latex/wx/socksrv.tex b/docs/latex/wx/socksrv.tex index 29bb083b2c..a63db59c46 100644 --- a/docs/latex/wx/socksrv.tex +++ b/docs/latex/wx/socksrv.tex @@ -58,17 +58,17 @@ Destructor (it doesn't close the accepted connections). % \membersection{wxSocketServer::Accept}\label{wxsocketserveraccept} -\func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}} +\func{wxSocketBase *}{Accept}{\param{bool}{ wait = true}} Accepts an incoming connection request, and creates a new \helpref{wxSocketBase}{wxsocketbase} object which represents the server-side of the connection. -If {\it wait} is TRUE and there are no pending connections to be +If {\it wait} is true and there are no pending connections to be accepted, it will wait for the next incoming connection to arrive. {\bf Warning:} This will block the GUI. -If {\it wait} is FALSE, it will try to accept a pending connection +If {\it wait} is false, it will try to accept a pending connection if there is one, but it will always return immediately without blocking the GUI. If you want to use Accept in this way, you can either check for incoming connections with \helpref{WaitForAccept}{wxsocketserverwaitforaccept} @@ -78,7 +78,7 @@ that there is an incoming connection waiting to be accepted. \wxheading{Return value} Returns an opened socket connection, or NULL if an error occurred or -if the {\it wait} parameter was FALSE and there were no pending +if the {\it wait} parameter was false and there were no pending connections. \wxheading{See also} @@ -93,7 +93,7 @@ connections. % \membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith} -\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}, \param{bool}{ wait = TRUE}} +\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}, \param{bool}{ wait = true}} Accept an incoming connection using the specified socket object. @@ -103,8 +103,8 @@ Accept an incoming connection using the specified socket object. \wxheading{Return value} -Returns TRUE on success, or FALSE if an error occurred or if the -{\it wait} parameter was FALSE and there were no pending +Returns true on success, or false if an error occurred or if the +{\it wait} parameter was false and there were no pending connections. \helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, @@ -121,7 +121,7 @@ connections. 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 +with {\it wait} set to false, to detect when an incoming connection is waiting to be accepted. \wxheading{Parameters} @@ -134,7 +134,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} -Returns TRUE if an incoming connection arrived, FALSE if the timeout elapsed. +Returns true if an incoming connection arrived, false if the timeout elapsed. \wxheading{See also} diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex index b37d1b73eb..d9b0f4b16a 100644 --- a/docs/latex/wx/splitter.tex +++ b/docs/latex/wx/splitter.tex @@ -190,7 +190,7 @@ This should be called if you wish to initially view only a single pane in the sp \constfunc{bool}{IsSplit}{\void} -Returns TRUE if the window is split, FALSE otherwise. +Returns true if the window is split, false otherwise. \membersection{wxSplitterWindow::OnDoubleClickSash}\label{wxsplitterwindowondoubleclicksash} @@ -235,7 +235,7 @@ may wish to delete the window. \func{virtual bool}{OnSashPositionChange}{\param{int }{newSashPosition}} Application-overridable function called when the sash position is changed by -user. It may return FALSE to prevent the change or TRUE to allow it. +user. It may return false to prevent the change or true to allow it. \wxheading{Parameters} @@ -258,8 +258,8 @@ windows or only one. Both parameters should be non-NULL and {\it winOld} must specify one of the windows managed by the splitter. If the parameters are incorrect or the window -couldn't be replaced, FALSE is returned. Otherwise the function will return -TRUE, but please notice that it will not delete the replaced window and you +couldn't be replaced, false is returned. Otherwise the function will return +true, but please notice that it will not delete the replaced window and you may wish to do it yourself. \wxheading{See also} @@ -274,7 +274,7 @@ may wish to do it yourself. \membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition} -\func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = TRUE}} +\func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = true}} Sets the sash position. @@ -282,7 +282,7 @@ Sets the sash position. \docparam{position}{The sash position in pixels.} -\docparam{redraw}{If TRUE, resizes the panes and redraws the sash and border.} +\docparam{redraw}{If true, resizes the panes and redraws the sash and border.} \wxheading{Remarks} @@ -353,7 +353,7 @@ to choose the default position (half of the total window height).} \wxheading{Return value} -TRUE if successful, FALSE otherwise (the window was already split). +true if successful, false otherwise (the window was already split). \wxheading{Remarks} @@ -386,7 +386,7 @@ to choose the default position (half of the total window width).} \wxheading{Return value} -TRUE if successful, FALSE otherwise (the window was already split). +true if successful, false otherwise (the window was already split). \wxheading{Remarks} @@ -410,7 +410,7 @@ Unsplits the window. \wxheading{Return value} -TRUE if successful, FALSE otherwise (the window was not split). +true if successful, false otherwise (the window was not split). \wxheading{Remarks} diff --git a/docs/latex/wx/statline.tex b/docs/latex/wx/statline.tex index 93f62a82ae..3fe2b22681 100644 --- a/docs/latex/wx/statline.tex +++ b/docs/latex/wx/statline.tex @@ -72,7 +72,7 @@ for further details. \constfunc{bool}{IsVertical}{\void} -Returns TRUE if the line is vertical, FALSE if horizontal. +Returns true if the line is vertical, false if horizontal. \membersection{wxStaticLine::GetDefaultSize}\label{wxstaticlinegetdefaultsize} diff --git a/docs/latex/wx/statusbr.tex b/docs/latex/wx/statusbr.tex index 2ebf4e4d97..58a882beb5 100644 --- a/docs/latex/wx/statusbr.tex +++ b/docs/latex/wx/statusbr.tex @@ -97,7 +97,7 @@ Returns the size and position of a fields internal bounding rectangle. \wxheading{Return value} -TRUE if the field index is valid, FALSE otherwise. +true if the field index is valid, false otherwise. \wxheading{See also} diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index d573446a86..4b2997f0eb 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -270,8 +270,8 @@ Returns the amount of bytes read during the last IO call to the parent stream. \func{void}{Fixed}{\param{bool}{ fixed}} Toggles the fixed flag. Usually this flag is toggled at the same time as -{\it flushable}. This flag allows (when it has the FALSE value) or forbids -(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer. +{\it flushable}. This flag allows (when it has the false value) or forbids +(when it has the true value) the stream buffer to resize dynamically the IO buffer. \wxheading{See also} diff --git a/docs/latex/wx/strlist.tex b/docs/latex/wx/strlist.tex index 4c98872b30..8956e27041 100644 --- a/docs/latex/wx/strlist.tex +++ b/docs/latex/wx/strlist.tex @@ -61,16 +61,16 @@ Searches for string and deletes from list, deallocating memory. \membersection{wxStringList::ListToArray} -\func{char*}{ListToArray}{\param{bool}{ new\_copies = FALSE}} +\func{char*}{ListToArray}{\param{bool}{ new\_copies = false}} Converts the list to an array of strings, only allocating new memory if -\rtfsp{\bf new\_copies} is TRUE. +\rtfsp{\bf new\_copies} is true. \membersection{wxStringList::Member} \func{bool}{Member}{\param{const wxString\& }{s}} -Returns TRUE if {\bf s} is a member of the list (tested using {\bf strcmp}). +Returns true if {\bf s} is a member of the list (tested using {\bf strcmp}). \membersection{wxStringList::Sort} diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 243e5a48ef..3a18bd74a0 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -43,7 +43,7 @@ Destructor. \constfunc{wxStreamError}{IsOk}{\void} -Returns TRUE if no error occurred on the stream. +Returns true if no error occurred on the stream. \wxheading{See also} diff --git a/docs/latex/wx/sysopt.tex b/docs/latex/wx/sysopt.tex index b04265f49f..d937268bdd 100644 --- a/docs/latex/wx/sysopt.tex +++ b/docs/latex/wx/sysopt.tex @@ -65,7 +65,7 @@ Gets an option as an integer. The function is case-insensitive to {\it name}. \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}} -Returns TRUE if the given option is present. The function is case-insensitive to {\it name}. +Returns true if the given option is present. The function is case-insensitive to {\it name}. \wxheading{See also} diff --git a/docs/latex/wx/tab.tex b/docs/latex/wx/tab.tex index 4465b72454..c257f097ae 100644 --- a/docs/latex/wx/tab.tex +++ b/docs/latex/wx/tab.tex @@ -183,7 +183,7 @@ Returns the y offset from the top-left of the view area. \func{bool}{HitTest}{\param{int}{ x}, \param{int}{ y}} -Returns TRUE if the point x, y is within the tab area. +Returns true if the point x, y is within the tab area. \membersection{wxTabControl::OnDraw} diff --git a/docs/latex/wx/tabctrl.tex b/docs/latex/wx/tabctrl.tex index cf23b6a41e..f154888fac 100644 --- a/docs/latex/wx/tabctrl.tex +++ b/docs/latex/wx/tabctrl.tex @@ -180,7 +180,7 @@ Inserts a new tab. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \membersection{wxTabCtrl::SetItemData}\label{wxtabctrlsetitemdata} diff --git a/docs/latex/wx/tabview.tex b/docs/latex/wx/tabview.tex index 7bc44a860a..3d07fe7e86 100644 --- a/docs/latex/wx/tabview.tex +++ b/docs/latex/wx/tabview.tex @@ -49,7 +49,7 @@ A new layer (row) is started when the current layer has been filled up with tabs \membersection{wxTabView::CalculateTabWidth}\label{wxtabviewcalculatetabwidth} -\func{int}{CalculateTabWidth}{\param{int}{ noTabs}, \param{bool}{ adjustView = FALSE}} +\func{int}{CalculateTabWidth}{\param{int}{ noTabs}, \param{bool}{ adjustView = false}} The application can specify the tab width using this function, in terms of the number of tabs per layer (row) which will fit the view area, which @@ -58,16 +58,16 @@ should have been set previously with SetViewRect. {\it noTabs} is the number of tabs which should take up the full width of the view area. -{\it adjustView} can be set to TRUE in order to readjust the view width +{\it adjustView} can be set to true in order to readjust the view width to exactly fit the given number of tabs. The new tab width is returned. \membersection{wxTabView::ClearTabs} -\func{void}{ClearTabs}{\param{bool }{deleteTabs=TRUE}} +\func{void}{ClearTabs}{\param{bool }{deleteTabs=true}} -Clears the tabs, deleting them if {\it deleteTabs} is TRUE. +Clears the tabs, deleting them if {\it deleteTabs} is true. \membersection{wxTabView::Draw} @@ -237,8 +237,8 @@ You may want to call this function if the view width has changed (for example, f \func{bool}{OnEvent}{\param{wxMouseEvent\& }{event}} -Processes mouse events sent from the panel or dialog. Returns TRUE if the event was processed, -FALSE otherwise. +Processes mouse events sent from the panel or dialog. Returns true if the event was processed, +false otherwise. \membersection{wxTabView::OnTabActivate} @@ -252,7 +252,7 @@ Called when a tab is activated, with the new active tab id, and the former activ Called just before a tab is activated, with the new active tab id, and the former active tab id. -If the function returns FALSE, the tab is not activated. +If the function returns false, the tab is not activated. \membersection{wxTabView::SetBackgroundColour} @@ -313,11 +313,11 @@ higher than the other tabs. \membersection{wxTabView::SetTabSelection} -\func{void}{SetTabSelection}{\param{int}{ sel}, \param{bool}{ activateTool=TRUE}} +\func{void}{SetTabSelection}{\param{int}{ sel}, \param{bool}{ activateTool=true}} Sets the selected tab, calling the application's OnTabActivate function. -If {\it activateTool} is FALSE, OnTabActivate will not be called. +If {\it activateTool} is false, OnTabActivate will not be called. \membersection{wxTabView::SetTextColour} diff --git a/docs/latex/wx/tapp.tex b/docs/latex/wx/tapp.tex index 9deac1d1ba..f748843b83 100644 --- a/docs/latex/wx/tapp.tex +++ b/docs/latex/wx/tapp.tex @@ -7,7 +7,7 @@ A wxWindows application does not have a {\it main} procedure; the equivalent is \rtfsp{\it OnInit} will usually create a top window as a bare minimum. Unlike in earlier versions of wxWindows, OnInit does not return a frame. Instead it -returns a boolean value which indicates whether processing should continue (TRUE) or not (FALSE). +returns a boolean value which indicates whether processing should continue (true) or not (false). You call \helpref{wxApp::SetTopWindow}{wxappsettopwindow} to let wxWindows know about the top window. @@ -40,10 +40,10 @@ bool DerivedApp::OnInit() { wxFrame *the_frame = new wxFrame(NULL, ID_MYFRAME, argv[0]); ... - the_frame->Show(TRUE); + the_frame->Show(true); SetTopWindow(the_frame); - return TRUE; + return true; } \end{verbatim} diff --git a/docs/latex/wx/taskbar.tex b/docs/latex/wx/taskbar.tex index 0860f26b47..6651590b36 100644 --- a/docs/latex/wx/taskbar.tex +++ b/docs/latex/wx/taskbar.tex @@ -53,13 +53,13 @@ Destroys the wxTaskBarIcon object, removing the icon if not already removed. \func{bool}{IsIconInstalled}{\void} -Returns TRUE if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}. +Returns true if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}. \membersection{wxTaskBarIcon::IsOK}\label{wxtaskbariconisok} \func{bool}{IsOK}{\void} -Returns TRUE if the object initialized successfully. +Returns true if the object initialized successfully. \membersection{wxTaskBarIcon::OnLButtonDown}\label{wxtaskbaricononlbuttondown} diff --git a/docs/latex/wx/tclipbrd.tex b/docs/latex/wx/tclipbrd.tex index ae3f102ab3..4e814c08ae 100644 --- a/docs/latex/wx/tclipbrd.tex +++ b/docs/latex/wx/tclipbrd.tex @@ -60,9 +60,9 @@ chose. But for drag and drop it can only know it after To receive (paste in usual terminology) data from the clipboard, you should create a \helpref{wxDataObject}{wxdataobject} derived class which supports the data formats you need and pass it as argument to -\helpref{wxClipboard::GetData}{wxclipboardgetdata}. If it returns {\tt FALSE}, +\helpref{wxClipboard::GetData}{wxclipboardgetdata}. If it returns {\tt false}, no data in (any of) the supported format(s) is available. If it returns {\tt -TRUE}, the data has been successfully transferred to wxDataObject. +true}, the data has been successfully transferred to wxDataObject. For drag and drop case, the \helpref{wxDropTarget::OnData}{wxdroptargetondata} virtual function will be called when a data object is dropped, from which the diff --git a/docs/latex/wx/tcommdlg.tex b/docs/latex/wx/tcommdlg.tex index cd91cc9036..452d851d25 100644 --- a/docs/latex/wx/tcommdlg.tex +++ b/docs/latex/wx/tcommdlg.tex @@ -59,7 +59,7 @@ uses it to set the background of a window. \begin{verbatim} wxColourData data; - data.SetChooseFull(TRUE); + data.SetChooseFull(true); for (int i = 0; i < 16; i++) { wxColour colour(i*16, i*16, i*16); diff --git a/docs/latex/wx/tcpclint.tex b/docs/latex/wx/tcpclint.tex index 2d080a31d4..fcb71c3640 100644 --- a/docs/latex/wx/tcpclint.tex +++ b/docs/latex/wx/tcpclint.tex @@ -64,5 +64,5 @@ store application-specific data in instances of the new class. \func{bool}{ValidHost}{\param{const wxString\& }{host}} -Returns TRUE if this is a valid host name, FALSE otherwise. +Returns true if this is a valid host name, false otherwise. diff --git a/docs/latex/wx/tcpconn.tex b/docs/latex/wx/tcpconn.tex index bf4dcf59cf..924890f6a7 100644 --- a/docs/latex/wx/tcpconn.tex +++ b/docs/latex/wx/tcpconn.tex @@ -83,7 +83,7 @@ transactions. Called by the server application to advise the client of a change in the data associated with the given item. Causes the client connection's \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise} -member to be called. Returns TRUE if successful. +member to be called. Returns true if successful. \membersection{wxTCPConnection::Execute} @@ -93,7 +93,7 @@ Called by the client application to execute a command on the server. Can also be used to transfer arbitrary data to the server (similar to \helpref{wxTCPConnection::Poke}{wxtcpconnectionpoke} in that respect). Causes the server connection's \helpref{wxTCPConnection::OnExecute}{wxtcpconnectiononexecute} member to be -called. Returns TRUE if successful. +called. Returns true if successful. \membersection{wxTCPConnection::Disconnect} @@ -104,7 +104,7 @@ program; it causes the \helpref{wxTCPConnection::OnDisconnect}{wxtcpconnectionon to be sent to the corresponding connection object in the other program. The default behaviour of {\bf OnDisconnect} is to delete the connection, but the calling application must explicitly delete its -side of the connection having called {\bf Disconnect}. Returns TRUE if +side of the connection having called {\bf Disconnect}. Returns true if successful. \membersection{wxTCPConnection::OnAdvise}\label{wxtcpconnectiononadvise} @@ -152,7 +152,7 @@ or NULL to indicate no data. Message sent to the server application by the client, when the client wishes to start an `advise loop' for the given topic and item. The -server can refuse to participate by returning FALSE. +server can refuse to participate by returning false. \membersection{wxTCPConnection::OnStopAdvise}\label{wxtcpconnectiononstopadvise} @@ -160,7 +160,7 @@ server can refuse to participate by returning FALSE. Message sent to the server application by the client, when the client wishes to stop an `advise loop' for the given topic and item. The -server can refuse to stop the advise loop by returning FALSE, although +server can refuse to stop the advise loop by returning false, although this doesn't have much meaning in practice. \membersection{wxTCPConnection::Poke}\label{wxtcpconnectionpoke} @@ -170,7 +170,7 @@ this doesn't have much meaning in practice. Called by the client application to poke data into the server. Can be used to transfer arbitrary data to the server. Causes the server connection's \helpref{wxTCPConnection::OnPoke}{wxtcpconnectiononpoke} member -to be called. Returns TRUE if successful. +to be called. Returns true if successful. \membersection{wxTCPConnection::Request}\label{wxtcpconnectionrequest} @@ -187,7 +187,7 @@ successful, NULL otherwise. Called by the client application to ask if an advise loop can be started with the server. Causes the server connection's \helpref{wxTCPConnection::OnStartAdvise}{wxtcpconnectiononstartadvise}\rtfsp -member to be called. Returns TRUE if the server okays it, FALSE +member to be called. Returns true if the server okays it, false otherwise. \membersection{wxTCPConnection::StopAdvise}\label{wxtcpconnectionstopadvise} @@ -196,5 +196,5 @@ otherwise. Called by the client application to ask if an advise loop can be stopped. Causes the server connection's \helpref{wxTCPConnection::OnStopAdvise}{wxtcpconnectiononstopadvise} member -to be called. Returns TRUE if the server okays it, FALSE otherwise. +to be called. Returns true if the server okays it, false otherwise. diff --git a/docs/latex/wx/tcpservr.tex b/docs/latex/wx/tcpservr.tex index c25930389a..cdb140c698 100644 --- a/docs/latex/wx/tcpservr.tex +++ b/docs/latex/wx/tcpservr.tex @@ -32,7 +32,7 @@ Constructs a server object. Registers the server using the given service name. Under Unix, the string must contain an integer id which is used as an Internet port -number. FALSE is returned if the call failed (for example, the port +number. false is returned if the call failed (for example, the port number is already in use). \membersection{wxTCPServer::OnAcceptConnection}\label{wxtcpserveronacceptconnection} diff --git a/docs/latex/wx/tdb.tex b/docs/latex/wx/tdb.tex index 401f78758e..4ff6da4cc9 100644 --- a/docs/latex/wx/tdb.tex +++ b/docs/latex/wx/tdb.tex @@ -424,7 +424,7 @@ the necessary handle: \end{verbatim} When the wxDbConnectInf::AllocHenv() function is called successfully, a -value of TRUE will be returned. A value of FALSE means allocation failed, +value of true will be returned. A value of false means allocation failed, and the handle will be undefined. A shorter form of doing the above steps is encapsulated into the @@ -579,9 +579,9 @@ can specify anywhere from one column up to all columns in the table. \begin{verbatim} table->SetColDefs(0, "FIRST_NAME", DB_DATA_TYPE_VARCHAR, FirstName, - SQL_C_CHAR, sizeof(name), TRUE, TRUE); + SQL_C_CHAR, sizeof(name), true, true); table->SetColDefs(1, "LAST_NAME", DB_DATA_TYPE_VARCHAR, LastName, - SQL_C_CHAR, sizeof(LastName), TRUE, TRUE); + SQL_C_CHAR, sizeof(LastName), true, true); \end{verbatim} Notice that column definitions start at index 0 and go up to one less than @@ -718,7 +718,7 @@ syntax problem in the WHERE clause that was specified. The exact SQL parsing the table's database connection's "errorList[]" array member for the stored text of the error. -When the \helpref{wxDbTable::Query}{wxdbtablequery} returns TRUE, the +When the \helpref{wxDbTable::Query}{wxdbtablequery} returns true, the database was able to successfully complete the requested query using the provided criteria. This does not mean that there are any rows in the result set, it just mean that the query was successful. @@ -740,7 +740,7 @@ set into the bound memory variables. After \helpref{wxDbTable::Query}{wxdbtableq has completed successfully, the default/current cursor is placed so it is pointing just before the first record in the result set. If the result set is empty (no rows matched the criteria), then any calls to -retrieve data from the result set will return FALSE. +retrieve data from the result set will return false. \begin{verbatim} wxString msg; @@ -762,7 +762,7 @@ in the result set. When \helpref{wxDbTable::GetNext}{wxdbtablegetnext} is called and there are no rows remaining in the result set after the current cursor position, \helpref{wxDbTable::GetNext}{wxdbtablegetnext} (as well as all the other -wxDbTable::GetXxxxx() functions) will return FALSE. +wxDbTable::GetXxxxx() functions) will return false. {\bf Close the table} @@ -894,7 +894,7 @@ functionality as the driver can emulate. \begin{itemize}\itemsep=0pt \item Does not support the SQL\_TIMESTAMP structure \item Supports only one cursor and one connect (apparently? with Microsoft driver only?) -\item Does not automatically create the primary index if the 'keyField' param of SetColDef is TRUE. The user must create ALL indexes from their program with calls to \helpref{wxDbTable::CreateIndex}{wxdbtablecreateindex} +\item Does not automatically create the primary index if the 'keyField' param of SetColDef is true. The user must create ALL indexes from their program with calls to \helpref{wxDbTable::CreateIndex}{wxdbtablecreateindex} \item Table names can only be 8 characters long \item Column names can only be 10 characters long \item Currently cannot CREATE a dBase table - bug or limitation of the drivers used?? @@ -916,7 +916,7 @@ functionality as the driver can emulate. {\it mySQL} \begin{itemize}\itemsep=0pt \item If a column is part of the Primary Key, the column cannot be NULL. -\item Cannot support selecting for update [\helpref{wxDbTable::CanSelectForUpdate}{wxdbtablecanselectforupdate}]. Always returns FALSE. +\item Cannot support selecting for update [\helpref{wxDbTable::CanSelectForUpdate}{wxdbtablecanselectforupdate}]. Always returns false. \item Columns that are part of primary or secondary keys must be defined as being NOT NULL when they are created. Some code is added in \helpref{wxDbTable::CreateIndex}{wxdbtablecreateindex} to try to adjust the column definition if it is not defined correctly, but it is experimental (as of wxWindows v2.2.1) \item Does not support sub-queries in SQL statements \end{itemize} @@ -958,7 +958,7 @@ wxDbTable *table = NULL; // The data table to access wxChar FirstName[50+1]; // buffer for data from column "FIRST_NAME" wxChar LastName[50+1]; // buffer for data from column "LAST_NAME" -bool errorOccured = FALSE; +bool errorOccured = false; const wxChar tableName[] = "CONTACTS"; const UWORD numTableColumns = 2; // Number of bound columns @@ -990,9 +990,9 @@ table = new wxDbTable(db, tableName, numTableColumns, "", // returned back to the client. // table->SetColDefs(0, "FIRST_NAME", DB_DATA_TYPE_VARCHAR, FirstName, - SQL_C_CHAR, sizeof(name), TRUE, TRUE); + SQL_C_CHAR, sizeof(name), true, true); table->SetColDefs(1, "LAST_NAME", DB_DATA_TYPE_VARCHAR, LastName, - SQL_C_CHAR, sizeof(LastName), TRUE, TRUE); + SQL_C_CHAR, sizeof(LastName), true, true); // Open the table for access table->Open(); @@ -1015,7 +1015,7 @@ if (!table->Query()) { wxMessageBox("Error on Query()","ERROR!", wxOK | wxICON_EXCLAMATION); - errorOccured = TRUE; + errorOccured = true; } wxString msg; diff --git a/docs/latex/wx/tdelwin.tex b/docs/latex/wx/tdelwin.tex index d425e42ae4..b5864727a8 100644 --- a/docs/latex/wx/tdelwin.tex +++ b/docs/latex/wx/tdelwin.tex @@ -15,7 +15,7 @@ in turn generates an EVT\_CLOSE event: see \helpref{wxCloseEvent}{wxcloseevent}. It is the duty of the application to define a suitable event handler, and decide whether or not to destroy the window. If the application is for some reason forcing the application to close -(\helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns FALSE), the window should always be destroyed, otherwise there is the option to +(\helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns false), the window should always be destroyed, otherwise there is the option to ignore the request, or maybe wait until the user has answered a question before deciding whether it is safe to close. The handler for EVT\_CLOSE should signal to the calling code if it does not destroy the window, by calling @@ -35,13 +35,13 @@ certain that the window is destroyed. Your application can either use \helpref{wxWindow::Close}{wxwindowclose} event just as the framework does, or it can call \helpref{wxWindow::Destroy}{wxwindowdestroy} directly. -If using Close(), you can pass a TRUE argument to this function to tell the event handler +If using Close(), you can pass a true argument to this function to tell the event handler that we definitely want to delete the frame and it cannot be vetoed. The advantage of using Close instead of Destroy is that it will call any clean-up code defined by the EVT\_CLOSE handler; for example it may close a document contained in a window after first asking the user whether the work should be saved. Close can be vetoed -by this process (return FALSE), whereas Destroy definitely destroys the window. +by this process (return false), whereas Destroy definitely destroys the window. \wxheading{What is the default behaviour?} diff --git a/docs/latex/wx/tdnd.tex b/docs/latex/wx/tdnd.tex index 3f57d7ab24..fe251ebb55 100644 --- a/docs/latex/wx/tdnd.tex +++ b/docs/latex/wx/tdnd.tex @@ -36,7 +36,7 @@ like this: \begin{verbatim} wxDropSource dragSource( this ); dragSource.SetData( my_data ); - wxDragResult result = dragSource.DoDragDrop( TRUE ); + wxDragResult result = dragSource.DoDragDrop( true ); \end{verbatim} \item {\bf Dragging:} The call to DoDragDrop() blocks the program until the user release the mouse button (unless you override \helpref{GiveFeedback}{wxdropsourcegivefeedback} function diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex index 343a3ea55d..6aeddc5166 100644 --- a/docs/latex/wx/tempfile.tex +++ b/docs/latex/wx/tempfile.tex @@ -65,7 +65,7 @@ Associates wxTempFile with the file to be replaced and opens it. You should use \func{bool}{Open}{\param{const wxString\& }{strName}} -Open the temporary file, returns {\tt TRUE} on success, {\tt FALSE} if an error +Open the temporary file, returns {\tt true} on success, {\tt false} if an error occurred. {\it strName} is the name of file to be replaced. The temporary file is always @@ -77,19 +77,19 @@ and the program should have write access to it for the function to succeed. \constfunc{bool}{IsOpened}{\void} -Returns {\tt TRUE} if the file was successfully opened. +Returns {\tt true} if the file was successfully opened. \membersection{wxTempFile::Write}\label{wxtempfilewrite} \func{bool}{Write}{\param{const void }{*p}, \param{size\_t }{n}} -Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure. +Write to the file, return {\tt true} on success, {\tt false} on failure. \membersection{wxTempFile::Write}\label{wxtempfilewrites} \func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv\&}{ conv = wxConvLibc}} -Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure. +Write to the file, return {\tt true} on success, {\tt false} on failure. The second argument is only meaningful in Unicode build of wxWindows when {\it conv} is used to convert {\it str} to multibyte representation. @@ -99,7 +99,7 @@ The second argument is only meaningful in Unicode build of wxWindows when \func{bool}{Commit}{\void} Validate changes: deletes the old file of name m\_strName and renames the new -file to the old name. Returns {\tt TRUE} if both actions succeeded. If {\tt FALSE} is +file to the old name. Returns {\tt true} if both actions succeeded. If {\tt false} is returned it may unfortunately mean two quite different things: either that either the old file couldn't be deleted or that the new file couldn't be renamed to the old name. diff --git a/docs/latex/wx/tevent.tex b/docs/latex/wx/tevent.tex index f58d767d67..f05fbeb52f 100644 --- a/docs/latex/wx/tevent.tex +++ b/docs/latex/wx/tevent.tex @@ -122,14 +122,14 @@ The normal order of event table searching by ProcessEvent is as follows: \item If the object is disabled (via a call to \helpref{wxEvtHandler::SetEvtHandlerEnabled}{wxevthandlersetevthandlerenabled}) the function skips to step (6). \item If the object is a wxWindow, {\bf ProcessEvent} is recursively called on the window's\rtfsp -\helpref{wxValidator}{wxvalidator}. If this returns TRUE, the function exits. +\helpref{wxValidator}{wxvalidator}. If this returns true, the function exits. \item {\bf SearchEventTable} is called for this event handler. If this fails, the base class table is tried, and so on until no more tables exist or an appropriate function was found, in which case the function exits. \item The search is applied down the entire chain of event handlers (usually the chain has a length of one). If this succeeds, the function exits. \item If the object is a wxWindow and the event is a wxCommandEvent, {\bf ProcessEvent} is -recursively applied to the parent window's event handler. If this returns TRUE, the function exits. +recursively applied to the parent window's event handler. If this returns true, the function exits. \item Finally, {\bf ProcessEvent} is called on the wxApp object. \end{enumerate} diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index 899204f454..1c07c84c17 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -48,25 +48,25 @@ Return the text colour specified by this attribute. \constfunc{bool}{HasBackgroundColour}{\void} -Returns {\tt TRUE} if this style specifies the background colour to use. +Returns {\tt true} if this style specifies the background colour to use. \membersection{wxTextAttr::HasFont} \constfunc{bool}{HasFont}{\void} -Returns {\tt TRUE} if this style specifies the font to use. +Returns {\tt true} if this style specifies the font to use. \membersection{wxTextAttr::HasTextColour} \constfunc{bool}{HasTextColour}{\void} -Returns {\tt TRUE} if this style specifies the foreground colour to use. +Returns {\tt true} if this style specifies the foreground colour to use. \membersection{wxTextAttr::IsDefault} \constfunc{bool}{IsDefault}{\void} -Returns {\tt TRUE} if this style specifies any non-default attributes. +Returns {\tt true} if this style specifies any non-default attributes. %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -358,34 +358,34 @@ the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoin \func{virtual bool}{CanCopy}{\void} -Returns {\tt TRUE} if the selection can be copied to the clipboard. +Returns {\tt true} if the selection can be copied to the clipboard. \membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut} \func{virtual bool}{CanCut}{\void} -Returns {\tt TRUE} if the selection can be cut to the clipboard. +Returns {\tt true} if the selection can be cut to the clipboard. \membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste} \func{virtual bool}{CanPaste}{\void} -Returns {\tt TRUE} if the contents of the clipboard can be pasted into the +Returns {\tt true} if the contents of the clipboard can be pasted into the text control. On some platforms (Motif, GTK) this is an approximation -and returns {\tt TRUE} if the control is editable, {\tt FALSE} otherwise. +and returns {\tt true} if the control is editable, {\tt false} otherwise. \membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo} \func{virtual bool}{CanRedo}{\void} -Returns {\tt TRUE} if there is a redo facility available and the last operation +Returns {\tt true} if there is a redo facility available and the last operation can be redone. \membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo} \func{virtual bool}{CanUndo}{\void} -Returns {\tt TRUE} if there is an undo facility available and the last operation +Returns {\tt true} if there is an undo facility available and the last operation can be undone. \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear} @@ -439,7 +439,7 @@ under any platform but MSW. \wxheading{Return value} -{\tt TRUE} if the event resulted in a change to the control, {\tt FALSE} +{\tt true} if the event resulted in a change to the control, {\tt false} otherwise. \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle} @@ -589,7 +589,7 @@ sequence in the native control. \constfunc{bool}{IsEditable}{\void} -Returns {\tt TRUE} if the controls contents may be edited by user (note that it +Returns {\tt true} if the controls contents may be edited by user (note that it always can be changed by the program), i.e. if the control hasn't been put in read-only mode by a previous call to \helpref{SetEditable}{wxtextctrlseteditable}. @@ -598,14 +598,14 @@ read-only mode by a previous call to \constfunc{bool}{IsModified}{\void} -Returns {\tt TRUE} if the text has been modified by user. Note that calling +Returns {\tt true} if the text has been modified by user. Note that calling \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified. \membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline} \constfunc{bool}{IsMultiLine}{\void} -Returns {\tt TRUE} if this is a multi line edit control and {\tt FALSE} +Returns {\tt true} if this is a multi line edit control and {\tt false} otherwise. \wxheading{See also} @@ -616,7 +616,7 @@ otherwise. \constfunc{bool}{IsSingleLine}{\void} -Returns {\tt TRUE} if this is a single line edit control and {\tt FALSE} +Returns {\tt true} if this is a single line edit control and {\tt false} otherwise. \wxheading{See also} @@ -635,7 +635,7 @@ Loads and displays the named file, if it exists. \wxheading{Return value} -{\tt TRUE} if successful, {\tt FALSE} otherwise. +{\tt true} if successful, {\tt false} otherwise. % VZ: commenting this out as: (a) the docs are wrong (you can't replace % anything), (b) wxTextCtrl doesn't have any OnChar() anyhow @@ -708,7 +708,7 @@ Converts given position to a zero-based column, line number pair. \wxheading{Return value} -{\tt TRUE} on success, {\tt FALSE} on failure (most likely due to a too large position +{\tt true} on success, {\tt false} on failure (most likely due to a too large position parameter). \wxheading{See also} @@ -769,7 +769,7 @@ Saves the contents of the control in a text file. \wxheading{Return value} -{\tt TRUE} if the operation was successful, {\tt FALSE} otherwise. +{\tt true} if the operation was successful, {\tt false} otherwise. \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle} @@ -794,7 +794,7 @@ wouldn't change it at all). \wxheading{Return value} -{\tt TRUE} on success, {\tt FALSE} if an error occured - may also mean that +{\tt true} on success, {\tt false} if an error occured - may also mean that the styles are not supported under this platform. \wxheading{See also} @@ -809,7 +809,7 @@ Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} f \wxheading{Parameters} -\docparam{editable}{If {\tt TRUE}, the control is editable. If {\tt FALSE}, the control is read-only.} +\docparam{editable}{If {\tt true}, the control is editable. If {\tt false}, the control is read-only.} \wxheading{See also} @@ -888,7 +888,7 @@ background colour is not set in {\it style}, the values of\rtfsp \wxheading{Return value} -{\tt TRUE} on success, {\tt FALSE} if an error occured - may also mean that +{\tt true} on success, {\tt false} if an error occured - may also mean that the styles are not supported under this platform. \membersection{wxTextCtrl::SetValue}\label{wxtextctrlsetvalue} @@ -896,7 +896,7 @@ the styles are not supported under this platform. \func{virtual void}{SetValue}{\param{const wxString\& }{ value}} Sets the text value and marks the control as not-modified (which means that -\helpref{IsModified}{wxtextctrlismodified} would return {\tt FALSE} immediately +\helpref{IsModified}{wxtextctrlismodified} would return {\tt false} immediately after the call to SetValue). Note that this function will generate a {\tt wxEVT\_COMMAND\_TEXT\_UPDATED} diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index 002e5dd41d..5e37c98308 100644 --- a/docs/latex/wx/textfile.tex +++ b/docs/latex/wx/textfile.tex @@ -119,14 +119,14 @@ be used in this case. \constfunc{bool}{Exists}{\void} -Return TRUE if file exists - the name of the file should have been specified +Return true if file exists - the name of the file should have been specified in the constructor before calling Exists(). \membersection{wxTextFile::IsOpened}\label{wxtextfileisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file is currently opened. +Returns true if the file is currently opened. \membersection{wxTextFile::GetLineCount}\label{wxtextfilegetlinecount} @@ -169,7 +169,7 @@ and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}/\helpref{GetNextLin \constfunc{bool}{Eof}{\void} -Returns TRUE if the current line is the last one. +Returns true if the current line is the last one. \membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol} @@ -291,5 +291,5 @@ The {\it conv} argument is only meaningful in Unicode build of wxWindows when it is used to convert all lines to multibyte representation before writing them them to physical file. -Returns TRUE if operation succeeded, FALSE if it failed. +Returns true if operation succeeded, false if it failed. diff --git a/docs/latex/wx/tfont.tex b/docs/latex/wx/tfont.tex index 82b219b3eb..4f4b1d9207 100644 --- a/docs/latex/wx/tfont.tex +++ b/docs/latex/wx/tfont.tex @@ -13,7 +13,7 @@ the following parameters (not all of them have to be specified, of course): {\bf wxMODERN} is a fixed pitch font; the others are either fixed or variable pitch.} \twocolitem{Style}{The value can be {\bf wxNORMAL, wxSLANT} or {\bf wxITALIC}.} \twocolitem{Weight}{The value can be {\bf wxNORMAL, wxLIGHT} or {\bf wxBOLD}.} -\twocolitem{Underlining}{The value can be TRUE or FALSE.} +\twocolitem{Underlining}{The value can be true or false.} \twocolitem{Face name}{An optional string specifying the actual typeface to be used. If NULL, a default typeface will chosen based on the family.} \twocolitem{Encoding}{The font encoding (see {\bf wxFONTENCODING\_XXX} diff --git a/docs/latex/wx/tglbtn.tex b/docs/latex/wx/tglbtn.tex index 75184f5541..d5a719b3f7 100644 --- a/docs/latex/wx/tglbtn.tex +++ b/docs/latex/wx/tglbtn.tex @@ -109,7 +109,7 @@ Gets the state of the toggle button. \wxheading{Return value} -Returns {\tt TRUE} if it is pressed, {\tt FALSE} otherwise. +Returns {\tt true} if it is pressed, {\tt false} otherwise. \membersection{wxToggleButton::SetValue}\label{wxtogglebuttonsetvalue} @@ -120,5 +120,5 @@ Sets the toggle button to the given state. This does not cause a \wxheading{Parameters} -\docparam{state}{If {\tt TRUE}, the button is pressed.} +\docparam{state}{If {\tt true}, the button is pressed.} diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex index 33328eef99..b530b6fa54 100644 --- a/docs/latex/wx/thread.tex +++ b/docs/latex/wx/thread.tex @@ -193,31 +193,31 @@ The following priorities are defined: \constfunc{bool}{IsAlive}{\void} -Returns TRUE if the thread is alive (i.e. started and not terminating). +Returns true if the thread is alive (i.e. started and not terminating). \membersection{wxThread::IsDetached}\label{wxthreadisdetached} \constfunc{bool}{IsDetached}{\void} -Returns TRUE if the thread is of the detached kind, FALSE if it is a joinable one. +Returns true if the thread is of the detached kind, false if it is a joinable one. \membersection{wxThread::IsMain}\label{wxthreadismain} \func{static bool}{IsMain}{\void} -Returns TRUE if the calling thread is the main application thread. +Returns true if the calling thread is the main application thread. \membersection{wxThread::IsPaused}\label{wxthreadispaused} \constfunc{bool}{IsPaused}{\void} -Returns TRUE if the thread is paused. +Returns true if the thread is paused. \membersection{wxThread::IsRunning}\label{wxthreadisrunning} \constfunc{bool}{IsRunning}{\void} -Returns TRUE if the thread is running. +Returns true if the thread is running. \membersection{wxThread::Kill}\label{wxthreadkill} @@ -314,7 +314,7 @@ Sets the thread concurrency level for this process. This is, roughly, the number of threads that the system tries to schedule to run in parallel. The value of $0$ for {\it level} may be used to set the default one. -Returns TRUE on success or FALSE otherwise (for example, if this function is +Returns true on success or false otherwise (for example, if this function is not implemented for this platform - currently everything except Solaris). \membersection{wxThread::TestDestroy}\label{wxthreadtestdestroy} @@ -323,7 +323,7 @@ not implemented for this platform - currently everything except Solaris). This function should be called periodically by the thread to ensure that calls to \helpref{Pause}{wxthreadpause} and \helpref{Delete}{wxthreaddelete} will -work. If it returns TRUE, the thread should exit as soon as possible. +work. If it returns true, the thread should exit as soon as possible. \membersection{wxThread::This}\label{wxthreadthis} diff --git a/docs/latex/wx/time.tex b/docs/latex/wx/time.tex index 2df4c34397..eaa58d1fec 100644 --- a/docs/latex/wx/time.tex +++ b/docs/latex/wx/time.tex @@ -45,11 +45,11 @@ Initialize the object using the number of seconds that have elapsed since ???. Copy constructor. -\func{}{wxTime}{\param{hourTy }{h}, \param{minuteTy }{m}, \param{secondTy }{s = 0}, \param{bool }{dst = FALSE}} +\func{}{wxTime}{\param{hourTy }{h}, \param{minuteTy }{m}, \param{secondTy }{s = 0}, \param{bool }{dst = false}} Initialize using hours, minutes, seconds, and whether DST time. -\func{}{wxTime}{\param{const wxDate\&}{ date}, \param{hourTy }{h = 0}, \param{minuteTy }{m = 0}, \param{secondTy }{s = 0}, \param{bool }{dst = FALSE}} +\func{}{wxTime}{\param{const wxDate\&}{ date}, \param{hourTy }{h = 0}, \param{minuteTy }{m = 0}, \param{secondTy }{s = 0}, \param{bool }{dst = false}} Initialize using a \helpref{wxDate}{wxdate} object, hours, minutes, seconds, and whether DST time. @@ -129,7 +129,7 @@ Formats the time according to the current formatting options: see \helpref{wxTim \constfunc{bool}{IsBetween}{\param{const wxTime\& }{a}, \param{const wxTime\& }{b}} -Returns TRUE if this time is between the two given times. +Returns true if this time is between the two given times. \membersection{wxTime::Max}\label{wxtimemax} diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex index 262e8332fc..98c0f22c4a 100644 --- a/docs/latex/wx/timer.tex +++ b/docs/latex/wx/timer.tex @@ -65,14 +65,14 @@ Returns the current interval for the timer (in milliseconds). \constfunc{bool}{IsOneShot}{\void} -Returns {\tt TRUE} if the timer is one shot, i.e.\ if it will stop after firing the +Returns {\tt true} if the timer is one shot, i.e.\ if it will stop after firing the first notification automatically. \membersection{wxTimer::IsRunning}\label{wxtimerisrunning} \constfunc{bool}{IsRunning}{\void} -Returns {\tt TRUE} if the timer is running, {\tt FALSE} if it is stopped. +Returns {\tt true} if the timer is running, {\tt false} if it is stopped. \membersection{wxTimer::Notify}\label{wxtimernotify} @@ -93,14 +93,14 @@ id equal to {\it id}\/ specified here. \membersection{wxTimer::Start}\label{wxtimerstart} -\func{bool}{Start}{\param{int}{milliseconds = -1}, \param{bool }{oneShot = {\tt FALSE}}} +\func{bool}{Start}{\param{int}{milliseconds = -1}, \param{bool }{oneShot = {\tt false}}} (Re)starts the timer. If {\it milliseconds}\/ parameter is -1 (value by default), -the previous value is used. Returns {\tt FALSE} if the timer could not be started, -{\tt TRUE} otherwise (in MS Windows timers are a limited resource). +the previous value is used. Returns {\tt false} if the timer could not be started, +{\tt true} otherwise (in MS Windows timers are a limited resource). -If {\it oneShot}\/ is {\tt FALSE} (the default), the \helpref{Notify}{wxtimernotify} -function will be called repeatedly until the timer is stopped. If {\tt TRUE}, +If {\it oneShot}\/ is {\tt false} (the default), the \helpref{Notify}{wxtimernotify} +function will be called repeatedly until the timer is stopped. If {\tt true}, it will be called only once and the timer will stop automatically. To make your code more readable you may also use the following symbolic constants \twocolwidtha{5cm}% diff --git a/docs/latex/wx/timespan.tex b/docs/latex/wx/timespan.tex index a46b716600..aa0c8e8473 100644 --- a/docs/latex/wx/timespan.tex +++ b/docs/latex/wx/timespan.tex @@ -202,40 +202,40 @@ Returns the timespan for one hour. \constfunc{bool}{IsEqualTo}{\param{const wxTimeSpan\& }{ts}} -Returns {\tt TRUE} if two timespans are equal. +Returns {\tt true} if two timespans are equal. \membersection{wxTimeSpan::IsLongerThan}\label{wxtimespanislongerthan} \constfunc{bool}{IsLongerThan}{\param{const wxTimeSpan\& }{ts}} Compares two timespans: works with the absolute values, i.e. -2 -hours is longer than 1 hour. Also, it will return {\tt FALSE} if +hours is longer than 1 hour. Also, it will return {\tt false} if the timespans are equal in absolute value. \membersection{wxTimeSpan::IsNegative}\label{wxtimespanisnegative} \constfunc{bool}{IsNegative}{\void} -Returns {\tt TRUE} if the timespan is negative. +Returns {\tt true} if the timespan is negative. \membersection{wxTimeSpan::IsNull}\label{wxtimespanisnull} \constfunc{bool}{IsNull}{\void} -Returns {\tt TRUE} if the timespan is empty. +Returns {\tt true} if the timespan is empty. \membersection{wxTimeSpan::IsPositive}\label{wxtimespanispositive} \constfunc{bool}{IsPositive}{\void} -Returns {\tt TRUE} if the timespan is positive. +Returns {\tt true} if the timespan is positive. \membersection{wxTimeSpan::IsShorterThan}\label{wxtimespanisshorterthan} \constfunc{bool}{IsShorterThan}{\param{const wxTimeSpan\& }{ts}} Compares two timespans: works with the absolute values, i.e. 1 -hour is shorter than -2 hours. Also, it will return {\tt FALSE} if +hour is shorter than -2 hours. Also, it will return {\tt false} if the timespans are equal in absolute value. \membersection{wxTimeSpan::Minutes}\label{wxtimespanminutes} diff --git a/docs/latex/wx/tnoneng.tex b/docs/latex/wx/tnoneng.tex index 084c807e94..fd5d75fa06 100644 --- a/docs/latex/wx/tnoneng.tex +++ b/docs/latex/wx/tnoneng.tex @@ -98,7 +98,7 @@ if (!wxFontMapper::Get()->IsEncodingAvailable(enc, facename)) { wxFontEncoding alternative; if (wxTheFontMapper->GetAltForEncoding(enc, &alternative, - facename, FALSE)) + facename, false)) { wxEncodingConverted encconv; if (!encconv.Init(enc, alternative)) diff --git a/docs/latex/wx/tokenizr.tex b/docs/latex/wx/tokenizr.tex index 0b8490ce1d..c9e0c44732 100644 --- a/docs/latex/wx/tokenizr.tex +++ b/docs/latex/wx/tokenizr.tex @@ -10,7 +10,7 @@ string to tokenize and also the delimiters which separate tokens in the string Then \helpref{GetNextToken}{wxstringtokenizergetnexttoken} may be called repeatedly until it \helpref{HasMoreTokens}{wxstringtokenizerhasmoretokens} -returns FALSE. +returns false. For example: @@ -89,7 +89,7 @@ Returns the number of tokens in the input string. \constfunc{bool}{HasMoreTokens}{\void} -Returns TRUE if the tokenizer has further tokens, FALSE if none are left. +Returns true if the tokenizer has further tokens, false if none are left. \membersection{wxStringTokenizer::GetNextToken}\label{wxstringtokenizergetnexttoken} diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index 6b1ddc01d0..4326648f39 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -282,7 +282,7 @@ back later), you may use \helpref{RemoveTool}{wxtoolbarremovetool} instead. Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the change to take place, it will happen immediately. -Returns TRUE if the tool was deleted, FALSE otherwise. +Returns true if the tool was deleted, false otherwise. \wxheading{See also} @@ -305,7 +305,7 @@ Enables or disables the tool. \docparam{toolId}{Tool to enable or disable.} -\docparam{enable}{If TRUE, enables the tool, otherwise disables it.} +\docparam{enable}{If true, enables the tool, otherwise disables it.} {\bf NB:} This function should only be called after \helpref{Realize}{wxtoolbarrealize}. @@ -411,7 +411,7 @@ Called to determine whether a tool is enabled (responds to user input). \wxheading{Return value} -TRUE if the tool is enabled, FALSE otherwise. +true if the tool is enabled, false otherwise. \wxheading{See also} @@ -479,7 +479,7 @@ Gets the on/off state of a toggle tool. \wxheading{Return value} -TRUE if the tool is toggled on, FALSE otherwise. +true if the tool is toggled on, false otherwise. \wxheading{See also} @@ -515,7 +515,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place. \func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp \param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp -\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp +\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = false},\rtfsp \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} Inserts the tool with the specified attributes into the toolbar at the given @@ -542,11 +542,11 @@ you should use the EVT\_MENU or EVT\_TOOL macro instead. \docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.} -\docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.} +\docparam{toggleDown}{true if the tool is a toggle and the toggle is down, otherwise is false.} \wxheading{Return value} -If the tool is a toggle and this function returns FALSE, the toggle +If the tool is a toggle and this function returns false, the toggle toggle state (internal and visual) will not be changed. This provides a way of specifying that toggle operations are not permitted in some circumstances. @@ -765,7 +765,7 @@ Toggles a tool on or off. This does not cause any event to get emitted. \docparam{toolId}{Tool in question.} -\docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.} +\docparam{toggle}{If true, toggles the tool on, otherwise toggles it off.} \wxheading{Remarks} diff --git a/docs/latex/wx/tprint.tex b/docs/latex/wx/tprint.tex index e6f672c936..463f8d3689 100644 --- a/docs/latex/wx/tprint.tex +++ b/docs/latex/wx/tprint.tex @@ -38,7 +38,7 @@ please look at the printout sample code. { wxPrinter printer; MyPrintout printout("My printout"); - printer.Print(this, &printout, TRUE); + printer.Print(this, &printout, true); break; } case WXPRINT_PREVIEW: @@ -48,14 +48,14 @@ please look at the printout sample code. wxPreviewFrame *frame = new wxPreviewFrame(preview, this, "Demo Print Preview", 100, 100, 600, 650); frame->Centre(wxBOTH); frame->Initialize(); - frame->Show(TRUE); + frame->Show(true); break; } case WXPRINT_PRINT_SETUP: { wxPrintDialog printerDialog(this); - printerDialog.GetPrintData().SetSetupDialog(TRUE); - printerDialog.Show(TRUE); + printerDialog.GetPrintData().SetSetupDialog(true); + printerDialog.Show(true); break; } \end{verbatim} diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index 4b69c939ba..9d102d9419 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -274,7 +274,7 @@ will be sent which can be vetoed as well. \func{void}{EndEditLabel}{\param{bool }{cancelEdit}} -Ends label editing. If {\it cancelEdit} is {\tt TRUE}, the edit will be cancelled. +Ends label editing. If {\it cancelEdit} is {\tt true}, the edit will be cancelled. This function is currently supported under Windows only. @@ -296,13 +296,13 @@ Expands the given item. \membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect} -\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = {\tt FALSE}}} +\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = {\tt false}}} -Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is {\tt TRUE}, +Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is {\tt true}, only the rectangle around the item's label will be returned, otherwise the item's image is also taken into account. -The return value is {\tt TRUE} if the rectangle was successfully retrieved or {\tt FALSE} +The return value is {\tt true} if the rectangle was successfully retrieved or {\tt false} if it was not (in this case {\it rect} is not changed) - for example, if the item is currently invisible. @@ -323,9 +323,9 @@ This function is only available in the generic version. \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount} -\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt TRUE}}} +\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}} -Returns the number of items in the branch. If {\it recursively} is {\tt TRUE}, returns the total number +Returns the number of items in the branch. If {\it recursively} is {\tt true}, returns the total number of descendants, otherwise only one level of children is counted. \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount} @@ -639,7 +639,7 @@ both selected and unselected items. \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}} -Returns {\tt TRUE} if the given item is in bold state. +Returns {\tt true} if the given item is in bold state. See also: \helpref{SetItemBold}{wxtreectrlsetitembold} @@ -647,25 +647,25 @@ See also: \helpref{SetItemBold}{wxtreectrlsetitembold} \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}} -Returns {\tt TRUE} if the item is expanded (only makes sense if it has children). +Returns {\tt true} if the item is expanded (only makes sense if it has children). \membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected} \constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}} -Returns {\tt TRUE} if the item is selected. +Returns {\tt true} if the item is selected. \membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible} \constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}} -Returns {\tt TRUE} if the item is visible (it might be outside the view, or not expanded). +Returns {\tt true} if the item is visible (it might be outside the view, or not expanded). \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren} \constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}} -Returns {\tt TRUE} if the item has children. +Returns {\tt true} if the item has children. \membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems} @@ -745,9 +745,9 @@ Sets the colour of the item's background. \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold} -\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt TRUE}}} +\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt true}}} -Makes item appear in bold font if {\it bold} parameter is {\tt TRUE} or resets it to +Makes item appear in bold font if {\it bold} parameter is {\tt true} or resets it to the normal state. See also: \helpref{IsBold}{wxtreectrlisbold} @@ -788,7 +788,7 @@ although font attributes may vary. \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren} -\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = {\tt TRUE}}} +\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = {\tt true}}} Force appearance of the button next to the item. This is useful to allow the user to expand the items which don't have any children now, diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex index 98980ad290..d696179a29 100644 --- a/docs/latex/wx/treeevt.tex +++ b/docs/latex/wx/treeevt.tex @@ -95,6 +95,6 @@ Returns the position of the mouse pointer if the event is a drag event. \constfunc{bool}{IsEditCancelled}{} -Returns TRUE if the label edit was cancelled. This should be +Returns true if the label edit was cancelled. This should be called from within an EVT\_TREE\_END\_LABEL\_EDIT handler. diff --git a/docs/latex/wx/treelay.tex b/docs/latex/wx/treelay.tex index 0594f8c797..711d8b1adb 100644 --- a/docs/latex/wx/treelay.tex +++ b/docs/latex/wx/treelay.tex @@ -167,7 +167,7 @@ Gets the left margin set with \helpref{wxTreeLayout::SetMargins}{wxtreelayoutset \constfunc{bool}{GetOrientation}{\void} -Gets the orientation: TRUE means top-to-bottom, FALSE means left-to-right (the default). +Gets the orientation: true means top-to-bottom, false means left-to-right (the default). \membersection{wxTreeLayout::GetTopMargin} @@ -234,7 +234,7 @@ may be necessary for your application. \func{void}{SetOrientation}{\param{bool}{ orientation}} -Sets the tree orientation: TRUE means top-to-bottom, FALSE means left-to-right (the default). +Sets the tree orientation: true means top-to-bottom, false means left-to-right (the default). \membersection{wxTreeLayout::SetTopNode}\label{wxtreelayoutsettopnode} diff --git a/docs/latex/wx/tresourc.tex b/docs/latex/wx/tresourc.tex index 22b6c8933a..53ddab1ea9 100644 --- a/docs/latex/wx/tresourc.tex +++ b/docs/latex/wx/tresourc.tex @@ -152,7 +152,7 @@ bool AppClass::OnInit() wxResourceParseData(panel3); ... - return TRUE; + return true; } \end{verbatim} diff --git a/docs/latex/wx/tsizer.tex b/docs/latex/wx/tsizer.tex index 618c9f7b04..ba9483a394 100644 --- a/docs/latex/wx/tsizer.tex +++ b/docs/latex/wx/tsizer.tex @@ -286,7 +286,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 their sizer by assigning one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer} -and setting the auto-layout option to TRUE using +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 aware of: @@ -303,7 +303,7 @@ aware of: // Add controls to panel and panelsizer here... - panel->SetAutoLayout( TRUE ); + panel->SetAutoLayout( true ); panel->SetSizer( panelsizer ); \end{verbatim} diff --git a/docs/latex/wx/tsplittr.tex b/docs/latex/wx/tsplittr.tex index 2be27dee73..5e7a363960 100644 --- a/docs/latex/wx/tsplittr.tex +++ b/docs/latex/wx/tsplittr.tex @@ -22,7 +22,7 @@ subwindows and hiding one of them. rightWindow = new MyWindow(splitter); rightWindow->SetScrollbars(20, 20, 50, 50); - rightWindow->Show(FALSE); + rightWindow->Show(false); splitter->Initialize(leftWindow); @@ -39,8 +39,8 @@ The next fragment shows how the splitter window can be manipulated after creatio { if ( splitter->IsSplit() ) splitter->Unsplit(); - leftWindow->Show(TRUE); - rightWindow->Show(TRUE); + leftWindow->Show(true); + rightWindow->Show(true); splitter->SplitVertically( leftWindow, rightWindow ); } @@ -48,8 +48,8 @@ The next fragment shows how the splitter window can be manipulated after creatio { if ( splitter->IsSplit() ) splitter->Unsplit(); - leftWindow->Show(TRUE); - rightWindow->Show(TRUE); + leftWindow->Show(true); + rightWindow->Show(true); splitter->SplitHorizontally( leftWindow, rightWindow ); } diff --git a/docs/latex/wx/tstring.tex b/docs/latex/wx/tstring.tex index d69304d57e..dce111c7cb 100644 --- a/docs/latex/wx/tstring.tex +++ b/docs/latex/wx/tstring.tex @@ -140,7 +140,7 @@ to them will probably lead to program crash). Moreover, some very useful functions are not standard at all. This is why in addition to all wxString functions, there are also a few global string functions which try to correct these problems: \helpref{wxIsEmpty()}{wxisempty} verifies whether the string -is empty (returning {\tt TRUE} for {\tt NULL} pointers), +is empty (returning {\tt true} for {\tt NULL} pointers), \helpref{wxStrlen()}{wxstrlen} also handles NULLs correctly and returns 0 for them and \helpref{wxStricmp()}{wxstricmp} is just a platform-independent version of case-insensitive string comparison function known either as diff --git a/docs/latex/wx/ttab.tex b/docs/latex/wx/ttab.tex index 2e594f4470..b3b4112c82 100644 --- a/docs/latex/wx/ttab.tex +++ b/docs/latex/wx/ttab.tex @@ -112,7 +112,7 @@ void MyDialog::Init(void) // Calculate the tab width for 4 tabs, based on a view width of 326 and // the current horizontal spacing. Adjust the view width to exactly fit // the tabs. - view->CalculateTabWidth(4, TRUE); + view->CalculateTabWidth(4, true); if (!view->AddTab(TEST_TAB_CAT, wxString("Cat"))) return; diff --git a/docs/latex/wx/ttoolbar.tex b/docs/latex/wx/ttoolbar.tex index 9879a96323..069a8888ab 100644 --- a/docs/latex/wx/ttoolbar.tex +++ b/docs/latex/wx/ttoolbar.tex @@ -159,13 +159,13 @@ bool MyApp::OnInit(void) // function that lays out default decorations and the remaining content window. wxSizeEvent event(wxSize(-1, -1), frame->GetId()); frame->OnSize(event); - frame->Show(TRUE); + frame->Show(true); frame->SetStatusText("Hello, wxWindows"); SetTopWindow(frame); - return TRUE; + return true; } bool MyApp::InitToolbar(wxToolBar* toolBar) @@ -200,24 +200,24 @@ bool MyApp::InitToolbar(wxToolBar* toolBar) #endif int currentX = 5; - toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "New file"); + toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "New file"); currentX += width + 5; - toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Open file"); + toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Open file"); currentX += width + 5; - toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Save file"); + toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Save file"); currentX += width + 5; toolBar->AddSeparator(); - toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Copy"); + toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Copy"); currentX += width + 5; - toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Cut"); + toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Cut"); currentX += width + 5; - toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Paste"); + toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Paste"); currentX += width + 5; toolBar->AddSeparator(); - toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Print"); + toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Print"); currentX += width + 5; toolBar->AddSeparator(); - toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Help"); + toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, false, currentX, -1, (wxObject *) NULL, "Help"); toolBar->Realize(); @@ -226,7 +226,7 @@ bool MyApp::InitToolbar(wxToolBar* toolBar) for (i = 0; i < 8; i++) delete toolBarBitmaps[i]; - return TRUE; + return true; } // wxID_HELP will be processed for the 'About' menu and the toolbar help button. @@ -249,7 +249,7 @@ MyFrame::MyFrame(wxFrame* parent, wxWindowID id, const wxString& title, const wx void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) { - Close(TRUE); + Close(true); } void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event)) diff --git a/docs/latex/wx/tvalidat.tex b/docs/latex/wx/tvalidat.tex index 871797c76a..291ba56429 100644 --- a/docs/latex/wx/tvalidat.tex +++ b/docs/latex/wx/tvalidat.tex @@ -50,7 +50,7 @@ data for the control. If such a variable address is not supplied by the user, th the validator should store the data internally. The \helpref{wxValidator::Validate}{wxvalidatorvalidate} member function should return -TRUE if the data in the control (not the C++ variable) is valid. It should also show +true if the data in the control (not the C++ variable) is valid. It should also show an appropriate message if data was not valid. The \helpref{wxValidator::TransferToWindow}{wxvalidatortransfertowindow} member function should @@ -88,7 +88,7 @@ call \helpref{wxWindow::InitDialog}{wxwindowinitdialog} explicitly before showin window.} When the user clicks on a button, for example the OK button, the application should -first call \helpref{wxWindow::Validate}{wxwindowvalidate}, which returns FALSE if +first call \helpref{wxWindow::Validate}{wxwindowvalidate}, which returns false if any of the child window validators failed to validate the window data. The button handler should return immediately if validation failed. Secondly, the application should call \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow} and @@ -108,7 +108,7 @@ void wxDialog::OnOK(wxCommandEvent& event) else { SetReturnCode(wxID_OK); - this->Show(FALSE); + this->Show(false); } } } diff --git a/docs/latex/wx/txrc.tex b/docs/latex/wx/txrc.tex index 7cbcd7a532..c2aa4b4f7c 100644 --- a/docs/latex/wx/txrc.tex +++ b/docs/latex/wx/txrc.tex @@ -228,8 +228,8 @@ bool MyApp::OnInit() MyFrame *frame = new MyFrame("XML resources demo", wxPoint(50, 50), wxSize(450, 340)); - frame->Show(TRUE); - return TRUE; + frame->Show(true); + return true; } // ---------------------------------------------------------------------------- @@ -249,8 +249,8 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) // event handlers void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) { - // TRUE is to force the frame to close - Close(TRUE); + // true is to force the frame to close + Close(true); } void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event)) diff --git a/docs/latex/wx/txtdrptg.tex b/docs/latex/wx/txtdrptg.tex index 14157895fb..c0c19c53df 100644 --- a/docs/latex/wx/txtdrptg.tex +++ b/docs/latex/wx/txtdrptg.tex @@ -46,5 +46,5 @@ Override this function to receive dropped text. \wxheading{Return value} -Return TRUE to accept the data, FALSE to veto the operation. +Return true to accept the data, false to veto the operation. diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex index ef4cd1fbb1..a82b4af74c 100644 --- a/docs/latex/wx/upduievt.tex +++ b/docs/latex/wx/upduievt.tex @@ -62,31 +62,31 @@ Constructor. \member{bool}{m\_checked} -TRUE if the element should be checked, FALSE otherwise. +true if the element should be checked, false otherwise. \membersection{wxUpdateUIEvent::m\_enabled} \member{bool}{m\_checked} -TRUE if the element should be enabled, FALSE otherwise. +true if the element should be enabled, false otherwise. \membersection{wxUpdateUIEvent::m\_setChecked} \member{bool}{m\_setChecked} -TRUE if the application has set the {\bf m\_checked} member. +true if the application has set the {\bf m\_checked} member. \membersection{wxUpdateUIEvent::m\_setEnabled} \member{bool}{m\_setEnabled} -TRUE if the application has set the {\bf m\_enabled} member. +true if the application has set the {\bf m\_enabled} member. \membersection{wxUpdateUIEvent::m\_setText} \member{bool}{m\_setText} -TRUE if the application has set the {\bf m\_text} member. +true if the application has set the {\bf m\_text} member. \membersection{wxUpdateUIEvent::m\_text} @@ -111,31 +111,31 @@ Enable or disable the UI element. \constfunc{bool}{GetChecked}{\void} -Returns TRUE if the UI element should be checked. +Returns true if the UI element should be checked. \membersection{wxUpdateUIEvent::GetEnabled}\label{wxupdateuieventgetenabled} \constfunc{bool}{GetEnabled}{\void} -Returns TRUE if the UI element should be enabled. +Returns true if the UI element should be enabled. \membersection{wxUpdateUIEvent::GetSetChecked}\label{wxupdateuieventgetsetchecked} \constfunc{bool}{GetSetChecked}{\void} -Returns TRUE if the application has called {\bf SetChecked}. For wxWindows internal use only. +Returns true if the application has called {\bf SetChecked}. For wxWindows internal use only. \membersection{wxUpdateUIEvent::GetSetEnabled}\label{wxupdateuieventgetsetenabled} \constfunc{bool}{GetSetEnabled}{\void} -Returns TRUE if the application has called {\bf SetEnabled}. For wxWindows internal use only. +Returns true if the application has called {\bf SetEnabled}. For wxWindows internal use only. \membersection{wxUpdateUIEvent::GetSetText}\label{wxupdateuieventgetsettext} \constfunc{bool}{GetSetText}{\void} -Returns TRUE if the application has called {\bf SetText}. For wxWindows internal use only. +Returns true if the application has called {\bf SetText}. For wxWindows internal use only. \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext} diff --git a/docs/latex/wx/validatr.tex b/docs/latex/wx/validatr.tex index 765c4d2084..0a725ccc74 100644 --- a/docs/latex/wx/validatr.tex +++ b/docs/latex/wx/validatr.tex @@ -72,7 +72,7 @@ Returns the window associated with the validator. \membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror} -\func{void}{SetBellOnError}{\param{bool}{ doIt = TRUE}} +\func{void}{SetBellOnError}{\param{bool}{ doIt = true}} This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed. @@ -88,19 +88,19 @@ Associates a window with the validator. \func{virtual bool}{TransferToWindow}{} This overridable function is called when the value in the window must be -transferred to the validator. Return FALSE if there is a problem. +transferred to the validator. Return false if there is a problem. \membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow} \func{virtual bool}{TransferToWindow}{} This overridable function is called when the value associated with the validator must be -transferred to the window. Return FALSE if there is a problem. +transferred to the window. Return false if there is a problem. \membersection{wxValidator::Validate}\label{wxvalidatorvalidate} \func{virtual bool}{Validate}{\param{wxWindow*}{ parent}} This overridable function is called when the value in the associated window must be validated. -Return FALSE if the value in the window is not valid; you may pop up an error dialog. +Return false if the value in the window is not valid; you may pop up an error dialog. diff --git a/docs/latex/wx/valtext.tex b/docs/latex/wx/valtext.tex index 87ca0bb22b..0928570119 100644 --- a/docs/latex/wx/valtext.tex +++ b/docs/latex/wx/valtext.tex @@ -55,7 +55,7 @@ checks if each input character is in the list (one character per list element), \docparam{valPtr}{A pointer to a wxString variable that contains the value. This variable should have a lifetime equal to or longer than the validator lifetime (which is usually -determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT TRUE +determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT true } \membersection{wxTextValidator::\destruct{wxTextValidator}} diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex index f09ee5898c..8fe9b75c6e 100644 --- a/docs/latex/wx/variant.tex +++ b/docs/latex/wx/variant.tex @@ -206,13 +206,13 @@ Inserts a value at the front of the list. \constfunc{bool}{IsNull}{\void} -Returns TRUE if there is no data associated with this variant, FALSE if there is data. +Returns true if there is no data associated with this variant, false if there is data. \membersection{wxVariant::IsType}\label{wxvariantistype} \constfunc{bool}{IsType}{\param{const wxString\&}{ type}} -Returns TRUE if {\it type} matches the type of the variant, FALSE otherwise. +Returns true if {\it type} matches the type of the variant, false otherwise. \membersection{wxVariant::MakeNull}\label{wxvariantmakenull} @@ -230,7 +230,7 @@ Makes a string representation of the variant value (for any type). \constfunc{bool}{Member}{\param{const wxVariant\&}{ value}} -Returns TRUE if {\it value} matches an element in the list. +Returns true if {\it value} matches an element in the list. \membersection{wxVariant::NullList}\label{wxvariantnulllist} @@ -417,7 +417,7 @@ Copy the data from `this' object to {\it data}. \constfunc{bool}{Eq}{\param{wxVariantData\&}{ data}} -Returns TRUE if this object is equal to {\it data}. +Returns true if this object is equal to {\it data}. \membersection{wxVariantData::GetType}\label{wxvariantdatagettype} diff --git a/docs/latex/wx/view.tex b/docs/latex/wx/view.tex index 82d2a1c357..b7810be68f 100644 --- a/docs/latex/wx/view.tex +++ b/docs/latex/wx/view.tex @@ -70,9 +70,9 @@ This function calls wxView::OnActivateView. \membersection{wxView::Close} -\func{virtual bool}{Close}{\param{bool}{ deleteWindow = TRUE}} +\func{virtual bool}{Close}{\param{bool}{ deleteWindow = true}} -Closes the view by calling OnClose. If {\it deleteWindow} is TRUE, this function should +Closes the view by calling OnClose. If {\it deleteWindow} is true, this function should delete the window associated with the view. \membersection{wxView::GetDocument} @@ -126,7 +126,7 @@ to close the associated document. Does not delete the view. The application may wish to do some cleaning up operations in this function, {\it if} a call to wxDocument::Close succeeded. For example, if your application's all share the same window, you need to disassociate the window from the view -and perhaps clear the window. If {\it deleteWindow} is TRUE, delete the +and perhaps clear the window. If {\it deleteWindow} is true, delete the frame associated with the view. \membersection{wxView::OnClosingDocument}\label{wxviewonclosingdocument} @@ -146,7 +146,7 @@ wxView::OnCreate. In its OnCreate member function, the wxView can create a wxDoc or a derived class. This wxDocChildFrame provides user interface elements to view and/or edit the contents of the wxDocument. -By default, simply returns TRUE. If the function returns FALSE, the +By default, simply returns true. If the function returns false, the view will be deleted. \membersection{wxView::OnCreatePrintout} diff --git a/docs/latex/wx/wave.tex b/docs/latex/wx/wave.tex index fc8d5fb553..13921b05be 100644 --- a/docs/latex/wx/wave.tex +++ b/docs/latex/wx/wave.tex @@ -20,7 +20,7 @@ on Windows and GTK (Linux) only. Default constructor. -\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}} +\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}} Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to determine whether this succeeded. @@ -29,7 +29,7 @@ determine whether this succeeded. \docparam{fileName}{The filename or Windows resource.} -\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.} +\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.} \membersection{wxWave::\destruct{wxWave}} @@ -39,7 +39,7 @@ Destroys the wxWave object. \membersection{wxWave::Create}\label{wxwavecreate} -\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}} +\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}} Constructs a wave object from a file or resource. @@ -47,21 +47,21 @@ Constructs a wave object from a file or resource. \docparam{fileName}{The filename or Windows resource.} -\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.} +\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.} \wxheading{Return value} -TRUE if the call was successful, FALSE otherwise. +true if the call was successful, false otherwise. \membersection{wxWave::IsOk}\label{wxwaveisok} \constfunc{bool}{IsOk}{\void} -Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise. +Returns true if the object contains a successfully loaded file or resource, false otherwise. \membersection{wxWave::Play}\label{wxwaveplay} -\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}} +\constfunc{bool}{Play}{\param{bool}{ async = true}, \param{bool}{ looped = false}} Plays the wave file synchronously or asynchronously, looped or single-shot. diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 76f11e0a47..f1e8ad3fce 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -254,7 +254,7 @@ implements the following methods:\par \membersection{wxWindow::Close}\label{wxwindowclose} -\func{bool}{Close}{\param{bool}{ force = {\tt FALSE}}} +\func{bool}{Close}{\param{bool}{ force = {\tt false}}} This function simply generates a \helpref{wxCloseEvent}{wxcloseevent} whose handler usually tries to close the window. It doesn't close the window itself, @@ -262,8 +262,8 @@ however. \wxheading{Parameters} -\docparam{force}{{\tt FALSE} if the window's close handler should be able to veto the destruction -of this window, {\tt TRUE} if it cannot.} +\docparam{force}{{\tt false} if the window's close handler should be able to veto the destruction +of this window, {\tt true} if it cannot.} \wxheading{Remarks} @@ -385,7 +385,7 @@ windows. \wxheading{Return value} -{\tt TRUE} if the window has either been successfully deleted, or it has been added +{\tt true} if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. \membersection{wxWindow::DestroyChildren} @@ -398,11 +398,11 @@ Destroys all children of a window. Called automatically by the destructor. \func{void}{Disable}{\void} -Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}. +Disables the window, same as \helpref{Enable({\tt false})}{wxwindowenable}. \wxheading{Return value} -Returns {\tt TRUE} if the window has been disabled, {\tt FALSE} if it had been +Returns {\tt true} if the window has been disabled, {\tt false} if it had been already disabled before the call to this function. \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} @@ -413,7 +413,7 @@ Enables or disables eligibility for drop file events (OnDropFiles). \wxheading{Parameters} -\docparam{accept}{If {\tt TRUE}, the window is eligible for drop file events. If {\tt FALSE}, the window +\docparam{accept}{If {\tt true}, the window is eligible for drop file events. If {\tt false}, the window will not accept drop file events.} \wxheading{Remarks} @@ -422,7 +422,7 @@ Windows only. \membersection{wxWindow::Enable}\label{wxwindowenable} -\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}} +\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}} Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again @@ -430,11 +430,11 @@ when the parent is. \wxheading{Parameters} -\docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.} +\docparam{enable}{If {\tt true}, enables the window for input. If {\tt false}, disables the window.} \wxheading{Return value} -Returns {\tt TRUE} if the window has been enabled or disabled, {\tt FALSE} if +Returns {\tt true} if the window has been enabled or disabled, {\tt false} if nothing was done, i.e. if the window had already been in the specified state. \wxheading{See also} @@ -922,7 +922,7 @@ Return the sizer associated with the window by a previous call to \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y}, \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL}, - \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt FALSE}}} + \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt false}}} Gets the dimensions of the string as it would be drawn on the window with the currently selected font. @@ -941,7 +941,7 @@ window with the currently selected font. \docparam{font}{Font to use instead of the current window font (optional).} -\docparam{use16}{If {\tt TRUE}, {\it string} contains 16-bit characters. The default is {\tt FALSE}.} +\docparam{use16}{If {\tt true}, {\it string} contains 16-bit characters. The default is {\tt false}.} \pythonnote{In place of a single overloaded method name, wxPython @@ -1013,7 +1013,7 @@ method. {\bf GetWindowStyle()} is another name for the same function. \constfunc{virtual bool}{HasCapture}{\void} -Returns TRUE if this window has the current mouse capture. +Returns true if this window has the current mouse capture. \wxheading{See also} @@ -1025,7 +1025,7 @@ Returns TRUE if this window has the current mouse capture. \func{bool}{Hide}{\void} -Equivalent to calling \helpref{Show}{wxwindowshow}({\tt FALSE}). +Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}). \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog} @@ -1038,7 +1038,7 @@ to the dialog via validators. \constfunc{virtual bool}{IsEnabled}{\void} -Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise. +Returns {\tt true} if the window is enabled for input, {\tt false} otherwise. \wxheading{See also} @@ -1054,7 +1054,7 @@ Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise. \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}} -Returns {\tt TRUE} if the given point or rectangle area has been exposed since the +Returns {\tt true} if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. @@ -1070,7 +1070,7 @@ implements the following methods:\par \constfunc{virtual bool}{IsRetained}{\void} -Returns {\tt TRUE} if the window is retained, {\tt FALSE} otherwise. +Returns {\tt true} if the window is retained, {\tt false} otherwise. \wxheading{Remarks} @@ -1080,13 +1080,13 @@ Retained windows are only available on X platforms. \constfunc{virtual bool}{IsShown}{\void} -Returns {\tt TRUE} if the window is shown, {\tt FALSE} if it has been hidden. +Returns {\tt true} if the window is shown, {\tt false} if it has been hidden. \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel} \constfunc{bool}{IsTopLevel}{\void} -Returns {\tt TRUE} if the given window is a top-level one. Currently all frames and +Returns {\tt true} if the given window is a top-level one. Currently all frames and dialogs are considered to be top-level windows (even if they have a parent window). @@ -1118,7 +1118,7 @@ default resource table will be used.} \wxheading{Return value} -{\tt TRUE} if the operation succeeded, otherwise {\tt FALSE}. +{\tt true} if the operation succeeded, otherwise {\tt false}. \membersection{wxWindow::Lower}\label{wxwindowlower} @@ -1137,8 +1137,8 @@ is not implemented anywhere). \wxheading{Parameters} -\docparam{flag}{If {\tt TRUE}, this call disables all other windows in the application so that -the user can only interact with this window. If {\tt FALSE}, the effect is reversed.} +\docparam{flag}{If {\tt true}, this call disables all other windows in the application so that +the user can only interact with this window. If {\tt false}, the effect is reversed.} \membersection{wxWindow::Move}\label{wxwindowmove} @@ -1194,8 +1194,8 @@ implements the following methods:\par %% %% \wxheading{Remarks} %% -%% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt TRUE}, -%% otherwise it returns {\tt FALSE} (it is being deactivated). +%% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt true}, +%% otherwise it returns {\tt false} (it is being deactivated). %% %% \wxheading{See also} %% @@ -1310,7 +1310,7 @@ implements the following methods:\par %% %% \wxheading{Return value} %% -%% If {\tt TRUE} is returned by OnClose, the window will be deleted by the system, otherwise the +%% If {\tt true} is returned by OnClose, the window will be deleted by the system, otherwise the %% attempt will be ignored. Do not delete the window from within this handler, although %% you may delete other windows. %% @@ -1672,14 +1672,14 @@ implements the following methods:\par \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler} -\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt FALSE}}} +\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt false}}} Removes and returns the top-most event handler on the event handler stack. \wxheading{Parameters} -\docparam{deleteHandler}{If this is {\tt TRUE}, the handler will be deleted after it is removed. The -default value is {\tt FALSE}.} +\docparam{deleteHandler}{If this is {\tt true}, the handler will be deleted after it is removed. The +default value is {\tt false}.} \wxheading{See also} @@ -1768,7 +1768,7 @@ or frame). \membersection{wxWindow::Refresh}\label{wxwindowrefresh} -\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt TRUE}}, \param{const wxRect* }{rect +\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}} Causes a message or event to be generated to repaint the @@ -1776,7 +1776,7 @@ window. \wxheading{Parameters} -\docparam{eraseBackground}{If {\tt TRUE}, the background will be +\docparam{eraseBackground}{If {\tt true}, the background will be erased.} \docparam{rect}{If non-NULL, only the given rectangle will @@ -1833,7 +1833,7 @@ must be present in this windows event handlers chain} \wxheading{Return value} -Returns {\tt TRUE} if it was found and {\tt FALSE} otherwise (this also results +Returns {\tt true} if it was found and {\tt false} otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there). @@ -1887,7 +1887,7 @@ positive) or up. \wxheading{Return value} -Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already +Returns {\tt true} if the window was scrolled, {\tt false} if it was already on top/bottom and nothing was done. \wxheading{Remarks} @@ -1909,7 +1909,7 @@ positive) or up. \wxheading{Return value} -Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already +Returns {\tt true} if the window was scrolled, {\tt false} if it was already on top/bottom and nothing was done. \wxheading{Remarks} @@ -1962,7 +1962,7 @@ size changes. \wxheading{Parameters} -\docparam{autoLayout}{Set this to {\tt TRUE} if you wish the Layout function to be called +\docparam{autoLayout}{Set this to {\tt true} if you wish the Layout function to be called from within wxWindow::OnSize functions.} \wxheading{See also} @@ -2272,7 +2272,7 @@ Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead. \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp \param{int }{thumbSize}, \param{int }{range},\rtfsp -\param{bool }{refresh = {\tt TRUE}}} +\param{bool }{refresh = {\tt true}}} Sets the scrollbar properties of a built-in scrollbar. @@ -2286,7 +2286,7 @@ Sets the scrollbar properties of a built-in scrollbar. \docparam{range}{The maximum position of the scrollbar.} -\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.} +\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.} \wxheading{Remarks} @@ -2321,7 +2321,7 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \begin{comment} \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage} -\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt TRUE}}} +\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt true}}} Sets the page size of one of the built-in scrollbars. @@ -2331,7 +2331,7 @@ Sets the page size of one of the built-in scrollbars. \docparam{pageSize}{Page size in scroll units.} -\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.} +\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.} \wxheading{Remarks} @@ -2359,7 +2359,7 @@ handling of pages and ranges. \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos} -\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt TRUE}}} +\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt true}}} Sets the position of one of the built-in scrollbars. @@ -2369,7 +2369,7 @@ Sets the position of one of the built-in scrollbars. \docparam{pos}{Position in scroll units.} -\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.} +\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.} \wxheading{Remarks} @@ -2386,7 +2386,7 @@ application to take note of scrollbar attributes and redraw contents accordingly \begin{comment} \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange} -\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt TRUE}}} +\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt true}}} Sets the range of one of the built-in scrollbars. @@ -2396,7 +2396,7 @@ Sets the range of one of the built-in scrollbars. \docparam{range}{Scroll range.} -\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.} +\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.} \wxheading{Remarks} @@ -2515,24 +2515,24 @@ The resizing increments are only significant under Motif or Xt. \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer} -\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}} +\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}} Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout constraints object is already owned by the -window, it will be deleted if the deleteOld parameter is TRUE. +window, it will be deleted if the deleteOld parameter is true. Note that this function will also call -\helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt TRUE} -parameter if the {\it sizer}\/ is non-NULL and {\tt FALSE} otherwise. +\helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt true} +parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise. \wxheading{Parameters} \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.} -\docparam{deleteOld}{If TRUE (the default), this will delete any prexisting sizer. -Pass FALSE if you wish to handle deleting the old sizer yourself.} +\docparam{deleteOld}{If true (the default), this will delete any prexisting sizer. +Pass false if you wish to handle deleting the old sizer yourself.} \wxheading{Remarks} @@ -2546,7 +2546,7 @@ only the sizer will have effect. \membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit} -\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}} +\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}} The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints for the window based on the sizer's minimum size. @@ -2576,7 +2576,7 @@ obviously needs to support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme. -Dialogs, notebook pages and the status bar have this flag set to TRUE +Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best. \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator} @@ -2659,7 +2659,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags. \membersection{wxWindow::Show}\label{wxwindowshow} -\func{virtual bool}{Show}{\param{bool}{ show = {\tt TRUE}}} +\func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}} Shows or hides the window. You may need to call \helpref{Raise}{wxwindowraise} for a top level window if you want to bring it to top, although this is not @@ -2667,11 +2667,11 @@ needed if Show() is called immediately after the frame creation. \wxheading{Parameters} -\docparam{show}{If {\tt TRUE} displays the window. Otherwise, hides it.} +\docparam{show}{If {\tt true} displays the window. Otherwise, hides it.} \wxheading{Return value} -{\tt TRUE} if the window has been shown or hidden or {\tt FALSE} if nothing was +{\tt true} if the window has been shown or hidden or {\tt false} if nothing was done because it already was in the requested state. \wxheading{See also} @@ -2690,7 +2690,7 @@ Reenables window updating after a previous call to \func{virtual bool}{TransferDataFromWindow}{\void} Transfers values from child controls to data areas specified by their validators. Returns -{\tt FALSE} if a transfer failed. +{\tt false} if a transfer failed. If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set, the method will also call TransferDataFromWindow() of all child windows. @@ -2711,7 +2711,7 @@ the method will also call TransferDataToWindow() of all child windows. \wxheading{Return value} -Returns {\tt FALSE} if a transfer failed. +Returns {\tt false} if a transfer failed. \wxheading{See also} @@ -2740,7 +2740,7 @@ the method will also call Validate() of all child windows. \wxheading{Return value} -Returns {\tt FALSE} if any of the validations failed. +Returns {\tt false} if any of the validations failed. \wxheading{See also} diff --git a/docs/latex/wx/wizard.tex b/docs/latex/wx/wizard.tex index ebe73802ee..034da96e51 100644 --- a/docs/latex/wx/wizard.tex +++ b/docs/latex/wx/wizard.tex @@ -165,7 +165,7 @@ Returns the size available for the pages. \func{virtual bool}{HasNextPage}{\param{wxWizardPage *}{page}} -Return {\tt TRUE} if this page is not the last one in the wizard. The base +Return {\tt true} if this page is not the last one in the wizard. The base class version implements this by calling \helpref{page->GetNext}{wxwizardpagegetnext} but this could be undesirable if, for example, the pages are created on demand only. @@ -178,7 +178,7 @@ for example, the pages are created on demand only. \func{virtual bool}{HasPrevPage}{\param{wxWizardPage *}{page}} -Return {\tt TRUE} if this page is not the last one in the wizard. The base +Return {\tt true} if this page is not the last one in the wizard. The base class version implements this by calling \helpref{page->GetPrev}{wxwizardpagegetprev} but this could be undesirable if, for example, the pages are created on demand only. @@ -191,8 +191,8 @@ for example, the pages are created on demand only. \func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}} -Executes the wizard starting from the given page, returns {\tt TRUE} if it was -successfully finished or {\tt FALSE} if user cancelled it. The {\it firstPage} +Executes the wizard starting from the given page, returns {\tt true} if it was +successfully finished or {\tt false} if user cancelled it. The {\it firstPage} can not be {\tt NULL}. \membersection{wxWizard::SetPageSize}\label{wxwizardsetpagesize} diff --git a/docs/latex/wx/wizevt.tex b/docs/latex/wx/wizevt.tex index 1d0ba404b5..6432e73094 100644 --- a/docs/latex/wx/wizevt.tex +++ b/docs/latex/wx/wizevt.tex @@ -51,7 +51,7 @@ the wizard (this event may also be vetoed).} \membersection{wxWizardEvent::wxWizardEvent}\label{wxwizardeventwxwizardevent} -\func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = TRUE}} +\func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = true}} Constructor. It is not normally used by the user code as the objects of this type are constructed by wxWizard. @@ -61,9 +61,9 @@ type are constructed by wxWizard. \constfunc{bool}{GetDirection}{\void} Return the direction in which the page is changing: for {\tt -EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt TRUE} if we're going forward or -FALSE otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt TRUE} if -we came from the previous page and {\tt FALSE} if we returned from the next +EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt true} if we're going forward or +false otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt true} if +we came from the previous page and {\tt false} if we returned from the next one. \membersection{wxWizardEvent::GetPage}\label{wxwizardeventgetpage} diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index b9cd2f0418..a77d3324f7 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -92,7 +92,7 @@ so is the default version of \helpref{IsSameAs}{wxstringissameas}. For case insensitive comparisons you should use \helpref{CmpNoCase}{wxstringcmpnocase} or give a second parameter to IsSameAs. This last function is may be more convenient if only equality of the strings matters because it returns a boolean -true value if the strings are the same and not 0 (which is usually FALSE in C) +true value if the strings are the same and not 0 (which is usually false in C) as {\tt Cmp()} does. \helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher: @@ -149,7 +149,7 @@ functions. The string provides functions for conversion to signed and unsigned integer and floating point numbers. All three functions take a pointer to the variable to -put the numeric value in and return TRUE if the {\bf entire} string could be +put the numeric value in and return true if the {\bf entire} string could be converted to a number. \helpref{ToLong}{wxstringtolong}\\ @@ -567,7 +567,7 @@ See also: \helpref{Clear()}{wxstringclear}. \membersection{wxString::Find}\label{wxstringfind} -\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = FALSE}} +\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}} Searches for the given character. Returns the starting index, or -1 if not found. @@ -652,11 +652,11 @@ Same as \helpref{wxString::Find}{wxstringfind}. Same as \helpref{wxString::Find}{wxstringfind}. -\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = TRUE}, \param{bool}{ fromEnd = FALSE}} +\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = true}, \param{bool}{ fromEnd = false}} Search the element in the array, starting from either side. -If {\it fromEnd} is TRUE, reverse search direction. +If {\it fromEnd} is true, reverse search direction. If {\bf caseSensitive}, comparison is case sensitive (the default). @@ -673,46 +673,46 @@ Returns the index of the first item matched, or wxNOT\_FOUND. \constfunc{bool}{IsAscii}{\void} -Returns TRUE if the string contains only ASCII characters. +Returns true if the string contains only ASCII characters. \membersection{wxString::IsEmpty}\label{wxstringisempty} \constfunc{bool}{IsEmpty}{\void} -Returns TRUE if the string is empty. +Returns true if the string is empty. \membersection{wxString::IsNull}\label{wxstringisnull} \constfunc{bool}{IsNull}{\void} -Returns TRUE if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). +Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}). \membersection{wxString::IsNumber}\label{wxstringisnumber} \constfunc{bool}{IsNumber}{\void} -Returns TRUE if the string is an integer (with possible sign). +Returns true if the string is an integer (with possible sign). \membersection{wxString::IsSameAs}\label{wxstringissameas} -\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = TRUE}} +\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}} Test for string equality, case-sensitive (default) or not. -caseSensitive is TRUE by default (case matters). +caseSensitive is true by default (case matters). -Returns TRUE if strings are equal, FALSE otherwise. +Returns true if strings are equal, false otherwise. See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas2} \membersection{wxString::IsSameAs}\label{wxstringissameas2} -\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = TRUE}} +\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}} Test whether the string is equal to the single character {\it c}. The test is -case-sensitive if {\it caseSensitive} is TRUE (default) or not if it is FALSE. +case-sensitive if {\it caseSensitive} is true (default) or not if it is false. -Returns TRUE if the string is equal to the character, FALSE otherwise. +Returns true if the string is equal to the character, false otherwise. See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas} @@ -720,7 +720,7 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \he \constfunc{bool}{IsWord}{\void} -Returns TRUE if the string is a word. TODO: what's the definition of a word? +Returns true if the string is a word. TODO: what's the definition of a word? \membersection{wxString::Last}\label{wxstringlast} @@ -778,7 +778,7 @@ Converts all characters to upper case. \constfunc{bool}{Matches}{\param{const char*}{ szMask}} -Returns TRUE if the string contents matches a mask containing '*' and '?'. +Returns true if the string contents matches a mask containing '*' and '?'. \membersection{wxString::Mid}\label{wxstringmid} @@ -789,7 +789,7 @@ the string if {\it count} is the default value. \membersection{wxString::Pad}\label{wxstringpad} -\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = TRUE}} +\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = true}} Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default). @@ -838,7 +838,7 @@ Removes the last character. \membersection{wxString::Replace}\label{wxstringreplace} -\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}} +\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = true}} Replace first (or all) occurrences of substring with another one. @@ -876,9 +876,9 @@ The same as Printf. \constfunc{bool}{StartsWith}{\param{const wxChar }{*prefix}, \param{wxString }{*rest = NULL}} This function can be used to test if the string starts with the specified -{\it prefix}. If it does, the function will return {\tt TRUE} and put the rest +{\it prefix}. If it does, the function will return {\tt true} and put the rest of the string (i.e. after the prefix) into {\it rest} string if it is not -{\tt NULL}. Otherwise, the function returns {\tt FALSE} and doesn't modify the +{\tt NULL}. Otherwise, the function returns {\tt false} and doesn't modify the {\it rest}. \membersection{wxString::Strip}\label{wxstringstrip} @@ -906,8 +906,8 @@ inclusive. \constfunc{bool}{ToDouble}{\param{double}{ *val}} -Attempts to convert the string to a floating point number. Returns TRUE on -success (the number is stored in the location pointed to by {\it val}) or FALSE +Attempts to convert the string to a floating point number. Returns true on +success (the number is stored in the location pointed to by {\it val}) or false if the string does not represent such number. \wxheading{See also} @@ -920,8 +920,8 @@ if the string does not represent such number. \constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}} Attempts to convert the string to a signed integer in base {\it base}. Returns -{\tt TRUE} on success in which case the number is stored in the location -pointed to by {\it val} or {\tt FALSE} if the string does not represent a +{\tt true} on success in which case the number is stored in the location +pointed to by {\it val} or {\tt false} if the string does not represent a valid number in the given base. The value of {\it base} must be comprised between $2$ and $36$, inclusive, or @@ -942,8 +942,8 @@ familiar with C) results. \constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}} Attempts to convert the string to a ansigned integer in base {\it base}. -Returns {\tt TRUE} on success in which case the number is stored in the -location pointed to by {\it val} or {\tt FALSE} if the string does not +Returns {\tt true} on success in which case the number is stored in the +location pointed to by {\it val} or {\tt false} if the string does not represent a valid number in the given base. See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed @@ -956,7 +956,7 @@ description of the {\it base} parameter. \membersection{wxString::Trim}\label{wxstringtrim} -\func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}} +\func{wxString\&}{Trim}{\param{bool}{ fromRight = true}} Removes spaces from the left or from the right (default). @@ -999,7 +999,7 @@ The same as MakeUpper. \constfunc{bool}{operator!}{\void} -Empty string is FALSE, so !string will only return TRUE if the string is empty. +Empty string is false, so !string will only return true if the string is empty. This allows the tests for NULLness of a {\it const char *} pointer and emptyness of the string to look the same in the code and makes it easier to port old code to wxString. diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex index 1b5974706a..2f6fe90453 100644 --- a/docs/latex/wx/xmlres.tex +++ b/docs/latex/wx/xmlres.tex @@ -106,7 +106,7 @@ Helper function: finds a resource (calls UpdateResources) and returns a node con \membersection{wxXmlResource::FindResource}\label{wxxmlresourcefindresource} -\func{wxXmlNode*}{FindResource}{\param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive = FALSE}} +\func{wxXmlNode*}{FindResource}{\param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive = false}} Finds a resource (calls UpdateResources) and returns a node containing it. diff --git a/docs/latex/wx/xmlresh.tex b/docs/latex/wx/xmlresh.tex index eb6e2ba273..fe03e0dc99 100644 --- a/docs/latex/wx/xmlresh.tex +++ b/docs/latex/wx/xmlresh.tex @@ -53,8 +53,8 @@ Add styles common to all wxWindow-derived classes. \func{bool}{CanHandle}{\param{wxXmlNode* }{node}} -Returns TRUE if it understands this node and can create -a resource from it, FALSE otherwise. +Returns true if it understands this node and can create +a resource from it, false otherwise. \wxheading{Note} @@ -65,7 +65,7 @@ safe to operate on {\it node} directly or to call IsOfClass. \membersection{wxXmlResourceHandler::CreateChildren}\label{wxxmlresourcehandlercreatechildren} -\func{void}{CreateChildren}{\param{wxObject* }{parent}, \param{bool }{this\_hnd\_only = FALSE}} +\func{void}{CreateChildren}{\param{wxObject* }{parent}, \param{bool }{this\_hnd\_only = false}} Creates children. @@ -106,9 +106,9 @@ Gets a bitmap. \membersection{wxXmlResourceHandler::GetBool}\label{wxxmlresourcehandlergetbool} -\func{bool}{GetBool}{\param{const wxString\& }{param}, \param{bool }{defaultv = FALSE}} +\func{bool}{GetBool}{\param{const wxString\& }{param}, \param{bool }{defaultv = false}} -Gets a bool flag (1, t, yes, on, true are TRUE, everything else is FALSE). +Gets a bool flag (1, t, yes, on, true are true, everything else is false). \membersection{wxXmlResourceHandler::GetColour}\label{wxxmlresourcehandlergetcolour} -- 2.45.2