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{::wxGetDiskSpace
}\label{wxgetdiskspace
}
182 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
184 This function returns the total number of bytes and number of free bytes on
185 the disk containing the directory
{\it path
} (it should exist). Both
186 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
187 information is not needed.
191 {\tt TRUE
} on success,
{\tt FALSE
} if an error occured (for example, the
192 directory doesn't exist).
194 \wxheading{Portability
}
196 This function is implemented for Win16 (only for drives less than
2Gb), Win32,
197 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
199 This function first appeared in wxWindows
2.3.2.
201 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
203 \func{wxString
}{wxGetOSDirectory
}{\void}
205 Returns the Windows directory under Windows; on other platforms returns the empty string.
207 \membersection{::wxIsAbsolutePath
}
209 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
211 Returns TRUE if the argument is an absolute filename, i.e. with a slash
212 or drive name at the beginning.
214 \membersection{::wxPathOnly
}
216 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
218 Returns the directory part of the filename.
220 \membersection{::wxUnix2DosFilename
}
222 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
224 Converts a Unix to a DOS filename by replacing forward
225 slashes with backslashes.
227 \membersection{::wxConcatFiles
}
229 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
230 \param{const wxString\&
}{file3
}}
232 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
235 \membersection{::wxCopyFile
}
237 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = TRUE
}}
239 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful. If
240 {\it overwrite
} parameter is TRUE (default), the destination file is overwritten
241 if it exists, but if
{\it overwrite
} is FALSE, the functions failes in this
244 \membersection{::wxGetCwd
}\label{wxgetcwd
}
246 \func{wxString
}{wxGetCwd
}{\void}
248 Returns a string containing the current (or working) directory.
250 \membersection{::wxGetWorkingDirectory
}
252 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
254 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
256 Copies the current working directory into the buffer if supplied, or
257 copies the working directory into new storage (which you must delete yourself)
258 if the buffer is NULL.
260 {\it sz
} is the size of the buffer if supplied.
262 \membersection{::wxGetTempFileName
}
264 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
266 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
268 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
269 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
270 is allocated for the temporary filename using
{\it new
}.
272 Under Windows, the filename will include the drive and name of the
273 directory allocated for temporary files (usually the contents of the
274 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
276 It is the application's responsibility to create and delete the file.
278 \membersection{::wxIsWild
}\label{wxiswild
}
280 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
282 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
284 \membersection{::wxMatchWild
}\label{wxmatchwild
}
286 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
288 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
289 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
290 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
292 \membersection{::wxMkdir
}
294 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
296 Makes the directory
{\it dir
}, returning TRUE if successful.
298 {\it perm
} is the access mask for the directory for the systems on which it is
299 supported (Unix) and doesn't have effect for the other ones.
301 \membersection{::wxRemoveFile
}
303 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
305 Removes
{\it file
}, returning TRUE if successful.
307 \membersection{::wxRenameFile
}
309 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
311 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
313 \membersection{::wxRmdir
}
315 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
317 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
319 The
{\it flags
} parameter is reserved for future use.
321 \membersection{::wxSetWorkingDirectory
}
323 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
325 Sets the current working directory, returning TRUE if the operation succeeded.
326 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
328 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
330 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{wxString *
}{ path
},
\param{wxString *
}{ name
},
\param{wxString *
}{ ext
}}
332 This function splits a full file name into components: the path (including possible disk/drive
333 specification under Windows), the base name and the extension. Any of the output parameters
334 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
335 a particular component.
337 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
338 Windows, however it will not consider backslashes as path separators under Unix (where backslash
339 is a valid character in a filename).
341 On entry,
{\it fullname
} should be non-NULL (it may be empty though).
343 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
344 contains the file name and
{\it ext
} contains the file extension without leading dot. All
345 three of them may be empty if the corresponding component is. The old contents of the
346 strings pointed to by these parameters will be overwritten in any case (if the pointers
349 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
351 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
353 Copies the given file to
{\it stream
}. Useful when converting an old application to
354 use streams (within the
document/view framework, for example).
356 Use of this function requires the file wx
\_doc.h to be included.
358 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
360 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
362 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
363 use streams (within the
document/view framework, for example).
365 Use of this function requires the file wx
\_doc.h to be included.
367 \section{Network functions
}\label{networkfunctions
}
369 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
371 \func{wxString
}{wxGetFullHostName
}{\void}
373 Returns the FQDN (fully qualified domain host name) or an empty string on
378 \helpref{wxGetHostName
}{wxgethostname
}
380 \wxheading{Include files
}
384 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
386 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
388 Copies the user's email address into the supplied buffer, by
389 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
390 and
\helpref{wxGetUserId
}{wxgetuserid
}.
392 Returns TRUE if successful, FALSE otherwise.
394 \wxheading{Include files
}
398 \membersection{::wxGetHostName
}\label{wxgethostname
}
400 \func{wxString
}{wxGetHostName
}{\void}
402 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
404 Copies the current host machine's name into the supplied buffer. Please note
405 that the returned name is
{\it not
} fully qualified, i.e. it does not include
408 Under Windows or NT, this function first looks in the environment
409 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
410 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
412 The first variant of this function returns the hostname if successful or an
413 empty string otherwise. The second (deprecated) function returns TRUE
414 if successful, FALSE otherwise.
418 \helpref{wxGetFullHostName
}{wxgetfullhostname
}
420 \wxheading{Include files
}
424 \section{User identification
}\label{useridfunctions
}
426 \membersection{::wxGetUserId
}\label{wxgetuserid
}
428 \func{wxString
}{wxGetUserId
}{\void}
430 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
432 This function returns the "user id" also known as "login name" under Unix i.e.
433 something like "jsmith". It uniquely identifies the current user (on this system).
435 Under Windows or NT, this function first looks in the environment
436 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
437 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
439 The first variant of this function returns the login name if successful or an
440 empty string otherwise. The second (deprecated) function returns TRUE
441 if successful, FALSE otherwise.
445 \helpref{wxGetUserName
}{wxgetusername
}
447 \wxheading{Include files
}
451 \membersection{::wxGetUserName
}\label{wxgetusername
}
453 \func{wxString
}{wxGetUserName
}{\void}
455 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
457 This function returns the full user name (something like "Mr. John Smith").
459 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
460 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
461 is running, the entry
{\bf Current
} in the section
{\bf User
} of
462 the PENWIN.INI file is used.
464 The first variant of this function returns the user name if successful or an
465 empty string otherwise. The second (deprecated) function returns TRUE
466 if successful, FALSE otherwise.
470 \helpref{wxGetUserId
}{wxgetuserid
}
472 \wxheading{Include files
}
476 \section{String functions
}
478 \membersection{::copystring
}
480 \func{char*
}{copystring
}{\param{const char*
}{s
}}
482 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
483 deleted with the
{\it delete
} operator.
485 \membersection{::wxIsEmpty
}\label{wxisempty
}
487 \func{bool
}{wxIsEmpty
}{\param{const char *
}{ p
}}
489 Returns
{\tt TRUE
} if the pointer is either
{\tt NULL
} or points to an empty
490 string,
{\tt FALSE
} otherwise.
492 \membersection{::wxStricmp
}\label{wxstricmp
}
494 \func{int
}{wxStricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
496 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
497 to or greater than
{\it p2
}. The comparison is case-insensitive.
499 This function complements the standard C function
{\it strcmp()
} which performs
500 case-sensitive comparison.
502 \membersection{::wxStringMatch
}
504 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
505 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
507 Returns
{\tt TRUE
} if the substring
{\it s1
} is found within
{\it s2
},
508 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is
{\tt FALSE
},
509 no substring matching is done.
511 This function is obsolete, use
\helpref{wxString::Find
}{wxstringfind
} instead.
513 \membersection{::wxStringEq
}\label{wxstringeq
}
515 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
520 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
523 This function is obsolete, use
\helpref{wxString
}{wxstring
} instead.
525 \membersection{::wxStrlen
}\label{wxstrlen
}
527 \func{size
\_t}{wxStrlen
}{\param{const char *
}{ p
}}
529 This is a safe version of standard function
{\it strlen()
}: it does exactly the
530 same thing (i.e. returns the length of the string) except that it returns
0 if
531 {\it p
} is the
{\tt NULL
} pointer.
533 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
535 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
537 This function returns the translation of string
{\it str
} in the current
538 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
539 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
540 original string is returned. In debug build, an error message is logged - this
541 should help to find the strings which were not yet translated. As this function
542 is used very often, an alternative syntax is provided: the
\_() macro is
543 defined as wxGetTranslation().
545 \membersection{::wxSnprintf
}\label{wxsnprintf
}
547 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
549 This function replaces the dangerous standard function
{\tt sprintf()
} and is
550 like
{\tt snprintf()
} available on some platforms. The only difference with
551 sprintf() is that an additional argument - buffer size - is taken and the
552 buffer is never overflowed.
554 Returns the number of characters copied to the buffer or -
1 if there is not
559 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
561 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
563 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argptr
}}
565 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list}
566 argument instead of arbitrary number of parameters.
570 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
572 \section{Dialog functions
}\label{dialogfunctions
}
574 Below are a number of convenience functions for getting input from the
575 user or displaying messages. Note that in these functions the last three
576 parameters are optional. However, it is recommended to pass a parent frame
577 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
578 the front when the dialog box is popped up.
580 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
582 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
583 \param{size
\_t }{currentTip
}}
585 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
586 used with
\helpref{wxShowTip
}{wxshowtip
}.
588 \docparam{filename
}{The name of the file containing the tips, one per line
}
589 \docparam{currentTip
}{The index of the first tip to show - normally this index
590 is remembered between the
2 program runs.
}
594 \helpref{Tips overview
}{tipsoverview
}
596 \wxheading{Include files
}
600 \membersection{::wxFileSelector
}\label{wxfileselector
}
602 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
603 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
604 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
605 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
607 Pops up a file selector box. In Windows, this is the common file selector
608 dialog. In X, this is a file selector box with the same functionality.
609 The path and filename are distinct elements of a full file pathname.
610 If path is empty, the current directory will be used. If filename is empty,
611 no default filename will be supplied. The wildcard determines what files
612 are displayed in the file selector, and file extension supplies a type
613 extension for the required filename. Flags may be a combination of wxOPEN,
614 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, wxFILE
\_MUST\_EXIST, wxMULTIPLE or
0.
616 Both the Unix and Windows versions implement a wildcard filter. Typing a
617 filename containing wildcards
(*, ?) in the filename text item, and
618 clicking on Ok, will result in only those files matching the pattern being
621 The wildcard may be a specification for multiple types of file
622 with a description for each, such as:
625 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
628 The application must check for an empty return value (the user pressed
629 Cancel). For example:
632 const wxString& s = wxFileSelector("Choose a file to open");
639 \wxheading{Include files}
643 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
645 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
647 Shows the colour selection dialog and returns the colour selected by user or
648 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
649 is valid) if the dialog was cancelled.
651 \wxheading{Parameters}
653 \docparam{parent}{The parent window for the colour selection dialog}
655 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
657 \wxheading{Include files}
661 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
663 \func{size\_t}{wxGetMultipleChoices}{\\
664 \param{wxArrayInt\& }{selections},\\
665 \param{const wxString\& }{message},\\
666 \param{const wxString\& }{caption},\\
667 \param{const wxArrayString\& }{aChoices},\\
668 \param{wxWindow *}{parent = NULL},\\
669 \param{int}{ x = -1}, \param{int}{ y = -1},\\
670 \param{bool}{ centre = TRUE},\\
671 \param{int }{width=150}, \param{int }{height=200}}
673 \func{size\_t}{wxGetMultipleChoices}{\\
674 \param{wxArrayInt\& }{selections},\\
675 \param{const wxString\& }{message},\\
676 \param{const wxString\& }{caption},\\
677 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
678 \param{wxWindow *}{parent = NULL},\\
679 \param{int}{ x = -1}, \param{int}{ y = -1},\\
680 \param{bool}{ centre = TRUE},\\
681 \param{int }{width=150}, \param{int }{height=200}}
683 Pops up a dialog box containing a message, OK/Cancel buttons and a
684 multiple-selection listbox. The user may choose an arbitrary (including 0)
685 number of items in the listbox whose indices will be returned in
686 {\it selection} array. The initial contents of this array will be used to
687 select the items when the dialog is shown.
689 You may pass the list of strings to choose from either using {\it choices}
690 which is an array of {\it n} strings for the listbox or by using a single
691 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
693 If {\it centre} is TRUE, the message text (which may include new line
694 characters) is centred; if FALSE, the message is left-justified.
696 \wxheading{Include files}
700 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
701 and {\tt choices}, and no {\tt selections} parameter; the function
702 returns an array containing the user selections.}
704 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
706 \func{long}{wxGetNumberFromUser}{
707 \param{const wxString\& }{message},
708 \param{const wxString\& }{prompt},
709 \param{const wxString\& }{caption},
710 \param{long }{value},
711 \param{long }{min = 0},
712 \param{long }{max = 100},
713 \param{wxWindow *}{parent = NULL},
714 \param{const wxPoint\& }{pos = wxDefaultPosition}}
716 Shows a dialog asking the user for numeric input. The dialogs title is set to
717 {\it caption}, it contains a (possibly) multiline {\it message} above the
718 single line {\it prompt} and the zone for entering the number.
720 The number entered must be in the range {\it min}..{\it max} (both of which
721 should be positive) and {\it value} is the initial value of it. If the user
722 enters an invalid value or cancels the dialog, the function will return -1.
724 Dialog is centered on its {\it parent} unless an explicit position is given in
727 \wxheading{Include files}
731 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
733 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
734 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
736 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
737 in the dialog is not shown on screen but replaced with stars. This is intended
738 to be used for entering passwords as the function name implies.
740 \wxheading{Include files}
744 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
746 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
747 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
748 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
750 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
751 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
752 or press Cancel to return the empty string.
754 If {\it centre} is TRUE, the message text (which may include new line characters)
755 is centred; if FALSE, the message is left-justified.
757 \wxheading{Include files}
761 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
763 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
764 \param{int }{nsel}, \param{int *}{selection},
765 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
766 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
768 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
769 listbox. The user may choose one or more item(s) and press OK or Cancel.
771 The number of initially selected choices, and array of the selected indices,
772 are passed in; this array will contain the user selections on exit, with
773 the function returning the number of selections. {\it selection} must be
774 as big as the number of choices, in case all are selected.
776 If Cancel is pressed, -1 is returned.
778 {\it choices} is an array of {\it n} strings for the listbox.
780 If {\it centre} is TRUE, the message text (which may include new line characters)
781 is centred; if FALSE, the message is left-justified.
783 \wxheading{Include files}
787 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
789 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
790 \param{const wxString\& }{caption},\\
791 \param{const wxArrayString\& }{aChoices},\\
792 \param{wxWindow *}{parent = NULL},\\
793 \param{int}{ x = -1}, \param{int}{ y = -1},\\
794 \param{bool}{ centre = TRUE},\\
795 \param{int }{width=150}, \param{int }{height=200}}
797 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
798 \param{const wxString\& }{caption},\\
799 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
800 \param{wxWindow *}{parent = NULL},\\
801 \param{int}{ x = -1}, \param{int}{ y = -1},\\
802 \param{bool}{ centre = TRUE},\\
803 \param{int }{width=150}, \param{int }{height=200}}
805 Pops up a dialog box containing a message, OK/Cancel buttons and a
806 single-selection listbox. The user may choose an item and press OK to return a
807 string or Cancel to return the empty string. Use
808 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
809 valid choice and if you want to be able to detect pressing Cancel reliably.
811 You may pass the list of strings to choose from either using {\it choices}
812 which is an array of {\it n} strings for the listbox or by using a single
813 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
815 If {\it centre} is TRUE, the message text (which may include new line
816 characters) is centred; if FALSE, the message is left-justified.
818 \wxheading{Include files}
822 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
825 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
827 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
828 \param{const wxString\& }{caption},\\
829 \param{const wxArrayString\& }{aChoices},\\
830 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
831 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
833 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
834 \param{const wxString\& }{caption},\\
835 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
836 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
837 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
839 As {\bf wxGetSingleChoice} but returns the index representing the selected
840 string. If the user pressed cancel, -1 is returned.
842 \wxheading{Include files}
846 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
849 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
851 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
852 \param{const wxString\& }{caption},\\
853 \param{const wxArrayString\& }{aChoices},\\
854 \param{const wxString\& }{client\_data[]},\\
855 \param{wxWindow *}{parent = NULL},\\
856 \param{int}{ x = -1}, \param{int}{ y = -1},\\
857 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
859 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
860 \param{const wxString\& }{caption},\\
861 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
862 \param{const wxString\& }{client\_data[]},\\
863 \param{wxWindow *}{parent = NULL},\\
864 \param{int}{ x = -1}, \param{int}{ y = -1},\\
865 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
867 As {\bf wxGetSingleChoice} but takes an array of client data pointers
868 corresponding to the strings, and returns one of these pointers or NULL if
869 Cancel was pressed. The {\it client\_data} array must have the same number of
870 elements as {\it choices} or {\it aChoices}!
872 \wxheading{Include files}
876 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
877 and {\tt choices}, and the client data array must have the
878 same length as the choices array.}
880 \membersection{::wxMessageBox}\label{wxmessagebox}
882 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
883 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
885 General purpose message dialog. {\it style} may be a bit list of the
886 following identifiers:
888 \begin{twocollist}\itemsep=0pt
889 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
891 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
893 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
894 \twocolitem{wxCENTRE}{Centres the text.}
895 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
896 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
897 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
898 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
899 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
902 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
908 int answer = wxMessageBox("Quit program?", "Confirm",
909 wxYES_NO | wxCANCEL, main_frame);
915 {\it message} may contain newline characters, in which case the
916 message will be split into separate lines, to cater for large messages.
918 Under Windows, the native MessageBox function is used unless wxCENTRE
919 is specified in the style, in which case a generic function is used.
920 This is because the native MessageBox function cannot centre text.
921 The symbols are not shown when the generic function is used.
923 \wxheading{Include files}
927 \membersection{::wxShowTip}\label{wxshowtip}
929 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
930 \param{wxTipProvider *}{tipProvider},
931 \param{bool }{showAtStartup = TRUE}}
933 This function shows a "startup tip" to the user.
935 \docparam{parent}{The parent window for the modal dialog}
937 \docparam{tipProvider}{An object which is used to get the text of the tips.
938 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
940 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
941 otherwise. This is used as the initial value for "Show tips at startup"
942 checkbox which is shown in the tips dialog.}
946 \helpref{Tips overview}{tipsoverview}
948 \wxheading{Include files}
952 \section{GDI functions}\label{gdifunctions}
954 The following are relevant to the GDI (Graphics Device Interface).
956 \wxheading{Include files}
960 \membersection{::wxClientDisplayRect}
962 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
963 \param{int *}{width}, \param{int *}{height}}
965 \func{wxRect}{wxGetClientDisplayRect}{\void}
967 Returns the dimensions of the work area on the display. On Windows
968 this means the area not covered by the taskbar, etc. Other platforms
969 are currently defaulting to the whole display until a way is found to
970 provide this info for all window managers, etc.
972 \membersection{::wxColourDisplay}
974 \func{bool}{wxColourDisplay}{\void}
976 Returns TRUE if the display is colour, FALSE otherwise.
978 \membersection{::wxDisplayDepth}
980 \func{int}{wxDisplayDepth}{\void}
982 Returns the depth of the display (a value of 1 denotes a monochrome display).
984 \membersection{::wxDisplaySize}
986 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
988 \func{wxSize}{wxGetDisplaySize}{\void}
990 Returns the display size in pixels.
992 \membersection{::wxDisplaySizeMM}
994 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
996 \func{wxSize}{wxGetDisplaySizeMM}{\void}
998 Returns the display size in millimeters.
1000 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
1002 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
1003 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
1005 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
1006 makes it into a placeable metafile by prepending a header containing the given
1007 bounding box. The bounding box may be obtained from a device context after drawing
1008 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
1010 In addition to adding the placeable metafile header, this function adds
1011 the equivalent of the following code to the start of the metafile data:
1014 SetMapMode(dc, MM_ANISOTROPIC);
1015 SetWindowOrg(dc, minX, minY);
1016 SetWindowExt(dc, maxX - minX, maxY - minY);
1019 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
1021 Placeable metafiles may be imported by many Windows applications, and can be
1022 used in RTF (Rich Text Format) files.
1024 {\it scale} allows the specification of scale for the metafile.
1026 This function is only available under Windows.
1028 \membersection{::wxSetCursor}\label{wxsetcursor}
1030 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
1032 Globally sets the cursor; only has an effect in Windows and GTK.
1033 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
1035 \section{Printer settings}\label{printersettings}
1037 These routines are obsolete and should no longer be used!
1039 The following functions are used to control PostScript printing. Under
1040 Windows, PostScript output can only be sent to a file.
1042 \wxheading{Include files}
1046 \membersection{::wxGetPrinterCommand}
1048 \func{wxString}{wxGetPrinterCommand}{\void}
1050 Gets the printer command used to print a file. The default is {\tt lpr}.
1052 \membersection{::wxGetPrinterFile}
1054 \func{wxString}{wxGetPrinterFile}{\void}
1056 Gets the PostScript output filename.
1058 \membersection{::wxGetPrinterMode}
1060 \func{int}{wxGetPrinterMode}{\void}
1062 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
1063 The default is PS\_PREVIEW.
1065 \membersection{::wxGetPrinterOptions}
1067 \func{wxString}{wxGetPrinterOptions}{\void}
1069 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
1071 \membersection{::wxGetPrinterOrientation}
1073 \func{int}{wxGetPrinterOrientation}{\void}
1075 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
1077 \membersection{::wxGetPrinterPreviewCommand}
1079 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
1081 Gets the command used to view a PostScript file. The default depends on the platform.
1083 \membersection{::wxGetPrinterScaling}
1085 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
1087 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
1089 \membersection{::wxGetPrinterTranslation}
1091 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
1093 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
1095 \membersection{::wxSetPrinterCommand}
1097 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
1099 Sets the printer command used to print a file. The default is {\tt lpr}.
1101 \membersection{::wxSetPrinterFile}
1103 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
1105 Sets the PostScript output filename.
1107 \membersection{::wxSetPrinterMode}
1109 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
1111 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
1112 The default is PS\_PREVIEW.
1114 \membersection{::wxSetPrinterOptions}
1116 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
1118 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
1120 \membersection{::wxSetPrinterOrientation}
1122 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
1124 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
1126 \membersection{::wxSetPrinterPreviewCommand}
1128 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
1130 Sets the command used to view a PostScript file. The default depends on the platform.
1132 \membersection{::wxSetPrinterScaling}
1134 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
1136 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
1138 \membersection{::wxSetPrinterTranslation}
1140 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
1142 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
1144 \section{Clipboard functions}\label{clipsboard}
1146 These clipboard functions are implemented for Windows only. The use of these functions
1147 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
1150 \wxheading{Include files}
1154 \membersection{::wxClipboardOpen}
1156 \func{bool}{wxClipboardOpen}{\void}
1158 Returns TRUE if this application has already opened the clipboard.
1160 \membersection{::wxCloseClipboard}
1162 \func{bool}{wxCloseClipboard}{\void}
1164 Closes the clipboard to allow other applications to use it.
1166 \membersection{::wxEmptyClipboard}
1168 \func{bool}{wxEmptyClipboard}{\void}
1170 Empties the clipboard.
1172 \membersection{::wxEnumClipboardFormats}
1174 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
1176 Enumerates the formats found in a list of available formats that belong
1177 to the clipboard. Each call to this function specifies a known
1178 available format; the function returns the format that appears next in
1181 {\it dataFormat} specifies a known format. If this parameter is zero,
1182 the function returns the first format in the list.
1184 The return value specifies the next known clipboard data format if the
1185 function is successful. It is zero if the {\it dataFormat} parameter specifies
1186 the last format in the list of available formats, or if the clipboard
1189 Before it enumerates the formats function, an application must open the clipboard by using the
1190 wxOpenClipboard function.
1192 \membersection{::wxGetClipboardData}
1194 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
1196 Gets data from the clipboard.
1198 {\it dataFormat} may be one of:
1200 \begin{itemize}\itemsep=0pt
1201 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
1202 \item wxCF\_BITMAP: returns a new wxBitmap.
1205 The clipboard must have previously been opened for this call to succeed.
1207 \membersection{::wxGetClipboardFormatName}
1209 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
1211 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
1212 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
1214 \membersection{::wxIsClipboardFormatAvailable}
1216 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
1218 Returns TRUE if the given data format is available on the clipboard.
1220 \membersection{::wxOpenClipboard}
1222 \func{bool}{wxOpenClipboard}{\void}
1224 Opens the clipboard for passing data to it or getting data from it.
1226 \membersection{::wxRegisterClipboardFormat}
1228 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
1230 Registers the clipboard data format name and returns an identifier.
1232 \membersection{::wxSetClipboardData}
1234 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
1236 Passes data to the clipboard.
1238 {\it dataFormat} may be one of:
1240 \begin{itemize}\itemsep=0pt
1241 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
1242 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
1243 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
1244 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
1247 The clipboard must have previously been opened for this call to succeed.
1249 \section{Miscellaneous functions}\label{miscellany}
1251 \membersection{::wxDROP\_ICON}\label{wxdropicon}
1253 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
1255 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
1256 name. Under MSW, the cursor is loaded from the resource file and the icon is
1257 loaded from XPM file under other platforms.
1259 This macro should be used with
1260 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
1262 \wxheading{Include files}
1266 \membersection{::wxNewId}
1268 \func{long}{wxNewId}{\void}
1270 Generates an integer identifier unique to this run of the program.
1272 \wxheading{Include files}
1276 \membersection{::wxRegisterId}
1278 \func{void}{wxRegisterId}{\param{long}{ id}}
1280 Ensures that ids subsequently generated by {\bf NewId} do not clash with
1283 \wxheading{Include files}
1287 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1289 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1291 Changes the cursor to the given cursor for all windows in the application.
1292 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1293 to its previous state. These two calls can be nested, and a counter
1294 ensures that only the outer calls take effect.
1296 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1298 \wxheading{Include files}
1302 \membersection{::wxBell}
1304 \func{void}{wxBell}{\void}
1306 Ring the system bell.
1308 \wxheading{Include files}
1312 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
1314 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
1316 Creates and returns an object of the given class, if the class has been
1317 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
1319 \membersection{::wxDDECleanUp}\label{wxddecleanup}
1321 \func{void}{wxDDECleanUp}{\void}
1323 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
1324 called by the application.
1326 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
1328 \wxheading{Include files}
1332 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1334 \func{void}{wxDDEInitialize}{\void}
1336 Initializes the DDE system. May be called multiple times without harm.
1338 This no longer needs to be called by the application: it will be called
1339 by wxWindows if necessary.
1341 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1342 \helpref{wxDDECleanUp}{wxddecleanup}.
1344 \wxheading{Include files}
1348 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1350 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1352 {\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
1354 Display a debugging message; under Windows, this will appear on the
1355 debugger command window, and under Unix, it will be written to standard
1358 The syntax is identical to {\bf printf}: pass a format string and a
1359 variable list of arguments.
1361 {\bf Tip:} under Windows, if your application crashes before the
1362 message appears in the debugging window, put a wxYield call after
1363 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1364 (at least for Watcom C++): preformat your messages and use OutputDebugString
1367 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1369 \wxheading{Include files}
1373 \membersection{::wxDisplaySize}
1375 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1377 Gets the physical size of the display in pixels.
1379 \wxheading{Include files}
1383 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1385 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1387 This function enables or disables all top level windows. It is used by
1388 \helpref{::wxSafeYield}{wxsafeyield}.
1390 \wxheading{Include files}
1394 \membersection{::wxEntry}\label{wxentry}
1396 This initializes wxWindows in a platform-dependent way. Use this if you
1397 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1398 you can initialize wxWindows from an Microsoft Foundation Classes application using
1401 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1402 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1404 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1405 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1406 message loop will be entered.
1408 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1409 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1411 wxWindows initialization under Windows (for applications constructed as a DLL).
1413 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1415 wxWindows initialization under Unix.
1419 To clean up wxWindows, call wxApp::OnExit followed by the static function
1420 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1423 int CTheApp::ExitInstance()
1425 // OnExit isn't called by CleanUp so must be called explicitly.
1429 return CWinApp::ExitInstance();
1433 \wxheading{Include files}
1437 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1439 \func{void}{wxEndBusyCursor}{\void}
1441 Changes the cursor back to the original cursor, for all windows in the application.
1442 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1444 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1446 \wxheading{Include files}
1450 \membersection{::wxError}\label{wxerror}
1452 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1454 Displays {\it msg} and continues. This writes to standard error under
1455 Unix, and pops up a message box under Windows. Used for internal
1456 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1458 \wxheading{Include files}
1462 \membersection{::wxExecute}\label{wxexecute}
1464 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1466 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1468 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
1470 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
1472 Executes another program in Unix or Windows.
1474 The first form takes a command string, such as {\tt "emacs file.txt"}.
1476 The second form takes an array of values: a command, any number of
1477 arguments, terminated by NULL.
1479 The semantics of the third and fourth versions is different from the first two
1480 and is described in more details below.
1482 If {\it sync} is FALSE (the default), flow of control immediately returns.
1483 If TRUE, the current application waits until the other program has terminated.
1485 In the case of synchronous execution, the return value is the exit code of
1486 the process (which terminates by the moment the function returns) and will be
1487 $-1$ if the process couldn't be started and typically 0 if the process
1488 terminated successfully. Also, while waiting for the process to
1489 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1490 should ensure that this can cause no recursion, in the simplest case by
1491 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1493 For asynchronous execution, however, the return value is the process id and
1494 zero value indicates that the command could not be executed. As an added
1495 complication, the return value of $-1$ in this case indicattes that we didn't
1496 launch a new process, but connected to the running one (this can only happen in
1497 case of using DDE under Windows for command execution). In particular, in this,
1498 and only this, case the calling code will not get the notification about
1499 process termination.
1501 If callback isn't NULL and if execution is asynchronous (note that callback
1502 parameter can not be non-NULL for synchronous execution),
1503 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1504 the process finishes.
1506 Finally, you may use the third overloaded version of this function to execute
1507 a process (always synchronously) and capture its output in the array
1508 {\it output}. The fourth version adds the possibility to additionally capture
1509 the messages from standard error output in the {\it errors} array.
1511 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
1512 \helpref{Exec sample}{sampleexec}.
1514 \wxheading{Include files}
1518 \membersection{::wxExit}\label{wxexit}
1520 \func{void}{wxExit}{\void}
1522 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1523 Should only be used in an emergency: normally the top-level frame
1524 should be deleted (after deleting all other frames) to terminate the
1525 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1527 \wxheading{Include files}
1531 \membersection{::wxFatalError}\label{wxfatalerror}
1533 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1535 Displays {\it msg} and exits. This writes to standard error under Unix,
1536 and pops up a message box under Windows. Used for fatal internal
1537 wxWindows errors. See also \helpref{wxError}{wxerror}.
1539 \wxheading{Include files}
1543 \membersection{::wxFindMenuItemId}
1545 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1547 Find a menu item identifier associated with the given frame's menu bar.
1549 \wxheading{Include files}
1553 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
1555 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1557 Find a window by its label. Depending on the type of window, the label may be a window title
1558 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1559 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1560 The search is recursive in both cases.
1562 \wxheading{Include files}
1566 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1568 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1570 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1571 If {\it parent} is NULL, the search will start from all top-level
1572 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1573 The search is recursive in both cases.
1575 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1577 \wxheading{Include files}
1581 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
1583 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
1585 Find the deepest window at the given mouse position in screen coordinates,
1586 returning the window if found, or NULL if not.
1588 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
1590 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
1592 Find the deepest window at the mouse pointer position, returning the window
1593 and current pointer position in screen coordinates.
1595 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1597 \func{wxWindow *}{wxGetActiveWindow}{\void}
1599 Gets the currently active window (Windows only).
1601 \wxheading{Include files}
1605 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1607 \func{wxString}{wxGetDisplayName}{\void}
1609 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1611 \wxheading{Include files}
1615 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1617 \func{wxString}{wxGetHomeDir}{\void}
1619 Return the (current) user's home directory.
1621 \wxheading{See also}
1623 \helpref{wxGetUserHome}{wxgetuserhome}
1625 \wxheading{Include files}
1629 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1631 \func{long}{wxGetFreeMemory}{\void}
1633 Returns the amount of free memory in bytes under environments which
1634 support it, and -1 if not supported. Currently, it is supported only
1635 under Windows, Linux and Solaris.
1637 \wxheading{Include files}
1641 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
1643 \func{wxPoint}{wxGetMousePosition}{\void}
1645 Returns the mouse position in screen coordinates.
1647 \wxheading{Include files}
1651 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1653 \func{wxString}{wxGetOsDescription}{\void}
1655 Returns the string containing the description of the current platform in a
1656 user-readable form. For example, this function may return strings like
1657 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1659 \wxheading{See also}
1661 \helpref{::wxGetOsVersion}{wxgetosversion}
1663 \wxheading{Include files}
1667 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1669 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1671 Gets operating system version information.
1673 \begin{twocollist}\itemsep=0pt
1674 \twocolitemruled{Platform}{Return types}
1675 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1676 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1677 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1678 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1679 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1680 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1681 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1682 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1683 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1684 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1687 \wxheading{See also}
1689 \helpref{::wxGetOsDescription}{wxgetosdescription}
1691 \wxheading{Include files}
1695 \membersection{::wxGetResource}\label{wxgetresource}
1697 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1698 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1700 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1701 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1703 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1704 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1706 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1707 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1709 Gets a resource value from the resource database (for example, WIN.INI, or
1710 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1711 otherwise the specified file is used.
1713 Under X, if an application class (wxApp::GetClassName) has been defined,
1714 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1715 an applications default file when merging all resource databases.
1717 The reason for passing the result in an argument is that it
1718 can be convenient to define a default value, which gets overridden
1719 if the value exists in the resource file. It saves a separate
1720 test for that resource's existence, and it also allows
1721 the overloading of the function for different types.
1723 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1725 \wxheading{Include files}
1729 \membersection{::wxGetUserId}
1731 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1733 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1734 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1735 Under Windows, this returns ``user''.
1737 \wxheading{Include files}
1741 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1743 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1745 Returns the home directory for the given user. If the username is empty
1746 (default value), this function behaves like
1747 \helpref{wxGetHomeDir}{wxgethomedir}.
1749 \wxheading{Include files}
1753 \membersection{::wxGetUserName}
1755 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1757 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1758 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1759 Under Windows, this returns ``unknown''.
1761 \wxheading{Include files}
1765 \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
1767 \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
1769 If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
1770 faults under Windows or segmentation violations in the Unix world) will be
1771 caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
1772 By default, i.e. before this function is called, they will be handled in the
1773 normal way which usually just means that the application will be terminated.
1774 Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore
1775 this default behaviour.
1777 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
1779 \func{void}{wxInitAllImageHandlers}{\void}
1781 Initializes all available image handlers. For a list of available handlers,
1782 see \helpref{wxImage}{wximage}.
1784 \wxheading{See also}
1786 \helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
1788 \wxheading{Include files}
1792 \membersection{::wxInitialize}\label{wxinitialize}
1794 \func{bool}{wxInitialize}{\void}
1796 This function is used in wxBase only and only if you don't create
1797 \helpref{wxApp}{wxapp} object at all. In this case you must call it from your
1798 {\tt main()} function before calling any other wxWindows functions.
1800 If the function returns {\tt FALSE} the initialization could not be performed,
1801 in this case the library cannot be used and
1802 \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither.
1804 This function may be called several times but
1805 \helpref{wxUninitialize}{wxuninitialize} must be called for each successful
1806 call to this function.
1808 \wxheading{Include files}
1812 \membersection{::wxIsBusy}\label{wxisbusy}
1814 \func{bool}{wxIsBusy}{\void}
1816 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1817 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1819 See also \helpref{wxBusyCursor}{wxbusycursor}.
1821 \wxheading{Include files}
1825 \membersection{::wxKill}\label{wxkill}
1827 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
1829 Equivalent to the Unix kill function: send the given signal {\it sig} to the
1830 process with PID {\it pid}. The valud signal values are
1835 wxSIGNONE = 0, // verify if the process exists under Unix
1844 wxSIGKILL, // forcefully kill, dangerous!
1850 wxSIGTERM // terminate the process gently
1854 {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning
1855 under both Unix and Windows but all the other signals are equivalent to
1856 {\tt wxSIGTERM} under Windows.
1858 Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will
1859 be filled with an element of {\tt wxKillError} enum:
1864 wxKILL_OK, // no error
1865 wxKILL_BAD_SIGNAL, // no such signal
1866 wxKILL_ACCESS_DENIED, // permission denied
1867 wxKILL_NO_PROCESS, // no such process
1868 wxKILL_ERROR // another, unspecified error
1872 \wxheading{See also}
1874 \helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
1875 \helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
1876 \helpref{Exec sample}{sampleexec}
1878 \wxheading{Include files}
1882 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1884 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1886 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1887 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1889 The resource must be defined in the {\tt .rc} file using the following syntax:
1892 myResource TEXT file.ext
1895 where {\tt file.ext} is a file that the resource compiler can find.
1897 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1898 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1899 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1901 This function is available under Windows only.
1903 \wxheading{Include files}
1907 \membersection{::wxNow}\label{wxnow}
1909 \func{wxString}{wxNow}{\void}
1911 Returns a string representing the current date and time.
1913 \wxheading{Include files}
1917 \membersection{::wxPostDelete}\label{wxpostdelete}
1919 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1921 Tells the system to delete the specified object when
1922 all other events have been processed. In some environments, it is
1923 necessary to use this instead of deleting a frame directly with the
1924 delete operator, because some GUIs will still send events to a deleted window.
1926 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1928 \wxheading{Include files}
1932 \membersection{::wxPostEvent}\label{wxpostevent}
1934 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
1936 This function posts the event to the specified {\it dest} object. The
1937 difference between sending an event and posting it is that in the first case
1938 the event is processed before the function returns (in wxWindows, event sending
1939 is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
1940 the second, the function returns immediately and the event will be processed
1941 sometime later - usually during the next even loop iteration.
1943 Note that a copy of the {\it event} is made by the function, so the original
1944 copy can be deleted as soon as function returns. This function can also be used
1945 to send events between different threads safely. As this function makes a
1946 copy of the event, the event needs to have a fully implemented Clone() method,
1947 which may not be the case for all event in wxWindows.
1949 See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
1952 \wxheading{Include files}
1956 \membersection{::wxSafeYield}\label{wxsafeyield}
1958 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1960 This function is similar to wxYield, except that it disables the user input to
1961 all program windows before calling wxYield and re-enables it again
1962 afterwards. If {\it win} is not NULL, this window will remain enabled,
1963 allowing the implementation of some limited user interaction.
1965 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1967 \wxheading{Include files}
1971 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1973 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1975 Under X only, sets the current display name. This is the X host and display name such
1976 as ``colonsay:0.0", and the function indicates which display should be used for creating
1977 windows from this point on. Setting the display within an application allows multiple
1978 displays to be used.
1980 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1982 \wxheading{Include files}
1986 \membersection{::wxShell}\label{wxshell}
1988 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1990 Executes a command in an interactive shell window. If no command is
1991 specified, then just the shell is spawned.
1993 See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
1995 \wxheading{Include files}
1999 \membersection{::wxSleep}\label{wxsleep}
2001 \func{void}{wxSleep}{\param{int}{ secs}}
2003 Sleeps for the specified number of seconds.
2005 \wxheading{Include files}
2009 \membersection{::wxStripMenuCodes}
2011 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
2013 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
2015 Strips any menu codes from {\it in} and places the result
2016 in {\it out} (or returns the new string, in the first form).
2018 Menu codes include \& (mark the next character with an underline
2019 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
2021 \wxheading{Include files}
2025 \membersection{::wxToLower}\label{wxtolower}
2027 \func{char}{wxToLower}{\param{char }{ch}}
2029 Converts the character to lower case. This is implemented as a macro for efficiency.
2031 \wxheading{Include files}
2035 \membersection{::wxToUpper}\label{wxtoupper}
2037 \func{char}{wxToUpper}{\param{char }{ch}}
2039 Converts the character to upper case. This is implemented as a macro for efficiency.
2041 \wxheading{Include files}
2045 \membersection{::wxTrace}\label{wxtrace}
2047 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
2049 Takes printf-style variable argument syntax. Output
2050 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2052 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2054 \wxheading{Include files}
2058 \membersection{::wxTraceLevel}\label{wxtracelevel}
2060 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
2062 Takes printf-style variable argument syntax. Output
2063 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2064 The first argument should be the level at which this information is appropriate.
2065 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2068 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2070 \wxheading{Include files}
2074 \membersection{::wxTrap}\label{wxtrap}
2076 \func{void}{wxTrap}{\void}
2078 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
2079 debugger exception meaning that the control is passed to the debugger if one is
2080 attached to the process. Otherwise the program just terminates abnormally.
2082 In release mode this function does nothing.
2084 \wxheading{Include files}
2088 \membersection{::wxUninitialize}\label{wxuninitialize}
2090 \func{void}{wxUninitialize}{\void}
2092 This function is for use in console (wxBase) programs only. It must be called
2093 once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
2095 \wxheading{Include files}
2099 \membersection{::wxUsleep}\label{wxusleep}
2101 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
2103 Sleeps for the specified number of milliseconds. Notice that usage of this
2104 function is encouraged instead of calling usleep(3) directly because the
2105 standard usleep() function is not MT safe.
2107 \wxheading{Include files}
2111 \membersection{::wxWriteResource}\label{wxwriteresource}
2113 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2114 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
2116 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2117 \param{float }{value}, \param{const wxString\& }{file = NULL}}
2119 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2120 \param{long }{value}, \param{const wxString\& }{file = NULL}}
2122 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2123 \param{int }{value}, \param{const wxString\& }{file = NULL}}
2125 Writes a resource value into the resource database (for example, WIN.INI, or
2126 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2127 otherwise the specified file is used.
2129 Under X, the resource databases are cached until the internal function
2130 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
2131 all updated resource databases are written to their files.
2133 Note that it is considered bad manners to write to the .Xdefaults
2134 file under Unix, although the WIN.INI file is fair game under Windows.
2136 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
2138 \wxheading{Include files}
2142 \membersection{::wxYield}\label{wxyield}
2144 \func{bool}{wxYield}{\void}
2146 Calls \helpref{wxApp::Yield}{wxappyield}.
2148 This function is kept only for backwards compatibility, please use the
2149 wxApp method instead in any new code.
2151 \wxheading{Include files}
2153 <wx/app.h> or <wx/utils.h>
2155 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
2157 \func{void}{wxWakeUpIdle}{\void}
2159 This functions wakes up the (internal and platform dependent) idle system, i.e. it
2160 will force the system to send an idle event even if the system currently {\it is}
2161 idle and thus would not send any idle event until after some other event would get
2162 sent. This is also useful for sending events between two threads and is used by
2163 the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
2164 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2166 \wxheading{Include files}
2170 \section{Macros}\label{macros}
2172 These macros are defined in wxWindows.
2174 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
2176 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
2178 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
2180 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
2182 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
2184 This macro will swap the bytes of the {\it value} variable from little
2185 endian to big endian or vice versa.
2187 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
2189 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
2191 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
2193 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
2195 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
2197 This macro will swap the bytes of the {\it value} variable from little
2198 endian to big endian or vice versa if the program is compiled on a
2199 big-endian architecture (such as Sun work stations). If the program has
2200 been compiled on a little-endian architecture, the value will be unchanged.
2202 Use these macros to read data from and write data to a file that stores
2203 data in little endian (Intel i386) format.
2205 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
2207 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
2209 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
2211 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
2213 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
2215 This macro will swap the bytes of the {\it value} variable from little
2216 endian to big endian or vice versa if the program is compiled on a
2217 little-endian architecture (such as Intel PCs). If the program has
2218 been compiled on a big-endian architecture, the value will be unchanged.
2220 Use these macros to read data from and write data to a file that stores
2221 data in big endian format.
2223 \membersection{CLASSINFO}\label{classinfo}
2225 \func{wxClassInfo *}{CLASSINFO}{className}
2227 Returns a pointer to the wxClassInfo object associated with this class.
2229 \wxheading{Include files}
2233 \membersection{DECLARE\_ABSTRACT\_CLASS}
2235 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
2237 Used inside a class declaration to declare that the class should be
2238 made known to the class hierarchy, but objects of this class cannot be created
2239 dynamically. The same as DECLARE\_CLASS.
2244 class wxCommand: public wxObject
2246 DECLARE_ABSTRACT_CLASS(wxCommand)
2255 \wxheading{Include files}
2259 \membersection{DECLARE\_APP}\label{declareapp}
2261 \func{}{DECLARE\_APP}{className}
2263 This is used in headers to create a forward declaration of the wxGetApp function implemented
2264 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
2272 \wxheading{Include files}
2276 \membersection{DECLARE\_CLASS}
2278 \func{}{DECLARE\_CLASS}{className}
2280 Used inside a class declaration to declare that the class should be
2281 made known to the class hierarchy, but objects of this class cannot be created
2282 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
2284 \wxheading{Include files}
2288 \membersection{DECLARE\_DYNAMIC\_CLASS}
2290 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
2292 Used inside a class declaration to declare that the objects of this class should be dynamically
2293 creatable from run-time type information.
2298 class wxFrame: public wxWindow
2300 DECLARE_DYNAMIC_CLASS(wxFrame)
2303 const wxString\& frameTitle;
2309 \wxheading{Include files}
2313 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
2315 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
2317 Used in a C++ implementation file to complete the declaration of
2318 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
2323 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
2325 wxCommand::wxCommand(void)
2331 \wxheading{Include files}
2335 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
2337 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
2339 Used in a C++ implementation file to complete the declaration of
2340 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
2342 \wxheading{Include files}
2346 \membersection{IMPLEMENT\_APP}\label{implementapp}
2348 \func{}{IMPLEMENT\_APP}{className}
2350 This is used in the application class implementation file to make the application class known to
2351 wxWindows for dynamic construction. You use this instead of
2362 IMPLEMENT_APP(MyApp)
2365 See also \helpref{DECLARE\_APP}{declareapp}.
2367 \wxheading{Include files}
2371 \membersection{IMPLEMENT\_CLASS}
2373 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
2375 Used in a C++ implementation file to complete the declaration of
2376 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
2378 \wxheading{Include files}
2382 \membersection{IMPLEMENT\_CLASS2}
2384 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
2386 Used in a C++ implementation file to complete the declaration of a
2387 class that has run-time type information and two base classes. The
2388 same as IMPLEMENT\_ABSTRACT\_CLASS2.
2390 \wxheading{Include files}
2394 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
2396 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
2398 Used in a C++ implementation file to complete the declaration of
2399 a class that has run-time type information, and whose instances
2400 can be created dynamically.
2405 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
2407 wxFrame::wxFrame(void)
2413 \wxheading{Include files}
2417 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
2419 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
2421 Used in a C++ implementation file to complete the declaration of
2422 a class that has run-time type information, and whose instances
2423 can be created dynamically. Use this for classes derived from two
2426 \wxheading{Include files}
2430 \membersection{wxBITMAP}\label{wxbitmapmacro}
2432 \func{}{wxBITMAP}{bitmapName}
2434 This macro loads a bitmap from either application resources (on the platforms
2435 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2436 avoid using {\tt \#ifdef}s when creating bitmaps.
2438 \wxheading{See also}
2440 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2441 \helpref{wxICON}{wxiconmacro}
2443 \wxheading{Include files}
2447 \membersection{wxConstCast}\label{wxconstcast}
2449 \func{classname *}{wxConstCast}{ptr, classname}
2451 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
2452 supports {\it const\_cast} or into an old, C-style cast, otherwise.
2454 \wxheading{See also}
2456 \helpref{wxDynamicCast}{wxdynamiccast}\\
2457 \helpref{wxStaticCast}{wxstaticcast}
2459 \membersection{WXDEBUG\_NEW}\label{debugnew}
2461 \func{}{WXDEBUG\_NEW}{arg}
2463 This is defined in debug mode to be call the redefined new operator
2464 with filename and line number arguments. The definition is:
2467 #define WXDEBUG_NEW new(__FILE__,__LINE__)
2470 In non-debug mode, this is defined as the normal new operator.
2472 \wxheading{Include files}
2476 \membersection{wxDynamicCast}\label{wxdynamiccast}
2478 \func{classname *}{wxDynamicCast}{ptr, classname}
2480 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
2481 the pointer is of this type (the check is done during the run-time) or
2482 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
2483 wxObject::IsKindOf() function.
2485 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
2491 wxWindow *win = wxWindow::FindFocus();
2492 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
2495 // a text control has the focus...
2499 // no window has the focus or it is not a text control
2503 \wxheading{See also}
2505 \helpref{RTTI overview}{runtimeclassoverview}\\
2506 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
2507 \helpref{wxConstCast}{wxconstcast}\\
2508 \helpref{wxStatiicCast}{wxstaticcast}
2510 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
2512 \func{classname *}{wxDynamicCastThis}{classname}
2514 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
2515 latter provokes spurious compilation warnings from some compilers (because it
2516 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
2517 this macro should be used to avoid them.
2519 \wxheading{See also}
2521 \helpref{wxDynamicCast}{wxdynamiccast}
2523 \membersection{wxICON}\label{wxiconmacro}
2525 \func{}{wxICON}{iconName}
2527 This macro loads an icon from either application resources (on the platforms
2528 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2529 avoid using {\tt \#ifdef}s when creating icons.
2531 \wxheading{See also}
2533 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2534 \helpref{wxBITMAP}{wxbitmapmacro}
2536 \wxheading{Include files}
2540 \membersection{wxStaticCast}\label{wxstaticcast}
2542 \func{classname *}{wxStaticCast}{ptr, classname}
2544 This macro checks that the cast is valid in debug mode (an assert failure will
2545 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
2546 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
2548 \helpref{wxDynamicCast}{wxdynamiccast}\\
2549 \helpref{wxConstCast}{wxconstcast}
2551 \membersection{WXTRACE}\label{trace}
2553 \wxheading{Include files}
2557 \func{}{WXTRACE}{formatString, ...}
2559 Calls wxTrace with printf-style variable argument syntax. Output
2560 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2562 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2564 \wxheading{Include files}
2568 \membersection{WXTRACELEVEL}\label{tracelevel}
2570 \func{}{WXTRACELEVEL}{level, formatString, ...}
2572 Calls wxTraceLevel with printf-style variable argument syntax. Output
2573 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2574 The first argument should be the level at which this information is appropriate.
2575 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2578 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2580 \wxheading{Include files}
2584 \section{wxWindows resource functions}\label{resourcefuncs}
2586 \overview{wxWindows resource system}{resourceformats}
2588 This section details functions for manipulating wxWindows (.WXR) resource
2589 files and loading user interface elements from resources.
2591 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2592 about initialisation file resource reading and writing, using such functions
2593 as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}
2595 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2597 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2598 loading from resource data.
2600 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2602 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2604 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2605 \tt{#}defining a name to an integer). Unlikely to be used by an application except
2606 perhaps for implementing resource functionality for interpreted languages.
2608 \membersection{::wxResourceClear}
2610 \func{void}{wxResourceClear}{\void}
2612 Clears the wxWindows resource table.
2614 \membersection{::wxResourceCreateBitmap}
2616 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2618 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2619 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2623 static const wxString\& project_resource = "bitmap(name = 'project_resource',\
2624 bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2625 bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2628 then this function can be called as follows:
2631 wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
2634 \membersection{::wxResourceCreateIcon}
2636 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2638 Creates a new icon from a file, static data, or Windows resource, given a valid
2639 wxWindows icon resource identifier. For example, if the .WXR file contains
2643 static const wxString\& project_resource = "icon(name = 'project_resource',\
2644 icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2645 icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2648 then this function can be called as follows:
2651 wxIcon *icon = wxResourceCreateIcon("project_resource");
2654 \membersection{::wxResourceCreateMenuBar}
2656 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2658 Creates a new menu bar given a valid wxWindows menubar resource
2659 identifier. For example, if the .WXR file contains the following:
2662 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2666 ['&Open File', 2, 'Open a file'],\
2667 ['&Save File', 3, 'Save a file'],\
2669 ['E&xit', 4, 'Exit program']\
2672 ['&About', 6, 'About this program']\
2677 then this function can be called as follows:
2680 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2684 \membersection{::wxResourceGetIdentifier}
2686 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2688 Used for retrieving the integer value associated with an identifier.
2689 A zero value indicates that the identifier was not found.
2691 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2693 \membersection{::wxResourceParseData}\label{wxresourcedata}
2695 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2697 Parses a string containing one or more wxWindows resource objects. If
2698 the resource objects are global static data that are included into the
2699 C++ program, then this function must be called for each variable
2700 containing the resource data, to make it known to wxWindows.
2702 {\it resource} should contain data in the following form:
2705 dialog(name = 'dialog1',
2706 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2707 title = 'Test dialog box',
2708 x = 312, y = 234, width = 400, height = 300,
2710 control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2711 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2712 control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
2713 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2714 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2715 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2718 This function will typically be used after including a {\tt .wxr} file into
2719 a C++ program as follows:
2722 #include "dialog1.wxr"
2725 Each of the contained resources will declare a new C++ variable, and each
2726 of these variables should be passed to wxResourceParseData.
2728 \membersection{::wxResourceParseFile}
2730 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2732 Parses a file containing one or more wxWindows resource objects
2733 in C++-compatible syntax. Use this function to dynamically load
2734 wxWindows resource data.
2736 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2738 \func{bool}{wxResourceParseString}{\param{char*}{ s}, \param{wxResourceTable *}{table = NULL}}
2740 Parses a string containing one or more wxWindows resource objects. If
2741 the resource objects are global static data that are included into the
2742 C++ program, then this function must be called for each variable
2743 containing the resource data, to make it known to wxWindows.
2745 {\it resource} should contain data with the following form:
2748 dialog(name = 'dialog1',
2749 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2750 title = 'Test dialog box',
2751 x = 312, y = 234, width = 400, height = 300,
2753 control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2754 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2755 control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
2756 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2757 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2758 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2761 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2762 load an entire {\tt .wxr file} into a string.
2764 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2766 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char* }{xbm\_data}, \param{int }{width},
2767 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2769 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}}
2771 Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.
2772 This is required if other resources will use the bitmap data, since otherwise there
2773 is no connection between names used in resources, and the global bitmap data.
2775 \membersection{::wxResourceRegisterIconData}
2777 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2779 \section{Log functions}\label{logfunctions}
2781 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2782 further information. The functions use (implicitly) the currently active log
2783 target, so their descriptions here may not apply if the log target is not the
2784 standard one (installed by wxWindows in the beginning of the program).
2786 \wxheading{Include files}
2790 \membersection{::wxLogError}\label{wxlogerror}
2792 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2794 The function to use for error messages, i.e. the messages that must be shown
2795 to the user. The default processing is to pop up a message box to inform the
2798 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2800 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2802 Like \helpref{wxLogError}{wxlogerror}, but also
2803 terminates the program with the exit code 3. Using {\it abort()} standard
2804 function also terminates the program with this exit code.
2806 \membersection{::wxLogWarning}\label{wxlogwarning}
2808 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2810 For warnings - they are also normally shown to the user, but don't interrupt
2813 \membersection{::wxLogMessage}\label{wxlogmessage}
2815 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2817 for all normal, informational messages. They also appear in a message box by
2818 default (but it can be changed). Notice that the standard behaviour is to not
2819 show informational messages if there are any errors later - the logic being
2820 that the later error messages make the informational messages preceding them
2823 \membersection{::wxLogVerbose}\label{wxlogverbose}
2825 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2827 For verbose output. Normally, it is suppressed, but
2828 might be activated if the user wishes to know more details about the program
2829 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2831 \membersection{::wxLogStatus}\label{wxlogstatus}
2833 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
2835 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2837 Messages logged by this function will appear in the statusbar of the {\it
2838 frame} or of the top level application window by default (i.e. when using
2839 the second version of the function).
2841 If the target frame doesn't have a statusbar, the message will be lost.
2843 \membersection{::wxLogSysError}\label{wxlogsyserror}
2845 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2847 Mostly used by wxWindows itself, but might be handy for logging errors after
2848 system call (API function) failure. It logs the specified message text as well
2849 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2850 on the platform) and the corresponding error message. The second form
2851 of this function takes the error code explicitly as the first argument.
2853 \wxheading{See also}
2855 \helpref{wxSysErrorCode}{wxsyserrorcode},
2856 \helpref{wxSysErrorMsg}{wxsyserrormsg}
2858 \membersection{::wxLogDebug}\label{wxlogdebug}
2860 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2862 The right function for debug output. It only does anything at all in the debug
2863 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
2864 nothing in release mode (otherwise).
2866 \membersection{::wxLogTrace}\label{wxlogtrace}
2868 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2870 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
2872 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
2874 As {\bf wxLogDebug}, trace functions only do something in debug build and
2875 expand to nothing in the release one. The reason for making
2876 it a separate function from it is that usually there are a lot of trace
2877 messages, so it might make sense to separate them from other debug messages.
2879 The trace messages also usually can be separated into different categories and
2880 the second and third versions of this function only log the message if the
2881 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
2882 allows to selectively trace only some operations and not others by changing
2883 the value of the trace mask (possible during the run-time).
2885 For the second function (taking a string mask), the message is logged only if
2886 the mask has been previously enabled by the call to
2887 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
2888 used by wxWindows are:
2890 \begin{itemize}\itemsep=0pt
2891 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
2892 \item wxTRACE\_Messages: trace window messages/X callbacks
2893 \item wxTRACE\_ResAlloc: trace GDI resource allocation
2894 \item wxTRACE\_RefCount: trace various ref counting operations
2895 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
2898 The third version of the function only logs the message if all the bit
2899 corresponding to the {\it mask} are set in the wxLog trace mask which can be
2900 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
2901 flexible than the previous one because it doesn't allow defining the user
2902 trace masks easily - this is why it is deprecated in favour of using string
2905 \begin{itemize}\itemsep=0pt
2906 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2907 \item wxTraceMessages: trace window messages/X callbacks
2908 \item wxTraceResAlloc: trace GDI resource allocation
2909 \item wxTraceRefCount: trace various ref counting operations
2910 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
2913 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
2915 \func{unsigned long}{wxSysErrorCode}{\void}
2917 Returns the error code from the last system call. This function uses
2918 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
2920 \wxheading{See also}
2922 \helpref{wxSysErrorMsg}{wxsyserrormsg},
2923 \helpref{wxLogSysError}{wxlogsyserror}
2925 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
2927 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
2929 Returns the error message corresponding to the given system error code. If
2930 {\it errCode} is $0$ (default), the last error code (as returned by
2931 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
2933 \wxheading{See also}
2935 \helpref{wxSysErrorCode}{wxsyserrorcode},
2936 \helpref{wxLogSysError}{wxlogsyserror}
2938 \section{Time functions}\label{timefunctions}
2940 The functions in this section deal with getting the current time and
2941 starting/stopping the global timers. Please note that the timer functions are
2942 deprecated because they work with one global timer only and
2943 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
2944 should be used instead. For retrieving the current time, you may also use
2945 \helpref{wxDateTime::Now}{wxdatetimenow} or
2946 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
2948 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
2950 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
2952 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
2954 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
2957 See also \helpref{wxTimer}{wxtimer}.
2959 \wxheading{Include files}
2963 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
2965 \func{long}{wxGetLocalTime}{\void}
2967 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
2969 \wxheading{See also}
2971 \helpref{wxDateTime::Now}{wxdatetimenow}
2973 \wxheading{Include files}
2977 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
2979 \func{wxLongLone}{wxGetLocalTimeMillis}{\void}
2981 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
2983 \wxheading{See also}
2985 \helpref{wxDateTime::Now}{wxdatetimenow},\\
2986 \helpref{wxLongLone}{wxlonglong}
2988 \wxheading{Include files}
2992 \membersection{::wxGetUTCTime}\label{wxgetutctime}
2994 \func{long}{wxGetUTCTime}{\void}
2996 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
2998 \wxheading{See also}
3000 \helpref{wxDateTime::Now}{wxdatetimenow}
3002 \wxheading{Include files}
3006 \membersection{::wxStartTimer}\label{wxstarttimer}
3008 \func{void}{wxStartTimer}{\void}
3010 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
3012 See also \helpref{wxTimer}{wxtimer}.
3014 \wxheading{Include files}
3018 \section{Debugging macros and functions}\label{debugmacros}
3020 Useful macros and functions for error checking and defensive programming. ASSERTs are only
3021 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
3024 \wxheading{Include files}
3028 \membersection{::wxOnAssert}\label{wxonassert}
3030 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
3032 This function may be redefined to do something non trivial and is called
3033 whenever one of debugging macros fails (i.e. condition is false in an
3035 % TODO: this should probably be an overridable in wxApp.
3037 \membersection{wxASSERT}\label{wxassert}
3039 \func{}{wxASSERT}{\param{}{condition}}
3041 Assert macro. An error message will be generated if the condition is FALSE in
3042 debug mode, but nothing will be done in the release build.
3044 Please note that the condition in wxASSERT() should have no side effects
3045 because it will not be executed in release mode at all.
3047 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
3049 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
3051 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
3053 Assert macro with message. An error message will be generated if the condition is FALSE.
3055 See also: \helpref{wxASSERT}{wxassert}
3057 \membersection{wxFAIL}\label{wxfail}
3059 \func{}{wxFAIL}{\void}
3061 Will always generate an assert error if this code is reached (in debug mode).
3063 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
3065 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
3067 \func{}{wxFAIL\_MSG}{\param{}{msg}}
3069 Will always generate an assert error with specified message if this code is reached (in debug mode).
3071 This macro is useful for marking unreachable" code areas, for example
3072 it may be used in the "default:" branch of a switch statement if all possible
3073 cases are processed above.
3075 See also: \helpref{wxFAIL}{wxfail}
3077 \membersection{wxCHECK}\label{wxcheck}
3079 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
3081 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
3082 This check is done even in release mode.
3084 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
3086 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
3088 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
3089 This check is done even in release mode.
3091 This macro may be only used in non void functions, see also
3092 \helpref{wxCHECK\_RET}{wxcheckret}.
3094 \membersection{wxCHECK\_RET}\label{wxcheckret}
3096 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
3098 Checks that the condition is true, and returns if not (FAILs with given error
3099 message in debug mode). This check is done even in release mode.
3101 This macro should be used in void functions instead of
3102 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
3104 \membersection{wxCHECK2}\label{wxcheck2}
3106 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
3108 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
3109 {\it operation} if it is not. This is a generalisation of
3110 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
3111 returning from the function must be done when the {\it condition} is false.
3113 This check is done even in release mode.
3115 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
3117 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
3119 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
3120 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
3121 instead of wxFAIL() if the {\it condition} is false.
3123 \section{Environment access functions}\label{environfunctions}
3125 The functions in this section allow to access (get) or change value of
3126 environment variables in a portable way. They are currently implemented under
3127 Win32 and POSIX-like systems (Unix).
3129 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
3131 \wxheading{Include files}
3135 \membersection{wxGetenv}\label{wxgetenvmacro}
3137 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
3139 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
3142 Note that under Win32 it may not return correct value for the variables set
3143 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
3146 \membersection{wxGetEnv}\label{wxgetenv}
3148 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
3150 Returns the current value of the environment variable {\it var} in {\it value}.
3151 {\it value} may be {\tt NULL} if you just want to know if the variable exists
3152 and are not interested in its value.
3154 Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise.
3156 \membersection{wxSetEnv}\label{wxsetenv}
3158 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
3160 Sets the value of the environment variable {\it var} (adding it if necessary)
3163 Returns {\tt TRUE} on success.
3165 \membersection{wxUnsetEnv}\label{wxunsetenv}
3167 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
3169 Removes the variable {\it var} from the environment.
3170 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
3173 Returns {\tt TRUE} on success.