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{File functions
}\label{filefunctions
}
9 \wxheading{Include files
}
15 \helpref{wxPathList
}{wxpathlist
}
17 \membersection{::wxDirExists
}
19 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
21 Returns TRUE if the directory exists.
23 \membersection{::wxDos2UnixFilename
}
25 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
27 Converts a DOS to a Unix filename by replacing backslashes with forward
30 \membersection{::wxFileExists
}
32 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
34 Returns TRUE if the file exists. It also returns TRUE if the file is
37 \membersection{::wxFileNameFromPath
}
39 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
41 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
43 Returns the filename for a full path. The second form returns a pointer to
44 temporary storage that should not be deallocated.
46 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
48 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
50 This function does directory searching; returns the first file
51 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
52 get the next matching file. Neither will
report the current directory "." or the
53 parent directory "..".
55 {\it spec
} may contain wildcards.
57 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
62 wxString f = wxFindFirstFile("/home/project/*.*");
63 while ( !f.IsEmpty() )
70 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
72 \func{wxString
}{wxFindNextFile
}{\void}
74 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
76 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
78 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
80 \func{wxString
}{wxGetOSDirectory
}{\void}
82 Returns the Windows directory under Windows; on other platforms returns the empty string.
84 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
86 \func{void
}{wxInitAllImageHandlers
}{\void}
88 Adds some common image format handlers, which, depending on wxWindows
89 configuration, can be handlers for BMP (loading) (always installed), GIF
90 (loading), PCX (loading), PNM (loading and saving as raw
91 rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
93 See also:
\helpref{wxImage
}{wximage
} \helpref{wxImageHandler
}{wximagehandler
}
95 \membersection{::wxIsAbsolutePath
}
97 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
99 Returns TRUE if the argument is an absolute filename, i.e. with a slash
100 or drive name at the beginning.
102 \membersection{::wxPathOnly
}
104 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
106 Returns the directory part of the filename.
108 \membersection{::wxUnix2DosFilename
}
110 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
112 Converts a Unix to a DOS filename by replacing forward
113 slashes with backslashes.
115 \membersection{::wxConcatFiles
}
117 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
118 \param{const wxString\&
}{file3
}}
120 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
123 \membersection{::wxCopyFile
}
125 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
127 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
129 \membersection{::wxGetCwd
}\label{wxgetcwd
}
131 \func{wxString
}{wxGetCwd
}{\void}
133 Returns a string containing the current (or working) directory.
135 \membersection{::wxGetWorkingDirectory
}
137 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
139 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
141 Copies the current working directory into the buffer if supplied, or
142 copies the working directory into new storage (which you must delete yourself)
143 if the buffer is NULL.
145 {\it sz
} is the size of the buffer if supplied.
147 \membersection{::wxGetTempFileName
}
149 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
151 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
153 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
154 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
155 is allocated for the temporary filename using
{\it new
}.
157 Under Windows, the filename will include the drive and name of the
158 directory allocated for temporary files (usually the contents of the
159 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
161 It is the application's responsibility to create and delete the file.
163 \membersection{::wxIsWild
}\label{wxiswild
}
165 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
167 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
169 \membersection{::wxMatchWild
}\label{wxmatchwild
}
171 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
173 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
174 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
175 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
177 \membersection{::wxMkdir
}
179 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
181 Makes the directory
{\it dir
}, returning TRUE if successful.
183 {\it perm
} is the access mask for the directory for the systems on which it is
184 supported (Unix) and doesn't have effect for the other ones.
186 \membersection{::wxRemoveFile
}
188 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
190 Removes
{\it file
}, returning TRUE if successful.
192 \membersection{::wxRenameFile
}
194 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
196 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
198 \membersection{::wxRmdir
}
200 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
202 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
204 The
{\it flags
} parameter is reserved for future use.
206 \membersection{::wxSetWorkingDirectory
}
208 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
210 Sets the current working directory, returning TRUE if the operation succeeded.
211 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
213 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
215 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
217 This function splits a full file name into components: the path (including possible disk/drive
218 specification under Windows), the base name and the extension. Any of the output parameters
219 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
220 a particular component.
222 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
223 Windows, however it will not consider backslashes as path separators under Unix (where backslash
224 is a valid character in a filename).
226 On entry,
{\it fullname
} should be non NULL (it may be empty though).
228 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
229 contains the file name and
{\it ext
} contains the file extension without leading dot. All
230 three of them may be empty if the corresponding component is. The old contents of the
231 strings pointed to by these parameters will be overwritten in any case (if the pointers
234 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
236 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
238 Copies the given file to
{\it stream
}. Useful when converting an old application to
239 use streams (within the
document/view framework, for example).
241 Use of this function requires the file wx
\_doc.h to be included.
243 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
245 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
247 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
248 use streams (within the
document/view framework, for example).
250 Use of this function requires the file wx
\_doc.h to be included.
252 \section{Network functions
}\label{networkfunctions
}
254 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
256 \func{wxString
}{wxGetFullHostName
}{\void}
258 Returns the FQDN (fully qualified domain host name) or an empty string on
261 See also:
\helpref{wxGetHostName
}{wxgethostname
}
263 \wxheading{Include files
}
267 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
269 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
271 Copies the user's email address into the supplied buffer, by
272 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
273 and
\helpref{wxGetUserId
}{wxgetuserid
}.
275 Returns TRUE if successful, FALSE otherwise.
277 \wxheading{Include files
}
281 \membersection{::wxGetHostName
}\label{wxgethostname
}
283 \func{wxString
}{wxGetHostName
}{\void}
284 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
286 Copies the current host machine's name into the supplied buffer. Please note
287 that the returned name is
{\it not
} fully qualified, i.e. it does not include
290 Under Windows or NT, this function first looks in the environment
291 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
292 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
294 The first variant of this function returns the hostname if successful or an
295 empty string otherwise. The second (deprecated) function returns TRUE
296 if successful, FALSE otherwise.
298 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
300 \wxheading{Include files
}
304 \section{User identification
}\label{useridfunctions
}
306 \membersection{::wxGetUserId
}\label{wxgetuserid
}
308 \func{wxString
}{wxGetUserId
}{\void}
309 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
311 This function returns the "user id" also known as "login name" under Unix i.e.
312 something like "jsmith". It uniquely identifies the current user (on this system).
314 Under Windows or NT, this function first looks in the environment
315 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
316 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
318 The first variant of this function returns the login name if successful or an
319 empty string otherwise. The second (deprecated) function returns TRUE
320 if successful, FALSE otherwise.
322 See also:
\helpref{wxGetUserName
}{wxgetusername
}
324 \wxheading{Include files
}
328 \membersection{::wxGetUserName
}\label{wxgetusername
}
330 \func{wxString
}{wxGetUserName
}{\void}
331 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
333 This function returns the full user name (something like "Mr. John Smith").
335 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
336 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
337 is running, the entry
{\bf Current
} in the section
{\bf User
} of
338 the PENWIN.INI file is used.
340 The first variant of this function returns the user name if successful or an
341 empty string otherwise. The second (deprecated) function returns TRUE
342 if successful, FALSE otherwise.
344 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
346 \wxheading{Include files
}
350 \section{String functions
}
352 \membersection{::copystring
}
354 \func{char*
}{copystring
}{\param{const char*
}{s
}}
356 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
357 deleted with the
{\it delete
} operator.
359 \membersection{::wxStringMatch
}
361 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
362 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
364 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
365 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
366 no substring matching is done.
368 \membersection{::wxStringEq
}\label{wxstringeq
}
370 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
375 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
378 \membersection{::IsEmpty
}\label{isempty
}
380 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
382 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
383 pointer to this function and it will return TRUE for it.
385 \membersection{::Stricmp
}\label{stricmp
}
387 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
389 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
390 to or greater than
{\it p2
}. The comparison is case-insensitive.
392 This function complements the standard C function
{\it strcmp()
} which performs
393 case-sensitive comparison.
395 \membersection{::Strlen
}\label{strlen
}
397 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
399 This is a safe version of standard function
{\it strlen()
}: it does exactly the
400 same thing (i.e. returns the length of the string) except that it returns
0 if
401 {\it p
} is the NULL pointer.
403 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
405 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
407 This function returns the translation of string
{\it str
} in the current
408 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
409 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
410 original string is returned. In debug build, an error message is logged - this
411 should help to find the strings which were not yet translated. As this function
412 is used very often, an alternative syntax is provided: the
\_() macro is
413 defined as wxGetTranslation().
415 \section{Dialog functions
}\label{dialogfunctions
}
417 Below are a number of convenience functions for getting input from the
418 user or displaying messages. Note that in these functions the last three
419 parameters are optional. However, it is recommended to pass a parent frame
420 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
421 the front when the dialog box is popped up.
423 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
425 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
426 \param{size
\_t }{currentTip
}}
428 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
429 used with
\helpref{wxShowTip
}{wxshowtip
}.
431 \docparam{filename
}{The name of the file containing the tips, one per line
}
432 \docparam{currentTip
}{The index of the first tip to show - normally this index
433 is remembered between the
2 program runs.
}
435 \wxheading{See also:
}
437 \helpref{Tips overview
}{tipsoverview
}
439 \wxheading{Include files
}
443 \membersection{::wxFileSelector
}\label{wxfileselector
}
445 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
446 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
447 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
448 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
450 Pops up a file selector box. In Windows, this is the common file selector
451 dialog. In X, this is a file selector box with somewhat less functionality.
452 The path and filename are distinct elements of a full file pathname.
453 If path is empty, the current directory will be used. If filename is empty,
454 no default filename will be supplied. The wildcard determines what files
455 are displayed in the file selector, and file extension supplies a type
456 extension for the required filename. Flags may be a combination of wxOPEN,
457 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0.
459 Both the Unix and Windows versions implement a wildcard filter. Typing a
460 filename containing wildcards
(*, ?) in the filename text item, and
461 clicking on Ok, will result in only those files matching the pattern being
464 The wildcard may be a specification for multiple types of file
465 with a description for each, such as:
468 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
471 The application must check for an empty return value (the user pressed
472 Cancel). For example:
475 const wxString& s = wxFileSelector("Choose a file to open");
482 \wxheading{Include files}
486 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
488 \func{long}{wxGetNumberFromUser}{
489 \param{const wxString\& }{message},
490 \param{const wxString\& }{prompt},
491 \param{const wxString\& }{caption},
492 \param{long }{value},
493 \param{long }{min = 0},
494 \param{long }{max = 100},
495 \param{wxWindow *}{parent = NULL},
496 \param{const wxPoint\& }{pos = wxDefaultPosition}}
498 Shows a dialog asking the user for numeric input. The dialogs title is set to
499 {\it caption}, it contains a (possibly) multiline {\it message} above the
500 single line {\it prompt} and the zone for entering the number.
502 The number entered must be in the range {\it min}..{\it max} (both of which
503 should be positive) and {\it value} is the initial value of it. If the user
504 enters an invalid value or cancels the dialog, the function will return -1.
506 Dialog is centered on its {\it parent} unless an explicit position is given in
509 \wxheading{Include files}
513 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
515 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
516 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
517 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
519 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
520 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
521 or press Cancel to return the empty string.
523 If {\it centre} is TRUE, the message text (which may include new line characters)
524 is centred; if FALSE, the message is left-justified.
526 \wxheading{Include files}
530 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
532 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
533 \param{int }{nsel}, \param{int *}{selection},
534 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
535 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
537 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
538 listbox. The user may choose one or more item(s) and press OK or Cancel.
540 The number of initially selected choices, and array of the selected indices,
541 are passed in; this array will contain the user selections on exit, with
542 the function returning the number of selections. {\it selection} must be
543 as big as the number of choices, in case all are selected.
545 If Cancel is pressed, -1 is returned.
547 {\it choices} is an array of {\it n} strings for the listbox.
549 If {\it centre} is TRUE, the message text (which may include new line characters)
550 is centred; if FALSE, the message is left-justified.
552 \wxheading{Include files}
556 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
558 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
559 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
560 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
562 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
563 listbox. The user may choose an item and press OK to return a string or
564 Cancel to return the empty string.
566 {\it choices} is an array of {\it n} strings for the listbox.
568 If {\it centre} is TRUE, the message text (which may include new line characters)
569 is centred; if FALSE, the message is left-justified.
571 \wxheading{Include files}
575 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
577 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
578 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
579 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
581 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
582 If the user pressed cancel, -1 is returned.
584 \wxheading{Include files}
588 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
590 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
591 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
592 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
594 As {\bf wxGetSingleChoice} but takes an array of client data pointers
595 corresponding to the strings, and returns one of these pointers.
597 \wxheading{Include files}
601 \membersection{::wxMessageBox}\label{wxmessagebox}
603 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
604 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
606 General purpose message dialog. {\it style} may be a bit list of the
607 following identifiers:
609 \begin{twocollist}\itemsep=0pt
610 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
612 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
614 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
615 \twocolitem{wxCENTRE}{Centres the text.}
616 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
617 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
618 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
619 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
622 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
628 int answer = wxMessageBox("Quit program?", "Confirm",
629 wxYES_NO | wxCANCEL, main_frame);
635 {\it message} may contain newline characters, in which case the
636 message will be split into separate lines, to cater for large messages.
638 Under Windows, the native MessageBox function is used unless wxCENTRE
639 is specified in the style, in which case a generic function is used.
640 This is because the native MessageBox function cannot centre text.
641 The symbols are not shown when the generic function is used.
643 \wxheading{Include files}
647 \membersection{::wxShowTip}\label{wxshowtip}
649 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
650 \param{wxTipProvider *}{tipProvider},
651 \param{bool }{showAtStartup = TRUE}}
653 This function shows a "startup tip" to the user.
655 \docparam{parent}{The parent window for the modal dialog}
657 \docparam{tipProvider}{An object which is used to get the text of the tips.
658 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
660 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
661 otherwise. This is used as the initial value for "Show tips at startup"
662 checkbox which is shown in the tips dialog.}
664 \wxheading{See also:}
666 \helpref{Tips overview}{tipsoverview}
668 \wxheading{Include files}
672 \section{GDI functions}\label{gdifunctions}
674 The following are relevant to the GDI (Graphics Device Interface).
676 \wxheading{Include files}
680 \membersection{::wxColourDisplay}
682 \func{bool}{wxColourDisplay}{\void}
684 Returns TRUE if the display is colour, FALSE otherwise.
686 \membersection{::wxDisplayDepth}
688 \func{int}{wxDisplayDepth}{\void}
690 Returns the depth of the display (a value of 1 denotes a monochrome display).
692 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
694 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
695 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
697 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
698 makes it into a placeable metafile by prepending a header containing the given
699 bounding box. The bounding box may be obtained from a device context after drawing
700 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
702 In addition to adding the placeable metafile header, this function adds
703 the equivalent of the following code to the start of the metafile data:
706 SetMapMode(dc, MM_ANISOTROPIC);
707 SetWindowOrg(dc, minX, minY);
708 SetWindowExt(dc, maxX - minX, maxY - minY);
711 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
713 Placeable metafiles may be imported by many Windows applications, and can be
714 used in RTF (Rich Text Format) files.
716 {\it scale} allows the specification of scale for the metafile.
718 This function is only available under Windows.
720 \membersection{::wxSetCursor}\label{wxsetcursor}
722 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
724 Globally sets the cursor; only has an effect in Windows and GTK.
725 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
727 \section{Printer settings}\label{printersettings}
729 These routines are obsolete and should no longer be used!
731 The following functions are used to control PostScript printing. Under
732 Windows, PostScript output can only be sent to a file.
734 \wxheading{Include files}
738 \membersection{::wxGetPrinterCommand}
740 \func{wxString}{wxGetPrinterCommand}{\void}
742 Gets the printer command used to print a file. The default is {\tt lpr}.
744 \membersection{::wxGetPrinterFile}
746 \func{wxString}{wxGetPrinterFile}{\void}
748 Gets the PostScript output filename.
750 \membersection{::wxGetPrinterMode}
752 \func{int}{wxGetPrinterMode}{\void}
754 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
755 The default is PS\_PREVIEW.
757 \membersection{::wxGetPrinterOptions}
759 \func{wxString}{wxGetPrinterOptions}{\void}
761 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
763 \membersection{::wxGetPrinterOrientation}
765 \func{int}{wxGetPrinterOrientation}{\void}
767 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
769 \membersection{::wxGetPrinterPreviewCommand}
771 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
773 Gets the command used to view a PostScript file. The default depends on the platform.
775 \membersection{::wxGetPrinterScaling}
777 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
779 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
781 \membersection{::wxGetPrinterTranslation}
783 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
785 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
787 \membersection{::wxSetPrinterCommand}
789 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
791 Sets the printer command used to print a file. The default is {\tt lpr}.
793 \membersection{::wxSetPrinterFile}
795 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
797 Sets the PostScript output filename.
799 \membersection{::wxSetPrinterMode}
801 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
803 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
804 The default is PS\_PREVIEW.
806 \membersection{::wxSetPrinterOptions}
808 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
810 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
812 \membersection{::wxSetPrinterOrientation}
814 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
816 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
818 \membersection{::wxSetPrinterPreviewCommand}
820 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
822 Sets the command used to view a PostScript file. The default depends on the platform.
824 \membersection{::wxSetPrinterScaling}
826 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
828 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
830 \membersection{::wxSetPrinterTranslation}
832 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
834 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
836 \section{Clipboard functions}\label{clipsboard}
838 These clipboard functions are implemented for Windows only.
840 \wxheading{Include files}
844 \membersection{::wxClipboardOpen}
846 \func{bool}{wxClipboardOpen}{\void}
848 Returns TRUE if this application has already opened the clipboard.
850 \membersection{::wxCloseClipboard}
852 \func{bool}{wxCloseClipboard}{\void}
854 Closes the clipboard to allow other applications to use it.
856 \membersection{::wxEmptyClipboard}
858 \func{bool}{wxEmptyClipboard}{\void}
860 Empties the clipboard.
862 \membersection{::wxEnumClipboardFormats}
864 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
866 Enumerates the formats found in a list of available formats that belong
867 to the clipboard. Each call to this function specifies a known
868 available format; the function returns the format that appears next in
871 {\it dataFormat} specifies a known format. If this parameter is zero,
872 the function returns the first format in the list.
874 The return value specifies the next known clipboard data format if the
875 function is successful. It is zero if the {\it dataFormat} parameter specifies
876 the last format in the list of available formats, or if the clipboard
879 Before it enumerates the formats function, an application must open the clipboard by using the
880 wxOpenClipboard function.
882 \membersection{::wxGetClipboardData}
884 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
886 Gets data from the clipboard.
888 {\it dataFormat} may be one of:
890 \begin{itemize}\itemsep=0pt
891 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
892 \item wxCF\_BITMAP: returns a new wxBitmap.
895 The clipboard must have previously been opened for this call to succeed.
897 \membersection{::wxGetClipboardFormatName}
899 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
901 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
902 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
904 \membersection{::wxIsClipboardFormatAvailable}
906 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
908 Returns TRUE if the given data format is available on the clipboard.
910 \membersection{::wxOpenClipboard}
912 \func{bool}{wxOpenClipboard}{\void}
914 Opens the clipboard for passing data to it or getting data from it.
916 \membersection{::wxRegisterClipboardFormat}
918 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
920 Registers the clipboard data format name and returns an identifier.
922 \membersection{::wxSetClipboardData}
924 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
926 Passes data to the clipboard.
928 {\it dataFormat} may be one of:
930 \begin{itemize}\itemsep=0pt
931 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
932 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
933 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
934 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
937 The clipboard must have previously been opened for this call to succeed.
939 \section{Miscellaneous functions}\label{miscellany}
941 \membersection{::wxNewId}
943 \func{long}{wxNewId}{\void}
945 Generates an integer identifier unique to this run of the program.
947 \wxheading{Include files}
951 \membersection{::wxRegisterId}
953 \func{void}{wxRegisterId}{\param{long}{ id}}
955 Ensures that ids subsequently generated by {\bf NewId} do not clash with
958 \wxheading{Include files}
962 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
964 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
966 Changes the cursor to the given cursor for all windows in the application.
967 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
968 to its previous state. These two calls can be nested, and a counter
969 ensures that only the outer calls take effect.
971 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
973 \wxheading{Include files}
977 \membersection{::wxBell}
979 \func{void}{wxBell}{\void}
981 Ring the system bell.
983 \wxheading{Include files}
987 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
989 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
991 Creates and returns an object of the given class, if the class has been
992 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
994 \membersection{::wxDDECleanUp}\label{wxddecleanup}
996 \func{void}{wxDDECleanUp}{\void}
998 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
999 called by the application.
1001 See also helpref{wxDDEInitialize}{wxddeinitialize}.
1003 \wxheading{Include files}
1007 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1009 \func{void}{wxDDEInitialize}{\void}
1011 Initializes the DDE system. May be called multiple times without harm.
1013 This no longer needs to be called by the application: it will be called
1014 by wxWindows if necessary.
1016 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1017 \helpref{wxDDECleanUp}{wxddecleanup}.
1019 \wxheading{Include files}
1023 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1025 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1027 {\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogoverview} instead!}
1029 Display a debugging message; under Windows, this will appear on the
1030 debugger command window, and under Unix, it will be written to standard
1033 The syntax is identical to {\bf printf}: pass a format string and a
1034 variable list of arguments.
1036 {\bf Tip:} under Windows, if your application crashes before the
1037 message appears in the debugging window, put a wxYield call after
1038 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1039 (at least for Watcom C++): preformat your messages and use OutputDebugString
1042 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1044 \wxheading{Include files}
1048 \membersection{::wxDisplaySize}
1050 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1052 Gets the physical size of the display in pixels.
1054 \wxheading{Include files}
1058 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1060 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1062 This function enables or disables all top level windows. It is used by
1063 \helpref{::wxSafeYield}{wxsafeyield}.
1065 \wxheading{Include files}
1069 \membersection{::wxEntry}\label{wxentry}
1071 This initializes wxWindows in a platform-dependent way. Use this if you
1072 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1073 you can initialize wxWindows from an Microsoft Foundation Classes application using
1076 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1077 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1079 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1080 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1081 message loop will be entered.
1083 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1084 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1086 wxWindows initialization under Windows (for applications constructed as a DLL).
1088 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1090 wxWindows initialization under Unix.
1094 To clean up wxWindows, call wxApp::OnExit followed by the static function
1095 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1098 int CTheApp::ExitInstance()
1100 // OnExit isn't called by CleanUp so must be called explicitly.
1104 return CWinApp::ExitInstance();
1108 \wxheading{Include files}
1112 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1114 \func{void}{wxEndBusyCursor}{\void}
1116 Changes the cursor back to the original cursor, for all windows in the application.
1117 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1119 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1121 \wxheading{Include files}
1125 \membersection{::wxError}\label{wxerror}
1127 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1129 Displays {\it msg} and continues. This writes to standard error under
1130 Unix, and pops up a message box under Windows. Used for internal
1131 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1133 \wxheading{Include files}
1137 \membersection{::wxExecute}\label{wxexecute}
1139 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1141 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1143 Executes another program in Unix or Windows.
1145 The first form takes a command string, such as {\tt "emacs file.txt"}.
1147 The second form takes an array of values: a command, any number of
1148 arguments, terminated by NULL.
1150 If {\it sync} is FALSE (the default), flow of control immediately returns.
1151 If TRUE, the current application waits until the other program has terminated.
1153 In the case of synchronous execution, the return value is the exit code of
1154 the process (which terminates by the moment the function returns) and will be
1155 $-1$ if the process couldn't be started and typically 0 if the process
1156 terminated successfully. Also, while waiting for the process to
1157 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1158 should ensure that this can cause no recursion, in the simples case by
1159 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1161 For asynchronous execution, however, the return value is the process id and
1162 zero value indicates that the command could not be executed.
1164 If callback isn't NULL and if execution is asynchronous (note that callback
1165 parameter can not be non NULL for synchronous execution),
1166 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1167 the process finishes.
1169 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1171 \wxheading{Include files}
1175 \membersection{::wxExit}\label{wxexit}
1177 \func{void}{wxExit}{\void}
1179 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1180 Should only be used in an emergency: normally the top-level frame
1181 should be deleted (after deleting all other frames) to terminate the
1182 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1184 \wxheading{Include files}
1188 \membersection{::wxFatalError}\label{wxfatalerror}
1190 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1192 Displays {\it msg} and exits. This writes to standard error under Unix,
1193 and pops up a message box under Windows. Used for fatal internal
1194 wxWindows errors. See also \helpref{wxError}{wxerror}.
1196 \wxheading{Include files}
1200 \membersection{::wxFindMenuItemId}
1202 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1204 Find a menu item identifier associated with the given frame's menu bar.
1206 \wxheading{Include files}
1210 \membersection{::wxFindWindowByLabel}
1212 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1214 Find a window by its label. Depending on the type of window, the label may be a window title
1215 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1216 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1217 The search is recursive in both cases.
1219 \wxheading{Include files}
1223 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1225 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1227 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1228 If {\it parent} is NULL, the search will start from all top-level
1229 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1230 The search is recursive in both cases.
1232 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1234 \wxheading{Include files}
1238 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1240 \func{wxWindow *}{wxGetActiveWindow}{\void}
1242 Gets the currently active window (Windows only).
1244 \wxheading{Include files}
1248 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1250 \func{wxString}{wxGetDisplayName}{\void}
1252 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1254 \wxheading{Include files}
1258 \membersection{::wxGetHomeDir}
1260 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1262 Fills the buffer with a string representing the user's home directory (Unix only).
1264 \wxheading{Include files}
1268 \membersection{::wxGetHostName}
1270 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1272 Copies the host name of the machine the program is running on into the
1273 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1274 successful. Under Unix, this will return a machine name. Under Windows,
1275 this returns ``windows''.
1277 \wxheading{Include files}
1281 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1283 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1285 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1287 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1290 See also \helpref{wxTimer}{wxtimer}.
1292 \wxheading{Include files}
1296 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1298 \func{long}{wxGetFreeMemory}{\void}
1300 Returns the amount of free memory in Kbytes under environments which
1301 support it, and -1 if not supported. Currently, returns a positive value
1302 under Windows, and -1 under Unix.
1304 \wxheading{Include files}
1308 \membersection{::wxGetMousePosition}
1310 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1312 Returns the mouse position in screen coordinates.
1314 \wxheading{Include files}
1318 \membersection{::wxGetOsVersion}
1320 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1322 Gets operating system version information.
1324 \begin{twocollist}\itemsep=0pt
1325 \twocolitemruled{Platform}{Return tyes}
1326 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1327 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1328 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1329 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1330 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1331 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1332 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1333 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1334 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1337 \wxheading{Include files}
1341 \membersection{::wxGetResource}\label{wxgetresource}
1343 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1344 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1346 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1347 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1349 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1350 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1352 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1353 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1355 Gets a resource value from the resource database (for example, WIN.INI, or
1356 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1357 otherwise the specified file is used.
1359 Under X, if an application class (wxApp::GetClassName) has been defined,
1360 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1361 an applications default file when merging all resource databases.
1363 The reason for passing the result in an argument is that it
1364 can be convenient to define a default value, which gets overridden
1365 if the value exists in the resource file. It saves a separate
1366 test for that resource's existence, and it also allows
1367 the overloading of the function for different types.
1369 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1371 \wxheading{Include files}
1375 \membersection{::wxGetUserId}
1377 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1379 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1380 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1381 Under Windows, this returns ``user''.
1383 \wxheading{Include files}
1387 \membersection{::wxGetUserName}
1389 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1391 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1392 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1393 Under Windows, this returns ``unknown''.
1395 \wxheading{Include files}
1399 \membersection{::wxKill}\label{wxkill}
1401 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1403 Under Unix (the only supported platform), equivalent to the Unix kill function.
1404 Returns 0 on success, -1 on failure.
1406 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1407 It does not raise a signal in the receiving process.
1409 \wxheading{Include files}
1413 \membersection{::wxIsBusy}\label{wxisbusy}
1415 \func{bool}{wxIsBusy}{\void}
1417 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1418 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1420 See also \helpref{wxBusyCursor}{wxbusycursor}.
1422 \wxheading{Include files}
1426 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1428 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1430 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1431 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1433 The resource must be defined in the {\tt .rc} file using the following syntax:
1436 myResource TEXT file.ext
1439 where {\tt file.ext} is a file that the resource compiler can find.
1441 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1442 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1443 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1445 This function is available under Windows only.
1447 \wxheading{Include files}
1451 \membersection{::wxNow}\label{wxnow}
1453 \func{wxString}{wxNow}{\void}
1455 Returns a string representing the current date and time.
1457 \wxheading{Include files}
1461 \membersection{::wxPostDelete}\label{wxpostdelete}
1463 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1465 Tells the system to delete the specified object when
1466 all other events have been processed. In some environments, it is
1467 necessary to use this instead of deleting a frame directly with the
1468 delete operator, because some GUIs will still send events to a deleted window.
1470 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1472 \wxheading{Include files}
1476 \membersection{::wxPostEvent}\label{wxpostevent}
1478 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
1480 This function posts the event to the specified {\it dest} object. The
1481 difference between sending an event and posting it is that in the first case
1482 the event is processed before the function returns (in wxWindows, event sending
1483 is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
1484 the second, the function returns immediately and the event will be processed
1485 sometime later - usually during the next even loop iteration.
1487 Note that a copy of the {\it event} is made by the function, so the original
1488 copy can be deleted as soon as function returns. This function can also be used
1489 to send events between different threads safely.
1491 \wxheading{Include files}
1495 \membersection{::wxSafeYield}\label{wxsafeyield}
1497 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1499 This function is similar to wxYield, except that it disables the user input to
1500 all program windows before calling wxYield and re-enables it again
1501 afterwards. If {\it win} is not NULL, this window will remain enabled,
1502 allowing the implementation of some limited user interaction.
1504 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1506 \wxheading{Include files}
1510 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1512 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1514 Under X only, sets the current display name. This is the X host and display name such
1515 as ``colonsay:0.0", and the function indicates which display should be used for creating
1516 windows from this point on. Setting the display within an application allows multiple
1517 displays to be used.
1519 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1521 \wxheading{Include files}
1525 \membersection{::wxShell}\label{wxshell}
1527 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1529 Executes a command in an interactive shell window. If no command is
1530 specified, then just the shell is spawned.
1532 See also \helpref{wxExecute}{wxexecute}.
1534 \wxheading{Include files}
1538 \membersection{::wxSleep}\label{wxsleep}
1540 \func{void}{wxSleep}{\param{int}{ secs}}
1542 Sleeps for the specified number of seconds.
1544 \wxheading{Include files}
1548 \membersection{::wxStripMenuCodes}
1550 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1552 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1554 Strips any menu codes from {\it in} and places the result
1555 in {\it out} (or returns the new string, in the first form).
1557 Menu codes include \& (mark the next character with an underline
1558 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1560 \wxheading{Include files}
1564 \membersection{::wxStartTimer}\label{wxstarttimer}
1566 \func{void}{wxStartTimer}{\void}
1568 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1570 See also \helpref{wxTimer}{wxtimer}.
1572 \wxheading{Include files}
1576 \membersection{::wxToLower}\label{wxtolower}
1578 \func{char}{wxToLower}{\param{char }{ch}}
1580 Converts the character to lower case. This is implemented as a macro for efficiency.
1582 \wxheading{Include files}
1586 \membersection{::wxToUpper}\label{wxtoupper}
1588 \func{char}{wxToUpper}{\param{char }{ch}}
1590 Converts the character to upper case. This is implemented as a macro for efficiency.
1592 \wxheading{Include files}
1596 \membersection{::wxTrace}\label{wxtrace}
1598 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1600 Takes printf-style variable argument syntax. Output
1601 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1603 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1605 \wxheading{Include files}
1609 \membersection{::wxTraceLevel}\label{wxtracelevel}
1611 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1613 Takes printf-style variable argument syntax. Output
1614 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1615 The first argument should be the level at which this information is appropriate.
1616 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1619 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1621 \wxheading{Include files}
1625 \membersection{::wxUsleep}\label{wxusleep}
1627 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1629 Sleeps for the specified number of milliseconds. Notice that usage of this
1630 function is encouraged instead of calling usleep(3) directly because the
1631 standard usleep() function is not MT safe.
1633 \wxheading{Include files}
1637 \membersection{::wxWriteResource}\label{wxwriteresource}
1639 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1640 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1642 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1643 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1645 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1646 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1648 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1649 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1651 Writes a resource value into the resource database (for example, WIN.INI, or
1652 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1653 otherwise the specified file is used.
1655 Under X, the resource databases are cached until the internal function
1656 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1657 all updated resource databases are written to their files.
1659 Note that it is considered bad manners to write to the .Xdefaults
1660 file under Unix, although the WIN.INI file is fair game under Windows.
1662 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1664 \wxheading{Include files}
1668 \membersection{::wxYield}\label{wxyield}
1670 \func{bool}{wxYield}{\void}
1672 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1673 time-consuming process writes to a text window. Without an occasional
1674 yield, the text window will not be updated properly, and (since Windows
1675 multitasking is cooperative) other processes will not respond.
1677 Caution should be exercised, however, since yielding may allow the
1678 user to perform actions which are not compatible with the current task.
1679 Disabling menu items or whole menus during processing can avoid unwanted
1680 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1683 \wxheading{Include files}
1685 <wx/app.h> or <wx/utils.h>
1687 \section{Macros}\label{macros}
1689 These macros are defined in wxWindows.
1691 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1693 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1695 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1697 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1699 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1701 This macro will swap the bytes of the {\it value} variable from little
1702 endian to big endian or vice versa.
1704 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1706 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1708 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1710 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1712 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1714 This macro will swap the bytes of the {\it value} variable from little
1715 endian to big endian or vice versa if the program is compiled on a
1716 big-endian architecture (such as Sun work stations). If the program has
1717 been compiled on a little-endian architecture, the value will be unchanged.
1719 Use these macros to read data from and write data to a file that stores
1720 data in little endian (Intel i386) format.
1722 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1724 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1726 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1728 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1730 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1732 This macro will swap the bytes of the {\it value} variable from little
1733 endian to big endian or vice versa if the program is compiled on a
1734 little-endian architecture (such as Intel PCs). If the program has
1735 been compiled on a big-endian architecture, the value will be unchanged.
1737 Use these macros to read data from and write data to a file that stores
1738 data in big endian format.
1740 \membersection{CLASSINFO}\label{classinfo}
1742 \func{wxClassInfo *}{CLASSINFO}{className}
1744 Returns a pointer to the wxClassInfo object associated with this class.
1746 \wxheading{Include files}
1750 \membersection{DECLARE\_ABSTRACT\_CLASS}
1752 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1754 Used inside a class declaration to declare that the class should be
1755 made known to the class hierarchy, but objects of this class cannot be created
1756 dynamically. The same as DECLARE\_CLASS.
1761 class wxCommand: public wxObject
1763 DECLARE_ABSTRACT_CLASS(wxCommand)
1772 \wxheading{Include files}
1776 \membersection{DECLARE\_APP}\label{declareapp}
1778 \func{}{DECLARE\_APP}{className}
1780 This is used in headers to create a forward declaration of the wxGetApp function implemented
1781 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1789 \wxheading{Include files}
1793 \membersection{DECLARE\_CLASS}
1795 \func{}{DECLARE\_CLASS}{className}
1797 Used inside a class declaration to declare that the class should be
1798 made known to the class hierarchy, but objects of this class cannot be created
1799 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1801 \wxheading{Include files}
1805 \membersection{DECLARE\_DYNAMIC\_CLASS}
1807 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1809 Used inside a class declaration to declare that the objects of this class should be dynamically
1810 createable from run-time type information.
1815 class wxFrame: public wxWindow
1817 DECLARE_DYNAMIC_CLASS(wxFrame)
1820 const wxString\& frameTitle;
1826 \wxheading{Include files}
1830 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1832 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1834 Used in a C++ implementation file to complete the declaration of
1835 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1840 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1842 wxCommand::wxCommand(void)
1848 \wxheading{Include files}
1852 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1854 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1856 Used in a C++ implementation file to complete the declaration of
1857 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1859 \wxheading{Include files}
1863 \membersection{IMPLEMENT\_APP}\label{implementapp}
1865 \func{}{IMPLEMENT\_APP}{className}
1867 This is used in the application class implementation file to make the application class known to
1868 wxWindows for dynamic construction. You use this instead of
1879 IMPLEMENT_APP(MyApp)
1882 See also \helpref{DECLARE\_APP}{declareapp}.
1884 \wxheading{Include files}
1888 \membersection{IMPLEMENT\_CLASS}
1890 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1892 Used in a C++ implementation file to complete the declaration of
1893 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1895 \wxheading{Include files}
1899 \membersection{IMPLEMENT\_CLASS2}
1901 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1903 Used in a C++ implementation file to complete the declaration of a
1904 class that has run-time type information and two base classes. The
1905 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1907 \wxheading{Include files}
1911 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1913 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1915 Used in a C++ implementation file to complete the declaration of
1916 a class that has run-time type information, and whose instances
1917 can be created dynamically.
1922 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1924 wxFrame::wxFrame(void)
1930 \wxheading{Include files}
1934 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1936 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1938 Used in a C++ implementation file to complete the declaration of
1939 a class that has run-time type information, and whose instances
1940 can be created dynamically. Use this for classes derived from two
1943 \wxheading{Include files}
1947 \membersection{wxBITMAP}\label{wxbitmapmacro}
1949 \func{}{wxBITMAP}{bitmapName}
1951 This macro loads a bitmap from either application resources (on the platforms
1952 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
1953 avoid using {\tt #ifdef}s when creating bitmaps.
1955 \wxheading{See also}
1957 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
1958 \helpref{wxICON}{wxiconmacro}
1960 \wxheading{Include files}
1964 \membersection{WXDEBUG\_NEW}\label{debugnew}
1966 \func{}{WXDEBUG\_NEW}{arg}
1968 This is defined in debug mode to be call the redefined new operator
1969 with filename and line number arguments. The definition is:
1972 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1975 In non-debug mode, this is defined as the normal new operator.
1977 \wxheading{Include files}
1981 \membersection{wxDynamicCast}\label{wxdynamiccast}
1983 \func{}{wxDynamicCast}{ptr, classname}
1985 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1986 the pointer is of this type (the check is done during the run-time) or NULL
1987 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1990 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1995 wxWindow *win = wxWindow::FindFocus();
1996 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1999 // a text control has the focus...
2003 // no window has the focus or it's not a text control
2007 \wxheading{See also}
2009 \helpref{RTTI overview}{runtimeclassoverview}
2011 \membersection{wxICON}\label{wxiconmacro}
2013 \func{}{wxICON}{iconName}
2015 This macro loads an icon from either application resources (on the platforms
2016 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2017 avoid using {\tt #ifdef}s when creating icons.
2019 \wxheading{See also}
2021 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2022 \helpref{wxBITMAP}{wxbitmapmacro}
2024 \wxheading{Include files}
2028 \membersection{WXTRACE}\label{trace}
2030 \wxheading{Include files}
2034 \func{}{WXTRACE}{formatString, ...}
2036 Calls wxTrace with printf-style variable argument syntax. Output
2037 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2039 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2041 \wxheading{Include files}
2045 \membersection{WXTRACELEVEL}\label{tracelevel}
2047 \func{}{WXTRACELEVEL}{level, formatString, ...}
2049 Calls wxTraceLevel with printf-style variable argument syntax. Output
2050 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2051 The first argument should be the level at which this information is appropriate.
2052 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2055 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2057 \wxheading{Include files}
2061 \section{wxWindows resource functions}\label{resourcefuncs}
2063 \overview{wxWindows resource system}{resourceformats}
2065 This section details functions for manipulating wxWindows (.WXR) resource
2066 files and loading user interface elements from resources.
2068 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2069 about initialisation file resource reading and writing, using such functions
2070 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2072 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2074 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2075 loading from resource data.
2077 {\bf Warning:} this needs updating for wxWindows 2.
2079 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2081 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2083 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2084 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2085 perhaps for implementing resource functionality for interpreted languages.
2087 \membersection{::wxResourceClear}
2089 \func{void}{wxResourceClear}{\void}
2091 Clears the wxWindows resource table.
2093 \membersection{::wxResourceCreateBitmap}
2095 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2097 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2098 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2102 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2103 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2104 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2107 then this function can be called as follows:
2110 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2113 \membersection{::wxResourceCreateIcon}
2115 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2117 Creates a new icon from a file, static data, or Windows resource, given a valid
2118 wxWindows icon resource identifier. For example, if the .WXR file contains
2122 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2123 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2124 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2127 then this function can be called as follows:
2130 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2133 \membersection{::wxResourceCreateMenuBar}
2135 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2137 Creates a new menu bar given a valid wxWindows menubar resource
2138 identifier. For example, if the .WXR file contains the following:
2141 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2145 ['&Open File', 2, 'Open a file'],\
2146 ['&Save File', 3, 'Save a file'],\
2148 ['E&xit', 4, 'Exit program']\
2151 ['&About', 6, 'About this program']\
2156 then this function can be called as follows:
2159 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2163 \membersection{::wxResourceGetIdentifier}
2165 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2167 Used for retrieving the integer value associated with an identifier.
2168 A zero value indicates that the identifier was not found.
2170 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2172 \membersection{::wxResourceParseData}\label{wxresourcedata}
2174 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2176 Parses a string containing one or more wxWindows resource objects. If
2177 the resource objects are global static data that are included into the
2178 C++ program, then this function must be called for each variable
2179 containing the resource data, to make it known to wxWindows.
2181 {\it resource} should contain data in the following form:
2184 dialog(name = 'dialog1',
2185 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2186 title = 'Test dialog box',
2187 x = 312, y = 234, width = 400, height = 300,
2189 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2190 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2191 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2192 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2193 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2194 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2197 This function will typically be used after including a {\tt .wxr} file into
2198 a C++ program as follows:
2201 #include "dialog1.wxr"
2204 Each of the contained resources will declare a new C++ variable, and each
2205 of these variables should be passed to wxResourceParseData.
2207 \membersection{::wxResourceParseFile}
2209 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2211 Parses a file containing one or more wxWindows resource objects
2212 in C++-compatible syntax. Use this function to dynamically load
2213 wxWindows resource data.
2215 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2217 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2219 Parses a string containing one or more wxWindows resource objects. If
2220 the resource objects are global static data that are included into the
2221 C++ program, then this function must be called for each variable
2222 containing the resource data, to make it known to wxWindows.
2224 {\it resource} should contain data with the following form:
2227 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2228 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2229 title = 'Test dialog box',\
2230 x = 312, y = 234, width = 400, height = 300,\
2232 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2233 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2234 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2235 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2236 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2237 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2240 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2241 load an entire {\tt .wxr file} into a string.
2243 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2245 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2246 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2248 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2250 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2251 This is required if other resources will use the bitmap data, since otherwise there
2252 is no connection between names used in resources, and the global bitmap data.
2254 \membersection{::wxResourceRegisterIconData}
2256 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2258 \section{Log functions}\label{logfunctions}
2260 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2261 further information.
2263 \wxheading{Include files}
2267 \membersection{::wxLogError}\label{wxlogerror}
2269 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2271 The function to use for error messages, i.e. the
2272 messages that must be shown to the user. The default processing is to pop up a
2273 message box to inform the user about it.
2275 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2277 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2279 Like \helpref{wxLogError}{wxlogerror}, but also
2280 terminates the program with the exit code 3. Using {\it abort()} standard
2281 function also terminates the program with this exit code.
2283 \membersection{::wxLogWarning}\label{wxlogwarning}
2285 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2287 For warnings - they are also normally shown to the
2288 user, but don't interrupt the program work.
2290 \membersection{::wxLogMessage}\label{wxlogmessage}
2292 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2294 for all normal, informational messages. They also
2295 appear in a message box by default (but it can be changed). Notice
2296 that the standard behaviour is to not show informational messages if there are
2297 any errors later - the logic being that the later error messages make the
2298 informational messages preceding them meaningless.
2300 \membersection{::wxLogVerbose}\label{wxlogverbose}
2302 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2304 For verbose output. Normally, it's suppressed, but
2305 might be activated if the user wishes to know more details about the program
2306 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2308 \membersection{::wxLogStatus}\label{wxlogstatus}
2310 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2312 For status messages - they will go into the status
2313 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2315 \membersection{::wxLogSysError}\label{wxlogsyserror}
2317 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2319 Mostly used by wxWindows itself, but might be
2320 handy for logging errors after system call (API function) failure. It logs the
2321 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2322 on the platform) and the corresponding error
2323 message. The second form of this function takes the error code explitly as the
2326 \membersection{::wxLogDebug}\label{wxlogdebug}
2328 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2330 The right function for debug output. It only
2331 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2332 and expands to nothing in release mode (otherwise).
2334 \membersection{::wxLogTrace}\label{wxlogtrace}
2336 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2338 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2340 As {\bf wxLogDebug}, only does something in debug
2341 build. The reason for making it a separate function from it is that usually
2342 there are a lot of trace messages, so it might make sense to separate them
2343 from other debug messages which would be flooded in them. Moreover, the second
2344 version of this function takes a trace mask as the first argument which allows
2345 to further restrict the amount of messages generated. The value of {\it mask} can be:
2347 \begin{itemize}\itemsep=0pt
2348 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2349 \item wxTraceMessages: trace window messages/X callbacks
2350 \item wxTraceResAlloc: trace GDI resource allocation
2351 \item wxTraceRefCount: trace various ref counting operations
2354 \section{Debugging macros and functions}\label{debugmacros}
2356 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2357 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2360 \wxheading{Include files}
2364 \membersection{::wxOnAssert}\label{wxonassert}
2366 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2368 This function may be redefined to do something non trivial and is called
2369 whenever one of debugging macros fails (i.e. condition is false in an
2371 % TODO: this should probably be an overridable in wxApp.
2373 \membersection{wxASSERT}\label{wxassert}
2375 \func{}{wxASSERT}{\param{}{condition}}
2377 Assert macro. An error message will be generated if the condition is FALSE in
2378 debug mode, but nothing will be done in the release build.
2380 Please note that the condition in wxASSERT() should have no side effects
2381 because it will not be executed in release mode at all.
2383 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2385 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2387 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2389 Assert macro with message. An error message will be generated if the condition is FALSE.
2391 See also: \helpref{wxASSERT}{wxassert}
2393 \membersection{wxFAIL}\label{wxfail}
2395 \func{}{wxFAIL}{\void}
2397 Will always generate an assert error if this code is reached (in debug mode).
2399 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2401 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2403 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2405 Will always generate an assert error with specified message if this code is reached (in debug mode).
2407 This macro is useful for marking unreachable" code areas, for example
2408 it may be used in the "default:" branch of a switch statement if all possible
2409 cases are processed above.
2411 See also: \helpref{wxFAIL}{wxfail}
2413 \membersection{wxCHECK}\label{wxcheck}
2415 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2417 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2418 This check is done even in release mode.
2420 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2422 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2424 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2425 This check is done even in release mode.
2427 This macro may be only used in non void functions, see also
2428 \helpref{wxCHECK\_RET}{wxcheckret}.
2430 \membersection{wxCHECK\_RET}\label{wxcheckret}
2432 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2434 Checks that the condition is true, and returns if not (FAILs with given error
2435 message in debug mode). This check is done even in release mode.
2437 This macro should be used in void functions instead of
2438 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2440 \membersection{wxCHECK2}\label{wxcheck2}
2442 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2444 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2445 {\it operation} if it is not. This is a generalisation of
2446 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2447 returning from the function must be done when the {\it condition} is false.
2449 This check is done even in release mode.
2451 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2453 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2455 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2456 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2457 instead of wxFAIL() if the {\it condition} is false.