AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

TRUE/FALSE -> true/false in documentation

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2003-01-18 00:16:34 +00:00
parent 4aa3178674
commit cc81d32f2b
220 changed files with 1448 additions and 1448 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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.

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

@ -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.

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

@ -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.

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

@ -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}

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

@ -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

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

@ -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}

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

@ -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.

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

@ -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}

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

@ -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).

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

@ -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}

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

@ -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.

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

@ -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.}

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

@ -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}

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

@ -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.

16
docs/latex/wx/clipbrd.tex
View File

@ -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.

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

@ -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.

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

@ -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}

24
docs/latex/wx/cmdlpars.tex
View File

@ -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}

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

@ -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

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

@ -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}

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

@ -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

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

@ -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.

56
docs/latex/wx/config.tex
View File

@ -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

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

@ -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}

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

@ -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}

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

@ -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}

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

@ -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

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

@ -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}

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

@ -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.

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

@ -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}

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

@ -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}

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

@ -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}

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

@ -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).

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

@ -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.

212
docs/latex/wx/db.tex
View File

@ -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. }

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

@ -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

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

@ -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.

16
docs/latex/wx/ddeconn.tex
View File

@ -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.

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

@ -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}

20
docs/latex/wx/debugcxt.tex
View File

@ -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}

24
docs/latex/wx/dialog.tex
View File

@ -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}

24
docs/latex/wx/dialup.tex
View File

@ -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}

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

@ -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.

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

@ -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}

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

@ -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.

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

@ -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

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

@ -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.}

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

@ -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}

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

@ -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}

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

@ -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}.}

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

@ -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.

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

@ -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}

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

@ -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}

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

@ -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.)

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

@ -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

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

@ -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}

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

@ -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}

20
docs/latex/wx/ffile.tex
View File

@ -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.

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

@ -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

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

@ -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}

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

@ -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.

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

@ -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.

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

@ -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.

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

@ -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}

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

@ -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}

16
docs/latex/wx/filetype.tex
View File

@ -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.

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

@ -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}

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

@ -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}}

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

@ -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.

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

@ -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

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

@ -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.

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

@ -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:

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

@ -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.
% ----------------------------------------------------------------------------

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

@ -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.

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

@ -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}

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

@ -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}

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

@ -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}

42
docs/latex/wx/gridevt.tex
View File

@ -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.

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

@ -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.

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

@ -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}

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

@ -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.

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

@ -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

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

@ -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}

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

@ -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}

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

@ -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.

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

@ -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.

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

@ -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:

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

@ -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.

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

@ -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.

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

@ -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)}

16
docs/latex/wx/httag.tex
View File

@ -88,7 +88,7 @@ and name of {\tt </table>} 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 <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
"SIZE" and "COLOR".
@ -170,7 +170,7 @@ Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} 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 </FONT>} is ending tag, {\tt <FONT>} is not)
\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}

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

@ -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}

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

@ -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}

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

@ -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 <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}

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

@ -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}

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

@ -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.

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

@ -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.

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

@ -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}

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

@ -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}

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

@ -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}

Some files were not shown because too many files have changed in this diff Show More