Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implemented wxGetClientDisplayRect which returns the dimensions of the

Browse Source 
desktop minus taskbar, etc. on Windows and defaults to the full
desktop dimensions on other platforms.  (If there is a way to do it
for other platforms please do.)


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@9947 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2001-04-30 20:55:11 +00:00
parent 926bb76c2a
commit ec5d77998a
11 changed files with 182 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -215,7 +215,7 @@ TRUE if successful.
\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}} \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
Copies {\it file1} to {\it file2}, returning TRUE if successful. If Copies {\it file1} to {\it file2}, returning TRUE if successful. If
{\it overwrite} parameter is TRUE (default), the destination file is overwritten {\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 if it exists, but if {\it overwrite} is FALSE, the functions failes in this
case. case.
@@ -502,14 +502,14 @@ case-sensitive comparison.
\func{size\_t}{Strlen}{\param{const char *}{ p}} \func{size\_t}{Strlen}{\param{const char *}{ p}}
This is a safe version of standard function {\it strlen()}: it does exactly the 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. {\it p} is the NULL pointer.
\membersection{::wxGetTranslation}\label{wxgettranslation} \membersection{::wxGetTranslation}\label{wxgettranslation}
\func{const char *}{wxGetTranslation}{\param{const char * }{str}} \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 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
message catalogs (see \helpref{internationalization overview}{internationalization}), the message catalogs (see \helpref{internationalization overview}{internationalization}), the
original string is returned. In debug build, an error message is logged - this original string is returned. In debug build, an error message is logged - this
@@ -593,7 +593,7 @@ filename containing wildcards (*, ?) in the filename text item, and
clicking on Ok, will result in only those files matching the pattern being clicking on Ok, will result in only those files matching the pattern being
displayed. 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: with a description for each, such as:
\begin{verbatim} \begin{verbatim}
@@ -657,11 +657,11 @@ is valid) if the dialog was cancelled.
Pops up a dialog box containing a message, OK/Cancel buttons and a Pops up a dialog box containing a message, OK/Cancel buttons and a
multiple-selection listbox. The user may choose an arbitrary (including 0) 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 {\it selection} array. The initial contents of this array will be used to
select the items when the dialog is shown. 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 which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}. {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
@@ -673,7 +673,7 @@ characters) is centred; if FALSE, the message is left-justified.
<wx/choicdlg.h> <wx/choicdlg.h>
\perlnote{In wxPerl there is just an array reference in place of {\tt n} \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.} returns an array containing the user selections.}
\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser} \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
@@ -688,7 +688,7 @@ returns an array containing the user selections.}
\param{wxWindow *}{parent = NULL}, \param{wxWindow *}{parent = NULL},
\param{const wxPoint\& }{pos = wxDefaultPosition}} \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 {\it caption}, it contains a (possibly) multiline {\it message} above the
single line {\it prompt} and the zone for entering the number. single line {\it prompt} and the zone for entering the number.
@@ -696,7 +696,7 @@ The number entered must be in the range {\it min}..{\it max} (both of which
should be positive) and {\it value} is the initial value of it. If the user 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. 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}. {\it pos}.
\wxheading{Include files} \wxheading{Include files}
@@ -779,11 +779,11 @@ is centred; if FALSE, the message is left-justified.
Pops up a dialog box containing a message, OK/Cancel buttons and a 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 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 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
valid choice and if you want to be able to detect pressing Cancel reliably. 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 which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}. {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
@@ -932,6 +932,18 @@ The following are relevant to the GDI (Graphics Device Interface).
<wx/gdicmn.h> <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} \membersection{::wxColourDisplay}
\func{bool}{wxColourDisplay}{\void} \func{bool}{wxColourDisplay}{\void}
@@ -1107,7 +1119,7 @@ Sets the translation (from the top left corner) for PostScript output. The defau
\section{Clipboard functions}\label{clipsboard} \section{Clipboard functions}\label{clipsboard}
These clipboard functions are implemented for Windows only. The use of these functions 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. class instead.
\wxheading{Include files} \wxheading{Include files}
@@ -1139,18 +1151,18 @@ Empties the clipboard.
Enumerates the formats found in a list of available formats that belong Enumerates the formats found in a list of available formats that belong
to the clipboard. Each call to this function specifies a known to the clipboard. Each call to this function specifies a known
available format; the function returns the format that appears next in 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, {\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 The return value specifies the next known clipboard data format if the
function is successful. It is zero if the {\it dataFormat} parameter specifies 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 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 Before it enumerates the formats function, an application must open the clipboard by using the
wxOpenClipboard function. wxOpenClipboard function.
\membersection{::wxGetClipboardData} \membersection{::wxGetClipboardData}
@@ -1211,7 +1223,7 @@ The clipboard must have previously been opened for this call to succeed.
\section{Miscellaneous functions}\label{miscellany} \section{Miscellaneous functions}\label{miscellany}
\membersection{::wxDROP\_ICON}\label{wxdropicon} \membersection{::wxDROP\_ICON}\label{wxdropicon}
\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}} \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
@@ -1219,7 +1231,7 @@ This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
name. Under MSW, the cursor is loaded from the resource file and the icon is name. Under MSW, the cursor is loaded from the resource file and the icon is
loaded from XPM file under other platforms. loaded from XPM file under other platforms.
This macro should be used with This macro should be used with
\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}. \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
\wxheading{Include files} \wxheading{Include files}
@@ -1301,7 +1313,7 @@ Initializes the DDE system. May be called multiple times without harm.
This no longer needs to be called by the application: it will be called This no longer needs to be called by the application: it will be called
by wxWindows if necessary. 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}. \helpref{wxDDECleanUp}{wxddecleanup}.
\wxheading{Include files} \wxheading{Include files}
@@ -1347,7 +1359,7 @@ Gets the physical size of the display in pixels.
\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
This function enables or disables all top level windows. It is used by This function enables or disables all top level windows. It is used by
\helpref{::wxSafeYield}{wxsafeyield}. \helpref{::wxSafeYield}{wxsafeyield}.
\wxheading{Include files} \wxheading{Include files}
@@ -1450,23 +1462,23 @@ the process (which terminates by the moment the function returns) and will be
$-1$ if the process couldn't be started and typically 0 if the process $-1$ if the process couldn't be started and typically 0 if the process
terminated successfully. Also, while waiting for the process to terminated successfully. Also, while waiting for the process to
terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller 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}. calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
For asynchronous execution, however, the return value is the process id and For asynchronous execution, however, the return value is the process id and
zero value indicates that the command could not be executed. zero value indicates that the command could not be executed.
If callback isn't NULL and if execution is asynchronous (note that callback 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 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
the process finishes. the process finishes.
Finally, you may use the third overloaded version of this function to execute 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 {\it output}. The fourth version adds the possibility to additionally capture
the messages from standard error output in the {\it errors} array. 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}. \helpref{Exec sample}{sampleexec}.
\wxheading{Include files} \wxheading{Include files}
@@ -1611,7 +1623,7 @@ Returns the mouse position in screen coordinates.
\func{wxString}{wxGetOsDescription}{\void} \func{wxString}{wxGetOsDescription}{\void}
Returns the string containing the description of the current platform in a 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}. {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
\wxheading{See also} \wxheading{See also}
@@ -1701,7 +1713,7 @@ Under Windows, this returns ``user''.
\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}} \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
Returns the home directory for the given user. If the username is empty 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}. \helpref{wxGetHomeDir}{wxgethomedir}.
\wxheading{Include files} \wxheading{Include files}
@@ -1850,7 +1862,7 @@ uses internally).
This function is similar to wxYield, except that it disables the user input to 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 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. allowing the implementation of some limited user interaction.
Returns the result of the call to \helpref{::wxYield}{wxyield}. Returns the result of the call to \helpref{::wxYield}{wxyield}.
@@ -2038,7 +2050,7 @@ This functions wakes up the (internal and platform dependent) idle system, i.e.
will force the system to send an idle event even if the system currently {\it is} 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 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 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}. \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
\wxheading{Include files} \wxheading{Include files}
@@ -2074,10 +2086,10 @@ endian to big endian or vice versa.
This macro will swap the bytes of the {\it value} variable from little 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 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. 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. data in little endian (Intel i386) format.
\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle} \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
@@ -2092,10 +2104,10 @@ data in little endian (Intel i386) format.
This macro will swap the bytes of the {\it value} variable from little 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 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. 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. data in big endian format.
\membersection{CLASSINFO}\label{classinfo} \membersection{CLASSINFO}\label{classinfo}
@@ -2315,7 +2327,7 @@ avoid using {\tt \#ifdef}s when creating bitmaps.
\wxheading{See also} \wxheading{See also}
\helpref{Bitmaps and icons overview}{wxbitmapoverview}, \helpref{Bitmaps and icons overview}{wxbitmapoverview},
\helpref{wxICON}{wxiconmacro} \helpref{wxICON}{wxiconmacro}
\wxheading{Include files} \wxheading{Include files}
@@ -2393,7 +2405,7 @@ avoid using {\tt \#ifdef}s when creating icons.
\wxheading{See also} \wxheading{See also}
\helpref{Bitmaps and icons overview}{wxbitmapoverview}, \helpref{Bitmaps and icons overview}{wxbitmapoverview},
\helpref{wxBITMAP}{wxbitmapmacro} \helpref{wxBITMAP}{wxbitmapmacro}
\wxheading{Include files} \wxheading{Include files}
@@ -2631,7 +2643,7 @@ load an entire {\tt .wxr file} into a string.
\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}} \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 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. is no connection between names used in resources, and the global bitmap data.
@@ -2740,13 +2752,13 @@ it a separate function from it is that usually there are a lot of trace
messages, so it might make sense to separate them from other debug messages. 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 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 {\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 allows to selectively trace only some operations and not others by changing
the value of the trace mask (possible during the run-time). 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 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 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
used by wxWindows are: used by wxWindows are:
@@ -2789,8 +2801,8 @@ Returns the error code from the last system call. This function uses
\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}} \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
Returns the error message corresponding to the given system error code. If Returns the error message corresponding to the given system error code. If
{\it errCode} is $0$ (default), the last error code (as returned by {\it errCode} is $0$ (default), the last error code (as returned by
\helpref{wxSysErrorCode}{wxsyserrorcode}) is used. \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
\wxheading{See also} \wxheading{See also}
@@ -2802,10 +2814,10 @@ Returns the error message corresponding to the given system error code. If
The functions in this section deal with getting the current time and The functions in this section deal with getting the current time and
starting/stopping the global timers. Please note that the timer functions are 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 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
should be used instead. For retrieving the current time, you may also use should be used instead. For retrieving the current time, you may also use
\helpref{wxDateTime::Now}{wxdatetimenow} or \helpref{wxDateTime::Now}{wxdatetimenow} or
\helpref{wxDateTime::UNow}{wxdatetimeunow} methods. \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime} \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
@@ -2951,7 +2963,7 @@ This check is done even in release mode.
Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). 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 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}. \helpref{wxCHECK\_RET}{wxcheckret}.
\membersection{wxCHECK\_RET}\label{wxcheckret} \membersection{wxCHECK\_RET}\label{wxcheckret}
@@ -2961,15 +2973,15 @@ This macro may be only used in non void functions, see also
Checks that the condition is true, and returns if not (FAILs with given error 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. 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}. \helpref{wxCHECK\_MSG}{wxcheckmsg}.
\membersection{wxCHECK2}\label{wxcheck2} \membersection{wxCHECK2}\label{wxcheck2}
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}} \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
{\it operation} if it is not. This is a generalisation of {\it operation} if it is not. This is a generalisation of
\helpref{wxCHECK}{wxcheck} and may be used when something else than just \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. returning from the function must be done when the {\it condition} is false.
@@ -2979,7 +2991,7 @@ This check is done even in release mode.
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}} \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 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
instead of wxFAIL() if the {\it condition} is false. instead of wxFAIL() if the {\it condition} is false.
@@ -3029,7 +3041,7 @@ Returns {\tt TRUE} on success.
\func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}} \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 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
function. function.

