1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions defined in wxWindows are described here.
7 \section{Thread functions
}\label{threadfunctions
}
9 \wxheading{Include files
}
15 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
17 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
19 \func{void
}{wxMutexGuiEnter
}{\void}
21 This function must be called when any thread other than the main GUI thread
22 wants to get access to the GUI library. This function will block the execution
23 of the calling thread until the main thread (or any other thread holding the
24 main GUI lock) leaves the GUI library and no other other thread will enter
25 the GUI library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
27 Typically, these functions are used like this:
30 void MyThread::Foo(void)
32 // before doing any GUI calls we must ensure that this thread is the only
38 my_window->DrawSomething();
44 Note that under GTK, no creation of top-level windows is allowed in any
45 thread but the main one.
47 This function is only defined on platforms which support preemptive
50 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
52 \func{void
}{wxMutexGuiLeave
}{\void}
54 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
56 This function is only defined on platforms which support preemptive
59 \section{File functions
}\label{filefunctions
}
61 \wxheading{Include files
}
67 \helpref{wxPathList
}{wxpathlist
},
\helpref{wxDir
}{wxdir
},
\helpref{wxFile
}{wxfile
}
69 \membersection{::wxDirExists
}
71 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
73 Returns TRUE if the directory exists.
75 \membersection{::wxDos2UnixFilename
}
77 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
79 Converts a DOS to a Unix filename by replacing backslashes with forward
82 \membersection{::wxFileExists
}
84 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
86 Returns TRUE if the file exists. It also returns TRUE if the file is
89 \membersection{::wxFileModificationTime
}
91 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
93 Returns time of last modification of given file.
96 \membersection{::wxFileNameFromPath
}
98 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
100 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
102 Returns the filename for a full path. The second form returns a pointer to
103 temporary storage that should not be deallocated.
105 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
107 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
109 This function does directory searching; returns the first file
110 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
111 get the next matching file. Neither will
report the current directory "." or the
112 parent directory "..".
114 {\it spec
} may contain wildcards.
116 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
121 wxString f = wxFindFirstFile("/home/project/*.*");
122 while ( !f.IsEmpty() )
125 f = wxFindNextFile();
129 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
131 \func{wxString
}{wxFindNextFile
}{\void}
133 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
135 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
137 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
139 \func{wxString
}{wxGetOSDirectory
}{\void}
141 Returns the Windows directory under Windows; on other platforms returns the empty string.
143 \membersection{::wxIsAbsolutePath
}
145 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
147 Returns TRUE if the argument is an absolute filename, i.e. with a slash
148 or drive name at the beginning.
150 \membersection{::wxPathOnly
}
152 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
154 Returns the directory part of the filename.
156 \membersection{::wxUnix2DosFilename
}
158 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
160 Converts a Unix to a DOS filename by replacing forward
161 slashes with backslashes.
163 \membersection{::wxConcatFiles
}
165 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
166 \param{const wxString\&
}{file3
}}
168 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
171 \membersection{::wxCopyFile
}
173 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
175 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
177 \membersection{::wxGetCwd
}\label{wxgetcwd
}
179 \func{wxString
}{wxGetCwd
}{\void}
181 Returns a string containing the current (or working) directory.
183 \membersection{::wxGetWorkingDirectory
}
185 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
187 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
189 Copies the current working directory into the buffer if supplied, or
190 copies the working directory into new storage (which you must delete yourself)
191 if the buffer is NULL.
193 {\it sz
} is the size of the buffer if supplied.
195 \membersection{::wxGetTempFileName
}
197 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
199 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
201 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
202 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
203 is allocated for the temporary filename using
{\it new
}.
205 Under Windows, the filename will include the drive and name of the
206 directory allocated for temporary files (usually the contents of the
207 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
209 It is the application's responsibility to create and delete the file.
211 \membersection{::wxIsWild
}\label{wxiswild
}
213 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
215 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
217 \membersection{::wxMatchWild
}\label{wxmatchwild
}
219 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
221 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
222 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
223 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
225 \membersection{::wxMkdir
}
227 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
229 Makes the directory
{\it dir
}, returning TRUE if successful.
231 {\it perm
} is the access mask for the directory for the systems on which it is
232 supported (Unix) and doesn't have effect for the other ones.
234 \membersection{::wxRemoveFile
}
236 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
238 Removes
{\it file
}, returning TRUE if successful.
240 \membersection{::wxRenameFile
}
242 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
244 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
246 \membersection{::wxRmdir
}
248 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
250 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
252 The
{\it flags
} parameter is reserved for future use.
254 \membersection{::wxSetWorkingDirectory
}
256 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
258 Sets the current working directory, returning TRUE if the operation succeeded.
259 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
261 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
263 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{wxString *
}{ path
},
\param{wxString *
}{ name
},
\param{wxString *
}{ ext
}}
265 This function splits a full file name into components: the path (including possible disk/drive
266 specification under Windows), the base name and the extension. Any of the output parameters
267 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
268 a particular component.
270 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
271 Windows, however it will not consider backslashes as path separators under Unix (where backslash
272 is a valid character in a filename).
274 On entry,
{\it fullname
} should be non NULL (it may be empty though).
276 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
277 contains the file name and
{\it ext
} contains the file extension without leading dot. All
278 three of them may be empty if the corresponding component is. The old contents of the
279 strings pointed to by these parameters will be overwritten in any case (if the pointers
282 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
284 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
286 Copies the given file to
{\it stream
}. Useful when converting an old application to
287 use streams (within the
document/view framework, for example).
289 Use of this function requires the file wx
\_doc.h to be included.
291 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
293 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
295 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
296 use streams (within the
document/view framework, for example).
298 Use of this function requires the file wx
\_doc.h to be included.
300 \section{Network functions
}\label{networkfunctions
}
302 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
304 \func{wxString
}{wxGetFullHostName
}{\void}
306 Returns the FQDN (fully qualified domain host name) or an empty string on
311 \helpref{wxGetHostName
}{wxgethostname
}
313 \wxheading{Include files
}
317 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
319 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
321 Copies the user's email address into the supplied buffer, by
322 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
323 and
\helpref{wxGetUserId
}{wxgetuserid
}.
325 Returns TRUE if successful, FALSE otherwise.
327 \wxheading{Include files
}
331 \membersection{::wxGetHostName
}\label{wxgethostname
}
333 \func{wxString
}{wxGetHostName
}{\void}
335 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
337 Copies the current host machine's name into the supplied buffer. Please note
338 that the returned name is
{\it not
} fully qualified, i.e. it does not include
341 Under Windows or NT, this function first looks in the environment
342 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
343 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
345 The first variant of this function returns the hostname if successful or an
346 empty string otherwise. The second (deprecated) function returns TRUE
347 if successful, FALSE otherwise.
351 \helpref{wxGetFullHostName
}{wxgetfullhostname
}
353 \wxheading{Include files
}
357 \section{User identification
}\label{useridfunctions
}
359 \membersection{::wxGetUserId
}\label{wxgetuserid
}
361 \func{wxString
}{wxGetUserId
}{\void}
363 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
365 This function returns the "user id" also known as "login name" under Unix i.e.
366 something like "jsmith". It uniquely identifies the current user (on this system).
368 Under Windows or NT, this function first looks in the environment
369 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
370 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
372 The first variant of this function returns the login name if successful or an
373 empty string otherwise. The second (deprecated) function returns TRUE
374 if successful, FALSE otherwise.
378 \helpref{wxGetUserName
}{wxgetusername
}
380 \wxheading{Include files
}
384 \membersection{::wxGetUserName
}\label{wxgetusername
}
386 \func{wxString
}{wxGetUserName
}{\void}
388 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
390 This function returns the full user name (something like "Mr. John Smith").
392 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
393 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
394 is running, the entry
{\bf Current
} in the section
{\bf User
} of
395 the PENWIN.INI file is used.
397 The first variant of this function returns the user name if successful or an
398 empty string otherwise. The second (deprecated) function returns TRUE
399 if successful, FALSE otherwise.
403 \helpref{wxGetUserId
}{wxgetuserid
}
405 \wxheading{Include files
}
409 \section{String functions
}
411 \membersection{::copystring
}
413 \func{char*
}{copystring
}{\param{const char*
}{s
}}
415 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
416 deleted with the
{\it delete
} operator.
418 \membersection{::wxStringMatch
}
420 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
421 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
423 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
424 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
425 no substring matching is done.
427 \membersection{::wxStringEq
}\label{wxstringeq
}
429 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
434 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
437 \membersection{::IsEmpty
}\label{isempty
}
439 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
441 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
442 pointer to this function and it will return TRUE for it.
444 \membersection{::Stricmp
}\label{stricmp
}
446 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
448 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
449 to or greater than
{\it p2
}. The comparison is case-insensitive.
451 This function complements the standard C function
{\it strcmp()
} which performs
452 case-sensitive comparison.
454 \membersection{::Strlen
}\label{strlen
}
456 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
458 This is a safe version of standard function
{\it strlen()
}: it does exactly the
459 same thing (i.e. returns the length of the string) except that it returns
0 if
460 {\it p
} is the NULL pointer.
462 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
464 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
466 This function returns the translation of string
{\it str
} in the current
467 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
468 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
469 original string is returned. In debug build, an error message is logged - this
470 should help to find the strings which were not yet translated. As this function
471 is used very often, an alternative syntax is provided: the
\_() macro is
472 defined as wxGetTranslation().
474 \membersection{::wxSnprintf
}\label{wxsnprintf
}
476 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
478 This function replaces the dangerous standard function
{\tt sprintf()
} and is
479 like
{\tt snprintf()
} available on some platforms. The only difference with
480 sprintf() is that an additional argument - buffer size - is taken and the
481 buffer is never overflowed.
483 Returns the number of characters copied to the buffer or -
1 if there is not
488 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
490 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
492 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argptr
}}
494 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list}
495 argument instead of arbitrary number of parameters.
499 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
501 \section{Dialog functions
}\label{dialogfunctions
}
503 Below are a number of convenience functions for getting input from the
504 user or displaying messages. Note that in these functions the last three
505 parameters are optional. However, it is recommended to pass a parent frame
506 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
507 the front when the dialog box is popped up.
509 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
511 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
512 \param{size
\_t }{currentTip
}}
514 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
515 used with
\helpref{wxShowTip
}{wxshowtip
}.
517 \docparam{filename
}{The name of the file containing the tips, one per line
}
518 \docparam{currentTip
}{The index of the first tip to show - normally this index
519 is remembered between the
2 program runs.
}
523 \helpref{Tips overview
}{tipsoverview
}
525 \wxheading{Include files
}
529 \membersection{::wxFileSelector
}\label{wxfileselector
}
531 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
532 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
533 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
534 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
536 Pops up a file selector box. In Windows, this is the common file selector
537 dialog. In X, this is a file selector box with the same functionality.
538 The path and filename are distinct elements of a full file pathname.
539 If path is empty, the current directory will be used. If filename is empty,
540 no default filename will be supplied. The wildcard determines what files
541 are displayed in the file selector, and file extension supplies a type
542 extension for the required filename. Flags may be a combination of wxOPEN,
543 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, wxFILE
\_MUST\_EXIST, wxMULTIPLE or
0.
545 Both the Unix and Windows versions implement a wildcard filter. Typing a
546 filename containing wildcards
(*, ?) in the filename text item, and
547 clicking on Ok, will result in only those files matching the pattern being
550 The wildcard may be a specification for multiple types of file
551 with a description for each, such as:
554 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
557 The application must check for an empty return value (the user pressed
558 Cancel). For example:
561 const wxString& s = wxFileSelector("Choose a file to open");
568 \wxheading{Include files}
572 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
574 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
576 Shows the colour selection dialog and returns the colour selected by user or
577 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
578 is valid) if the dialog was cancelled.
580 \wxheading{Parameters}
582 \docparam{parent}{The parent window for the colour selection dialog}
584 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
586 \wxheading{Include files}
590 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
592 \func{long}{wxGetNumberFromUser}{
593 \param{const wxString\& }{message},
594 \param{const wxString\& }{prompt},
595 \param{const wxString\& }{caption},
596 \param{long }{value},
597 \param{long }{min = 0},
598 \param{long }{max = 100},
599 \param{wxWindow *}{parent = NULL},
600 \param{const wxPoint\& }{pos = wxDefaultPosition}}
602 Shows a dialog asking the user for numeric input. The dialogs title is set to
603 {\it caption}, it contains a (possibly) multiline {\it message} above the
604 single line {\it prompt} and the zone for entering the number.
606 The number entered must be in the range {\it min}..{\it max} (both of which
607 should be positive) and {\it value} is the initial value of it. If the user
608 enters an invalid value or cancels the dialog, the function will return -1.
610 Dialog is centered on its {\it parent} unless an explicit position is given in
613 \wxheading{Include files}
617 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
619 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
620 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
622 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
623 in the dialog is not shown on screen but replaced with stars. This is intended
624 to be used for entering passwords as the function name implies.
626 \wxheading{Include files}
630 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
632 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
633 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
634 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
636 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
637 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
638 or press Cancel to return the empty string.
640 If {\it centre} is TRUE, the message text (which may include new line characters)
641 is centred; if FALSE, the message is left-justified.
643 \wxheading{Include files}
647 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
649 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
650 \param{int }{nsel}, \param{int *}{selection},
651 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
652 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
654 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
655 listbox. The user may choose one or more item(s) and press OK or Cancel.
657 The number of initially selected choices, and array of the selected indices,
658 are passed in; this array will contain the user selections on exit, with
659 the function returning the number of selections. {\it selection} must be
660 as big as the number of choices, in case all are selected.
662 If Cancel is pressed, -1 is returned.
664 {\it choices} is an array of {\it n} strings for the listbox.
666 If {\it centre} is TRUE, the message text (which may include new line characters)
667 is centred; if FALSE, the message is left-justified.
669 \wxheading{Include files}
673 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
675 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
676 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
677 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
679 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
680 listbox. The user may choose an item and press OK to return a string or
681 Cancel to return the empty string.
683 {\it choices} is an array of {\it n} strings for the listbox.
685 If {\it centre} is TRUE, the message text (which may include new line characters)
686 is centred; if FALSE, the message is left-justified.
688 \wxheading{Include files}
692 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
694 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
695 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
696 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
698 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
699 If the user pressed cancel, -1 is returned.
701 \wxheading{Include files}
705 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
707 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
708 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
709 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
711 As {\bf wxGetSingleChoice} but takes an array of client data pointers
712 corresponding to the strings, and returns one of these pointers.
714 \wxheading{Include files}
718 \membersection{::wxMessageBox}\label{wxmessagebox}
720 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
721 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
723 General purpose message dialog. {\it style} may be a bit list of the
724 following identifiers:
726 \begin{twocollist}\itemsep=0pt
727 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
729 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
731 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
732 \twocolitem{wxCENTRE}{Centres the text.}
733 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
734 \twocolitem{wxICON\_HAND}{Displays a hand symbol.}
735 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
736 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
739 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
745 int answer = wxMessageBox("Quit program?", "Confirm",
746 wxYES_NO | wxCANCEL, main_frame);
752 {\it message} may contain newline characters, in which case the
753 message will be split into separate lines, to cater for large messages.
755 Under Windows, the native MessageBox function is used unless wxCENTRE
756 is specified in the style, in which case a generic function is used.
757 This is because the native MessageBox function cannot centre text.
758 The symbols are not shown when the generic function is used.
760 \wxheading{Include files}
764 \membersection{::wxShowTip}\label{wxshowtip}
766 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
767 \param{wxTipProvider *}{tipProvider},
768 \param{bool }{showAtStartup = TRUE}}
770 This function shows a "startup tip" to the user.
772 \docparam{parent}{The parent window for the modal dialog}
774 \docparam{tipProvider}{An object which is used to get the text of the tips.
775 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
777 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
778 otherwise. This is used as the initial value for "Show tips at startup"
779 checkbox which is shown in the tips dialog.}
783 \helpref{Tips overview}{tipsoverview}
785 \wxheading{Include files}
789 \section{GDI functions}\label{gdifunctions}
791 The following are relevant to the GDI (Graphics Device Interface).
793 \wxheading{Include files}
797 \membersection{::wxColourDisplay}
799 \func{bool}{wxColourDisplay}{\void}
801 Returns TRUE if the display is colour, FALSE otherwise.
803 \membersection{::wxDisplayDepth}
805 \func{int}{wxDisplayDepth}{\void}
807 Returns the depth of the display (a value of 1 denotes a monochrome display).
809 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
811 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
812 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
814 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
815 makes it into a placeable metafile by prepending a header containing the given
816 bounding box. The bounding box may be obtained from a device context after drawing
817 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
819 In addition to adding the placeable metafile header, this function adds
820 the equivalent of the following code to the start of the metafile data:
823 SetMapMode(dc, MM_ANISOTROPIC);
824 SetWindowOrg(dc, minX, minY);
825 SetWindowExt(dc, maxX - minX, maxY - minY);
828 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
830 Placeable metafiles may be imported by many Windows applications, and can be
831 used in RTF (Rich Text Format) files.
833 {\it scale} allows the specification of scale for the metafile.
835 This function is only available under Windows.
837 \membersection{::wxSetCursor}\label{wxsetcursor}
839 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
841 Globally sets the cursor; only has an effect in Windows and GTK.
842 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
844 \section{Printer settings}\label{printersettings}
846 These routines are obsolete and should no longer be used!
848 The following functions are used to control PostScript printing. Under
849 Windows, PostScript output can only be sent to a file.
851 \wxheading{Include files}
855 \membersection{::wxGetPrinterCommand}
857 \func{wxString}{wxGetPrinterCommand}{\void}
859 Gets the printer command used to print a file. The default is {\tt lpr}.
861 \membersection{::wxGetPrinterFile}
863 \func{wxString}{wxGetPrinterFile}{\void}
865 Gets the PostScript output filename.
867 \membersection{::wxGetPrinterMode}
869 \func{int}{wxGetPrinterMode}{\void}
871 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
872 The default is PS\_PREVIEW.
874 \membersection{::wxGetPrinterOptions}
876 \func{wxString}{wxGetPrinterOptions}{\void}
878 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
880 \membersection{::wxGetPrinterOrientation}
882 \func{int}{wxGetPrinterOrientation}{\void}
884 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
886 \membersection{::wxGetPrinterPreviewCommand}
888 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
890 Gets the command used to view a PostScript file. The default depends on the platform.
892 \membersection{::wxGetPrinterScaling}
894 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
896 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
898 \membersection{::wxGetPrinterTranslation}
900 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
902 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
904 \membersection{::wxSetPrinterCommand}
906 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
908 Sets the printer command used to print a file. The default is {\tt lpr}.
910 \membersection{::wxSetPrinterFile}
912 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
914 Sets the PostScript output filename.
916 \membersection{::wxSetPrinterMode}
918 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
920 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
921 The default is PS\_PREVIEW.
923 \membersection{::wxSetPrinterOptions}
925 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
927 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
929 \membersection{::wxSetPrinterOrientation}
931 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
933 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
935 \membersection{::wxSetPrinterPreviewCommand}
937 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
939 Sets the command used to view a PostScript file. The default depends on the platform.
941 \membersection{::wxSetPrinterScaling}
943 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
945 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
947 \membersection{::wxSetPrinterTranslation}
949 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
951 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
953 \section{Clipboard functions}\label{clipsboard}
955 These clipboard functions are implemented for Windows only. The use of these functions
956 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
959 \wxheading{Include files}
963 \membersection{::wxClipboardOpen}
965 \func{bool}{wxClipboardOpen}{\void}
967 Returns TRUE if this application has already opened the clipboard.
969 \membersection{::wxCloseClipboard}
971 \func{bool}{wxCloseClipboard}{\void}
973 Closes the clipboard to allow other applications to use it.
975 \membersection{::wxEmptyClipboard}
977 \func{bool}{wxEmptyClipboard}{\void}
979 Empties the clipboard.
981 \membersection{::wxEnumClipboardFormats}
983 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
985 Enumerates the formats found in a list of available formats that belong
986 to the clipboard. Each call to this function specifies a known
987 available format; the function returns the format that appears next in
990 {\it dataFormat} specifies a known format. If this parameter is zero,
991 the function returns the first format in the list.
993 The return value specifies the next known clipboard data format if the
994 function is successful. It is zero if the {\it dataFormat} parameter specifies
995 the last format in the list of available formats, or if the clipboard
998 Before it enumerates the formats function, an application must open the clipboard by using the
999 wxOpenClipboard function.
1001 \membersection{::wxGetClipboardData}
1003 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
1005 Gets data from the clipboard.
1007 {\it dataFormat} may be one of:
1009 \begin{itemize}\itemsep=0pt
1010 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
1011 \item wxCF\_BITMAP: returns a new wxBitmap.
1014 The clipboard must have previously been opened for this call to succeed.
1016 \membersection{::wxGetClipboardFormatName}
1018 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
1020 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
1021 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
1023 \membersection{::wxIsClipboardFormatAvailable}
1025 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
1027 Returns TRUE if the given data format is available on the clipboard.
1029 \membersection{::wxOpenClipboard}
1031 \func{bool}{wxOpenClipboard}{\void}
1033 Opens the clipboard for passing data to it or getting data from it.
1035 \membersection{::wxRegisterClipboardFormat}
1037 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
1039 Registers the clipboard data format name and returns an identifier.
1041 \membersection{::wxSetClipboardData}
1043 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
1045 Passes data to the clipboard.
1047 {\it dataFormat} may be one of:
1049 \begin{itemize}\itemsep=0pt
1050 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
1051 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
1052 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
1053 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
1056 The clipboard must have previously been opened for this call to succeed.
1058 \section{Miscellaneous functions}\label{miscellany}
1060 \membersection{wxHandleFatalExcetions}\label{wxhandlefatalexcetions}
1062 \func{bool}{wxHandleFatalExcetions}{\param{bool }{doIt = TRUE}}
1064 Enables or disables handling of fatal program exceptions. If {\it doIt} is
1065 TRUE, \helpref{wxApp::OnFatalException}{wxapponfatalexception} will be called
1066 before the program crashes. Otherwise, the default behaviour will be restored.
1068 \membersection{::wxNewId}
1070 \func{long}{wxNewId}{\void}
1072 Generates an integer identifier unique to this run of the program.
1074 \wxheading{Include files}
1078 \membersection{::wxRegisterId}
1080 \func{void}{wxRegisterId}{\param{long}{ id}}
1082 Ensures that ids subsequently generated by {\bf NewId} do not clash with
1085 \wxheading{Include files}
1089 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1091 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1093 Changes the cursor to the given cursor for all windows in the application.
1094 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1095 to its previous state. These two calls can be nested, and a counter
1096 ensures that only the outer calls take effect.
1098 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1100 \wxheading{Include files}
1104 \membersection{::wxBell}
1106 \func{void}{wxBell}{\void}
1108 Ring the system bell.
1110 \wxheading{Include files}
1114 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
1116 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
1118 Creates and returns an object of the given class, if the class has been
1119 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
1121 \membersection{::wxDDECleanUp}\label{wxddecleanup}
1123 \func{void}{wxDDECleanUp}{\void}
1125 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
1126 called by the application.
1128 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
1130 \wxheading{Include files}
1134 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1136 \func{void}{wxDDEInitialize}{\void}
1138 Initializes the DDE system. May be called multiple times without harm.
1140 This no longer needs to be called by the application: it will be called
1141 by wxWindows if necessary.
1143 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1144 \helpref{wxDDECleanUp}{wxddecleanup}.
1146 \wxheading{Include files}
1150 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1152 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1154 {\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
1156 Display a debugging message; under Windows, this will appear on the
1157 debugger command window, and under Unix, it will be written to standard
1160 The syntax is identical to {\bf printf}: pass a format string and a
1161 variable list of arguments.
1163 {\bf Tip:} under Windows, if your application crashes before the
1164 message appears in the debugging window, put a wxYield call after
1165 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1166 (at least for Watcom C++): preformat your messages and use OutputDebugString
1169 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1171 \wxheading{Include files}
1175 \membersection{::wxDisplaySize}
1177 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1179 Gets the physical size of the display in pixels.
1181 \wxheading{Include files}
1185 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1187 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1189 This function enables or disables all top level windows. It is used by
1190 \helpref{::wxSafeYield}{wxsafeyield}.
1192 \wxheading{Include files}
1196 \membersection{::wxEntry}\label{wxentry}
1198 This initializes wxWindows in a platform-dependent way. Use this if you
1199 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1200 you can initialize wxWindows from an Microsoft Foundation Classes application using
1203 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1204 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1206 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1207 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1208 message loop will be entered.
1210 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1211 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1213 wxWindows initialization under Windows (for applications constructed as a DLL).
1215 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1217 wxWindows initialization under Unix.
1221 To clean up wxWindows, call wxApp::OnExit followed by the static function
1222 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1225 int CTheApp::ExitInstance()
1227 // OnExit isn't called by CleanUp so must be called explicitly.
1231 return CWinApp::ExitInstance();
1235 \wxheading{Include files}
1239 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1241 \func{void}{wxEndBusyCursor}{\void}
1243 Changes the cursor back to the original cursor, for all windows in the application.
1244 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1246 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1248 \wxheading{Include files}
1252 \membersection{::wxError}\label{wxerror}
1254 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1256 Displays {\it msg} and continues. This writes to standard error under
1257 Unix, and pops up a message box under Windows. Used for internal
1258 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1260 \wxheading{Include files}
1264 \membersection{::wxExecute}\label{wxexecute}
1266 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1268 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1270 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
1272 Executes another program in Unix or Windows.
1274 The first form takes a command string, such as {\tt "emacs file.txt"}.
1276 The second form takes an array of values: a command, any number of
1277 arguments, terminated by NULL.
1279 The semantics of the third version is different from the first two and is
1280 described in more details below.
1282 If {\it sync} is FALSE (the default), flow of control immediately returns.
1283 If TRUE, the current application waits until the other program has terminated.
1285 In the case of synchronous execution, the return value is the exit code of
1286 the process (which terminates by the moment the function returns) and will be
1287 $-1$ if the process couldn't be started and typically 0 if the process
1288 terminated successfully. Also, while waiting for the process to
1289 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1290 should ensure that this can cause no recursion, in the simplest case by
1291 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1293 For asynchronous execution, however, the return value is the process id and
1294 zero value indicates that the command could not be executed.
1296 If callback isn't NULL and if execution is asynchronous (note that callback
1297 parameter can not be non NULL for synchronous execution),
1298 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1299 the process finishes.
1301 Finally, you may use the third overloaded version of this function to execute
1302 a process (always synchronously) and capture its output in the array
1305 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
1306 \helpref{Exec sample}{sampleexec}.
1308 \wxheading{Include files}
1312 \membersection{::wxExit}\label{wxexit}
1314 \func{void}{wxExit}{\void}
1316 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1317 Should only be used in an emergency: normally the top-level frame
1318 should be deleted (after deleting all other frames) to terminate the
1319 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1321 \wxheading{Include files}
1325 \membersection{::wxFatalError}\label{wxfatalerror}
1327 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1329 Displays {\it msg} and exits. This writes to standard error under Unix,
1330 and pops up a message box under Windows. Used for fatal internal
1331 wxWindows errors. See also \helpref{wxError}{wxerror}.
1333 \wxheading{Include files}
1337 \membersection{::wxFindMenuItemId}
1339 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1341 Find a menu item identifier associated with the given frame's menu bar.
1343 \wxheading{Include files}
1347 \membersection{::wxFindWindowByLabel}
1349 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1351 Find a window by its label. Depending on the type of window, the label may be a window title
1352 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1353 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1354 The search is recursive in both cases.
1356 \wxheading{Include files}
1360 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1362 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1364 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1365 If {\it parent} is NULL, the search will start from all top-level
1366 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1367 The search is recursive in both cases.
1369 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1371 \wxheading{Include files}
1375 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1377 \func{wxWindow *}{wxGetActiveWindow}{\void}
1379 Gets the currently active window (Windows only).
1381 \wxheading{Include files}
1385 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1387 \func{wxString}{wxGetDisplayName}{\void}
1389 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1391 \wxheading{Include files}
1395 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1397 \func{wxString}{wxGetHomeDir}{\void}
1399 Return the (current) user's home directory.
1401 \wxheading{See also}
1403 \helpref{wxGetUserHome}{wxgetuserhome}
1405 \wxheading{Include files}
1409 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1411 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1413 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1415 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1418 See also \helpref{wxTimer}{wxtimer}.
1420 \wxheading{Include files}
1424 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1426 \func{long}{wxGetFreeMemory}{\void}
1428 Returns the amount of free memory in Kbytes under environments which
1429 support it, and -1 if not supported. Currently, returns a positive value
1430 under Windows, and -1 under Unix.
1432 \wxheading{Include files}
1436 \membersection{::wxGetMousePosition}
1438 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1440 Returns the mouse position in screen coordinates.
1442 \wxheading{Include files}
1446 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1448 \func{wxString}{wxGetOsDescription}{\void}
1450 Returns the string containing the description of the current platform in a
1451 user-readable form. For example, this function may return strings like
1452 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1454 \wxheading{See also}
1456 \helpref{::wxGetOsVersion}{wxgetosversion}
1458 \wxheading{Include files}
1462 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1464 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1466 Gets operating system version information.
1468 \begin{twocollist}\itemsep=0pt
1469 \twocolitemruled{Platform}{Return tyes}
1470 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1471 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1472 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1473 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1474 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1475 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1476 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1477 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1478 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1479 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1482 \wxheading{See also}
1484 \helpref{::wxGetOsDescription}{wxgetosdescription}
1486 \wxheading{Include files}
1490 \membersection{::wxGetResource}\label{wxgetresource}
1492 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1493 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1495 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1496 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1498 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1499 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1501 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1502 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1504 Gets a resource value from the resource database (for example, WIN.INI, or
1505 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1506 otherwise the specified file is used.
1508 Under X, if an application class (wxApp::GetClassName) has been defined,
1509 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1510 an applications default file when merging all resource databases.
1512 The reason for passing the result in an argument is that it
1513 can be convenient to define a default value, which gets overridden
1514 if the value exists in the resource file. It saves a separate
1515 test for that resource's existence, and it also allows
1516 the overloading of the function for different types.
1518 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1520 \wxheading{Include files}
1524 \membersection{::wxGetUserId}
1526 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1528 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1529 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1530 Under Windows, this returns ``user''.
1532 \wxheading{Include files}
1536 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1538 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1540 Returns the home directory for the given user. If the username is empty
1541 (default value), this function behaves like
1542 \helpref{wxGetHomeDir}{wxgethomedir}.
1544 \wxheading{Include files}
1548 \membersection{::wxGetUserName}
1550 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1552 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1553 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1554 Under Windows, this returns ``unknown''.
1556 \wxheading{Include files}
1560 \membersection{::wxKill}\label{wxkill}
1562 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1564 Under Unix (the only supported platform), equivalent to the Unix kill function.
1565 Returns 0 on success, -1 on failure.
1567 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1568 It does not raise a signal in the receiving process.
1570 \wxheading{Include files}
1574 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
1576 \func{void}{wxInitAllImageHandlers}{\void}
1578 Initializes all available image handlers. For a list of available handlers,
1579 see \helpref{wxImage}{wximage}.
1581 \wxheading{See also}
1583 \helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
1585 \membersection{::wxIsBusy}\label{wxisbusy}
1587 \func{bool}{wxIsBusy}{\void}
1589 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1590 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1592 See also \helpref{wxBusyCursor}{wxbusycursor}.
1594 \wxheading{Include files}
1598 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1600 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1602 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1603 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1605 The resource must be defined in the {\tt .rc} file using the following syntax:
1608 myResource TEXT file.ext
1611 where {\tt file.ext} is a file that the resource compiler can find.
1613 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1614 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1615 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1617 This function is available under Windows only.
1619 \wxheading{Include files}
1623 \membersection{::wxNow}\label{wxnow}
1625 \func{wxString}{wxNow}{\void}
1627 Returns a string representing the current date and time.
1629 \wxheading{Include files}
1633 \membersection{::wxPostDelete}\label{wxpostdelete}
1635 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1637 Tells the system to delete the specified object when
1638 all other events have been processed. In some environments, it is
1639 necessary to use this instead of deleting a frame directly with the
1640 delete operator, because some GUIs will still send events to a deleted window.
1642 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1644 \wxheading{Include files}
1648 \membersection{::wxPostEvent}\label{wxpostevent}
1650 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
1652 This function posts the event to the specified {\it dest} object. The
1653 difference between sending an event and posting it is that in the first case
1654 the event is processed before the function returns (in wxWindows, event sending
1655 is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
1656 the second, the function returns immediately and the event will be processed
1657 sometime later - usually during the next even loop iteration.
1659 Note that a copy of the {\it event} is made by the function, so the original
1660 copy can be deleted as soon as function returns. This function can also be used
1661 to send events between different threads safely. As this function makes a
1662 copy of the event, the event needs to have a fully implemented Clone() method,
1663 which may not be the case for all event in wxWindows.
1665 See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
1668 \wxheading{Include files}
1672 \membersection{::wxSafeYield}\label{wxsafeyield}
1674 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1676 This function is similar to wxYield, except that it disables the user input to
1677 all program windows before calling wxYield and re-enables it again
1678 afterwards. If {\it win} is not NULL, this window will remain enabled,
1679 allowing the implementation of some limited user interaction.
1681 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1683 \wxheading{Include files}
1687 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1689 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1691 Under X only, sets the current display name. This is the X host and display name such
1692 as ``colonsay:0.0", and the function indicates which display should be used for creating
1693 windows from this point on. Setting the display within an application allows multiple
1694 displays to be used.
1696 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1698 \wxheading{Include files}
1702 \membersection{::wxShell}\label{wxshell}
1704 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1706 Executes a command in an interactive shell window. If no command is
1707 specified, then just the shell is spawned.
1709 See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
1711 \wxheading{Include files}
1715 \membersection{::wxSleep}\label{wxsleep}
1717 \func{void}{wxSleep}{\param{int}{ secs}}
1719 Sleeps for the specified number of seconds.
1721 \wxheading{Include files}
1725 \membersection{::wxStripMenuCodes}
1727 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1729 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1731 Strips any menu codes from {\it in} and places the result
1732 in {\it out} (or returns the new string, in the first form).
1734 Menu codes include \& (mark the next character with an underline
1735 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1737 \wxheading{Include files}
1741 \membersection{::wxStartTimer}\label{wxstarttimer}
1743 \func{void}{wxStartTimer}{\void}
1745 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1747 See also \helpref{wxTimer}{wxtimer}.
1749 \wxheading{Include files}
1753 \membersection{::wxToLower}\label{wxtolower}
1755 \func{char}{wxToLower}{\param{char }{ch}}
1757 Converts the character to lower case. This is implemented as a macro for efficiency.
1759 \wxheading{Include files}
1763 \membersection{::wxToUpper}\label{wxtoupper}
1765 \func{char}{wxToUpper}{\param{char }{ch}}
1767 Converts the character to upper case. This is implemented as a macro for efficiency.
1769 \wxheading{Include files}
1773 \membersection{::wxTrace}\label{wxtrace}
1775 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1777 Takes printf-style variable argument syntax. Output
1778 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1780 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1782 \wxheading{Include files}
1786 \membersection{::wxTraceLevel}\label{wxtracelevel}
1788 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1790 Takes printf-style variable argument syntax. Output
1791 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1792 The first argument should be the level at which this information is appropriate.
1793 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1796 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1798 \wxheading{Include files}
1802 \membersection{::wxUsleep}\label{wxusleep}
1804 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1806 Sleeps for the specified number of milliseconds. Notice that usage of this
1807 function is encouraged instead of calling usleep(3) directly because the
1808 standard usleep() function is not MT safe.
1810 \wxheading{Include files}
1814 \membersection{::wxWriteResource}\label{wxwriteresource}
1816 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1817 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1819 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1820 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1822 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1823 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1825 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1826 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1828 Writes a resource value into the resource database (for example, WIN.INI, or
1829 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1830 otherwise the specified file is used.
1832 Under X, the resource databases are cached until the internal function
1833 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1834 all updated resource databases are written to their files.
1836 Note that it is considered bad manners to write to the .Xdefaults
1837 file under Unix, although the WIN.INI file is fair game under Windows.
1839 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1841 \wxheading{Include files}
1845 \membersection{::wxYield}\label{wxyield}
1847 \func{bool}{wxYield}{\void}
1849 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1850 time-consuming process writes to a text window. Without an occasional
1851 yield, the text window will not be updated properly, and on systems with
1852 cooperative multitasking, such as Windows 3.1 other processes will not respond.
1854 Caution should be exercised, however, since yielding may allow the
1855 user to perform actions which are not compatible with the current task.
1856 Disabling menu items or whole menus during processing can avoid unwanted
1857 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1860 Note that wxYield will not flush the message logs. This is intentional as
1861 calling wxYield is usually done to quickly update the screen and popping up a
1862 message box dialog may be undesirable. If you do with to flush the log
1863 messages immediately (otherwise it will be done during the next idle loop
1864 iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
1866 \wxheading{Include files}
1868 <wx/app.h> or <wx/utils.h>
1870 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
1872 \func{void}{wxWakeUpIdle}{\void}
1874 This functions wakes up the (internal and platform dependent) idle system, i.e. it
1875 will force the system to send an idle event even if the system currently {\it is}
1876 idle and thus would not send any idle event until after some other event would get
1877 sent. This is also useful for sending events between two threads and is used by
1878 the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
1879 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
1881 \wxheading{Include files}
1885 \section{Macros}\label{macros}
1887 These macros are defined in wxWindows.
1889 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1891 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1893 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1895 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1897 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1899 This macro will swap the bytes of the {\it value} variable from little
1900 endian to big endian or vice versa.
1902 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1904 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1906 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1908 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1910 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1912 This macro will swap the bytes of the {\it value} variable from little
1913 endian to big endian or vice versa if the program is compiled on a
1914 big-endian architecture (such as Sun work stations). If the program has
1915 been compiled on a little-endian architecture, the value will be unchanged.
1917 Use these macros to read data from and write data to a file that stores
1918 data in little endian (Intel i386) format.
1920 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1922 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1924 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1926 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1928 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1930 This macro will swap the bytes of the {\it value} variable from little
1931 endian to big endian or vice versa if the program is compiled on a
1932 little-endian architecture (such as Intel PCs). If the program has
1933 been compiled on a big-endian architecture, the value will be unchanged.
1935 Use these macros to read data from and write data to a file that stores
1936 data in big endian format.
1938 \membersection{CLASSINFO}\label{classinfo}
1940 \func{wxClassInfo *}{CLASSINFO}{className}
1942 Returns a pointer to the wxClassInfo object associated with this class.
1944 \wxheading{Include files}
1948 \membersection{DECLARE\_ABSTRACT\_CLASS}
1950 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1952 Used inside a class declaration to declare that the class should be
1953 made known to the class hierarchy, but objects of this class cannot be created
1954 dynamically. The same as DECLARE\_CLASS.
1959 class wxCommand: public wxObject
1961 DECLARE_ABSTRACT_CLASS(wxCommand)
1970 \wxheading{Include files}
1974 \membersection{DECLARE\_APP}\label{declareapp}
1976 \func{}{DECLARE\_APP}{className}
1978 This is used in headers to create a forward declaration of the wxGetApp function implemented
1979 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1987 \wxheading{Include files}
1991 \membersection{DECLARE\_CLASS}
1993 \func{}{DECLARE\_CLASS}{className}
1995 Used inside a class declaration to declare that the class should be
1996 made known to the class hierarchy, but objects of this class cannot be created
1997 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1999 \wxheading{Include files}
2003 \membersection{DECLARE\_DYNAMIC\_CLASS}
2005 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
2007 Used inside a class declaration to declare that the objects of this class should be dynamically
2008 createable from run-time type information.
2013 class wxFrame: public wxWindow
2015 DECLARE_DYNAMIC_CLASS(wxFrame)
2018 const wxString\& frameTitle;
2024 \wxheading{Include files}
2028 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
2030 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
2032 Used in a C++ implementation file to complete the declaration of
2033 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
2038 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
2040 wxCommand::wxCommand(void)
2046 \wxheading{Include files}
2050 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
2052 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
2054 Used in a C++ implementation file to complete the declaration of
2055 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
2057 \wxheading{Include files}
2061 \membersection{IMPLEMENT\_APP}\label{implementapp}
2063 \func{}{IMPLEMENT\_APP}{className}
2065 This is used in the application class implementation file to make the application class known to
2066 wxWindows for dynamic construction. You use this instead of
2077 IMPLEMENT_APP(MyApp)
2080 See also \helpref{DECLARE\_APP}{declareapp}.
2082 \wxheading{Include files}
2086 \membersection{IMPLEMENT\_CLASS}
2088 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
2090 Used in a C++ implementation file to complete the declaration of
2091 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
2093 \wxheading{Include files}
2097 \membersection{IMPLEMENT\_CLASS2}
2099 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
2101 Used in a C++ implementation file to complete the declaration of a
2102 class that has run-time type information and two base classes. The
2103 same as IMPLEMENT\_ABSTRACT\_CLASS2.
2105 \wxheading{Include files}
2109 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
2111 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
2113 Used in a C++ implementation file to complete the declaration of
2114 a class that has run-time type information, and whose instances
2115 can be created dynamically.
2120 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
2122 wxFrame::wxFrame(void)
2128 \wxheading{Include files}
2132 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
2134 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
2136 Used in a C++ implementation file to complete the declaration of
2137 a class that has run-time type information, and whose instances
2138 can be created dynamically. Use this for classes derived from two
2141 \wxheading{Include files}
2145 \membersection{wxBITMAP}\label{wxbitmapmacro}
2147 \func{}{wxBITMAP}{bitmapName}
2149 This macro loads a bitmap from either application resources (on the platforms
2150 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2151 avoid using {\tt \#ifdef}s when creating bitmaps.
2153 \wxheading{See also}
2155 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2156 \helpref{wxICON}{wxiconmacro}
2158 \wxheading{Include files}
2162 \membersection{WXDEBUG\_NEW}\label{debugnew}
2164 \func{}{WXDEBUG\_NEW}{arg}
2166 This is defined in debug mode to be call the redefined new operator
2167 with filename and line number arguments. The definition is:
2170 #define WXDEBUG_NEW new(__FILE__,__LINE__)
2173 In non-debug mode, this is defined as the normal new operator.
2175 \wxheading{Include files}
2179 \membersection{wxDynamicCast}\label{wxdynamiccast}
2181 \func{}{wxDynamicCast}{ptr, classname}
2183 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
2184 the pointer is of this type (the check is done during the run-time) or NULL
2185 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
2188 The {\it ptr} argument may be NULL, in which case NULL will be returned.
2193 wxWindow *win = wxWindow::FindFocus();
2194 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
2197 // a text control has the focus...
2201 // no window has the focus or it's not a text control
2205 \wxheading{See also}
2207 \helpref{RTTI overview}{runtimeclassoverview}
2209 \membersection{wxICON}\label{wxiconmacro}
2211 \func{}{wxICON}{iconName}
2213 This macro loads an icon from either application resources (on the platforms
2214 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2215 avoid using {\tt \#ifdef}s when creating icons.
2217 \wxheading{See also}
2219 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2220 \helpref{wxBITMAP}{wxbitmapmacro}
2222 \wxheading{Include files}
2226 \membersection{WXTRACE}\label{trace}
2228 \wxheading{Include files}
2232 \func{}{WXTRACE}{formatString, ...}
2234 Calls wxTrace with printf-style variable argument syntax. Output
2235 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2237 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2239 \wxheading{Include files}
2243 \membersection{WXTRACELEVEL}\label{tracelevel}
2245 \func{}{WXTRACELEVEL}{level, formatString, ...}
2247 Calls wxTraceLevel with printf-style variable argument syntax. Output
2248 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2249 The first argument should be the level at which this information is appropriate.
2250 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2253 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2255 \wxheading{Include files}
2259 \section{wxWindows resource functions}\label{resourcefuncs}
2261 \overview{wxWindows resource system}{resourceformats}
2263 This section details functions for manipulating wxWindows (.WXR) resource
2264 files and loading user interface elements from resources.
2266 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2267 about initialisation file resource reading and writing, using such functions
2268 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2270 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2272 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2273 loading from resource data.
2275 {\bf Warning:} this needs updating for wxWindows 2.
2277 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2279 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2281 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2282 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2283 perhaps for implementing resource functionality for interpreted languages.
2285 \membersection{::wxResourceClear}
2287 \func{void}{wxResourceClear}{\void}
2289 Clears the wxWindows resource table.
2291 \membersection{::wxResourceCreateBitmap}
2293 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2295 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2296 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2300 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2301 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2302 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2305 then this function can be called as follows:
2308 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2311 \membersection{::wxResourceCreateIcon}
2313 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2315 Creates a new icon from a file, static data, or Windows resource, given a valid
2316 wxWindows icon resource identifier. For example, if the .WXR file contains
2320 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2321 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2322 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2325 then this function can be called as follows:
2328 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2331 \membersection{::wxResourceCreateMenuBar}
2333 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2335 Creates a new menu bar given a valid wxWindows menubar resource
2336 identifier. For example, if the .WXR file contains the following:
2339 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2343 ['&Open File', 2, 'Open a file'],\
2344 ['&Save File', 3, 'Save a file'],\
2346 ['E&xit', 4, 'Exit program']\
2349 ['&About', 6, 'About this program']\
2354 then this function can be called as follows:
2357 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2361 \membersection{::wxResourceGetIdentifier}
2363 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2365 Used for retrieving the integer value associated with an identifier.
2366 A zero value indicates that the identifier was not found.
2368 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2370 \membersection{::wxResourceParseData}\label{wxresourcedata}
2372 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2374 Parses a string containing one or more wxWindows resource objects. If
2375 the resource objects are global static data that are included into the
2376 C++ program, then this function must be called for each variable
2377 containing the resource data, to make it known to wxWindows.
2379 {\it resource} should contain data in the following form:
2382 dialog(name = 'dialog1',
2383 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2384 title = 'Test dialog box',
2385 x = 312, y = 234, width = 400, height = 300,
2387 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2388 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2389 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2390 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2391 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2392 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2395 This function will typically be used after including a {\tt .wxr} file into
2396 a C++ program as follows:
2399 #include "dialog1.wxr"
2402 Each of the contained resources will declare a new C++ variable, and each
2403 of these variables should be passed to wxResourceParseData.
2405 \membersection{::wxResourceParseFile}
2407 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2409 Parses a file containing one or more wxWindows resource objects
2410 in C++-compatible syntax. Use this function to dynamically load
2411 wxWindows resource data.
2413 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2415 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2417 Parses a string containing one or more wxWindows resource objects. If
2418 the resource objects are global static data that are included into the
2419 C++ program, then this function must be called for each variable
2420 containing the resource data, to make it known to wxWindows.
2422 {\it resource} should contain data with the following form:
2425 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2426 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2427 title = 'Test dialog box',\
2428 x = 312, y = 234, width = 400, height = 300,\
2430 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2431 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2432 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2433 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2434 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2435 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2438 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2439 load an entire {\tt .wxr file} into a string.
2441 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2443 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2444 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2446 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2448 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2449 This is required if other resources will use the bitmap data, since otherwise there
2450 is no connection between names used in resources, and the global bitmap data.
2452 \membersection{::wxResourceRegisterIconData}
2454 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2456 \section{Log functions}\label{logfunctions}
2458 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2459 further information. The functions use (implicitly) the currently active log
2460 target, so their descriptions here may not apply if the log target is not the
2461 standard one (installed by wxWindows in the beginning of the program).
2463 \wxheading{Include files}
2467 \membersection{::wxLogError}\label{wxlogerror}
2469 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2471 The function to use for error messages, i.e. the messages that must be shown
2472 to the user. The default processing is to pop up a message box to inform the
2475 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2477 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2479 Like \helpref{wxLogError}{wxlogerror}, but also
2480 terminates the program with the exit code 3. Using {\it abort()} standard
2481 function also terminates the program with this exit code.
2483 \membersection{::wxLogWarning}\label{wxlogwarning}
2485 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2487 For warnings - they are also normally shown to the user, but don't interrupt
2490 \membersection{::wxLogMessage}\label{wxlogmessage}
2492 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2494 for all normal, informational messages. They also appear in a message box by
2495 default (but it can be changed). Notice that the standard behaviour is to not
2496 show informational messages if there are any errors later - the logic being
2497 that the later error messages make the informational messages preceding them
2500 \membersection{::wxLogVerbose}\label{wxlogverbose}
2502 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2504 For verbose output. Normally, it's suppressed, but
2505 might be activated if the user wishes to know more details about the program
2506 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2508 \membersection{::wxLogStatus}\label{wxlogstatus}
2510 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
2512 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2514 Messages logged by this function will appear in the statusbar of the {\it
2515 frame} or of the top level application window by default (i.e. when using
2516 the second version of the function).
2518 If the target frame doesn't have a statusbar, the message will be lost.
2520 \membersection{::wxLogSysError}\label{wxlogsyserror}
2522 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2524 Mostly used by wxWindows itself, but might be handy for logging errors after
2525 system call (API function) failure. It logs the specified message text as well
2526 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2527 on the platform) and the corresponding error message. The second form
2528 of this function takes the error code explitly as the first argument.
2530 \wxheading{See also}
2532 \helpref{wxSysErrorCode}{wxsyserrorcode},
2533 \helpref{wxSysErrorMsg}{wxsyserrormsg}
2535 \membersection{::wxLogDebug}\label{wxlogdebug}
2537 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2539 The right function for debug output. It only does anything at all in the debug
2540 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
2541 nothing in release mode (otherwise).
2543 \membersection{::wxLogTrace}\label{wxlogtrace}
2545 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2547 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
2549 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
2551 As {\bf wxLogDebug}, trace functions only do something in debug build and
2552 expand to nothing in the release one. The reason for making
2553 it a separate function from it is that usually there are a lot of trace
2554 messages, so it might make sense to separate them from other debug messages.
2556 The trace messages also usually can be separated into different categories and
2557 the second and third versions of this function only log the message if the
2558 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
2559 allows to selectively trace only some operations and not others by changing
2560 the value of the trace mask (possible during the run-time).
2562 For the second function (taking a string mask), the message is logged only if
2563 the mask has been previously enabled by the call to
2564 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
2565 used by wxWindows are:
2567 \begin{itemize}\itemsep=0pt
2568 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
2569 \item wxTRACE\_Messages: trace window messages/X callbacks
2570 \item wxTRACE\_ResAlloc: trace GDI resource allocation
2571 \item wxTRACE\_RefCount: trace various ref counting operations
2572 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
2575 The third version of the function only logs the message if all the bit
2576 corresponding to the {\it mask} are set in the wxLog trace mask which can be
2577 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
2578 flexible than the previous one because it doesn't allow defining the user
2579 trace masks easily - this is why it is deprecated in favour of using string
2582 \begin{itemize}\itemsep=0pt
2583 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2584 \item wxTraceMessages: trace window messages/X callbacks
2585 \item wxTraceResAlloc: trace GDI resource allocation
2586 \item wxTraceRefCount: trace various ref counting operations
2587 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
2590 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
2592 \func{unsigned long}{wxSysErrorCode}{\void}
2594 Returns the error code from the last system call. This function uses
2595 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
2597 \wxheading{See also}
2599 \helpref{wxSysErrorMsg}{wxsyserrormsg},
2600 \helpref{wxLogSysError}{wxlogsyserror}
2602 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
2604 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
2606 Returns the error message corresponding to the given system error code. If
2607 {\it errCode} is $0$ (default), the last error code (as returned by
2608 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
2610 \wxheading{See also}
2612 \helpref{wxSysErrorCode}{wxsyserrorcode},
2613 \helpref{wxLogSysError}{wxlogsyserror}
2615 \section{Debugging macros and functions}\label{debugmacros}
2617 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2618 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2621 \wxheading{Include files}
2625 \membersection{::wxOnAssert}\label{wxonassert}
2627 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2629 This function may be redefined to do something non trivial and is called
2630 whenever one of debugging macros fails (i.e. condition is false in an
2632 % TODO: this should probably be an overridable in wxApp.
2634 \membersection{wxASSERT}\label{wxassert}
2636 \func{}{wxASSERT}{\param{}{condition}}
2638 Assert macro. An error message will be generated if the condition is FALSE in
2639 debug mode, but nothing will be done in the release build.
2641 Please note that the condition in wxASSERT() should have no side effects
2642 because it will not be executed in release mode at all.
2644 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2646 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2648 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2650 Assert macro with message. An error message will be generated if the condition is FALSE.
2652 See also: \helpref{wxASSERT}{wxassert}
2654 \membersection{wxFAIL}\label{wxfail}
2656 \func{}{wxFAIL}{\void}
2658 Will always generate an assert error if this code is reached (in debug mode).
2660 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2662 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2664 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2666 Will always generate an assert error with specified message if this code is reached (in debug mode).
2668 This macro is useful for marking unreachable" code areas, for example
2669 it may be used in the "default:" branch of a switch statement if all possible
2670 cases are processed above.
2672 See also: \helpref{wxFAIL}{wxfail}
2674 \membersection{wxCHECK}\label{wxcheck}
2676 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2678 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2679 This check is done even in release mode.
2681 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2683 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2685 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2686 This check is done even in release mode.
2688 This macro may be only used in non void functions, see also
2689 \helpref{wxCHECK\_RET}{wxcheckret}.
2691 \membersection{wxCHECK\_RET}\label{wxcheckret}
2693 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2695 Checks that the condition is true, and returns if not (FAILs with given error
2696 message in debug mode). This check is done even in release mode.
2698 This macro should be used in void functions instead of
2699 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2701 \membersection{wxCHECK2}\label{wxcheck2}
2703 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2705 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2706 {\it operation} if it is not. This is a generalisation of
2707 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2708 returning from the function must be done when the {\it condition} is false.
2710 This check is done even in release mode.
2712 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2714 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2716 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2717 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2718 instead of wxFAIL() if the {\it condition} is false.