Documented wxStopWatch and wxToolBar::AddControl().

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 788836a1a7b2dc8b7b11ea2f397313a2763ecc74..f522dc3be33cdedc06b1782e07b21ab4c1688519 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -31,7 +31,8 @@ slashes.
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 

-Returns TRUE if the file exists.
+Returns TRUE if the file exists. It also returns TRUE if the file is
+a directory.

 
 \membersection{::wxFileNameFromPath}
 
 
 \membersection{::wxFileNameFromPath}
 


@@ -48,11 +49,12 @@ temporary storage that should not be deallocated.
 
 This function does directory searching; returns the first file
 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
 
 This function does directory searching; returns the first file
 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to

-get the next matching file.
+get the next matching file. Neither will report the current directory "." or the
+parent directory "..".

 
 {\it spec} may contain wildcards.
 
 
 {\it spec} may contain wildcards.
 

-{\it flags} is reserved for future use.
+{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.

 
 For example:
 
 
 For example:
 


@@ -79,6 +81,17 @@ See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
 
 Returns the Windows directory under Windows; on other platforms returns the empty string.
 
 
 Returns the Windows directory under Windows; on other platforms returns the empty string.
 

+\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+
+\func{void}{wxInitAllImageHandlers}{\void}
+
+Adds some common image format handlers, which, depending on wxWindows
+configuration, can be handlers for BMP (loading) (always installed), GIF
+(loading), PCX (loading), PNM (loading and saving as raw
+rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
+
+See also: \helpref{wxImage}{wximage} \helpref{wxImageHandler}{wximagehandler}
+

 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}


@@ -135,6 +148,8 @@ if the buffer is NULL.
 
 \func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
 
 
 \func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
 

+\func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
+

 Makes a temporary filename based on {\it prefix}, opens and closes the file,
 and places the name in {\it buf}. If {\it buf} is NULL, new store
 is allocated for the temporary filename using {\it new}.
 Makes a temporary filename based on {\it prefix}, opens and closes the file,
 and places the name in {\it buf}. If {\it buf} is NULL, new store
 is allocated for the temporary filename using {\it new}.


@@ -397,6 +412,33 @@ should help to find the strings which were not yet translated. As this function
 is used very often, an alternative syntax is provided: the \_() macro is
 defined as wxGetTranslation().
 
 is used very often, an alternative syntax is provided: the \_() macro is
 defined as wxGetTranslation().
 

+\membersection{::wxSnprintf}\label{wxsnprintf}
+
+\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
+
+This function replaces the dangerous standard function {\tt sprintf()} and is
+like {\tt snprintf()} available on some platforms. The only difference with
+sprintf() is that an additional argument - buffer size - is taken and the
+buffer is never overflowed.
+
+Returns the number of characters copied to the buffer or -1 if there is not
+enough space.
+
+\wxheading{See also:}
+\helpref{wxVsnprintf}{wxvsnprintf},
+\helpref{wxString::Printf}{wxstringprintf}
+
+\membersection{::wxVsnprintf}\label{wxsnprintf}
+
+\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
+
+The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
+argument instead of arbitrary number of parameters.
+
+\wxheading{See also:}
+\helpref{wxSnprintf}{wxsnprintf},
+\helpref{wxString::PrintfV}{wxstringprintfv}
+

 \section{Dialog functions}\label{dialogfunctions}
 
 Below are a number of convenience functions for getting input from the
 \section{Dialog functions}\label{dialogfunctions}
 
 Below are a number of convenience functions for getting input from the


@@ -407,16 +449,15 @@ the front when the dialog box is popped up.
 
 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
 
 
 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
 

-\func{wxTipProvider *}{wxCreateFileTipProvider}{
-    \param{const wxString\& }{filename},
-    \param{size\_t }{currentTip}}
+\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
+ \param{size\_t }{currentTip}}

 
 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
 used with \helpref{wxShowTip}{wxshowtip}.
 
 \docparam{filename}{The name of the file containing the tips, one per line}
 \docparam{currentTip}{The index of the first tip to show - normally this index
 
 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
 used with \helpref{wxShowTip}{wxshowtip}.
 
 \docparam{filename}{The name of the file containing the tips, one per line}
 \docparam{currentTip}{The index of the first tip to show - normally this index

-    is remembered between the 2 program runs.}
+is remembered between the 2 program runs.}

 
 \wxheading{See also:}
 
 
 \wxheading{See also:}
 


@@ -429,9 +470,9 @@ used with \helpref{wxShowTip}{wxshowtip}.
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\

