\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
-Copies {\it file1} to {\it file2}, returning TRUE if successful. If
+Copies {\it file1} to {\it file2}, returning TRUE if successful. If
{\it overwrite} parameter is TRUE (default), the destination file is overwritten
if it exists, but if {\it overwrite} is FALSE, the functions failes in this
case.
\func{size\_t}{Strlen}{\param{const char *}{ p}}
This is a safe version of standard function {\it strlen()}: it does exactly the
-same thing (i.e. returns the length of the string) except that it returns 0 if
+same thing (i.e. returns the length of the string) except that it returns 0 if
{\it p} is the NULL pointer.
\membersection{::wxGetTranslation}\label{wxgettranslation}
\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
-This function returns the translation of string {\it str} in the current
+This function returns the translation of string {\it str} in the current
\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
message catalogs (see \helpref{internationalization overview}{internationalization}), the
original string is returned. In debug build, an error message is logged - this
clicking on Ok, will result in only those files matching the pattern being
displayed.
-The wildcard may be a specification for multiple types of file
+The wildcard may be a specification for multiple types of file
with a description for each, such as:
\begin{verbatim}
Pops up a dialog box containing a message, OK/Cancel buttons and a
multiple-selection listbox. The user may choose an arbitrary (including 0)
-number of items in the listbox whose indices will be returned in
+number of items in the listbox whose indices will be returned in
{\it selection} array. The initial contents of this array will be used to
select the items when the dialog is shown.
-You may pass the list of strings to choose from either using {\it choices}
+You may pass the list of strings to choose from either using {\it choices}
which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
<wx/choicdlg.h>
\perlnote{In wxPerl there is just an array reference in place of {\tt n}
-and {\tt choices}, and no {\tt selections} parameter; the function
+and {\tt choices}, and no {\tt selections} parameter; the function
returns an array containing the user selections.}
\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
\param{wxWindow *}{parent = NULL},
\param{const wxPoint\& }{pos = wxDefaultPosition}}
-Shows a dialog asking the user for numeric input. The dialogs title is set to
+Shows a dialog asking the user for numeric input. The dialogs title is set to
{\it caption}, it contains a (possibly) multiline {\it message} above the
single line {\it prompt} and the zone for entering the number.
should be positive) and {\it value} is the initial value of it. If the user
enters an invalid value or cancels the dialog, the function will return -1.
-Dialog is centered on its {\it parent} unless an explicit position is given in
+Dialog is centered on its {\it parent} unless an explicit position is given in
{\it pos}.
\wxheading{Include files}
Pops up a dialog box containing a message, OK/Cancel buttons and a
single-selection listbox. The user may choose an item and press OK to return a
-string or Cancel to return the empty string. Use
+string or Cancel to return the empty string. Use
\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
valid choice and if you want to be able to detect pressing Cancel reliably.
-You may pass the list of strings to choose from either using {\it choices}
+You may pass the list of strings to choose from either using {\it choices}
which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
<wx/gdicmn.h>
+\membersection{::wxClientDisplayRect}
+
+\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
+\param{int *}{width}, \param{int *}{height}}
+
+\func{wxRect}{wxGetClientDisplayRect}{\void}
+
+Returns the dimensions of the work area on the display. On Windows
+this means the area not covered by the taskbar, etc. Other platforms
+are currently defaulting to the whole display until a way is found to
+provide this info for all window managers, etc.
+
\membersection{::wxColourDisplay}
\func{bool}{wxColourDisplay}{\void}
\section{Clipboard functions}\label{clipsboard}
These clipboard functions are implemented for Windows only. The use of these functions
-is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
class instead.
\wxheading{Include files}
Enumerates the formats found in a list of available formats that belong
to the clipboard. Each call to this function specifies a known
available format; the function returns the format that appears next in
-the list.
+the list.
{\it dataFormat} specifies a known format. If this parameter is zero,
-the function returns the first format in the list.
+the function returns the first format in the list.
The return value specifies the next known clipboard data format if the
function is successful. It is zero if the {\it dataFormat} parameter specifies
the last format in the list of available formats, or if the clipboard
-is not open.
+is not open.
-Before it enumerates the formats function, an application must open the clipboard by using the
-wxOpenClipboard function.
+Before it enumerates the formats function, an application must open the clipboard by using the
+wxOpenClipboard function.
\membersection{::wxGetClipboardData}
\section{Miscellaneous functions}\label{miscellany}
-\membersection{::wxDROP\_ICON}\label{wxdropicon}
+\membersection{::wxDROP\_ICON}\label{wxdropicon}
\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
name. Under MSW, the cursor is loaded from the resource file and the icon is
loaded from XPM file under other platforms.
-This macro should be used with
+This macro should be used with
\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
\wxheading{Include files}
This no longer needs to be called by the application: it will be called
by wxWindows if necessary.
-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
+See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
\helpref{wxDDECleanUp}{wxddecleanup}.
\wxheading{Include files}
\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
-This function enables or disables all top level windows. It is used by
+This function enables or disables all top level windows. It is used by
\helpref{::wxSafeYield}{wxsafeyield}.
\wxheading{Include files}
$-1$ if the process couldn't be started and typically 0 if the process
terminated successfully. Also, while waiting for the process to
terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
-should ensure that this can cause no recursion, in the simplest case by
+should ensure that this can cause no recursion, in the simplest case by
calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
For asynchronous execution, however, the return value is the process id and
zero value indicates that the command could not be executed.
If callback isn't NULL and if execution is asynchronous (note that callback
-parameter can not be non-NULL for synchronous execution),
+parameter can not be non-NULL for synchronous execution),
\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
the process finishes.
Finally, you may use the third overloaded version of this function to execute
-a process (always synchronously) and capture its output in the array
+a process (always synchronously) and capture its output in the array
{\it output}. The fourth version adds the possibility to additionally capture
the messages from standard error output in the {\it errors} array.
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
\helpref{Exec sample}{sampleexec}.
\wxheading{Include files}
\func{wxString}{wxGetOsDescription}{\void}
Returns the string containing the description of the current platform in a
-user-readable form. For example, this function may return strings like
+user-readable form. For example, this function may return strings like
{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
\wxheading{See also}
\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
Returns the home directory for the given user. If the username is empty
-(default value), this function behaves like
+(default value), this function behaves like
\helpref{wxGetHomeDir}{wxgethomedir}.
\wxheading{Include files}
This function is similar to wxYield, except that it disables the user input to
all program windows before calling wxYield and re-enables it again
-afterwards. If {\it win} is not NULL, this window will remain enabled,
+afterwards. If {\it win} is not NULL, this window will remain enabled,
allowing the implementation of some limited user interaction.
Returns the result of the call to \helpref{::wxYield}{wxyield}.
will force the system to send an idle event even if the system currently {\it is}
idle and thus would not send any idle event until after some other event would get
sent. This is also useful for sending events between two threads and is used by
-the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
+the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
\wxheading{Include files}
This macro will swap the bytes of the {\it value} variable from little
endian to big endian or vice versa if the program is compiled on a
-big-endian architecture (such as Sun work stations). If the program has
+big-endian architecture (such as Sun work stations). If the program has
been compiled on a little-endian architecture, the value will be unchanged.
-Use these macros to read data from and write data to a file that stores
+Use these macros to read data from and write data to a file that stores
data in little endian (Intel i386) format.
\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
This macro will swap the bytes of the {\it value} variable from little
endian to big endian or vice versa if the program is compiled on a
-little-endian architecture (such as Intel PCs). If the program has
+little-endian architecture (such as Intel PCs). If the program has
been compiled on a big-endian architecture, the value will be unchanged.
-Use these macros to read data from and write data to a file that stores
+Use these macros to read data from and write data to a file that stores
data in big endian format.
\membersection{CLASSINFO}\label{classinfo}
\wxheading{See also}
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
\helpref{wxICON}{wxiconmacro}
\wxheading{Include files}
\wxheading{See also}
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
\helpref{wxBITMAP}{wxbitmapmacro}
\wxheading{Include files}
\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}}
-Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
+Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
This is required if other resources will use the bitmap data, since otherwise there
is no connection between names used in resources, and the global bitmap data.
messages, so it might make sense to separate them from other debug messages.
The trace messages also usually can be separated into different categories and
-the second and third versions of this function only log the message if the
+the second and third versions of this function only log the message if the
{\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
allows to selectively trace only some operations and not others by changing
the value of the trace mask (possible during the run-time).
For the second function (taking a string mask), the message is logged only if
-the mask has been previously enabled by the call to
+the mask has been previously enabled by the call to
\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
used by wxWindows are:
\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
-Returns the error message corresponding to the given system error code. If
-{\it errCode} is $0$ (default), the last error code (as returned by
+Returns the error message corresponding to the given system error code. If
+{\it errCode} is $0$ (default), the last error code (as returned by
\helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
\wxheading{See also}
The functions in this section deal with getting the current time and
starting/stopping the global timers. Please note that the timer functions are
-deprecated because they work with one global timer only and
+deprecated because they work with one global timer only and
\helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
-should be used instead. For retrieving the current time, you may also use
-\helpref{wxDateTime::Now}{wxdatetimenow} or
+should be used instead. For retrieving the current time, you may also use
+\helpref{wxDateTime::Now}{wxdatetimenow} or
\helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
This check is done even in release mode.
-This macro may be only used in non void functions, see also
+This macro may be only used in non void functions, see also
\helpref{wxCHECK\_RET}{wxcheckret}.
\membersection{wxCHECK\_RET}\label{wxcheckret}
Checks that the condition is true, and returns if not (FAILs with given error
message in debug mode). This check is done even in release mode.
-This macro should be used in void functions instead of
+This macro should be used in void functions instead of
\helpref{wxCHECK\_MSG}{wxcheckmsg}.
\membersection{wxCHECK2}\label{wxcheck2}
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
-Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
-{\it operation} if it is not. This is a generalisation of
+Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
+{\it operation} if it is not. This is a generalisation of
\helpref{wxCHECK}{wxcheck} and may be used when something else than just
returning from the function must be done when the {\it condition} is false.
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
-This is the same as \helpref{wxCHECK2}{wxcheck2}, but
+This is the same as \helpref{wxCHECK2}{wxcheck2}, but
\helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
instead of wxFAIL() if the {\it condition} is false.
\func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
-Removes the variable {\it var} from the environment.
+Removes the variable {\it var} from the environment.
\helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
function.
projects / wxWidgets.git / commitdiff
