mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-09-23 06:33:59 +08:00
TRUE/FALSE -> true/false in documentation
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
+31
-31
@@ -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.
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.}
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
+12
-12
@@ -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}
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
+28
-28
@@ -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
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
+26
-26
@@ -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}
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
+106
-106
File diff suppressed because it is too large
Load Diff
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
+10
-10
@@ -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}
|
||||
|
||||
|
||||
+12
-12
@@ -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}
|
||||
|
||||
+12
-12
@@ -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}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.}
|
||||
|
||||
|
||||
@@ -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}
|
||||
|
||||
|
||||
+10
-10
@@ -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}
|
||||
|
||||
|
||||
@@ -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}.}
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user