\section{File functions}\label{filefunctions}
-See also \helpref{wxPathList}{wxpathlist}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\wxheading{See also}
+
+\helpref{wxPathList}{wxpathlist}
\membersection{::wxDirExists}
\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
-Returns a temporary pointer to the filename for a full path.
-Copy this pointer for long-term use.
+\func{char*}{wxFileNameFromPath}{\param{char* }{path}}
+
+Returns the filename for a full path. The second form returns a pointer to
+temporary storage that should not be deallocated.
\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
-\func{wxString}{wxFindFirstFile}{\param{const wxString\& }{spec}, \param{int}{ flags = 0}}
+\func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}}
This function does directory searching; returns the first file
-that matches the path {\it spec}, or NULL. Use \helpref{wxFindNextFile}{wxfindnextfile} to
+that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
get the next matching file.
{\it spec} may contain wildcards.
{\it flags} is reserved for future use.
-The returned filename is a pointer to static memory so should
-not be freed.
-
For example:
\begin{verbatim}
wxString f = wxFindFirstFile("/home/project/*.*");
- while (f)
+ while ( !f.IsEmpty() )
{
...
f = wxFindNextFile();
\membersection{::wxFindNextFile}\label{wxfindnextfile}
-\func{wxString}{wxFindFirstFile}{\void}
+\func{wxString}{wxFindNextFile}{\void}
Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
+See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
+
+\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
+
+\func{wxString}{wxGetOSDirectory}{\void}
+
+Returns the Windows directory under Windows; on other platforms returns the empty string.
+
\membersection{::wxIsAbsolutePath}
\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
-Returns a temporary pointer to the directory part of the filename. Copy this
-pointer for long-term use.
+Returns the directory part of the filename.
\membersection{::wxUnix2DosFilename}
Copies {\it file1} to {\it file2}, returning TRUE if successful.
-\membersection{::wxGetHostName}\label{wxgethostname}
-
-\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int }{sz}}
-
-Copies the current host machine's name into the supplied buffer.
-
-Under Windows or NT, this function first looks in the environment
-variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file is tried.
-
-Returns TRUE if successful, FALSE otherwise.
-
-\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
-
-\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
-
-Copies the user's email address into the supplied buffer, by
-concatenating the values returned by \helpref{wxGetHostName}{wxgethostname}\rtfsp
-and \helpref{wxGetUserId}{wxgetuserid}.
+\membersection{::wxGetCwd}\label{wxgetcwd}
-Returns TRUE if successful, FALSE otherwise.
+\func{wxString}{wxGetCwd}{\void}
-\membersection{::wxGetUserId}\label{wxgetuserid}
-
-\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int }{sz}}
-
-Copies the current user id into the supplied buffer.
-
-Under Windows or NT, this function first looks in the environment
-variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file is tried.
-
-Returns TRUE if successful, FALSE otherwise.
-
-\membersection{::wxGetUserName}\label{wxgetusername}
-
-\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int }{sz}}
-
-Copies the current user name into the supplied buffer.
-
-Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
-is running, the entry {\bf Current} in the section {\bf User} of
-the PENWIN.INI file is used.
-
-Returns TRUE if successful, FALSE otherwise.
+Returns a string containing the current (or working) directory.
\membersection{::wxGetWorkingDirectory}
-\func{wxString}{wxGetWorkingDirectory}{\param{const wxString\& }{buf=NULL}, \param{int }{sz=1000}}
+\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+
+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)
\membersection{::wxGetTempFileName}
-\func{wxString}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{const wxString\& }{buf=NULL}}
+\func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
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
\membersection{::wxMkdir}
-\func{bool}{wxMkdir}{\param{const wxString\& }{dir}}
+\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
Makes the directory {\it dir}, returning TRUE if successful.
+{\it perm} is the access mask for the directory for the systems on which it is
+supported (Unix) and doesn't have effect for the other ones.
+
\membersection{::wxRemoveFile}
\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
Sets the current working directory, returning TRUE if the operation succeeded.
Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
+\membersection{::wxSplitPath}\label{wxsplitfunction}
+
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}}
+
+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
+a particular component.
+
+wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
+Windows, however it will not consider backslashes as path separators under Unix (where backslash
+is a valid character in a filename).
+
+On entry, {\it fullname} should be non NULL (it may be empty though).
+
+On return, {\it path} contains the file path (without the trailing separator), {\it name}
+contains the file name and {\it ext} contains the file extension without leading dot. All
+three of them may be empty if the corresponding component is. The old contents of the
+strings pointed to by these parameters will be overwritten in any case (if the pointers
+are not NULL).
+
+\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+
+\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+
+Copies the given file to {\it stream}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+Use of this function requires the file wx\_doc.h to be included.
+
+\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+
+\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+
+Copies the given stream to the file {\it filename}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+Use of this function requires the file wx\_doc.h to be included.
+
+\section{Network functions}\label{networkfunctions}
+
+\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
+
+\func{wxString}{wxGetFullHostName}{\void}
+
+Returns the FQDN (fully qualified domain host name) or an empty string on
+error.
+
+See also: \helpref{wxGetHostName}{wxgethostname}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+
+\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
+
+Copies the user's email address into the supplied buffer, by
+concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
+and \helpref{wxGetUserId}{wxgetuserid}.
+
+Returns TRUE if successful, FALSE otherwise.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetHostName}\label{wxgethostname}
+
+\func{wxString}{wxGetHostName}{\void}
+\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
+
+Copies the current host machine's name into the supplied buffer. Please note
+that the returned name is {\it not} fully qualified, i.e. it does not include
+the domain name.
+
+Under Windows or NT, this function first looks in the environment
+variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file is tried.
+
+The first variant of this function returns the hostname if successful or an
+empty string otherwise. The second (deprecated) function returns TRUE
+if successful, FALSE otherwise.
+
+See also: \helpref{wxGetFullHostName}{wxgetfullhostname}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\section{User identification}\label{useridfunctions}
+
+\membersection{::wxGetUserId}\label{wxgetuserid}
+
+\func{wxString}{wxGetUserId}{\void}
+\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
+
+This function returns the "user id" also known as "login name" under Unix i.e.
+something like "jsmith". It uniquely identifies the current user (on this system).
+
+Under Windows or NT, this function first looks in the environment
+variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file is tried.
+
+The first variant of this function returns the login name if successful or an
+empty string otherwise. The second (deprecated) function returns TRUE
+if successful, FALSE otherwise.
+
+See also: \helpref{wxGetUserName}{wxgetusername}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetUserName}\label{wxgetusername}
+
+\func{wxString}{wxGetUserName}{\void}
+\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
+
+This function returns the full user name (something like "Mr. John Smith").
+
+Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
+is running, the entry {\bf Current} in the section {\bf User} of
+the PENWIN.INI file is used.
+
+The first variant of this function returns the user name if successful or an
+empty string otherwise. The second (deprecated) function returns TRUE
+if successful, FALSE otherwise.
+
+See also: \helpref{wxGetUserId}{wxgetuserid}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\section{String functions}
\membersection{::copystring}
#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
\end{verbatim}
-\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+\membersection{::IsEmpty}\label{isempty}
-\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+\func{bool}{IsEmpty}{\param{const char *}{ p}}
-Copies the given file to {\it stream}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
+pointer to this function and it will return TRUE for it.
-Use of this function requires the file wx\_doc.h to be included.
+\membersection{::Stricmp}\label{stricmp}
-\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+\func{int}{Stricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
-\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+Returns a negative value, 0, or positive value if {\it p1} is less than, equal
+to or greater than {\it p2}. The comparison is case-insensitive.
-Copies the given stream to the file {\it filename}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+This function complements the standard C function {\it strcmp()} which performs
+case-sensitive comparison.
-Use of this function requires the file wx\_doc.h to be included.
+\membersection{::Strlen}\label{strlen}
+
+\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
+{\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
+\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
+message catalogs (see \helpref{i18n overview}{internationalization}), the
+original string is returned. In debug build, an error message is logged - this
+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().
\section{Dialog functions}\label{dialogfunctions}
\membersection{::wxFileSelector}\label{wxfileselector}
-\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = NULL},\\
- \param{const wxString\& }{default\_filename = NULL}, \param{const wxString\& }{default\_extension = NULL},\\
- \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
+\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}}
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.
The path and filename are distinct elements of a full file pathname.
-If path is NULL, the current directory will be used. If filename is NULL,
+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,
types of file with a description for each, such as:
\begin{verbatim}
- "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
\end{verbatim}
-The application must check for a NULL return value (the user pressed
+The application must check for an empty return value (the user pressed
Cancel). For example:
\begin{verbatim}
-const wxString\& s = wxFileSelector("Choose a file to open");
+const wxString& s = wxFileSelector("Choose a file to open");
if (s)
{
...
}
\end{verbatim}
-Remember that the returned pointer is temporary and should be copied
-if other wxWindows calls will be made before the value is to be used.
+\wxheading{Include files}
+
+<wx/filedlg.h>
\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
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,
-or press Cancel to return NULL.
+or press Cancel to return the empty string.
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/textdlg.h>
+
\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
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>
+
\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
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 NULL.
+Cancel to return the empty string.
{\it choices} is an array of {\it n} strings for the listbox.
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>
+
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
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>
+
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
As {\bf wxGetSingleChoice} but takes an array of client data pointers
corresponding to the strings, and returns one of these pointers.
+\wxheading{Include files}
+
+<wx/choicdlg.h>
+
\membersection{::wxMessageBox}\label{wxmessagebox}
\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
This is because the native MessageBox function cannot centre text.
The symbols are not shown when the generic function is used.
+\wxheading{Include files}
+
+<wx/msgdlg.h>
+
\section{GDI functions}\label{gdifunctions}
The following are relevant to the GDI (Graphics Device Interface).
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
\membersection{::wxColourDisplay}
\func{bool}{wxColourDisplay}{\void}
SetWindowExt(dc, maxX - minX, maxY - minY);
\end{verbatim}
-This simulates the MM\_TEXT mapping mode, which wxWindows assumes.
+This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
Placeable metafiles may be imported by many Windows applications, and can be
used in RTF (Rich Text Format) files.
The following functions are used to control PostScript printing. Under
Windows, PostScript output can only be sent to a file.
+\wxheading{Include files}
+
+<wx/dcps.h>
+
\membersection{::wxGetPrinterCommand}
\func{wxString}{wxGetPrinterCommand}{\void}
These clipboard functions are implemented for Windows only.
+\wxheading{Include files}
+
+<wx/clipbrd.h>
+
\membersection{::wxClipboardOpen}
\func{bool}{wxClipboardOpen}{\void}
\section{Miscellaneous functions}\label{miscellany}
-\membersection{::NewId}
+\membersection{::wxNewId}
-\func{long}{NewId}{\void}
+\func{long}{wxNewId}{\void}
Generates an integer identifier unique to this run of the program.
-\membersection{::RegisterId}
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxRegisterId}
-\func{void}{RegisterId}{\param{long}{ id}}
+\func{void}{wxRegisterId}{\param{long}{ id}}
Ensures that ids subsequently generated by {\bf NewId} do not clash with
the given {\bf id}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxBell}
\func{void}{wxBell}{\void}
Ring the system bell.
-\membersection{::wxCleanUp}\label{wxcleanup}
-
-\func{void}{wxCleanUp}{\void}
+\wxheading{Include files}
-Normally, wxWindows will call this cleanup function for you. However, if
-you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
-manually, then you should also call wxCleanUp before terminating wxWindows,
-if wxWindows does not get a chance to do it.
+<wx/utils.h>
\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
See also helpref{wxDDEInitialize}{wxddeinitialize}.
+\wxheading{Include files}
+
+<wx/dde.h>
+
\membersection{::wxDDEInitialize}\label{wxddeinitialize}
\func{void}{wxDDEInitialize}{\void}
See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
\helpref{wxDDECleanUp}{wxddecleanup}.
+\wxheading{Include files}
+
+<wx/dde.h>
+
\membersection{::wxDebugMsg}\label{wxdebugmsg}
\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxDisplaySize}
\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
Gets the physical size of the display in pixels.
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
\membersection{::wxEntry}\label{wxentry}
This initializes wxWindows in a platform-dependent way. Use this if you
are not using the default wxWindows entry code (e.g. main or WinMain). For example,
you can initialize wxWindows from an Microsoft Foundation Classes application using
-this function. See also \helpref{wxCleanUp}{wxcleanup}.
+this function.
\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
\param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
wxWindows initialization under Unix.
+\wxheading{Remarks}
+
+To clean up wxWindows, call wxApp::OnExit followed by the static function
+wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
+
+\begin{verbatim}
+int CTheApp::ExitInstance()
+{
+ // OnExit isn't called by CleanUp so must be called explicitly.
+ wxTheApp->OnExit();
+ wxApp::CleanUp();
+
+ return CWinApp::ExitInstance();
+}
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/app.h>
+
\membersection{::wxError}\label{wxerror}
\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
Unix, and pops up a message box under Windows. Used for internal
wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
\func{void}{wxEndBusyCursor}{\void}
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxExecute}\label{wxexecute}
\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
If {\it sync} is FALSE (the default), flow of control immediately returns.
If TRUE, the current application waits until the other program has terminated.
-If execution is asynchronous, the return value is the process id,
-otherwise it is a status value. A zero value indicates that the command could not
-be executed.
+In the case of synchronous execution, the return value is the exit code of
+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
+should ensure that this can cause no recursion, in the simples case by
+calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
+
+For asynchronous execution, however, the return value is the process id and
+zero value indicates that the command could not be executed.
-If callback isn't NULL and if execution is asynchronous,
+If callback isn't NULL and if execution is asynchronous (note that callback
+parameter can not be non NULL for synchronous execution),
\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
the process finishes.
See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxExit}\label{wxexit}
\func{void}{wxExit}{\void}
should be deleted (after deleting all other frames) to terminate the
application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
+\wxheading{Include files}
+
+<wx/app.h>
+
\membersection{::wxFatalError}\label{wxfatalerror}
\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
and pops up a message box under Windows. Used for fatal internal
wxWindows errors. See also \helpref{wxError}{wxerror}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxFindMenuItemId}
\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
Find a menu item identifier associated with the given frame's menu bar.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxFindWindowByLabel}
\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
The search is recursive in both cases.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
If no such named window is found, {\bf wxFindWindowByLabel} is called.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
\func{wxWindow *}{wxGetActiveWindow}{\void}
Gets the currently active window (Windows only).
+\wxheading{Include files}
+
+<wx/windows.h>
+
\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
\func{wxString}{wxGetDisplayName}{\void}
Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetHomeDir}
\func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
Fills the buffer with a string representing the user's home directory (Unix only).
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetHostName}
\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
successful. Under Unix, this will return a machine name. Under Windows,
this returns ``windows''.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
See also \helpref{wxTimer}{wxtimer}.
+\wxheading{Include files}
+
+<wx/timer.h>
+
\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
\func{long}{wxGetFreeMemory}{\void}
support it, and -1 if not supported. Currently, returns a positive value
under Windows, and -1 under Unix.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetMousePosition}
\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
Returns the mouse position in screen coordinates.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetOsVersion}
\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
\end{twocollist}
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetResource}\label{wxgetresource}
\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetUserId}
\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
Under Windows, this returns ``user''.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxGetUserName}
\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
Under Windows, this returns ``unknown''.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxKill}\label{wxkill}
\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
It does not raise a signal in the receiving process.
-\membersection{::wxInitClipboard}\label{wxinitclipboard}
+\wxheading{Include files}
-\func{void}{wxInitClipboard}{\void}
-
-Initializes the generic clipboard system by creating an instance of
-the class \helpref{wxClipboard}{wxclipboard}.
+<wx/utils.h>
\membersection{::wxIsBusy}\label{wxisbusy}
See also \helpref{wxBusyCursor}{wxbusycursor}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxLoadUserResource}\label{wxloaduserresource}
\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
This function is available under Windows only.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxNow}\label{wxnow}
\func{wxString}{wxNow}{\void}
Returns a string representing the current date and time.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxPostDelete}\label{wxpostdelete}
\func{void}{wxPostDelete}{\param{wxObject *}{object}}
-Under X, tells the system to delete the specified object when
+Tells the system to delete the specified object when
all other events have been processed. In some environments, it is
necessary to use this instead of deleting a frame directly with the
-delete operator, because X will still send events to the window.
+delete operator, because some GUIs will still send events to a deleted window.
Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxSafeYield}{wxsafeyield}
+
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+
+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,
+allowing the implementation of some limited user interaction.
+
+Returns the result of the call to \helpref{::wxYield}{wxyield}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxEnableTopLevelWindows}{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}}
See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxShell}\label{wxshell}
\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
See also \helpref{wxExecute}{wxexecute}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxSleep}\label{wxsleep}
\func{void}{wxSleep}{\param{int}{ secs}}
Sleeps for the specified number of seconds.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxStripMenuCodes}
\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
Menu codes include \& (mark the next character with an underline
as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxStartTimer}\label{wxstarttimer}
\func{void}{wxStartTimer}{\void}
See also \helpref{wxTimer}{wxtimer}.
+\wxheading{Include files}
+
+<wx/timer.h>
+
\membersection{::wxToLower}\label{wxtolower}
\func{char}{wxToLower}{\param{char }{ch}}
Converts the character to lower case. This is implemented as a macro for efficiency.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxToUpper}\label{wxtoupper}
\func{char}{wxToUpper}{\param{char }{ch}}
Converts the character to upper case. This is implemented as a macro for efficiency.
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxTrace}\label{wxtrace}
\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Include files}
+
+<wx/memory.h>
+
\membersection{::wxTraceLevel}\label{wxtracelevel}
\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxUsleep}\label{wxusleep}
+
+\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+
+Sleeps for the specified number of milliseconds. Notice that usage of this
+function is encouraged instead of calling usleep(3) directly because the
+standard usleep() function is not MT safe.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxWriteResource}\label{wxwriteresource}
\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
-\membersection{::wxYield}
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxYield}\label{wxyield}
\func{bool}{wxYield}{\void}
Caution should be exercised, however, since yielding may allow the
user to perform actions which are not compatible with the current task.
Disabling menu items or whole menus during processing can avoid unwanted
-reentrance of code.
+reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
+function.
+
+\wxheading{Include files}
+
+<wx/utils.h>
\section{Macros}\label{macros}
Returns a pointer to the wxClassInfo object associated with this class.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{WXDEBUG\_NEW}\label{debugnew}
\func{}{WXDEBUG\_NEW}{arg}
In non-debug mode, this is defined as the normal new operator.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{DECLARE\_ABSTRACT\_CLASS}
\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
};
\end{verbatim}
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{DECLARE\_APP}\label{declareapp}
\func{}{DECLARE\_APP}{className}
DECLARE_APP(MyApp)
\end{verbatim}
+\wxheading{Include files}
+
+<wx/app.h>
+
\membersection{DECLARE\_CLASS}
\func{}{DECLARE\_CLASS}{className}
made known to the class hierarchy, but objects of this class cannot be created
dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{DECLARE\_DYNAMIC\_CLASS}
\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
};
\end{verbatim}
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
}
\end{verbatim}
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_APP}\label{implementapp}
\func{}{IMPLEMENT\_APP}{className}
See also \helpref{DECLARE\_APP}{declareapp}.
+\wxheading{Include files}
+
+<wx/app.h>
+
\membersection{IMPLEMENT\_CLASS}
\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_CLASS2}
\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
class that has run-time type information and two base classes. The
same as IMPLEMENT\_ABSTRACT\_CLASS2.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
}
\end{verbatim}
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
can be created dynamically. Use this for classes derived from two
base classes.
+\wxheading{Include files}
+
+<wx/object.h>
+
\membersection{WXTRACE}\label{trace}
\func{}{WXTRACE}{formatString, ...}
This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Include files}
+
+<wx/memory.h>
+
\membersection{WXTRACELEVEL}\label{tracelevel}
\func{}{WXTRACELEVEL}{level, formatString, ...}
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Include files}
+
+<wx/memory.h>
+
\section{wxWindows resource functions}\label{resourcefuncs}
\overview{wxWindows resource system}{resourceformats}
See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
loading from resource data.
+{\bf Warning:} this needs updating for wxWindows 2.
+
\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
further information.
+\wxheading{Include files}
+
+<wx/log.h>
+
\membersection{::wxLogError}\label{wxlogerror}
\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
builds.
+\wxheading{Include files}
+
+<wx/debug.h>
+
\membersection{::wxOnAssert}\label{wxonassert}
\func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
This function may be redefined to do something non trivial and is called
whenever one of debugging macros fails (i.e. condition is false in an
-assertion). TODO: this should probably be an overridable in wxApp.
+assertion).
+% TODO: this should probably be an overridable in wxApp.
\membersection{wxASSERT}\label{wxassert}
\func{}{wxASSERT}{\param{}{condition}}
-Assert macro. An error message will be generated if the condition is FALSE.
+Assert macro. An error message will be generated if the condition is FALSE in
+debug mode, but nothing will be done in the release build.
+
+Please note that the condition in wxASSERT() should have no side effects
+because it will not be executed in release mode at all.
+
+See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
\membersection{wxASSERT\_MSG}\label{wxassertmsg}
Assert macro with message. An error message will be generated if the condition is FALSE.
+See also: \helpref{wxASSERT}{wxassert}
+
\membersection{wxFAIL}\label{wxfail}
-\func{}{wxFAIL}{\param{}{condition}}
+\func{}{wxFAIL}{\void}
Will always generate an assert error if this code is reached (in debug mode).
+See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
+
\membersection{wxFAIL\_MSG}\label{wxfailmsg}
-\func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
+\func{}{wxFAIL\_MSG}{\param{}{msg}}
Will always generate an assert error with specified message if this code is reached (in debug mode).
+This macro is useful for marking unreachable" code areas, for example
+it may be used in the "default:" branch of a switch statement if all possible
+cases are processed above.
+
+See also: \helpref{wxFAIL}{wxfail}
+
\membersection{wxCHECK}\label{wxcheck}
\func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
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
+\helpref{wxCHECK\_RET}{wxcheckret}.
+
+\membersection{wxCHECK\_RET}\label{wxcheckret}
+
+\func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
+
+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
+\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
+\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.
+
+This check is done even in release mode.
+
+\membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
+
+\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
+
+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.
+
projects / wxWidgets.git / blobdiff