-  \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
-  \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
-  \param{int}{ x = -1}, \param{int}{ y = -1}}
+ \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
+ \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1}}

 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.
 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.


@@ -440,18 +481,15 @@ If path is empty, the current directory will be used. If filename is empty,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant
-at present in Windows.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxMULTIPLE or 0.

 
 

-Both the X and Windows versions implement a wildcard filter. Typing a
+Both the Unix and Windows versions implement a wildcard filter. Typing a

 filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being
 filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being

-displayed. In the X version, supplying no default name will result in the
-wildcard filter being inserted in the filename text item; the filter is
-ignored if a default name is supplied.
+displayed.

 
 

-Under Windows (only), the wildcard may be a specification for multiple
-types of file with a description for each, such as:
+The wildcard may be a specification for multiple types of file 
+with a description for each, such as:

 
 \begin{verbatim}
  "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
 
 \begin{verbatim}
  "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"


@@ -475,14 +513,14 @@ if (s)
 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{
 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{

-    \param{const wxString\& }{message},
-    \param{const wxString\& }{prompt},
-    \param{const wxString\& }{caption},
-    \param{long }{value},
-    \param{long }{min = 0},
-    \param{long }{max = 100},
-    \param{wxWindow *}{parent = NULL},
-    \param{const wxPoint\& }{pos = wxDefaultPosition}}
+ \param{const wxString\& }{message},
+ \param{const wxString\& }{prompt},
+ \param{const wxString\& }{caption},
+ \param{long }{value},
+ \param{long }{min = 0},
+ \param{long }{max = 100},
+ \param{wxWindow *}{parent = NULL},
+ \param{const wxPoint\& }{pos = wxDefaultPosition}}

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


@@ -502,8 +540,8 @@ Dialog is centered on its {\it parent} unless an explicit position is given in
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\

-  \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
-  \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}

 
 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
 \rtfsp{\it default\_value}.  The user may type in text and press OK to return this text,
 
 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
 \rtfsp{\it default\_value}.  The user may type in text and press OK to return this text,


@@ -519,9 +557,9 @@ is centred; if FALSE, the message is left-justified.
 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
 
 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
 
 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\

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

 
 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
 listbox. The user may choose one or more item(s) and press OK or Cancel.
 
 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
 listbox. The user may choose one or more item(s) and press OK or Cancel.


@@ -545,8 +583,8 @@ is centred; if FALSE, the message is left-justified.
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \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}}
+ \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
 
 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


@@ -564,8 +602,8 @@ is centred; if FALSE, the message is left-justified.
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\

-  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
-  \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+ \param{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.
 
 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
 If the user pressed cancel, -1 is returned.


@@ -577,8 +615,8 @@ If the user pressed cancel, -1 is returned.
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \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}}
+ \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
 corresponding to the strings, and returns one of these pointers.
 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers
 corresponding to the strings, and returns one of these pointers.


@@ -590,7 +628,7 @@ corresponding to the strings, and returns one of these pointers.
 \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},\\

-  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}

 
 General purpose message dialog.  {\it style} may be a bit list of the
 following identifiers:
 
 General purpose message dialog.  {\it style} may be a bit list of the
 following identifiers:


@@ -635,22 +673,20 @@ The symbols are not shown when the generic function is used.
 
 \membersection{::wxShowTip}\label{wxshowtip}
 
 
 \membersection{::wxShowTip}\label{wxshowtip}
 

-\func{bool}{wxShowTip}{
-    \param{wxWindow *}{parent},
-    \param{wxTipProvider *}{tipProvider},
-    \param{bool }{showAtStartup = TRUE}}
+\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
+ \param{wxTipProvider *}{tipProvider},
+ \param{bool }{showAtStartup = TRUE}}

 
 This function shows a "startup tip" to the user.
 
 \docparam{parent}{The parent window for the modal dialog}
 
 \docparam{tipProvider}{An object which is used to get the text of the tips.
 
 This function shows a "startup tip" to the user.
 
 \docparam{parent}{The parent window for the modal dialog}
 
 \docparam{tipProvider}{An object which is used to get the text of the tips.

-    It may be created with 
-    \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}

 
 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
 
 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE

-    otherwise. This is used as the initial value for "Show tips at startup"
-    checkbox which is shown in the tips dialog.}
+otherwise. This is used as the initial value for "Show tips at startup"
+checkbox which is shown in the tips dialog.}

 
 \wxheading{See also:}
 
 
 \wxheading{See also:}
 


