Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user

[wxWidgets.git] / docs / latex / wx / function.tex

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 9df5c66f493cf78790342d158794498c615eee8d..d23f7160f2daeb15c98857213c5afe1de5a2545e 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -118,7 +118,7 @@ Returns TRUE if the directory exists.
 
 \membersection{::wxDos2UnixFilename}
 
 
 \membersection{::wxDos2UnixFilename}
 

-\func{void}{Dos2UnixFilename}{\param{const wxString\& }{s}}
+\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}

 
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.
 
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.


@@ -213,9 +213,12 @@ TRUE if successful.
 
 \membersection{::wxCopyFile}
 
 
 \membersection{::wxCopyFile}
 

-\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+\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.
+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.

 
 \membersection{::wxGetCwd}\label{wxgetcwd}
 
 
 \membersection{::wxGetCwd}\label{wxgetcwd}
 


@@ -499,14 +502,14 @@ case-sensitive comparison.
 \func{size\_t}{Strlen}{\param{const char *}{ p}}
 
 This is a safe version of standard function {\it strlen()}: it does exactly the
 \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}}
 
 {\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
 \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


@@ -590,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
 displayed.
 
 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}
 with a description for each, such as:
 
 \begin{verbatim}


@@ -630,6 +633,49 @@ is valid) if the dialog was cancelled.
 
 <wx/colordlg.h>
 
 
 <wx/colordlg.h>
 

+\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+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
+{\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}
+which is an array of {\it n} strings for the listbox or by using a single
+{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
+
+If {\it centre} is TRUE, the message text (which may include new line
+characters) is centred; if FALSE, the message is left-justified.
+
+\wxheading{Include files}
+
+<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
+returns an array containing the user selections.}
+

 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{
 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{


@@ -642,7 +688,7 @@ is valid) if the dialog was cancelled.
  \param{wxWindow *}{parent = NULL},
  \param{const wxPoint\& }{pos = wxDefaultPosition}}
 
  \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.
 
 {\it caption}, it contains a (possibly) multiline {\it message} above the
 single line {\it prompt} and the zone for entering the number.
 


@@ -650,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
 enters an invalid value or cancels the dialog, the function will return -1.
 
 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}
 {\it pos}.
 
 \wxheading{Include files}


@@ -715,49 +761,97 @@ is centred; if FALSE, the message is left-justified.
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 

-\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
- \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}

 
 

-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.
+\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}

 
 

-{\it choices} is an array of {\it n} strings for the listbox.
+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
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
+valid choice and if you want to be able to detect pressing Cancel reliably.

 
 

-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+You may pass the list of strings to choose from either using {\it choices}
+which is an array of {\it n} strings for the listbox or by using a single
+{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
+
+If {\it centre} is TRUE, the message text (which may include new line
+characters) is centred; if FALSE, the message is left-justified.

 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 
 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+

 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 

-\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\

  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
  \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
 
  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
  \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
 

-As {\bf wxGetSingleChoice} but returns the index representing the selected string.
-If the user pressed cancel, -1 is returned.
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+As {\bf wxGetSingleChoice} but returns the index representing the selected
+string. If the user pressed cancel, -1 is returned.

 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 
 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+

 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 

-\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
- \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
- \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{const wxString\& }{client\_data[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{const wxString\& }{client\_data[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}

 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers
 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers

-corresponding to the strings, and returns one of these pointers.
+corresponding to the strings, and returns one of these pointers or NULL if
+Cancel was pressed. The {\it client\_data} array must have the same number of
+elements as {\it choices} or {\it aChoices}!

 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 
 
 \wxheading{Include files}
 
 <wx/choicdlg.h>
 

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and the client data array must have the
+same length as the choices array.}
+

 \membersection{::wxMessageBox}\label{wxmessagebox}
 
 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
 \membersection{::wxMessageBox}\label{wxmessagebox}
 
 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\


@@ -774,7 +868,8 @@ wxYES\_NO or wxOK.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}
 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}
 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}

-\twocolitem{wxICON\_HAND}{Displays a hand symbol.}
+\twocolitem{wxICON\_HAND}{Displays an error symbol.}
+\twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}

 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
 \end{twocollist}
 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
 \end{twocollist}


@@ -837,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}
 
 \func{bool}{wxColourDisplay}{\void}
 \membersection{::wxColourDisplay}
 
 \func{bool}{wxColourDisplay}{\void}


@@ -849,6 +956,22 @@ Returns TRUE if the display is colour, FALSE otherwise.
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 

+\membersection{::wxDisplaySize}
+
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+
+\func{wxSize}{wxGetDisplaySize}{\void}
+
+Returns the display size in pixels.
+
+\membersection{::wxDisplaySizeMM}
+
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
+
+\func{wxSize}{wxGetDisplaySizeMM}{\void}
+
+Returns the display size in millimeters.
+

 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
 
 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
 
 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},


@@ -996,7 +1119,7 @@ Sets the translation (from the top left corner) for PostScript output. The defau
 \section{Clipboard functions}\label{clipsboard}
 
 These clipboard functions are implemented for Windows only. The use of these functions
 \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}
 class instead.
 
 \wxheading{Include files}


@@ -1028,18 +1151,18 @@ Empties the clipboard.
 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
 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,
 
 {\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
 
 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}
 
 
 \membersection{::wxGetClipboardData}
 


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


@@ -1108,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
 loaded from XPM file under other platforms.
 
 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}
 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
 
 \wxheading{Include files}


@@ -1190,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
 by wxWindows if necessary.
 
 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}
 \helpref{wxDDECleanUp}{wxddecleanup}.
 
 \wxheading{Include files}


@@ -1236,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}.
 
 \wxheading{Include files}
 \helpref{::wxSafeYield}{wxsafeyield}.
 
 \wxheading{Include files}