4
include/wx/gdicmn.h
View File

@@ -509,6 +509,10 @@ extern wxSize WXDLLEXPORT wxGetDisplaySize();
extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height); extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
extern wxSize WXDLLEXPORT wxGetDisplaySizeMM(); extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
// Get position and size of the display workarea
extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
// set global cursor // set global cursor
extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor); extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);

7
src/common/gdicmn.cpp
View File

@@ -723,6 +723,13 @@ wxSize wxGetDisplaySize()
return wxSize(x, y); return wxSize(x, y);
} }
wxRect wxGetClientDisplayRect()
{
int x, y, width, height;
wxClientDisplayRect(&x, &y, &width, &height); // call plat-specific version
return wxRect(x, y, width, height);
}
wxSize wxGetDisplaySizeMM() wxSize wxGetDisplaySizeMM()
{ {
int x, y; int x, y;

17
src/gtk/utilsgtk.cpp
View File

@@ -36,9 +36,9 @@
* field named "explicit" - which is, of course, an error for a C++ * field named "explicit" - which is, of course, an error for a C++
* compiler. To be on the safe side, just redefine it everywhere. */ * compiler. To be on the safe side, just redefine it everywhere. */
#define explicit __wx_explicit #define explicit __wx_explicit
#include "X11/XKBlib.h" #include "X11/XKBlib.h"
#undef explicit #undef explicit
#endif // HAVE_X11_XKBLIB_H #endif // HAVE_X11_XKBLIB_H
@@ -94,6 +94,17 @@ void wxDisplaySizeMM( int *width, int *height )
if (height) *height = gdk_screen_height_mm(); if (height) *height = gdk_screen_height_mm();
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
void wxGetMousePosition( int* x, int* y ) void wxGetMousePosition( int* x, int* y )
{ {
gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL ); gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
@@ -136,7 +147,7 @@ static void GTK_EndProcessDetector(gpointer data, gint source,
// This has to come after gdk_input_remove() or we will // This has to come after gdk_input_remove() or we will
// occasionally receive multiple callbacks with corrupt data // occasionally receive multiple callbacks with corrupt data
// pointers. (KB) // pointers. (KB)
wxHandleProcessTermination(proc_data); wxHandleProcessTermination(proc_data);
} }

17
src/gtk1/utilsgtk.cpp
View File

@@ -36,9 +36,9 @@
* field named "explicit" - which is, of course, an error for a C++ * field named "explicit" - which is, of course, an error for a C++
* compiler. To be on the safe side, just redefine it everywhere. */ * compiler. To be on the safe side, just redefine it everywhere. */
#define explicit __wx_explicit #define explicit __wx_explicit
#include "X11/XKBlib.h" #include "X11/XKBlib.h"
#undef explicit #undef explicit
#endif // HAVE_X11_XKBLIB_H #endif // HAVE_X11_XKBLIB_H
@@ -94,6 +94,17 @@ void wxDisplaySizeMM( int *width, int *height )
if (height) *height = gdk_screen_height_mm(); if (height) *height = gdk_screen_height_mm();
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
void wxGetMousePosition( int* x, int* y ) void wxGetMousePosition( int* x, int* y )
{ {
gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL ); gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
@@ -136,7 +147,7 @@ static void GTK_EndProcessDetector(gpointer data, gint source,
// This has to come after gdk_input_remove() or we will // This has to come after gdk_input_remove() or we will
// occasionally receive multiple callbacks with corrupt data // occasionally receive multiple callbacks with corrupt data
// pointers. (KB) // pointers. (KB)
wxHandleProcessTermination(proc_data); wxHandleProcessTermination(proc_data);
} }

27
src/mac/carbon/utils.cpp
View File

@@ -208,7 +208,7 @@ bool wxGetResource(const wxString& section, const wxString& entry, int *value, c
if (succ) if (succ)
{ {
*value = (int)strtol(s, NULL, 10); *value = (int)strtol(s, NULL, 10);
delete[] s; delete[] s;
return TRUE; return TRUE;
} }
else return FALSE; else return FALSE;
@@ -239,7 +239,7 @@ void wxEndBusyCursor()
{ {
if (wxBusyCursorCount == 0) if (wxBusyCursorCount == 0)
return; return;
wxBusyCursorCount --; wxBusyCursorCount --;
if (wxBusyCursorCount == 0) if (wxBusyCursorCount == 0)
{ {
@@ -258,7 +258,7 @@ void wxEndBusyCursor()
bool wxIsBusy() bool wxIsBusy()
{ {
return (wxBusyCursorCount > 0); return (wxBusyCursorCount > 0);
} }
#ifndef __UNIX__ #ifndef __UNIX__
wxString wxMacFindFolder( short vol, wxString wxMacFindFolder( short vol,
@@ -268,7 +268,7 @@ wxString wxMacFindFolder( short vol,
short vRefNum ; short vRefNum ;
long dirID ; long dirID ;
wxString strDir ; wxString strDir ;
if ( FindFolder( vol, folderType, createFolder, &vRefNum, &dirID) == noErr) if ( FindFolder( vol, folderType, createFolder, &vRefNum, &dirID) == noErr)
{ {
FSSpec file ; FSSpec file ;
@@ -300,7 +300,7 @@ bool wxCheckForInterrupt(wxWindow *wnd)
void wxGetMousePosition( int* x, int* y ) void wxGetMousePosition( int* x, int* y )
{ {
Point pt ; Point pt ;
GetMouse( &pt ) ; GetMouse( &pt ) ;
LocalToGlobal( &pt ) ; LocalToGlobal( &pt ) ;
*x = pt.h ; *x = pt.h ;
@@ -316,7 +316,7 @@ bool wxColourDisplay()
// Returns depth of screen // Returns depth of screen
int wxDisplayDepth() int wxDisplayDepth()
{ {
Rect globRect ; Rect globRect ;
SetRect(&globRect, -32760, -32760, 32760, 32760); SetRect(&globRect, -32760, -32760, 32760, 32760);
GDHandle theMaxDevice; GDHandle theMaxDevice;
@@ -324,7 +324,7 @@ int wxDisplayDepth()
theMaxDevice = GetMaxDevice(&globRect); theMaxDevice = GetMaxDevice(&globRect);
if (theMaxDevice != nil) if (theMaxDevice != nil)
theDepth = (**(**theMaxDevice).gdPMap).pixelSize; theDepth = (**(**theMaxDevice).gdPMap).pixelSize;
return theDepth ; return theDepth ;
} }
@@ -335,7 +335,7 @@ void wxDisplaySize(int *width, int *height)
GetQDGlobalsScreenBits( &screenBits ); GetQDGlobalsScreenBits( &screenBits );
*width = screenBits.bounds.right - screenBits.bounds.left ; *width = screenBits.bounds.right - screenBits.bounds.left ;
*height = screenBits.bounds.bottom - screenBits.bounds.top ; *height = screenBits.bounds.bottom - screenBits.bounds.top ;
#if TARGET_CARBON #if TARGET_CARBON
SInt16 mheight ; SInt16 mheight ;
GetThemeMenuBarHeight( &mheight ) ; GetThemeMenuBarHeight( &mheight ) ;
@@ -350,6 +350,17 @@ void wxDisplaySizeMM(int *width, int *height)
wxDisplaySize(width, height); wxDisplaySize(width, height);
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
wxWindow* wxFindWindowAtPoint(const wxPoint& pt) wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
{ {
return wxGenericFindWindowAtPoint(pt); return wxGenericFindWindowAtPoint(pt);

27
src/mac/utils.cpp
View File

@@ -208,7 +208,7 @@ bool wxGetResource(const wxString& section, const wxString& entry, int *value, c
if (succ) if (succ)
{ {
*value = (int)strtol(s, NULL, 10); *value = (int)strtol(s, NULL, 10);
delete[] s; delete[] s;
return TRUE; return TRUE;
} }
else return FALSE; else return FALSE;
@@ -239,7 +239,7 @@ void wxEndBusyCursor()
{ {
if (wxBusyCursorCount == 0) if (wxBusyCursorCount == 0)
return; return;
wxBusyCursorCount --; wxBusyCursorCount --;
if (wxBusyCursorCount == 0) if (wxBusyCursorCount == 0)
{ {
@@ -258,7 +258,7 @@ void wxEndBusyCursor()
bool wxIsBusy() bool wxIsBusy()
{ {
return (wxBusyCursorCount > 0); return (wxBusyCursorCount > 0);
} }
#ifndef __UNIX__ #ifndef __UNIX__
wxString wxMacFindFolder( short vol, wxString wxMacFindFolder( short vol,
@@ -268,7 +268,7 @@ wxString wxMacFindFolder( short vol,
short vRefNum ; short vRefNum ;
long dirID ; long dirID ;
wxString strDir ; wxString strDir ;
if ( FindFolder( vol, folderType, createFolder, &vRefNum, &dirID) == noErr) if ( FindFolder( vol, folderType, createFolder, &vRefNum, &dirID) == noErr)
{ {
FSSpec file ; FSSpec file ;
@@ -300,7 +300,7 @@ bool wxCheckForInterrupt(wxWindow *wnd)
void wxGetMousePosition( int* x, int* y ) void wxGetMousePosition( int* x, int* y )
{ {
Point pt ; Point pt ;
GetMouse( &pt ) ; GetMouse( &pt ) ;
LocalToGlobal( &pt ) ; LocalToGlobal( &pt ) ;
*x = pt.h ; *x = pt.h ;
@@ -316,7 +316,7 @@ bool wxColourDisplay()
// Returns depth of screen // Returns depth of screen
int wxDisplayDepth() int wxDisplayDepth()
{ {
Rect globRect ; Rect globRect ;
SetRect(&globRect, -32760, -32760, 32760, 32760); SetRect(&globRect, -32760, -32760, 32760, 32760);
GDHandle theMaxDevice; GDHandle theMaxDevice;
@@ -324,7 +324,7 @@ int wxDisplayDepth()
theMaxDevice = GetMaxDevice(&globRect); theMaxDevice = GetMaxDevice(&globRect);
if (theMaxDevice != nil) if (theMaxDevice != nil)
theDepth = (**(**theMaxDevice).gdPMap).pixelSize; theDepth = (**(**theMaxDevice).gdPMap).pixelSize;
return theDepth ; return theDepth ;
} }
@@ -335,7 +335,7 @@ void wxDisplaySize(int *width, int *height)
GetQDGlobalsScreenBits( &screenBits ); GetQDGlobalsScreenBits( &screenBits );
*width = screenBits.bounds.right - screenBits.bounds.left ; *width = screenBits.bounds.right - screenBits.bounds.left ;
*height = screenBits.bounds.bottom - screenBits.bounds.top ; *height = screenBits.bounds.bottom - screenBits.bounds.top ;
#if TARGET_CARBON #if TARGET_CARBON
SInt16 mheight ; SInt16 mheight ;
GetThemeMenuBarHeight( &mheight ) ; GetThemeMenuBarHeight( &mheight ) ;
@@ -350,6 +350,17 @@ void wxDisplaySizeMM(int *width, int *height)
wxDisplaySize(width, height); wxDisplaySize(width, height);
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
wxWindow* wxFindWindowAtPoint(const wxPoint& pt) wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
{ {
return wxGenericFindWindowAtPoint(pt); return wxGenericFindWindowAtPoint(pt);

14
src/motif/utils.cpp
View File

@@ -658,6 +658,18 @@ void wxDisplaySizeMM(int *width, int *height)
*height = DisplayHeightMM(dpy, DefaultScreen (dpy)); *height = DisplayHeightMM(dpy, DefaultScreen (dpy));
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
// Configurable display in Motif // Configurable display in Motif
static WXDisplay *gs_currentDisplay = NULL; static WXDisplay *gs_currentDisplay = NULL;
static wxString gs_displayName; static wxString gs_displayName;
@@ -1161,7 +1173,7 @@ void wxAllocNearestColor(Display *d,Colormap cmp,XColor *xc)
xc -> green = color_defs[pixel].green; xc -> green = color_defs[pixel].green;
xc -> blue = color_defs[pixel].blue; xc -> blue = color_defs[pixel].blue;
xc -> flags = DoRed | DoGreen | DoBlue; xc -> flags = DoRed | DoGreen | DoBlue;
/* FIXME, TODO /* FIXME, TODO
if (!XAllocColor(d,cmp,xc)) if (!XAllocColor(d,cmp,xc))
cout << "wxAllocNearestColor : Warning : Cannot find nearest color !\n"; cout << "wxAllocNearestColor : Warning : Cannot find nearest color !\n";

16
src/msw/utils.cpp
View File

@@ -38,7 +38,7 @@
// In some mingws there is a missing extern "C" int the winsock header, // In some mingws there is a missing extern "C" int the winsock header,
// so we put it here just to be safe. Note that this must appear _before_ // so we put it here just to be safe. Note that this must appear _before_
// #include "wx/msw/private.h" which itself includes <windows.h>, as this // #include "wx/msw/private.h" which itself includes <windows.h>, as this
// one in turn includes <winsock.h> unless we define WIN32_LEAN_AND_MEAN. // one in turn includes <winsock.h> unless we define WIN32_LEAN_AND_MEAN.
// //
#if defined(__WIN32__) && !defined(__TWIN32__) && ! (defined(__GNUWIN32__) && !defined(__MINGW32__)) #if defined(__WIN32__) && !defined(__TWIN32__) && ! (defined(__GNUWIN32__) && !defined(__MINGW32__))
@@ -617,7 +617,7 @@ int wxGetOsVersion(int *majorVsn, int *minorVsn)
*majorVsn = info.dwMajorVersion; *majorVsn = info.dwMajorVersion;
if (minorVsn) if (minorVsn)
*minorVsn = info.dwMinorVersion; *minorVsn = info.dwMinorVersion;
switch ( info.dwPlatformId ) switch ( info.dwPlatformId )
{ {
case VER_PLATFORM_WIN32s: case VER_PLATFORM_WIN32s:
@@ -1032,6 +1032,18 @@ void wxDisplaySizeMM(int *width, int *height)
if ( height ) *height = GetDeviceCaps(dc, VERTSIZE); if ( height ) *height = GetDeviceCaps(dc, VERTSIZE);
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// Determine the desktop dimensions minus the taskbar and any other
// special decorations...
RECT r;
SystemParametersInfo(SPI_GETWORKAREA, 0, &r, 0);
if (x) *x = r.left;
if (y) *y = r.top;
if (width) *width = r.right - r.left;
if (height) *height = r.bottom - r.top;
}
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
// window information functions // window information functions

12
src/os2/utils.cpp
View File

@@ -823,6 +823,18 @@ void wxDisplaySizeMM(
); );
} }
void wxClientDisplayRect(int *x, int *y, int *width, int *height)
{
// This is supposed to return desktop dimensions minus any window
// manager panels, menus, taskbars, etc. If there is a way to do that
// for this platform please fix this function, otherwise it defaults
// to the entire desktop.
if (x) *x = 0;
if (y) *y = 0;
wxDisplaySize(width, height);
}
bool wxDirExists( bool wxDirExists(
const wxString& rDir const wxString& rDir
) )

7
wxPython/src/misc2.i
View File

@@ -114,12 +114,15 @@ bool wxColourDisplay();
int wxDisplayDepth(); int wxDisplayDepth();
int wxGetDisplayDepth(); int wxGetDisplayDepth();
void wxDisplaySize(int* OUTPUT, int* OUTPUT); void wxDisplaySize(int* OUTPUT, int* OUTPUT);
wxSize wxGetDisplaySize(); wxSize wxGetDisplaySize();
void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT); void wxDisplaySizeMM(int* OUTPUT, int* OUTPUT);
wxSize wxGetDisplaySizeMM(); wxSize wxGetDisplaySizeMM();
void wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
wxRect wxGetClientDisplayRect();
void wxSetCursor(wxCursor& cursor); void wxSetCursor(wxCursor& cursor);
//---------------------------------------------------------------------- //----------------------------------------------------------------------