@@ -826,7 +862,9 @@ 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.
+These clipboard functions are implemented for Windows only. The use of these functions
+is drepated and the code no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
+class instead.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1015,6 +1053,8 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 

+{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+

 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard
 error.
 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard
 error.


@@ -1022,10 +1062,6 @@ error.
 The syntax is identical to {\bf printf}: pass a format string and a
 variable list of arguments.
 
 The syntax is identical to {\bf printf}: pass a format string and a
 variable list of arguments.
 

-Note that under Windows, you can see the debugging messages without a
-debugger if you have the DBWIN debug log application that comes with
-Microsoft C++.
-

 {\bf Tip:} under Windows, if your application crashes before the
 message appears in the debugging window, put a wxYield call after
 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
 {\bf Tip:} under Windows, if your application crashes before the
 message appears in the debugging window, put a wxYield call after
 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s


@@ -1048,6 +1084,17 @@ Gets the physical size of the display in pixels.
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
+
+\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
+
+This function enables or disables all top level windows. It is used by
+\helpref{::wxSafeYield}{wxsafeyield}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxEntry}\label{wxentry}
 
 This initializes wxWindows in a platform-dependent way. Use this if you
 \membersection{::wxEntry}\label{wxentry}
 
 This initializes wxWindows in a platform-dependent way. Use this if you


@@ -1091,26 +1138,26 @@ int CTheApp::ExitInstance()
 
 <wx/app.h>
 
 
 <wx/app.h>
 

-\membersection{::wxError}\label{wxerror}
+\membersection{::wxEndBusyCursor}\label{wxendbusycursor}

 
 

-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+\func{void}{wxEndBusyCursor}{\void}

 
 

-Displays {\it msg} and continues. This writes to standard error under
-Unix, and pops up a message box under Windows. Used for internal
-wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
+Changes the cursor back to the original cursor, for all windows in the application.
+Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.

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

-\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
-
-\func{void}{wxEndBusyCursor}{\void}
+\membersection{::wxError}\label{wxerror}

 
 

-Changes the cursor back to the original cursor, for all windows in the application.
-Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}

 
 

-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+Displays {\it msg} and continues. This writes to standard error under
+Unix, and pops up a message box under Windows. Used for internal
+wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1455,6 +1502,30 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxPostEvent}\label{wxpostevent}
+
+\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
+
+This function posts the event to the specified {\it dest} object. The
+difference between sending an event and posting it is that in the first case
+the event is processed before the function returns (in wxWindows, event sending
+is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
+the second, the function returns immediately and the event will be processed
+sometime later - usually during the next even loop iteration.
+
+Note that a copy of the {\it event} is made by the function, so the original
+copy can be deleted as soon as function returns. This function can also be used
+to send events between different threads safely. As this function makes a
+copy of the event, the event needs to have a fully implemented Clone() method,
+which may not be the case for all event in wxWindows.
+
+See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
+uses internally).
+
+\wxheading{Include files}
+
+<wx/app.h>
+

 \membersection{::wxSafeYield}\label{wxsafeyield}
 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
 \membersection{::wxSafeYield}\label{wxsafeyield}
 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}


@@ -1470,18 +1541,6 @@ Returns the result of the call to \helpref{::wxYield}{wxyield}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
-
-\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
-
-This function enables or disables all top level windows. It is used by
-\helpref{::wxSafeYield}{wxsafeyield}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-

 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
 
 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
 
 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}


@@ -1657,7 +1716,22 @@ function.
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/utils.h>
+<wx/app.h> or <wx/utils.h>
+
+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
+
+\func{void}{wxWakeUpIdle}{\void}
+
+This functions wakes up the (internal and platform dependent) idle system, i.e. it
+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 
+\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
+
+\wxheading{Include files}
+
+<wx/app.h>

 
 \section{Macros}\label{macros}
 
 
 \section{Macros}\label{macros}
 


@@ -1919,6 +1993,23 @@ base classes.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+\membersection{wxBITMAP}\label{wxbitmapmacro}
+
+\func{}{wxBITMAP}{bitmapName}
+
+This macro loads a bitmap from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating bitmaps.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview}, 
+\helpref{wxICON}{wxiconmacro}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+

 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}
 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}


@@ -1966,6 +2057,23 @@ Example:
 
 \helpref{RTTI overview}{runtimeclassoverview}
 
 
 \helpref{RTTI overview}{runtimeclassoverview}
 

+\membersection{wxICON}\label{wxiconmacro}
+
+\func{}{wxICON}{iconName}
+
+This macro loads an icon from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating icons.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview}, 
+\helpref{wxBITMAP}{wxbitmapmacro}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+

 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}
 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}


