1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions and macros defined in wxWindows are described here.
7 \section{Version macros
}\label{versionfunctions
}
9 The following constants are defined in wxWindows:
11 \begin{itemize
}\itemsep=
0pt
12 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWindows
13 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWindows
14 \item {\tt wxRELASE
\_NUMBER} is the release number
17 For example, the values or these constants for wxWindows
2.1.15 are
2,
1 and
20 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
21 the full wxWindows version and
{\tt wxVERSION
\_NUMBER} is a combination of the
22 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
25 \wxheading{Include files
}
27 <wx/version.h> or <wx/defs.h>
29 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
31 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
33 This is a macro which evaluates to true if the current wxWindows version is at
34 least major.minor.release.
36 For example, to test if the program is compiled with wxWindows
2.2 or higher,
37 the following can be done:
41 #if wxCHECK_VERSION(
2,
2,
0)
42 if ( s.StartsWith("foo") )
43 #else // replacement code for old version
44 if ( strncmp(s, "foo",
3) ==
0 )
51 \section{Thread functions
}\label{threadfunctions
}
53 \wxheading{Include files
}
59 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
61 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
63 \func{void
}{wxMutexGuiEnter
}{\void}
65 This function must be called when any thread other than the main GUI thread
66 wants to get access to the GUI library. This function will block the execution
67 of the calling thread until the main thread (or any other thread holding the
68 main GUI lock) leaves the GUI library and no other thread will enter the GUI
69 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
71 Typically, these functions are used like this:
74 void MyThread::Foo(void)
76 // before doing any GUI calls we must ensure that this thread is the only
82 my_window->DrawSomething();
88 Note that under GTK, no creation of top-level windows is allowed in any
89 thread but the main one.
91 This function is only defined on platforms which support preemptive
94 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
96 \func{void
}{wxMutexGuiLeave
}{\void}
98 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
100 This function is only defined on platforms which support preemptive
103 \section{File functions
}\label{filefunctions
}
105 \wxheading{Include files
}
111 \helpref{wxPathList
}{wxpathlist
},
\helpref{wxDir
}{wxdir
},
\helpref{wxFile
}{wxfile
}
113 \membersection{::wxDirExists
}
115 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
117 Returns TRUE if the directory exists.
119 \membersection{::wxDos2UnixFilename
}
121 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
123 Converts a DOS to a Unix filename by replacing backslashes with forward
126 \membersection{::wxFileExists
}
128 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
130 Returns TRUE if the file exists. It also returns TRUE if the file is
133 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
135 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
137 Returns time of last modification of given file.
139 \membersection{::wxFileNameFromPath
}
141 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
143 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
145 Returns the filename for a full path. The second form returns a pointer to
146 temporary storage that should not be deallocated.
148 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
150 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
152 This function does directory searching; returns the first file
153 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
154 get the next matching file. Neither will
report the current directory "." or the
155 parent directory "..".
157 {\it spec
} may contain wildcards.
159 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
164 wxString f = wxFindFirstFile("/home/project/*.*");
165 while ( !f.IsEmpty() )
168 f = wxFindNextFile();
172 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
174 \func{wxString
}{wxFindNextFile
}{\void}
176 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
178 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
180 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
182 \func{wxString
}{wxGetOSDirectory
}{\void}
184 Returns the Windows directory under Windows; on other platforms returns the empty string.
186 \membersection{::wxIsAbsolutePath
}
188 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
190 Returns TRUE if the argument is an absolute filename, i.e. with a slash
191 or drive name at the beginning.
193 \membersection{::wxPathOnly
}
195 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
197 Returns the directory part of the filename.
199 \membersection{::wxUnix2DosFilename
}
201 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
203 Converts a Unix to a DOS filename by replacing forward
204 slashes with backslashes.
206 \membersection{::wxConcatFiles
}
208 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
209 \param{const wxString\&
}{file3
}}
211 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
214 \membersection{::wxCopyFile
}
216 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = TRUE
}}
218 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful. If
219 {\it overwrite
} parameter is TRUE (default), the destination file is overwritten
220 if it exists, but if
{\it overwrite
} is FALSE, the functions failes in this
223 \membersection{::wxGetCwd
}\label{wxgetcwd
}
225 \func{wxString
}{wxGetCwd
}{\void}
227 Returns a string containing the current (or working) directory.
229 \membersection{::wxGetWorkingDirectory
}
231 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
233 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
235 Copies the current working directory into the buffer if supplied, or
236 copies the working directory into new storage (which you must delete yourself)
237 if the buffer is NULL.
239 {\it sz
} is the size of the buffer if supplied.
241 \membersection{::wxGetTempFileName
}
243 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
245 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
247 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
248 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
249 is allocated for the temporary filename using
{\it new
}.
251 Under Windows, the filename will include the drive and name of the
252 directory allocated for temporary files (usually the contents of the
253 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
255 It is the application's responsibility to create and delete the file.
257 \membersection{::wxIsWild
}\label{wxiswild
}
259 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
261 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
263 \membersection{::wxMatchWild
}\label{wxmatchwild
}
265 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
267 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
268 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
269 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
271 \membersection{::wxMkdir
}
273 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
275 Makes the directory
{\it dir
}, returning TRUE if successful.
277 {\it perm
} is the access mask for the directory for the systems on which it is
278 supported (Unix) and doesn't have effect for the other ones.
280 \membersection{::wxRemoveFile
}
282 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
284 Removes
{\it file
}, returning TRUE if successful.
286 \membersection{::wxRenameFile
}
288 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
290 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
292 \membersection{::wxRmdir
}
294 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
296 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
298 The
{\it flags
} parameter is reserved for future use.
300 \membersection{::wxSetWorkingDirectory
}
302 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
304 Sets the current working directory, returning TRUE if the operation succeeded.
305 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
307 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
309 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{wxString *
}{ path
},
\param{wxString *
}{ name
},
\param{wxString *
}{ ext
}}
311 This function splits a full file name into components: the path (including possible disk/drive
312 specification under Windows), the base name and the extension. Any of the output parameters
313 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
314 a particular component.
316 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
317 Windows, however it will not consider backslashes as path separators under Unix (where backslash
318 is a valid character in a filename).
320 On entry,
{\it fullname
} should be non-NULL (it may be empty though).
322 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
323 contains the file name and
{\it ext
} contains the file extension without leading dot. All
324 three of them may be empty if the corresponding component is. The old contents of the
325 strings pointed to by these parameters will be overwritten in any case (if the pointers
328 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
330 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
332 Copies the given file to
{\it stream
}. Useful when converting an old application to
333 use streams (within the
document/view framework, for example).
335 Use of this function requires the file wx
\_doc.h to be included.
337 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
339 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
341 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
342 use streams (within the
document/view framework, for example).
344 Use of this function requires the file wx
\_doc.h to be included.
346 \section{Network functions
}\label{networkfunctions
}
348 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
350 \func{wxString
}{wxGetFullHostName
}{\void}
352 Returns the FQDN (fully qualified domain host name) or an empty string on
357 \helpref{wxGetHostName
}{wxgethostname
}
359 \wxheading{Include files
}
363 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
365 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
367 Copies the user's email address into the supplied buffer, by
368 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
369 and
\helpref{wxGetUserId
}{wxgetuserid
}.
371 Returns TRUE if successful, FALSE otherwise.
373 \wxheading{Include files
}
377 \membersection{::wxGetHostName
}\label{wxgethostname
}
379 \func{wxString
}{wxGetHostName
}{\void}
381 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
383 Copies the current host machine's name into the supplied buffer. Please note
384 that the returned name is
{\it not
} fully qualified, i.e. it does not include
387 Under Windows or NT, this function first looks in the environment
388 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
389 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
391 The first variant of this function returns the hostname if successful or an
392 empty string otherwise. The second (deprecated) function returns TRUE
393 if successful, FALSE otherwise.
397 \helpref{wxGetFullHostName
}{wxgetfullhostname
}
399 \wxheading{Include files
}
403 \section{User identification
}\label{useridfunctions
}
405 \membersection{::wxGetUserId
}\label{wxgetuserid
}
407 \func{wxString
}{wxGetUserId
}{\void}
409 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
411 This function returns the "user id" also known as "login name" under Unix i.e.
412 something like "jsmith". It uniquely identifies the current user (on this system).
414 Under Windows or NT, this function first looks in the environment
415 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
416 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
418 The first variant of this function returns the login name if successful or an
419 empty string otherwise. The second (deprecated) function returns TRUE
420 if successful, FALSE otherwise.
424 \helpref{wxGetUserName
}{wxgetusername
}
426 \wxheading{Include files
}
430 \membersection{::wxGetUserName
}\label{wxgetusername
}
432 \func{wxString
}{wxGetUserName
}{\void}
434 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
436 This function returns the full user name (something like "Mr. John Smith").
438 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
439 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
440 is running, the entry
{\bf Current
} in the section
{\bf User
} of
441 the PENWIN.INI file is used.
443 The first variant of this function returns the user name if successful or an
444 empty string otherwise. The second (deprecated) function returns TRUE
445 if successful, FALSE otherwise.
449 \helpref{wxGetUserId
}{wxgetuserid
}
451 \wxheading{Include files
}
455 \section{String functions
}
457 \membersection{::copystring
}
459 \func{char*
}{copystring
}{\param{const char*
}{s
}}
461 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
462 deleted with the
{\it delete
} operator.
464 \membersection{::wxStringMatch
}
466 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
467 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
469 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
470 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
471 no substring matching is done.
473 \membersection{::wxStringEq
}\label{wxstringeq
}
475 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
480 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
483 \membersection{::IsEmpty
}\label{isempty
}
485 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
487 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
488 pointer to this function and it will return TRUE for it.
490 \membersection{::Stricmp
}\label{stricmp
}
492 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
494 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
495 to or greater than
{\it p2
}. The comparison is case-insensitive.
497 This function complements the standard C function
{\it strcmp()
} which performs
498 case-sensitive comparison.
500 \membersection{::Strlen
}\label{strlen
}
502 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
504 This is a safe version of standard function
{\it strlen()
}: it does exactly the
505 same thing (i.e. returns the length of the string) except that it returns
0 if
506 {\it p
} is the NULL pointer.
508 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
510 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
512 This function returns the translation of string
{\it str
} in the current
513 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
514 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
515 original string is returned. In debug build, an error message is logged - this
516 should help to find the strings which were not yet translated. As this function
517 is used very often, an alternative syntax is provided: the
\_() macro is
518 defined as wxGetTranslation().
520 \membersection{::wxSnprintf
}\label{wxsnprintf
}
522 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
524 This function replaces the dangerous standard function
{\tt sprintf()
} and is
525 like
{\tt snprintf()
} available on some platforms. The only difference with
526 sprintf() is that an additional argument - buffer size - is taken and the
527 buffer is never overflowed.
529 Returns the number of characters copied to the buffer or -
1 if there is not
534 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
536 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
538 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argptr
}}
540 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list}
541 argument instead of arbitrary number of parameters.
545 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
547 \section{Dialog functions
}\label{dialogfunctions
}
549 Below are a number of convenience functions for getting input from the
550 user or displaying messages. Note that in these functions the last three
551 parameters are optional. However, it is recommended to pass a parent frame
552 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
553 the front when the dialog box is popped up.
555 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
557 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
558 \param{size
\_t }{currentTip
}}
560 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
561 used with
\helpref{wxShowTip
}{wxshowtip
}.
563 \docparam{filename
}{The name of the file containing the tips, one per line
}
564 \docparam{currentTip
}{The index of the first tip to show - normally this index
565 is remembered between the
2 program runs.
}
569 \helpref{Tips overview
}{tipsoverview
}
571 \wxheading{Include files
}
575 \membersection{::wxFileSelector
}\label{wxfileselector
}
577 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
578 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
579 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
580 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
582 Pops up a file selector box. In Windows, this is the common file selector
583 dialog. In X, this is a file selector box with the same functionality.
584 The path and filename are distinct elements of a full file pathname.
585 If path is empty, the current directory will be used. If filename is empty,
586 no default filename will be supplied. The wildcard determines what files
587 are displayed in the file selector, and file extension supplies a type
588 extension for the required filename. Flags may be a combination of wxOPEN,
589 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, wxFILE
\_MUST\_EXIST, wxMULTIPLE or
0.
591 Both the Unix and Windows versions implement a wildcard filter. Typing a
592 filename containing wildcards
(*, ?) in the filename text item, and
593 clicking on Ok, will result in only those files matching the pattern being
596 The wildcard may be a specification for multiple types of file
597 with a description for each, such as:
600 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
603 The application must check for an empty return value (the user pressed
604 Cancel). For example:
607 const wxString& s = wxFileSelector("Choose a file to open");
614 \wxheading{Include files}
618 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
620 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
622 Shows the colour selection dialog and returns the colour selected by user or
623 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
624 is valid) if the dialog was cancelled.
626 \wxheading{Parameters}
628 \docparam{parent}{The parent window for the colour selection dialog}
630 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
632 \wxheading{Include files}
636 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
638 \func{size\_t}{wxGetMultipleChoices}{\\
639 \param{wxArrayInt\& }{selections},\\
640 \param{const wxString\& }{message},\\
641 \param{const wxString\& }{caption},\\
642 \param{const wxArrayString\& }{aChoices},\\
643 \param{wxWindow *}{parent = NULL},\\
644 \param{int}{ x = -1}, \param{int}{ y = -1},\\
645 \param{bool}{ centre = TRUE},\\
646 \param{int }{width=150}, \param{int }{height=200}}
648 \func{size\_t}{wxGetMultipleChoices}{\\
649 \param{wxArrayInt\& }{selections},\\
650 \param{const wxString\& }{message},\\
651 \param{const wxString\& }{caption},\\
652 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
653 \param{wxWindow *}{parent = NULL},\\
654 \param{int}{ x = -1}, \param{int}{ y = -1},\\
655 \param{bool}{ centre = TRUE},\\
656 \param{int }{width=150}, \param{int }{height=200}}
658 Pops up a dialog box containing a message, OK/Cancel buttons and a
659 multiple-selection listbox. The user may choose an arbitrary (including 0)
660 number of items in the listbox whose indices will be returned in
661 {\it selection} array. The initial contents of this array will be used to
662 select the items when the dialog is shown.
664 You may pass the list of strings to choose from either using {\it choices}
665 which is an array of {\it n} strings for the listbox or by using a single
666 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
668 If {\it centre} is TRUE, the message text (which may include new line
669 characters) is centred; if FALSE, the message is left-justified.
671 \wxheading{Include files}
675 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
677 \func{long}{wxGetNumberFromUser}{
678 \param{const wxString\& }{message},
679 \param{const wxString\& }{prompt},
680 \param{const wxString\& }{caption},
681 \param{long }{value},
682 \param{long }{min = 0},
683 \param{long }{max = 100},
684 \param{wxWindow *}{parent = NULL},
685 \param{const wxPoint\& }{pos = wxDefaultPosition}}
687 Shows a dialog asking the user for numeric input. The dialogs title is set to
688 {\it caption}, it contains a (possibly) multiline {\it message} above the
689 single line {\it prompt} and the zone for entering the number.
691 The number entered must be in the range {\it min}..{\it max} (both of which
692 should be positive) and {\it value} is the initial value of it. If the user
693 enters an invalid value or cancels the dialog, the function will return -1.
695 Dialog is centered on its {\it parent} unless an explicit position is given in
698 \wxheading{Include files}
702 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
704 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
705 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
707 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
708 in the dialog is not shown on screen but replaced with stars. This is intended
709 to be used for entering passwords as the function name implies.
711 \wxheading{Include files}
715 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
717 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
718 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
719 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
721 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
722 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
723 or press Cancel to return the empty string.
725 If {\it centre} is TRUE, the message text (which may include new line characters)
726 is centred; if FALSE, the message is left-justified.
728 \wxheading{Include files}
732 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
734 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
735 \param{int }{nsel}, \param{int *}{selection},
736 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
737 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
739 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
740 listbox. The user may choose one or more item(s) and press OK or Cancel.
742 The number of initially selected choices, and array of the selected indices,
743 are passed in; this array will contain the user selections on exit, with
744 the function returning the number of selections. {\it selection} must be
745 as big as the number of choices, in case all are selected.
747 If Cancel is pressed, -1 is returned.
749 {\it choices} is an array of {\it n} strings for the listbox.
751 If {\it centre} is TRUE, the message text (which may include new line characters)
752 is centred; if FALSE, the message is left-justified.
754 \wxheading{Include files}
758 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
760 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
761 \param{const wxString\& }{caption},\\
762 \param{const wxArrayString\& }{aChoices},\\
763 \param{wxWindow *}{parent = NULL},\\
764 \param{int}{ x = -1}, \param{int}{ y = -1},\\
765 \param{bool}{ centre = TRUE},\\
766 \param{int }{width=150}, \param{int }{height=200}}
768 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
769 \param{const wxString\& }{caption},\\
770 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
771 \param{wxWindow *}{parent = NULL},\\
772 \param{int}{ x = -1}, \param{int}{ y = -1},\\
773 \param{bool}{ centre = TRUE},\\
774 \param{int }{width=150}, \param{int }{height=200}}
776 Pops up a dialog box containing a message, OK/Cancel buttons and a
777 single-selection listbox. The user may choose an item and press OK to return a
778 string or Cancel to return the empty string. Use
779 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
780 valid choice and if you want to be able to detect pressing Cancel reliably.
782 You may pass the list of strings to choose from either using {\it choices}
783 which is an array of {\it n} strings for the listbox or by using a single
784 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
786 If {\it centre} is TRUE, the message text (which may include new line
787 characters) is centred; if FALSE, the message is left-justified.
789 \wxheading{Include files}
793 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
795 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
796 \param{const wxString\& }{caption},\\
797 \param{const wxArrayString\& }{aChoices},\\
798 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
799 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
801 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
802 \param{const wxString\& }{caption},\\
803 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
804 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
805 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
807 As {\bf wxGetSingleChoice} but returns the index representing the selected
808 string. If the user pressed cancel, -1 is returned.
810 \wxheading{Include files}
814 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
816 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
817 \param{const wxString\& }{caption},\\
818 \param{const wxArrayString\& }{aChoices},\\
819 \param{const wxString\& }{client\_data[]},\\
820 \param{wxWindow *}{parent = NULL},\\
821 \param{int}{ x = -1}, \param{int}{ y = -1},\\
822 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
824 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
825 \param{const wxString\& }{caption},\\
826 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
827 \param{const wxString\& }{client\_data[]},\\
828 \param{wxWindow *}{parent = NULL},\\
829 \param{int}{ x = -1}, \param{int}{ y = -1},\\
830 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
832 As {\bf wxGetSingleChoice} but takes an array of client data pointers
833 corresponding to the strings, and returns one of these pointers or NULL if
834 Cancel was pressed. The {\it client\_data} array must have the same number of
835 elements as {\it choices} or {\it aChoices}!
837 \wxheading{Include files}
841 \membersection{::wxMessageBox}\label{wxmessagebox}
843 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
844 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
846 General purpose message dialog. {\it style} may be a bit list of the
847 following identifiers:
849 \begin{twocollist}\itemsep=0pt
850 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
852 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
854 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
855 \twocolitem{wxCENTRE}{Centres the text.}
856 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
857 \twocolitem{wxICON\_HAND}{Displays a hand symbol.}
858 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
859 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
862 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
868 int answer = wxMessageBox("Quit program?", "Confirm",
869 wxYES_NO | wxCANCEL, main_frame);
875 {\it message} may contain newline characters, in which case the
876 message will be split into separate lines, to cater for large messages.
878 Under Windows, the native MessageBox function is used unless wxCENTRE
879 is specified in the style, in which case a generic function is used.
880 This is because the native MessageBox function cannot centre text.
881 The symbols are not shown when the generic function is used.
883 \wxheading{Include files}
887 \membersection{::wxShowTip}\label{wxshowtip}
889 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
890 \param{wxTipProvider *}{tipProvider},
891 \param{bool }{showAtStartup = TRUE}}
893 This function shows a "startup tip" to the user.
895 \docparam{parent}{The parent window for the modal dialog}
897 \docparam{tipProvider}{An object which is used to get the text of the tips.
898 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
900 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
901 otherwise. This is used as the initial value for "Show tips at startup"
902 checkbox which is shown in the tips dialog.}
906 \helpref{Tips overview}{tipsoverview}
908 \wxheading{Include files}
912 \section{GDI functions}\label{gdifunctions}
914 The following are relevant to the GDI (Graphics Device Interface).
916 \wxheading{Include files}
920 \membersection{::wxColourDisplay}
922 \func{bool}{wxColourDisplay}{\void}
924 Returns TRUE if the display is colour, FALSE otherwise.
926 \membersection{::wxDisplayDepth}
928 \func{int}{wxDisplayDepth}{\void}
930 Returns the depth of the display (a value of 1 denotes a monochrome display).
932 \membersection{::wxDisplaySize}
934 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
936 \func{wxSize}{wxGetDisplaySize}{\void}
938 Returns the display size in pixels.
940 \membersection{::wxDisplaySizeMM}
942 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
944 \func{wxSize}{wxGetDisplaySizeMM}{\void}
946 Returns the display size in millimeters.
948 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
950 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
951 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
953 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
954 makes it into a placeable metafile by prepending a header containing the given
955 bounding box. The bounding box may be obtained from a device context after drawing
956 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
958 In addition to adding the placeable metafile header, this function adds
959 the equivalent of the following code to the start of the metafile data:
962 SetMapMode(dc, MM_ANISOTROPIC);
963 SetWindowOrg(dc, minX, minY);
964 SetWindowExt(dc, maxX - minX, maxY - minY);
967 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
969 Placeable metafiles may be imported by many Windows applications, and can be
970 used in RTF (Rich Text Format) files.
972 {\it scale} allows the specification of scale for the metafile.
974 This function is only available under Windows.
976 \membersection{::wxSetCursor}\label{wxsetcursor}
978 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
980 Globally sets the cursor; only has an effect in Windows and GTK.
981 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
983 \section{Printer settings}\label{printersettings}
985 These routines are obsolete and should no longer be used!
987 The following functions are used to control PostScript printing. Under
988 Windows, PostScript output can only be sent to a file.
990 \wxheading{Include files}
994 \membersection{::wxGetPrinterCommand}
996 \func{wxString}{wxGetPrinterCommand}{\void}
998 Gets the printer command used to print a file. The default is {\tt lpr}.
1000 \membersection{::wxGetPrinterFile}
1002 \func{wxString}{wxGetPrinterFile}{\void}
1004 Gets the PostScript output filename.
1006 \membersection{::wxGetPrinterMode}
1008 \func{int}{wxGetPrinterMode}{\void}
1010 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
1011 The default is PS\_PREVIEW.
1013 \membersection{::wxGetPrinterOptions}
1015 \func{wxString}{wxGetPrinterOptions}{\void}
1017 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
1019 \membersection{::wxGetPrinterOrientation}
1021 \func{int}{wxGetPrinterOrientation}{\void}
1023 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
1025 \membersection{::wxGetPrinterPreviewCommand}
1027 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
1029 Gets the command used to view a PostScript file. The default depends on the platform.
1031 \membersection{::wxGetPrinterScaling}
1033 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
1035 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
1037 \membersection{::wxGetPrinterTranslation}
1039 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
1041 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
1043 \membersection{::wxSetPrinterCommand}
1045 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
1047 Sets the printer command used to print a file. The default is {\tt lpr}.
1049 \membersection{::wxSetPrinterFile}
1051 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
1053 Sets the PostScript output filename.
1055 \membersection{::wxSetPrinterMode}
1057 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
1059 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
1060 The default is PS\_PREVIEW.
1062 \membersection{::wxSetPrinterOptions}
1064 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
1066 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
1068 \membersection{::wxSetPrinterOrientation}
1070 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
1072 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
1074 \membersection{::wxSetPrinterPreviewCommand}
1076 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
1078 Sets the command used to view a PostScript file. The default depends on the platform.
1080 \membersection{::wxSetPrinterScaling}
1082 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
1084 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
1086 \membersection{::wxSetPrinterTranslation}
1088 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
1090 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
1092 \section{Clipboard functions}\label{clipsboard}
1094 These clipboard functions are implemented for Windows only. The use of these functions
1095 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
1098 \wxheading{Include files}
1102 \membersection{::wxClipboardOpen}
1104 \func{bool}{wxClipboardOpen}{\void}
1106 Returns TRUE if this application has already opened the clipboard.
1108 \membersection{::wxCloseClipboard}
1110 \func{bool}{wxCloseClipboard}{\void}
1112 Closes the clipboard to allow other applications to use it.
1114 \membersection{::wxEmptyClipboard}
1116 \func{bool}{wxEmptyClipboard}{\void}
1118 Empties the clipboard.
1120 \membersection{::wxEnumClipboardFormats}
1122 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
1124 Enumerates the formats found in a list of available formats that belong
1125 to the clipboard. Each call to this function specifies a known
1126 available format; the function returns the format that appears next in
1129 {\it dataFormat} specifies a known format. If this parameter is zero,
1130 the function returns the first format in the list.
1132 The return value specifies the next known clipboard data format if the
1133 function is successful. It is zero if the {\it dataFormat} parameter specifies
1134 the last format in the list of available formats, or if the clipboard
1137 Before it enumerates the formats function, an application must open the clipboard by using the
1138 wxOpenClipboard function.
1140 \membersection{::wxGetClipboardData}
1142 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
1144 Gets data from the clipboard.
1146 {\it dataFormat} may be one of:
1148 \begin{itemize}\itemsep=0pt
1149 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
1150 \item wxCF\_BITMAP: returns a new wxBitmap.
1153 The clipboard must have previously been opened for this call to succeed.
1155 \membersection{::wxGetClipboardFormatName}
1157 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
1159 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
1160 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
1162 \membersection{::wxIsClipboardFormatAvailable}
1164 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
1166 Returns TRUE if the given data format is available on the clipboard.
1168 \membersection{::wxOpenClipboard}
1170 \func{bool}{wxOpenClipboard}{\void}
1172 Opens the clipboard for passing data to it or getting data from it.
1174 \membersection{::wxRegisterClipboardFormat}
1176 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
1178 Registers the clipboard data format name and returns an identifier.
1180 \membersection{::wxSetClipboardData}
1182 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
1184 Passes data to the clipboard.
1186 {\it dataFormat} may be one of:
1188 \begin{itemize}\itemsep=0pt
1189 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
1190 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
1191 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
1192 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
1195 The clipboard must have previously been opened for this call to succeed.
1197 \section{Miscellaneous functions}\label{miscellany}
1199 \membersection{::wxDROP\_ICON}\label{wxdropicon}
1201 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
1203 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
1204 name. Under MSW, the cursor is loaded from the resource file and the icon is
1205 loaded from XPM file under other platforms.
1207 This macro should be used with
1208 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
1210 \wxheading{Include files}
1214 \membersection{::wxNewId}
1216 \func{long}{wxNewId}{\void}
1218 Generates an integer identifier unique to this run of the program.
1220 \wxheading{Include files}
1224 \membersection{::wxRegisterId}
1226 \func{void}{wxRegisterId}{\param{long}{ id}}
1228 Ensures that ids subsequently generated by {\bf NewId} do not clash with
1231 \wxheading{Include files}
1235 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1237 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1239 Changes the cursor to the given cursor for all windows in the application.
1240 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1241 to its previous state. These two calls can be nested, and a counter
1242 ensures that only the outer calls take effect.
1244 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1246 \wxheading{Include files}
1250 \membersection{::wxBell}
1252 \func{void}{wxBell}{\void}
1254 Ring the system bell.
1256 \wxheading{Include files}
1260 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
1262 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
1264 Creates and returns an object of the given class, if the class has been
1265 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
1267 \membersection{::wxDDECleanUp}\label{wxddecleanup}
1269 \func{void}{wxDDECleanUp}{\void}
1271 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
1272 called by the application.
1274 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
1276 \wxheading{Include files}
1280 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1282 \func{void}{wxDDEInitialize}{\void}
1284 Initializes the DDE system. May be called multiple times without harm.
1286 This no longer needs to be called by the application: it will be called
1287 by wxWindows if necessary.
1289 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1290 \helpref{wxDDECleanUp}{wxddecleanup}.
1292 \wxheading{Include files}
1296 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1298 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1300 {\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
1302 Display a debugging message; under Windows, this will appear on the
1303 debugger command window, and under Unix, it will be written to standard
1306 The syntax is identical to {\bf printf}: pass a format string and a
1307 variable list of arguments.
1309 {\bf Tip:} under Windows, if your application crashes before the
1310 message appears in the debugging window, put a wxYield call after
1311 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1312 (at least for Watcom C++): preformat your messages and use OutputDebugString
1315 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1317 \wxheading{Include files}
1321 \membersection{::wxDisplaySize}
1323 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1325 Gets the physical size of the display in pixels.
1327 \wxheading{Include files}
1331 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1333 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1335 This function enables or disables all top level windows. It is used by
1336 \helpref{::wxSafeYield}{wxsafeyield}.
1338 \wxheading{Include files}
1342 \membersection{::wxEntry}\label{wxentry}
1344 This initializes wxWindows in a platform-dependent way. Use this if you
1345 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1346 you can initialize wxWindows from an Microsoft Foundation Classes application using
1349 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1350 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1352 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1353 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1354 message loop will be entered.
1356 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1357 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1359 wxWindows initialization under Windows (for applications constructed as a DLL).
1361 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1363 wxWindows initialization under Unix.
1367 To clean up wxWindows, call wxApp::OnExit followed by the static function
1368 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1371 int CTheApp::ExitInstance()
1373 // OnExit isn't called by CleanUp so must be called explicitly.
1377 return CWinApp::ExitInstance();
1381 \wxheading{Include files}
1385 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1387 \func{void}{wxEndBusyCursor}{\void}
1389 Changes the cursor back to the original cursor, for all windows in the application.
1390 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1392 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1394 \wxheading{Include files}
1398 \membersection{::wxError}\label{wxerror}
1400 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1402 Displays {\it msg} and continues. This writes to standard error under
1403 Unix, and pops up a message box under Windows. Used for internal
1404 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1406 \wxheading{Include files}
1410 \membersection{::wxExecute}\label{wxexecute}
1412 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1414 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1416 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
1418 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
1420 Executes another program in Unix or Windows.
1422 The first form takes a command string, such as {\tt "emacs file.txt"}.
1424 The second form takes an array of values: a command, any number of
1425 arguments, terminated by NULL.
1427 The semantics of the third and fourth versions is different from the first two
1428 and is described in more details below.
1430 If {\it sync} is FALSE (the default), flow of control immediately returns.
1431 If TRUE, the current application waits until the other program has terminated.
1433 In the case of synchronous execution, the return value is the exit code of
1434 the process (which terminates by the moment the function returns) and will be
1435 $-1$ if the process couldn't be started and typically 0 if the process
1436 terminated successfully. Also, while waiting for the process to
1437 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1438 should ensure that this can cause no recursion, in the simplest case by
1439 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1441 For asynchronous execution, however, the return value is the process id and
1442 zero value indicates that the command could not be executed.
1444 If callback isn't NULL and if execution is asynchronous (note that callback
1445 parameter can not be non-NULL for synchronous execution),
1446 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1447 the process finishes.
1449 Finally, you may use the third overloaded version of this function to execute
1450 a process (always synchronously) and capture its output in the array
1451 {\it output}. The fourth version adds the possibility to additionally capture
1452 the messages from standard error output in the {\it errors} array.
1454 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
1455 \helpref{Exec sample}{sampleexec}.
1457 \wxheading{Include files}
1461 \membersection{::wxExit}\label{wxexit}
1463 \func{void}{wxExit}{\void}
1465 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1466 Should only be used in an emergency: normally the top-level frame
1467 should be deleted (after deleting all other frames) to terminate the
1468 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1470 \wxheading{Include files}
1474 \membersection{::wxFatalError}\label{wxfatalerror}
1476 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1478 Displays {\it msg} and exits. This writes to standard error under Unix,
1479 and pops up a message box under Windows. Used for fatal internal
1480 wxWindows errors. See also \helpref{wxError}{wxerror}.
1482 \wxheading{Include files}
1486 \membersection{::wxFindMenuItemId}
1488 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1490 Find a menu item identifier associated with the given frame's menu bar.
1492 \wxheading{Include files}
1496 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
1498 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1500 Find a window by its label. Depending on the type of window, the label may be a window title
1501 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1502 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1503 The search is recursive in both cases.
1505 \wxheading{Include files}
1509 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1511 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1513 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1514 If {\it parent} is NULL, the search will start from all top-level
1515 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1516 The search is recursive in both cases.
1518 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1520 \wxheading{Include files}
1524 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
1526 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
1528 Find the deepest window at the given mouse position in screen coordinates,
1529 returning the window if found, or NULL if not.
1531 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
1533 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
1535 Find the deepest window at the mouse pointer position, returning the window
1536 and current pointer position in screen coordinates.
1538 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1540 \func{wxWindow *}{wxGetActiveWindow}{\void}
1542 Gets the currently active window (Windows only).
1544 \wxheading{Include files}
1548 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1550 \func{wxString}{wxGetDisplayName}{\void}
1552 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1554 \wxheading{Include files}
1558 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1560 \func{wxString}{wxGetHomeDir}{\void}
1562 Return the (current) user's home directory.
1564 \wxheading{See also}
1566 \helpref{wxGetUserHome}{wxgetuserhome}
1568 \wxheading{Include files}
1572 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1574 \func{long}{wxGetFreeMemory}{\void}
1576 Returns the amount of free memory in bytes under environments which
1577 support it, and -1 if not supported. Currently, it is supported only
1578 under Windows, Linux and Solaris.
1580 \wxheading{Include files}
1584 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
1586 \func{wxPoint}{wxGetMousePosition}{\void}
1588 Returns the mouse position in screen coordinates.
1590 \wxheading{Include files}
1594 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1596 \func{wxString}{wxGetOsDescription}{\void}
1598 Returns the string containing the description of the current platform in a
1599 user-readable form. For example, this function may return strings like
1600 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1602 \wxheading{See also}
1604 \helpref{::wxGetOsVersion}{wxgetosversion}
1606 \wxheading{Include files}
1610 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1612 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1614 Gets operating system version information.
1616 \begin{twocollist}\itemsep=0pt
1617 \twocolitemruled{Platform}{Return types}
1618 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1619 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1620 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1621 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1622 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1623 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1624 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1625 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1626 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1627 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1630 \wxheading{See also}
1632 \helpref{::wxGetOsDescription}{wxgetosdescription}
1634 \wxheading{Include files}
1638 \membersection{::wxGetResource}\label{wxgetresource}
1640 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1641 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1643 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1644 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1646 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1647 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1649 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1650 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1652 Gets a resource value from the resource database (for example, WIN.INI, or
1653 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1654 otherwise the specified file is used.
1656 Under X, if an application class (wxApp::GetClassName) has been defined,
1657 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1658 an applications default file when merging all resource databases.
1660 The reason for passing the result in an argument is that it
1661 can be convenient to define a default value, which gets overridden
1662 if the value exists in the resource file. It saves a separate
1663 test for that resource's existence, and it also allows
1664 the overloading of the function for different types.
1666 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1668 \wxheading{Include files}
1672 \membersection{::wxGetUserId}
1674 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1676 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1677 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1678 Under Windows, this returns ``user''.
1680 \wxheading{Include files}
1684 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1686 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1688 Returns the home directory for the given user. If the username is empty
1689 (default value), this function behaves like
1690 \helpref{wxGetHomeDir}{wxgethomedir}.
1692 \wxheading{Include files}
1696 \membersection{::wxGetUserName}
1698 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1700 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1701 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1702 Under Windows, this returns ``unknown''.
1704 \wxheading{Include files}
1708 \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
1710 \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
1712 If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
1713 faults under Windows or segmentation violations in the Unix world) will be
1714 caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
1715 By default, i.e. before this function is called, they will be handled in the
1716 normal way which usually just means that the application will be terminated.
1717 Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore
1718 this default behaviour.
1720 \membersection{::wxKill}\label{wxkill}
1722 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1724 Under Unix (the only supported platform), equivalent to the Unix kill function.
1725 Returns 0 on success, -1 on failure.
1727 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1728 It does not raise a signal in the receiving process.
1730 \wxheading{Include files}
1734 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
1736 \func{void}{wxInitAllImageHandlers}{\void}
1738 Initializes all available image handlers. For a list of available handlers,
1739 see \helpref{wxImage}{wximage}.
1741 \wxheading{See also}
1743 \helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
1745 \membersection{::wxIsBusy}\label{wxisbusy}
1747 \func{bool}{wxIsBusy}{\void}
1749 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1750 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1752 See also \helpref{wxBusyCursor}{wxbusycursor}.
1754 \wxheading{Include files}
1758 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1760 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1762 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1763 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1765 The resource must be defined in the {\tt .rc} file using the following syntax:
1768 myResource TEXT file.ext
1771 where {\tt file.ext} is a file that the resource compiler can find.
1773 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1774 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1775 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1777 This function is available under Windows only.
1779 \wxheading{Include files}
1783 \membersection{::wxNow}\label{wxnow}
1785 \func{wxString}{wxNow}{\void}
1787 Returns a string representing the current date and time.
1789 \wxheading{Include files}
1793 \membersection{::wxPostDelete}\label{wxpostdelete}
1795 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1797 Tells the system to delete the specified object when
1798 all other events have been processed. In some environments, it is
1799 necessary to use this instead of deleting a frame directly with the
1800 delete operator, because some GUIs will still send events to a deleted window.
1802 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1804 \wxheading{Include files}
1808 \membersection{::wxPostEvent}\label{wxpostevent}
1810 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
1812 This function posts the event to the specified {\it dest} object. The
1813 difference between sending an event and posting it is that in the first case
1814 the event is processed before the function returns (in wxWindows, event sending
1815 is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
1816 the second, the function returns immediately and the event will be processed
1817 sometime later - usually during the next even loop iteration.
1819 Note that a copy of the {\it event} is made by the function, so the original
1820 copy can be deleted as soon as function returns. This function can also be used
1821 to send events between different threads safely. As this function makes a
1822 copy of the event, the event needs to have a fully implemented Clone() method,
1823 which may not be the case for all event in wxWindows.
1825 See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
1828 \wxheading{Include files}
1832 \membersection{::wxSafeYield}\label{wxsafeyield}
1834 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1836 This function is similar to wxYield, except that it disables the user input to
1837 all program windows before calling wxYield and re-enables it again
1838 afterwards. If {\it win} is not NULL, this window will remain enabled,
1839 allowing the implementation of some limited user interaction.
1841 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1843 \wxheading{Include files}
1847 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1849 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1851 Under X only, sets the current display name. This is the X host and display name such
1852 as ``colonsay:0.0", and the function indicates which display should be used for creating
1853 windows from this point on. Setting the display within an application allows multiple
1854 displays to be used.
1856 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1858 \wxheading{Include files}
1862 \membersection{::wxShell}\label{wxshell}
1864 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1866 Executes a command in an interactive shell window. If no command is
1867 specified, then just the shell is spawned.
1869 See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
1871 \wxheading{Include files}
1875 \membersection{::wxSleep}\label{wxsleep}
1877 \func{void}{wxSleep}{\param{int}{ secs}}
1879 Sleeps for the specified number of seconds.
1881 \wxheading{Include files}
1885 \membersection{::wxStripMenuCodes}
1887 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1889 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1891 Strips any menu codes from {\it in} and places the result
1892 in {\it out} (or returns the new string, in the first form).
1894 Menu codes include \& (mark the next character with an underline
1895 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1897 \wxheading{Include files}
1901 \membersection{::wxToLower}\label{wxtolower}
1903 \func{char}{wxToLower}{\param{char }{ch}}
1905 Converts the character to lower case. This is implemented as a macro for efficiency.
1907 \wxheading{Include files}
1911 \membersection{::wxToUpper}\label{wxtoupper}
1913 \func{char}{wxToUpper}{\param{char }{ch}}
1915 Converts the character to upper case. This is implemented as a macro for efficiency.
1917 \wxheading{Include files}
1921 \membersection{::wxTrace}\label{wxtrace}
1923 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1925 Takes printf-style variable argument syntax. Output
1926 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1928 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1930 \wxheading{Include files}
1934 \membersection{::wxTraceLevel}\label{wxtracelevel}
1936 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1938 Takes printf-style variable argument syntax. Output
1939 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1940 The first argument should be the level at which this information is appropriate.
1941 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1944 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1946 \wxheading{Include files}
1950 \membersection{::wxUsleep}\label{wxusleep}
1952 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1954 Sleeps for the specified number of milliseconds. Notice that usage of this
1955 function is encouraged instead of calling usleep(3) directly because the
1956 standard usleep() function is not MT safe.
1958 \wxheading{Include files}
1962 \membersection{::wxWriteResource}\label{wxwriteresource}
1964 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1965 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1967 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1968 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1970 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1971 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1973 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1974 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1976 Writes a resource value into the resource database (for example, WIN.INI, or
1977 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1978 otherwise the specified file is used.
1980 Under X, the resource databases are cached until the internal function
1981 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1982 all updated resource databases are written to their files.
1984 Note that it is considered bad manners to write to the .Xdefaults
1985 file under Unix, although the WIN.INI file is fair game under Windows.
1987 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1989 \wxheading{Include files}
1993 \membersection{::wxYield}\label{wxyield}
1995 \func{bool}{wxYield}{\void}
1997 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1998 time-consuming process writes to a text window. Without an occasional
1999 yield, the text window will not be updated properly, and on systems with
2000 cooperative multitasking, such as Windows 3.1 other processes will not respond.
2002 Caution should be exercised, however, since yielding may allow the
2003 user to perform actions which are not compatible with the current task.
2004 Disabling menu items or whole menus during processing can avoid unwanted
2005 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
2008 Note that wxYield will not flush the message logs. This is intentional as
2009 calling wxYield is usually done to quickly update the screen and popping up a
2010 message box dialog may be undesirable. If you do wish to flush the log
2011 messages immediately (otherwise it will be done during the next idle loop
2012 iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
2014 \wxheading{Include files}
2016 <wx/app.h> or <wx/utils.h>
2018 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
2020 \func{void}{wxWakeUpIdle}{\void}
2022 This functions wakes up the (internal and platform dependent) idle system, i.e. it
2023 will force the system to send an idle event even if the system currently {\it is}
2024 idle and thus would not send any idle event until after some other event would get
2025 sent. This is also useful for sending events between two threads and is used by
2026 the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
2027 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2029 \wxheading{Include files}
2033 \section{Macros}\label{macros}
2035 These macros are defined in wxWindows.
2037 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
2039 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
2041 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
2043 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
2045 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
2047 This macro will swap the bytes of the {\it value} variable from little
2048 endian to big endian or vice versa.
2050 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
2052 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
2054 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
2056 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
2058 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
2060 This macro will swap the bytes of the {\it value} variable from little
2061 endian to big endian or vice versa if the program is compiled on a
2062 big-endian architecture (such as Sun work stations). If the program has
2063 been compiled on a little-endian architecture, the value will be unchanged.
2065 Use these macros to read data from and write data to a file that stores
2066 data in little endian (Intel i386) format.
2068 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
2070 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
2072 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
2074 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
2076 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
2078 This macro will swap the bytes of the {\it value} variable from little
2079 endian to big endian or vice versa if the program is compiled on a
2080 little-endian architecture (such as Intel PCs). If the program has
2081 been compiled on a big-endian architecture, the value will be unchanged.
2083 Use these macros to read data from and write data to a file that stores
2084 data in big endian format.
2086 \membersection{CLASSINFO}\label{classinfo}
2088 \func{wxClassInfo *}{CLASSINFO}{className}
2090 Returns a pointer to the wxClassInfo object associated with this class.
2092 \wxheading{Include files}
2096 \membersection{DECLARE\_ABSTRACT\_CLASS}
2098 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
2100 Used inside a class declaration to declare that the class should be
2101 made known to the class hierarchy, but objects of this class cannot be created
2102 dynamically. The same as DECLARE\_CLASS.
2107 class wxCommand: public wxObject
2109 DECLARE_ABSTRACT_CLASS(wxCommand)
2118 \wxheading{Include files}
2122 \membersection{DECLARE\_APP}\label{declareapp}
2124 \func{}{DECLARE\_APP}{className}
2126 This is used in headers to create a forward declaration of the wxGetApp function implemented
2127 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
2135 \wxheading{Include files}
2139 \membersection{DECLARE\_CLASS}
2141 \func{}{DECLARE\_CLASS}{className}
2143 Used inside a class declaration to declare that the class should be
2144 made known to the class hierarchy, but objects of this class cannot be created
2145 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
2147 \wxheading{Include files}
2151 \membersection{DECLARE\_DYNAMIC\_CLASS}
2153 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
2155 Used inside a class declaration to declare that the objects of this class should be dynamically
2156 creatable from run-time type information.
2161 class wxFrame: public wxWindow
2163 DECLARE_DYNAMIC_CLASS(wxFrame)
2166 const wxString\& frameTitle;
2172 \wxheading{Include files}
2176 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
2178 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
2180 Used in a C++ implementation file to complete the declaration of
2181 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
2186 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
2188 wxCommand::wxCommand(void)
2194 \wxheading{Include files}
2198 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
2200 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
2202 Used in a C++ implementation file to complete the declaration of
2203 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
2205 \wxheading{Include files}
2209 \membersection{IMPLEMENT\_APP}\label{implementapp}
2211 \func{}{IMPLEMENT\_APP}{className}
2213 This is used in the application class implementation file to make the application class known to
2214 wxWindows for dynamic construction. You use this instead of
2225 IMPLEMENT_APP(MyApp)
2228 See also \helpref{DECLARE\_APP}{declareapp}.
2230 \wxheading{Include files}
2234 \membersection{IMPLEMENT\_CLASS}
2236 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
2238 Used in a C++ implementation file to complete the declaration of
2239 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
2241 \wxheading{Include files}
2245 \membersection{IMPLEMENT\_CLASS2}
2247 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
2249 Used in a C++ implementation file to complete the declaration of a
2250 class that has run-time type information and two base classes. The
2251 same as IMPLEMENT\_ABSTRACT\_CLASS2.
2253 \wxheading{Include files}
2257 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
2259 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
2261 Used in a C++ implementation file to complete the declaration of
2262 a class that has run-time type information, and whose instances
2263 can be created dynamically.
2268 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
2270 wxFrame::wxFrame(void)
2276 \wxheading{Include files}
2280 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
2282 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
2284 Used in a C++ implementation file to complete the declaration of
2285 a class that has run-time type information, and whose instances
2286 can be created dynamically. Use this for classes derived from two
2289 \wxheading{Include files}
2293 \membersection{wxBITMAP}\label{wxbitmapmacro}
2295 \func{}{wxBITMAP}{bitmapName}
2297 This macro loads a bitmap from either application resources (on the platforms
2298 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2299 avoid using {\tt \#ifdef}s when creating bitmaps.
2301 \wxheading{See also}
2303 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2304 \helpref{wxICON}{wxiconmacro}
2306 \wxheading{Include files}
2310 \membersection{wxConstCast}\label{wxconstcast}
2312 \func{}{wxConstCast}{ptr, classname}
2314 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
2315 supports {\it const\_cast} or into an old, C-style cast, otherwise.
2317 \wxheading{See also}
2319 \helpref{wxDynamicCast}{wxdynamiccast}\\
2320 \helpref{wxStaticCast}{wxstaticcast}
2322 \membersection{WXDEBUG\_NEW}\label{debugnew}
2324 \func{}{WXDEBUG\_NEW}{arg}
2326 This is defined in debug mode to be call the redefined new operator
2327 with filename and line number arguments. The definition is:
2330 #define WXDEBUG_NEW new(__FILE__,__LINE__)
2333 In non-debug mode, this is defined as the normal new operator.
2335 \wxheading{Include files}
2339 \membersection{wxDynamicCast}\label{wxdynamiccast}
2341 \func{}{wxDynamicCast}{ptr, classname}
2343 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
2344 the pointer is of this type (the check is done during the run-time) or NULL
2345 otherwise. Usage of this macro is preferred over obsoleted wxObject::IsKindOf()
2348 The {\it ptr} argument may be NULL, in which case NULL will be returned.
2353 wxWindow *win = wxWindow::FindFocus();
2354 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
2357 // a text control has the focus...
2361 // no window has the focus or it is not a text control
2365 \wxheading{See also}
2367 \helpref{RTTI overview}{runtimeclassoverview}\\
2368 \helpref{wxConstCast}{wxconstcast}\\
2369 \helpref{wxStatiicCast}{wxstaticcast}
2371 \membersection{wxICON}\label{wxiconmacro}
2373 \func{}{wxICON}{iconName}
2375 This macro loads an icon from either application resources (on the platforms
2376 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2377 avoid using {\tt \#ifdef}s when creating icons.
2379 \wxheading{See also}
2381 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2382 \helpref{wxBITMAP}{wxbitmapmacro}
2384 \wxheading{Include files}
2388 \membersection{wxStaticCast}\label{wxstaticcast}
2390 \func{}{wxStaticCast}{ptr, classname}
2392 This macro checks that the cast is valid in debug mode (an assert failure will
2393 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
2394 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
2396 \helpref{wxDynamicCast}{wxdynamiccast}\\
2397 \helpref{wxConstCast}{wxconstcast}
2399 \membersection{WXTRACE}\label{trace}
2401 \wxheading{Include files}
2405 \func{}{WXTRACE}{formatString, ...}
2407 Calls wxTrace with printf-style variable argument syntax. Output
2408 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2410 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2412 \wxheading{Include files}
2416 \membersection{WXTRACELEVEL}\label{tracelevel}
2418 \func{}{WXTRACELEVEL}{level, formatString, ...}
2420 Calls wxTraceLevel with printf-style variable argument syntax. Output
2421 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2422 The first argument should be the level at which this information is appropriate.
2423 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2426 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2428 \wxheading{Include files}
2432 \section{wxWindows resource functions}\label{resourcefuncs}
2434 \overview{wxWindows resource system}{resourceformats}
2436 This section details functions for manipulating wxWindows (.WXR) resource
2437 files and loading user interface elements from resources.
2439 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2440 about initialisation file resource reading and writing, using such functions
2441 as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}
2443 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2445 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2446 loading from resource data.
2448 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2450 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2452 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2453 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2454 perhaps for implementing resource functionality for interpreted languages.
2456 \membersection{::wxResourceClear}
2458 \func{void}{wxResourceClear}{\void}
2460 Clears the wxWindows resource table.
2462 \membersection{::wxResourceCreateBitmap}
2464 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2466 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2467 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2471 static const wxString\& project_resource = "bitmap(name = 'project_resource',\
2472 bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2473 bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2476 then this function can be called as follows:
2479 wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
2482 \membersection{::wxResourceCreateIcon}
2484 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2486 Creates a new icon from a file, static data, or Windows resource, given a valid
2487 wxWindows icon resource identifier. For example, if the .WXR file contains
2491 static const wxString\& project_resource = "icon(name = 'project_resource',\
2492 icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2493 icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2496 then this function can be called as follows:
2499 wxIcon *icon = wxResourceCreateIcon("project_resource");
2502 \membersection{::wxResourceCreateMenuBar}
2504 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2506 Creates a new menu bar given a valid wxWindows menubar resource
2507 identifier. For example, if the .WXR file contains the following:
2510 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2514 ['&Open File', 2, 'Open a file'],\
2515 ['&Save File', 3, 'Save a file'],\
2517 ['E&xit', 4, 'Exit program']\
2520 ['&About', 6, 'About this program']\
2525 then this function can be called as follows:
2528 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2532 \membersection{::wxResourceGetIdentifier}
2534 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2536 Used for retrieving the integer value associated with an identifier.
2537 A zero value indicates that the identifier was not found.
2539 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2541 \membersection{::wxResourceParseData}\label{wxresourcedata}
2543 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2545 Parses a string containing one or more wxWindows resource objects. If
2546 the resource objects are global static data that are included into the
2547 C++ program, then this function must be called for each variable
2548 containing the resource data, to make it known to wxWindows.
2550 {\it resource} should contain data in the following form:
2553 dialog(name = 'dialog1',
2554 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2555 title = 'Test dialog box',
2556 x = 312, y = 234, width = 400, height = 300,
2558 control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2559 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2560 control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
2561 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2562 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2563 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2566 This function will typically be used after including a {\tt .wxr} file into
2567 a C++ program as follows:
2570 #include "dialog1.wxr"
2573 Each of the contained resources will declare a new C++ variable, and each
2574 of these variables should be passed to wxResourceParseData.
2576 \membersection{::wxResourceParseFile}
2578 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2580 Parses a file containing one or more wxWindows resource objects
2581 in C++-compatible syntax. Use this function to dynamically load
2582 wxWindows resource data.
2584 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2586 \func{bool}{wxResourceParseString}{\param{char*}{ s}, \param{wxResourceTable *}{table = NULL}}
2588 Parses a string containing one or more wxWindows resource objects. If
2589 the resource objects are global static data that are included into the
2590 C++ program, then this function must be called for each variable
2591 containing the resource data, to make it known to wxWindows.
2593 {\it resource} should contain data with the following form:
2596 dialog(name = 'dialog1',
2597 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2598 title = 'Test dialog box',
2599 x = 312, y = 234, width = 400, height = 300,
2601 control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2602 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2603 control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
2604 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2605 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2606 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2609 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2610 load an entire {\tt .wxr file} into a string.
2612 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2614 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char* }{xbm\_data}, \param{int }{width},
2615 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2617 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}}
2619 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2620 This is required if other resources will use the bitmap data, since otherwise there
2621 is no connection between names used in resources, and the global bitmap data.
2623 \membersection{::wxResourceRegisterIconData}
2625 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2627 \section{Log functions}\label{logfunctions}
2629 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2630 further information. The functions use (implicitly) the currently active log
2631 target, so their descriptions here may not apply if the log target is not the
2632 standard one (installed by wxWindows in the beginning of the program).
2634 \wxheading{Include files}
2638 \membersection{::wxLogError}\label{wxlogerror}
2640 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2642 The function to use for error messages, i.e. the messages that must be shown
2643 to the user. The default processing is to pop up a message box to inform the
2646 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2648 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2650 Like \helpref{wxLogError}{wxlogerror}, but also
2651 terminates the program with the exit code 3. Using {\it abort()} standard
2652 function also terminates the program with this exit code.
2654 \membersection{::wxLogWarning}\label{wxlogwarning}
2656 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2658 For warnings - they are also normally shown to the user, but don't interrupt
2661 \membersection{::wxLogMessage}\label{wxlogmessage}
2663 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2665 for all normal, informational messages. They also appear in a message box by
2666 default (but it can be changed). Notice that the standard behaviour is to not
2667 show informational messages if there are any errors later - the logic being
2668 that the later error messages make the informational messages preceding them
2671 \membersection{::wxLogVerbose}\label{wxlogverbose}
2673 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2675 For verbose output. Normally, it is suppressed, but
2676 might be activated if the user wishes to know more details about the program
2677 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2679 \membersection{::wxLogStatus}\label{wxlogstatus}
2681 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
2683 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2685 Messages logged by this function will appear in the statusbar of the {\it
2686 frame} or of the top level application window by default (i.e. when using
2687 the second version of the function).
2689 If the target frame doesn't have a statusbar, the message will be lost.
2691 \membersection{::wxLogSysError}\label{wxlogsyserror}
2693 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2695 Mostly used by wxWindows itself, but might be handy for logging errors after
2696 system call (API function) failure. It logs the specified message text as well
2697 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2698 on the platform) and the corresponding error message. The second form
2699 of this function takes the error code explicitly as the first argument.
2701 \wxheading{See also}
2703 \helpref{wxSysErrorCode}{wxsyserrorcode},
2704 \helpref{wxSysErrorMsg}{wxsyserrormsg}
2706 \membersection{::wxLogDebug}\label{wxlogdebug}
2708 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2710 The right function for debug output. It only does anything at all in the debug
2711 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
2712 nothing in release mode (otherwise).
2714 \membersection{::wxLogTrace}\label{wxlogtrace}
2716 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2718 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
2720 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
2722 As {\bf wxLogDebug}, trace functions only do something in debug build and
2723 expand to nothing in the release one. The reason for making
2724 it a separate function from it is that usually there are a lot of trace
2725 messages, so it might make sense to separate them from other debug messages.
2727 The trace messages also usually can be separated into different categories and
2728 the second and third versions of this function only log the message if the
2729 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
2730 allows to selectively trace only some operations and not others by changing
2731 the value of the trace mask (possible during the run-time).
2733 For the second function (taking a string mask), the message is logged only if
2734 the mask has been previously enabled by the call to
2735 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
2736 used by wxWindows are:
2738 \begin{itemize}\itemsep=0pt
2739 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
2740 \item wxTRACE\_Messages: trace window messages/X callbacks
2741 \item wxTRACE\_ResAlloc: trace GDI resource allocation
2742 \item wxTRACE\_RefCount: trace various ref counting operations
2743 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
2746 The third version of the function only logs the message if all the bit
2747 corresponding to the {\it mask} are set in the wxLog trace mask which can be
2748 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
2749 flexible than the previous one because it doesn't allow defining the user
2750 trace masks easily - this is why it is deprecated in favour of using string
2753 \begin{itemize}\itemsep=0pt
2754 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2755 \item wxTraceMessages: trace window messages/X callbacks
2756 \item wxTraceResAlloc: trace GDI resource allocation
2757 \item wxTraceRefCount: trace various ref counting operations
2758 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
2761 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
2763 \func{unsigned long}{wxSysErrorCode}{\void}
2765 Returns the error code from the last system call. This function uses
2766 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
2768 \wxheading{See also}
2770 \helpref{wxSysErrorMsg}{wxsyserrormsg},
2771 \helpref{wxLogSysError}{wxlogsyserror}
2773 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
2775 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
2777 Returns the error message corresponding to the given system error code. If
2778 {\it errCode} is $0$ (default), the last error code (as returned by
2779 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
2781 \wxheading{See also}
2783 \helpref{wxSysErrorCode}{wxsyserrorcode},
2784 \helpref{wxLogSysError}{wxlogsyserror}
2786 \section{Time functions}\label{timefunctions}
2788 The functions in this section deal with getting the current time and
2789 starting/stopping the global timers. Please note that the timer functions are
2790 deprecated because they work with one global timer only and
2791 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
2792 should be used instead. For retrieving the current time, you may also use
2793 \helpref{wxDateTime::Now}{wxdatetimenow} or
2794 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
2796 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
2798 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
2800 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
2802 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
2805 See also \helpref{wxTimer}{wxtimer}.
2807 \wxheading{Include files}
2811 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
2813 \func{long}{wxGetLocalTime}{\void}
2815 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
2817 \wxheading{See also}
2819 \helpref{wxDateTime::Now}{wxdatetimenow}
2821 \wxheading{Include files}
2825 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
2827 \func{wxLongLone}{wxGetLocalTimeMillis}{\void}
2829 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
2831 \wxheading{See also}
2833 \helpref{wxDateTime::Now}{wxdatetimenow},\\
2834 \helpref{wxLongLone}{wxlonglong}
2836 \wxheading{Include files}
2840 \membersection{::wxGetUTCTime}\label{wxgetutctime}
2842 \func{long}{wxGetUTCTime}{\void}
2844 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
2846 \wxheading{See also}
2848 \helpref{wxDateTime::Now}{wxdatetimenow}
2850 \wxheading{Include files}
2854 \membersection{::wxStartTimer}\label{wxstarttimer}
2856 \func{void}{wxStartTimer}{\void}
2858 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
2860 See also \helpref{wxTimer}{wxtimer}.
2862 \wxheading{Include files}
2866 \section{Debugging macros and functions}\label{debugmacros}
2868 Useful macros and functions for error checking and defensive programming. ASSERTs are only
2869 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2872 \wxheading{Include files}
2876 \membersection{::wxOnAssert}\label{wxonassert}
2878 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2880 This function may be redefined to do something non trivial and is called
2881 whenever one of debugging macros fails (i.e. condition is false in an
2883 % TODO: this should probably be an overridable in wxApp.
2885 \membersection{wxASSERT}\label{wxassert}
2887 \func{}{wxASSERT}{\param{}{condition}}
2889 Assert macro. An error message will be generated if the condition is FALSE in
2890 debug mode, but nothing will be done in the release build.
2892 Please note that the condition in wxASSERT() should have no side effects
2893 because it will not be executed in release mode at all.
2895 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2897 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2899 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2901 Assert macro with message. An error message will be generated if the condition is FALSE.
2903 See also: \helpref{wxASSERT}{wxassert}
2905 \membersection{wxFAIL}\label{wxfail}
2907 \func{}{wxFAIL}{\void}
2909 Will always generate an assert error if this code is reached (in debug mode).
2911 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2913 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2915 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2917 Will always generate an assert error with specified message if this code is reached (in debug mode).
2919 This macro is useful for marking unreachable" code areas, for example
2920 it may be used in the "default:" branch of a switch statement if all possible
2921 cases are processed above.
2923 See also: \helpref{wxFAIL}{wxfail}
2925 \membersection{wxCHECK}\label{wxcheck}
2927 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2929 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2930 This check is done even in release mode.
2932 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2934 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2936 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2937 This check is done even in release mode.
2939 This macro may be only used in non void functions, see also
2940 \helpref{wxCHECK\_RET}{wxcheckret}.
2942 \membersection{wxCHECK\_RET}\label{wxcheckret}
2944 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2946 Checks that the condition is true, and returns if not (FAILs with given error
2947 message in debug mode). This check is done even in release mode.
2949 This macro should be used in void functions instead of
2950 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2952 \membersection{wxCHECK2}\label{wxcheck2}
2954 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2956 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2957 {\it operation} if it is not. This is a generalisation of
2958 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2959 returning from the function must be done when the {\it condition} is false.
2961 This check is done even in release mode.
2963 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2965 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2967 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2968 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2969 instead of wxFAIL() if the {\it condition} is false.
2971 \section{Environment access functions}\label{environfunctions}
2973 The functions in this section allow to access (get) or change value of
2974 environment variables in a portable way. They are currently implemented under
2975 Win32 and POSIX-like systems (Unix).
2977 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
2979 \wxheading{Include files}
2983 \membersection{wxGetenv}\label{wxgetenvmacro}
2985 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
2987 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
2990 Note that under Win32 it may not return correct value for the variables set
2991 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
2994 \membersection{wxGetEnv}\label{wxgetenv}
2996 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
2998 Returns the current value of the environment variable {\it var} in {\it value}.
2999 {\it value} may be {\tt NULL} if you just want to know if the variable exists
3000 and are not interested in its value.
3002 Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise.
3004 \membersection{wxSetEnv}\label{wxsetenv}
3006 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
3008 Sets the value of the environment variable {\it var} (adding it if necessary)
3011 Returns {\tt TRUE} on success.
3013 \membersection{wxUnsetEnv}\label{wxunsetenv}
3015 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
3017 Removes the variable {\it var} from the environment.
3018 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
3021 Returns {\tt TRUE} on success.