@@ -1339,23 +1462,28 @@ 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
 terminated successfully. Also, while waiting for the process to
 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
 $-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
 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.
+zero value indicates that the command could not be executed. As an added
+complication, the return value of $-1$ in this case indicattes that we didn't
+launch a new process, but connected to the running one (this can only happen in
+case of using DDE under Windows for command execution). In particular, in this,
+and only this, case the calling code will not get the notification about
+process termination.

 
 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
 the process finishes.
 
 Finally, you may use the third overloaded version of this function to execute
 \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.
 
 {\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}
 \helpref{Exec sample}{sampleexec}.
 
 \wxheading{Include files}


@@ -1397,7 +1525,7 @@ Find a menu item identifier associated with the given frame's menu bar.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxFindWindowByLabel}
+\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}

 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
 
 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
 


@@ -1425,6 +1553,20 @@ If no such named window is found, {\bf wxFindWindowByLabel} is called.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
+
+\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
+
+Find the deepest window at the given mouse position in screen coordinates,
+returning the window if found, or NULL if not.
+
+\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
+
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
+
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.
+

 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}
 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}


@@ -1471,9 +1613,9 @@ under Windows, Linux and Solaris.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxGetMousePosition}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}

 
 

-\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
+\func{wxPoint}{wxGetMousePosition}{\void}

 
 Returns the mouse position in screen coordinates.
 
 
 Returns the mouse position in screen coordinates.
 


@@ -1486,7 +1628,7 @@ Returns the mouse position in screen coordinates.
 \func{wxString}{wxGetOsDescription}{\void}
 
 Returns the string containing the description of the current platform in a
 \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}
 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
 
 \wxheading{See also}


@@ -1576,7 +1718,7 @@ Under Windows, this returns ``user''.
 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
 
 Returns the home directory for the given user. If the username is empty
 \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}
 \helpref{wxGetHomeDir}{wxgethomedir}.
 
 \wxheading{Include files}


@@ -1725,7 +1867,7 @@ uses internally).
 
 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
 
 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}.
 allowing the implementation of some limited user interaction.
 
 Returns the result of the call to \helpref{::wxYield}{wxyield}.


@@ -1913,7 +2055,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}
  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
 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}
 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
 
 \wxheading{Include files}


@@ -1949,10 +2091,10 @@ endian to big endian or vice versa.
 
 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
 
 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.
 
 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}
 data in little endian (Intel i386) format.
 
 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}


@@ -1967,10 +2109,10 @@ data in little endian (Intel i386) format.
 
 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
 
 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.
 
 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}
 data in big endian format.
 
 \membersection{CLASSINFO}\label{classinfo}


@@ -2190,7 +2332,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}
 
 \wxheading{Include files}
 \helpref{wxICON}{wxiconmacro}
 
 \wxheading{Include files}


@@ -2268,7 +2410,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}
 
 \wxheading{Include files}
 \helpref{wxBITMAP}{wxbitmapmacro}
 
 \wxheading{Include files}


@@ -2340,7 +2482,7 @@ loading from resource data.
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp

-\verb$#$defining a name to an integer). Unlikely to be used by an application except
+\tt{#}defining a name to an integer). Unlikely to be used by an application except

 perhaps for implementing resource functionality for interpreted languages.
 
 \membersection{::wxResourceClear}
 perhaps for implementing resource functionality for interpreted languages.
 
 \membersection{::wxResourceClear}


@@ -2506,7 +2648,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 \tt{#}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.
 
 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.
 


@@ -2615,13 +2757,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.
 
 The trace messages also usually can be separated into different categories and
 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
 {\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:
 
 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
 used by wxWindows are:
 


@@ -2664,8 +2806,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 
-{\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}
 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
 
 \wxheading{See also}


@@ -2677,10 +2819,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
 starting/stopping the global timers. Please note that the timer functions are
 
 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
 \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}
 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
 
 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}


@@ -2826,7 +2968,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).
 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).
 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}
 \helpref{wxCHECK\_RET}{wxcheckret}.
 
 \membersection{wxCHECK\_RET}\label{wxcheckret}


@@ -2836,15 +2978,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
 message in debug mode). This check is done even in release mode.
 
 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}}
 
 \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.
 
 \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.
 


@@ -2854,7 +2996,60 @@ 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
 instead of wxFAIL() if the {\it condition} is false.
 
 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
 instead of wxFAIL() if the {\it condition} is false.
 

+\section{Environment access functions}\label{environfunctions}
+
+The functions in this section allow to access (get) or change value of
+environment variables in a portable way. They are currently implemented under
+Win32 and POSIX-like systems (Unix).
+
+% TODO add some stuff about env var inheriting but not propagating upwards (VZ)
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{wxGetenv}\label{wxgetenvmacro}
+
+\func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
+
+This is a macro defined as {\tt getenv()} or its wide char version in Unicode
+mode.
+
+Note that under Win32 it may not return correct value for the variables set
+with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
+instead.
+
+\membersection{wxGetEnv}\label{wxgetenv}
+
+\func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
+
+Returns the current value of the environment variable {\it var} in {\it value}.
+{\it value} may be {\tt NULL} if you just want to know if the variable exists
+and are not interested in its value.
+
+Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise.
+
+\membersection{wxSetEnv}\label{wxsetenv}
+
+\func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
+
+Sets the value of the environment variable {\it var} (adding it if necessary)
+to {\it value}.
+
+Returns {\tt TRUE} on success.
+
+\membersection{wxUnsetEnv}\label{wxunsetenv}
+
+\func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
+
+Removes the variable {\it var} from the environment.
+\helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
+function.
+
+Returns {\tt TRUE} on success.
+
+