\helpref{wxError}{wxerror}\\
\helpref{wxExecute}{wxexecute}\\
\helpref{wxExit}{wxexit}\\
+\helpref{wxEXPLICIT}{wxexplicit}\\
\helpref{wxFAIL\_MSG}{wxfailmsg}\\
\helpref{wxFAIL}{wxfail}\\
\helpref{wxFatalError}{wxfatalerror}\\
\helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
\helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
\helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
+\helpref{wxGetProcessId}{wxgetprocessid}\\
\helpref{wxGetResource}{wxgetresource}\\
\helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
For asynchronous execution, however, the return value is the process id and
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
+complication, the return value of $-1$ in this case indicates 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
\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
Equivalent to the Unix kill function: send the given signal {\it sig} to the
-process with PID {\it pid}. The valud signal values are
+process with PID {\it pid}. The valid signal values are
\begin{verbatim}
enum wxSignal
<wx/utils.h>
+\membersection{::wxGetProcessId}\label{wxgetprocessid}
+
+\func{unsigned long}{wxGetProcessId}{\void}
+
+Returns the number uniquely identifying the current process in the system.
+
+If an error occurs, $0$ is returned.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxShell}\label{wxshell}
\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
\func{char *}{wxFileNameFromPath}{\param{char *}{path}}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+
Returns the filename for a full path. The second form returns a pointer to
temporary storage that should not be deallocated.
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
+if it exists, but if {\it overwrite} is FALSE, the functions fails in this
case.
\membersection{::wxGetCwd}\label{wxgetcwd}
\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
-This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
Copies the current working directory into the buffer if supplied, or
copies the working directory into new storage (which you must delete yourself)
%%
%% It is the application's responsibility to create and delete the file.
-These functions are obsolete, please use\rtfsp
+{\bf NB:} These functions are obsolete, please use\rtfsp
\helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
instead.
\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+
This function splits a full file name into components: the path (including possible disk/drive
specification under Windows), the base name and the extension. Any of the output parameters
({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
\param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+{\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+
Returns {\tt TRUE} if the substring {\it s1} is found within {\it s2},
ignoring case if {\it exact} is FALSE. If {\it subString} is {\tt FALSE},
no substring matching is done.
-This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
-
\membersection{::wxStringEq}\label{wxstringeq}
\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
+
A macro defined as:
\begin{verbatim}
#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
\end{verbatim}
-This function is obsolete, use \helpref{wxString}{wxstring} instead.
-
\membersection{::wxStrlen}\label{wxstrlen}
\func{size\_t}{wxStrlen}{\param{const char *}{ p}}
Cancel). For example:
\begin{verbatim}
-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
+wxString filename = wxFileSelector("Choose a file to open");
+if ( !filename.empty() )
{
- ...
+ // work with the file
+ ...
}
+//else: cancelled by user
\end{verbatim}
\wxheading{Include files}
\section{Printer settings}\label{printersettings}
-These routines are obsolete and should no longer be used!
+{\bf NB:} These routines are obsolete and should no longer be used!
The following functions are used to control PostScript printing. Under
Windows, PostScript output can only be sent to a file.
\section{Miscellaneous functions}\label{miscellany}
+\membersection{wxEXPLICIT}\label{wxexplicit}
+
+{\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
+the compiler supports it or nothing otherwise. Thus, it can be used even in the
+code which might have to be compiled with an old compiler without support for
+this language feature but still take advantage of it when it is available.
+
\membersection{::wxNewId}\label{wxnewid}
\func{long}{wxNewId}{\void}
\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
+
Find a window by its label. Depending on the type of window, the label may be a window title
or panel item label. If {\it parent} is NULL, the search will start from all top-level
frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
+
Find a window by its name (as given in a window constructor or {\bf Create} function call).
If {\it parent} is NULL, the search will start from all top-level
frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
-This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
Strips any menu codes from {\it in} and places the result
wxWindows uses its own RTTI ("run-time type identification") system which
predates the current standard C++ RTTI and so is kept for backwards
-compatribility reasons but also because it allows some things which the
+compatibility reasons but also because it allows some things which the
standard RTTI doesn't directly support (such as creating a class from its
name).
\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log
+functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
Display a debugging message; under Windows, this will appear on the
debugger command window, and under Unix, it will be written to standard
(at least for Watcom C++): preformat your messages and use OutputDebugString
instead.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
\wxheading{Include files}
<wx/utils.h>
\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
-This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
+{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
instead.
Displays {\it msg} and continues. This writes to standard error under
\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
-This function is now obsolete, please use
+{\bf NB:} This function is now obsolete, please use
\helpref{wxLogFatalError}{wxlogfatalerror} instead.
Displays {\it msg} and exits. This writes to standard error under Unix,
\func{}{WXTRACE}{formatString, ...}
+{\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
Calls wxTrace with printf-style variable argument syntax. Output
is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
\wxheading{Include files}
<wx/memory.h>
\func{}{WXTRACELEVEL}{level, formatString, ...}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
Calls wxTraceLevel with printf-style variable argument syntax. Output
is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
The first argument should be the level at which this information is appropriate.
It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
this value.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
\wxheading{Include files}
<wx/memory.h>
\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
Takes printf-style variable argument syntax. Output
is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
\wxheading{Include files}
<wx/memory.h>
\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
Takes printf-style variable argument syntax. Output
is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
The first argument should be the level at which this information is appropriate.
It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
this value.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
\wxheading{Include files}
<wx/memory.h>
\membersection{::wxOnAssert}\label{wxonassert}
-\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
This function is called whenever one of debugging macros fails (i.e. condition
is false in an assertion). It is only defined in the debug mode, in release
the {\it msg} identifier - please note that it must be a valid C++ identifier
and not a string unlike in the other cases.
-This macro is mostly useful for testing the expressions involing the
+This macro is mostly useful for testing the expressions involving the
{\tt sizeof} operator as they can't be tested by the preprocessor but it is
sometimes desirable to test them at the compile time.
projects / wxWidgets.git / blobdiff