@@ -2199,7 +2307,9 @@ Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for

-further information.
+further information. The functions use (implicitly) the currently active log
+target, so their descriptions here may not apply if the log target is not the
+standard one (installed by wxWindows in the beginning of the program).

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -2209,9 +2319,9 @@ further information.
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
 

-The function to use for error messages, i.e. the
-messages that must be shown to the user. The default processing is to pop up a
-message box to inform the user about it.
+The function to use for error messages, i.e. the messages that must be shown
+to the user. The default processing is to pop up a message box to inform the
+user about it.

 
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 
 
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 


@@ -2225,18 +2335,18 @@ function also terminates the program with this exit code.
 
 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
 

-For warnings - they are also normally shown to the
-user, but don't interrupt the program work.
+For warnings - they are also normally shown to the user, but don't interrupt
+the program work.

 
 \membersection{::wxLogMessage}\label{wxlogmessage}
 
 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogMessage}\label{wxlogmessage}
 
 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
 

-for all normal, informational messages. They also
-appear in a message box by default (but it can be changed). Notice
-that the standard behaviour is to not show informational messages if there are
-any errors later - the logic being that the later error messages make the
-informational messages preceding them meaningless.
+for all normal, informational messages. They also appear in a message box by
+default (but it can be changed). Notice that the standard behaviour is to not
+show informational messages if there are any errors later - the logic being
+that the later error messages make the informational messages preceding them
+meaningless.

 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 
 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 


@@ -2248,48 +2358,79 @@ progress (another, but possibly confusing name for the same function is {\bf wxL
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 

+\func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
+

 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
 
 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
 

-For status messages - they will go into the status
-bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
+Messages logged by this function will appear in the statusbar of the {\it
+frame} or of the top level application window by default (i.e. when using
+the second version of the function).
+
+If the target frame doesn't have a statusbar, the message will be lost.

 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
 

-Mostly used by wxWindows itself, but might be
-handy for logging errors after system call (API function) failure. It logs the
-specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
-on the platform) and the corresponding error
-message. The second form of this function takes the error code explitly as the
-first argument.
+Mostly used by wxWindows itself, but might be handy for logging errors after
+system call (API function) failure. It logs the specified message text as well
+as the last system error code ({\it errno} or {\it ::GetLastError()} depending
+on the platform) and the corresponding error message. The second form
+of this function takes the error code explitly as the first argument.

 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 
 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 
 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
 

-The right function for debug output. It only
-does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
-and expands to nothing in release mode (otherwise).
+The right function for debug output. It only does anything at all in the debug
+mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
+nothing in release mode (otherwise).

 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 
 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 
 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
 

-\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
+
+As {\bf wxLogDebug}, trace functions only do something in debug build and
+expand to nothing in the release one. The reason for making
+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
+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 
+\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
+used by wxWindows are:
+
+\begin{itemize}\itemsep=0pt
+\item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
+\item wxTRACE\_Messages: trace window messages/X callbacks
+\item wxTRACE\_ResAlloc: trace GDI resource allocation
+\item wxTRACE\_RefCount: trace various ref counting operations
+\item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
+\end{itemize}

 
 

-As {\bf wxLogDebug}, only does something in debug
-build. The reason for making 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 which would be flooded in them. Moreover, the second
-version of this function takes a trace mask as the first argument which allows
-to further restrict the amount of messages generated. The value of {\it mask} can be:
+The third version of the function only logs the message if all the bit
+corresponding to the {\it mask} are set in the wxLog trace mask which can be
+set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
+flexible than the previous one because it doesn't allow defining the user
+trace masks easily - this is why it is deprecated in favour of using string
+trace masks.

 
 \begin{itemize}\itemsep=0pt
 \item wxTraceMemAlloc: trace memory allocation (new/delete)
 \item wxTraceMessages: trace window messages/X callbacks
 \item wxTraceResAlloc: trace GDI resource allocation
 \item wxTraceRefCount: trace various ref counting operations
 
 \begin{itemize}\itemsep=0pt
 \item wxTraceMemAlloc: trace memory allocation (new/delete)
 \item wxTraceMessages: trace window messages/X callbacks
 \item wxTraceResAlloc: trace GDI resource allocation
 \item wxTraceRefCount: trace various ref counting operations

+\item wxTraceOleCalls: trace OLE method calls (Win32 only)

 \end{itemize}
 
 \section{Debugging macros and functions}\label{debugmacros}
 \end{itemize}
 
 \section{Debugging macros and functions}\label{debugmacros}