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.
36 \membersection{::wxFileNameFromPath
}
38 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
40 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
42 Returns the filename for a full path. The second form returns a pointer to
43 temporary storage that should not be deallocated.
45 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
47 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
49 This function does directory searching; returns the first file
50 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
51 get the next matching file. Neither will
report the current directory "." or the
52 parent directory "..".
54 {\it spec
} may contain wildcards.
56 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
61 wxString f = wxFindFirstFile("/home/project/*.*");
62 while ( !f.IsEmpty() )
69 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
71 \func{wxString
}{wxFindNextFile
}{\void}
73 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
75 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
77 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
79 \func{wxString
}{wxGetOSDirectory
}{\void}
81 Returns the Windows directory under Windows; on other platforms returns the empty string.
83 \membersection{::wxIsAbsolutePath
}
85 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
87 Returns TRUE if the argument is an absolute filename, i.e. with a slash
88 or drive name at the beginning.
90 \membersection{::wxPathOnly
}
92 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
94 Returns the directory part of the filename.
96 \membersection{::wxUnix2DosFilename
}
98 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
100 Converts a Unix to a DOS filename by replacing forward
101 slashes with backslashes.
103 \membersection{::wxConcatFiles
}
105 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
106 \param{const wxString\&
}{file3
}}
108 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
111 \membersection{::wxCopyFile
}
113 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
115 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
117 \membersection{::wxGetCwd
}\label{wxgetcwd
}
119 \func{wxString
}{wxGetCwd
}{\void}
121 Returns a string containing the current (or working) directory.
123 \membersection{::wxGetWorkingDirectory
}
125 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
127 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
129 Copies the current working directory into the buffer if supplied, or
130 copies the working directory into new storage (which you must delete yourself)
131 if the buffer is NULL.
133 {\it sz
} is the size of the buffer if supplied.
135 \membersection{::wxGetTempFileName
}
137 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
139 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
140 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
141 is allocated for the temporary filename using
{\it new
}.
143 Under Windows, the filename will include the drive and name of the
144 directory allocated for temporary files (usually the contents of the
145 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
147 It is the application's responsibility to create and delete the file.
149 \membersection{::wxIsWild
}\label{wxiswild
}
151 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
153 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
155 \membersection{::wxMatchWild
}\label{wxmatchwild
}
157 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
159 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
160 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
161 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
163 \membersection{::wxMkdir
}
165 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
167 Makes the directory
{\it dir
}, returning TRUE if successful.
169 {\it perm
} is the access mask for the directory for the systems on which it is
170 supported (Unix) and doesn't have effect for the other ones.
172 \membersection{::wxRemoveFile
}
174 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
176 Removes
{\it file
}, returning TRUE if successful.
178 \membersection{::wxRenameFile
}
180 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
182 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
184 \membersection{::wxRmdir
}
186 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
188 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
190 The
{\it flags
} parameter is reserved for future use.
192 \membersection{::wxSetWorkingDirectory
}
194 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
196 Sets the current working directory, returning TRUE if the operation succeeded.
197 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
199 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
201 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
203 This function splits a full file name into components: the path (including possible disk/drive
204 specification under Windows), the base name and the extension. Any of the output parameters
205 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
206 a particular component.
208 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
209 Windows, however it will not consider backslashes as path separators under Unix (where backslash
210 is a valid character in a filename).
212 On entry,
{\it fullname
} should be non NULL (it may be empty though).
214 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
215 contains the file name and
{\it ext
} contains the file extension without leading dot. All
216 three of them may be empty if the corresponding component is. The old contents of the
217 strings pointed to by these parameters will be overwritten in any case (if the pointers
220 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
222 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
224 Copies the given file to
{\it stream
}. Useful when converting an old application to
225 use streams (within the
document/view framework, for example).
227 Use of this function requires the file wx
\_doc.h to be included.
229 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
231 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
233 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
234 use streams (within the
document/view framework, for example).
236 Use of this function requires the file wx
\_doc.h to be included.
238 \section{Network functions
}\label{networkfunctions
}
240 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
242 \func{wxString
}{wxGetFullHostName
}{\void}
244 Returns the FQDN (fully qualified domain host name) or an empty string on
247 See also:
\helpref{wxGetHostName
}{wxgethostname
}
249 \wxheading{Include files
}
253 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
255 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
257 Copies the user's email address into the supplied buffer, by
258 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
259 and
\helpref{wxGetUserId
}{wxgetuserid
}.
261 Returns TRUE if successful, FALSE otherwise.
263 \wxheading{Include files
}
267 \membersection{::wxGetHostName
}\label{wxgethostname
}
269 \func{wxString
}{wxGetHostName
}{\void}
270 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
272 Copies the current host machine's name into the supplied buffer. Please note
273 that the returned name is
{\it not
} fully qualified, i.e. it does not include
276 Under Windows or NT, this function first looks in the environment
277 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
278 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
280 The first variant of this function returns the hostname if successful or an
281 empty string otherwise. The second (deprecated) function returns TRUE
282 if successful, FALSE otherwise.
284 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
286 \wxheading{Include files
}
290 \section{User identification
}\label{useridfunctions
}
292 \membersection{::wxGetUserId
}\label{wxgetuserid
}
294 \func{wxString
}{wxGetUserId
}{\void}
295 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
297 This function returns the "user id" also known as "login name" under Unix i.e.
298 something like "jsmith". It uniquely identifies the current user (on this system).
300 Under Windows or NT, this function first looks in the environment
301 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
302 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
304 The first variant of this function returns the login name if successful or an
305 empty string otherwise. The second (deprecated) function returns TRUE
306 if successful, FALSE otherwise.
308 See also:
\helpref{wxGetUserName
}{wxgetusername
}
310 \wxheading{Include files
}
314 \membersection{::wxGetUserName
}\label{wxgetusername
}
316 \func{wxString
}{wxGetUserName
}{\void}
317 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
319 This function returns the full user name (something like "Mr. John Smith").
321 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
322 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
323 is running, the entry
{\bf Current
} in the section
{\bf User
} of
324 the PENWIN.INI file is used.
326 The first variant of this function returns the user name if successful or an
327 empty string otherwise. The second (deprecated) function returns TRUE
328 if successful, FALSE otherwise.
330 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
332 \wxheading{Include files
}
336 \section{String functions
}
338 \membersection{::copystring
}
340 \func{char*
}{copystring
}{\param{const char*
}{s
}}
342 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
343 deleted with the
{\it delete
} operator.
345 \membersection{::wxStringMatch
}
347 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
348 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
350 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
351 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
352 no substring matching is done.
354 \membersection{::wxStringEq
}\label{wxstringeq
}
356 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
361 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
364 \membersection{::IsEmpty
}\label{isempty
}
366 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
368 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
369 pointer to this function and it will return TRUE for it.
371 \membersection{::Stricmp
}\label{stricmp
}
373 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
375 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
376 to or greater than
{\it p2
}. The comparison is case-insensitive.
378 This function complements the standard C function
{\it strcmp()
} which performs
379 case-sensitive comparison.
381 \membersection{::Strlen
}\label{strlen
}
383 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
385 This is a safe version of standard function
{\it strlen()
}: it does exactly the
386 same thing (i.e. returns the length of the string) except that it returns
0 if
387 {\it p
} is the NULL pointer.
389 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
391 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
393 This function returns the translation of string
{\it str
} in the current
394 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
395 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
396 original string is returned. In debug build, an error message is logged - this
397 should help to find the strings which were not yet translated. As this function
398 is used very often, an alternative syntax is provided: the
\_() macro is
399 defined as wxGetTranslation().
401 \section{Dialog functions
}\label{dialogfunctions
}
403 Below are a number of convenience functions for getting input from the
404 user or displaying messages. Note that in these functions the last three
405 parameters are optional. However, it is recommended to pass a parent frame
406 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
407 the front when the dialog box is popped up.
409 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
411 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{
412 \param{const wxString\&
}{filename
},
413 \param{size
\_t }{currentTip
}}
415 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
416 used with
\helpref{wxShowTip
}{wxshowtip
}.
418 \docparam{filename
}{The name of the file containing the tips, one per line
}
419 \docparam{currentTip
}{The index of the first tip to show - normally this index
420 is remembered between the
2 program runs.
}
422 \wxheading{See also:
}
424 \helpref{Tips overview
}{tipsoverview
}
426 \wxheading{Include files
}
430 \membersection{::wxFileSelector
}\label{wxfileselector
}
432 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
433 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
434 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
435 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
437 Pops up a file selector box. In Windows, this is the common file selector
438 dialog. In X, this is a file selector box with somewhat less functionality.
439 The path and filename are distinct elements of a full file pathname.
440 If path is empty, the current directory will be used. If filename is empty,
441 no default filename will be supplied. The wildcard determines what files
442 are displayed in the file selector, and file extension supplies a type
443 extension for the required filename. Flags may be a combination of wxOPEN,
444 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0.
446 Both the Unix and Windows versions implement a wildcard filter. Typing a
447 filename containing wildcards
(*, ?) in the filename text item, and
448 clicking on Ok, will result in only those files matching the pattern being
451 The wildcard may be a specification for multiple types of file
452 with a description for each, such as:
455 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
458 The application must check for an empty return value (the user pressed
459 Cancel). For example:
462 const wxString& s = wxFileSelector("Choose a file to open");
469 \wxheading{Include files}
473 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
475 \func{long}{wxGetNumberFromUser}{
476 \param{const wxString\& }{message},
477 \param{const wxString\& }{prompt},
478 \param{const wxString\& }{caption},
479 \param{long }{value},
480 \param{long }{min = 0},
481 \param{long }{max = 100},
482 \param{wxWindow *}{parent = NULL},
483 \param{const wxPoint\& }{pos = wxDefaultPosition}}
485 Shows a dialog asking the user for numeric input. The dialogs title is set to
486 {\it caption}, it contains a (possibly) multiline {\it message} above the
487 single line {\it prompt} and the zone for entering the number.
489 The number entered must be in the range {\it min}..{\it max} (both of which
490 should be positive) and {\it value} is the initial value of it. If the user
491 enters an invalid value or cancels the dialog, the function will return -1.
493 Dialog is centered on its {\it parent} unless an explicit position is given in
496 \wxheading{Include files}
500 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
502 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
503 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
504 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
506 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
507 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
508 or press Cancel to return the empty string.
510 If {\it centre} is TRUE, the message text (which may include new line characters)
511 is centred; if FALSE, the message is left-justified.
513 \wxheading{Include files}
517 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
519 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
520 \param{int }{nsel}, \param{int *}{selection},
521 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
522 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
524 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
525 listbox. The user may choose one or more item(s) and press OK or Cancel.
527 The number of initially selected choices, and array of the selected indices,
528 are passed in; this array will contain the user selections on exit, with
529 the function returning the number of selections. {\it selection} must be
530 as big as the number of choices, in case all are selected.
532 If Cancel is pressed, -1 is returned.
534 {\it choices} is an array of {\it n} strings for the listbox.
536 If {\it centre} is TRUE, the message text (which may include new line characters)
537 is centred; if FALSE, the message is left-justified.
539 \wxheading{Include files}
543 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
545 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
546 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
547 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
549 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
550 listbox. The user may choose an item and press OK to return a string or
551 Cancel to return the empty string.
553 {\it choices} is an array of {\it n} strings for the listbox.
555 If {\it centre} is TRUE, the message text (which may include new line characters)
556 is centred; if FALSE, the message is left-justified.
558 \wxheading{Include files}
562 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
564 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
565 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
566 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
568 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
569 If the user pressed cancel, -1 is returned.
571 \wxheading{Include files}
575 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
577 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
578 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
579 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
581 As {\bf wxGetSingleChoice} but takes an array of client data pointers
582 corresponding to the strings, and returns one of these pointers.
584 \wxheading{Include files}
588 \membersection{::wxMessageBox}\label{wxmessagebox}
590 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
591 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
593 General purpose message dialog. {\it style} may be a bit list of the
594 following identifiers:
596 \begin{twocollist}\itemsep=0pt
597 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
599 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
601 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
602 \twocolitem{wxCENTRE}{Centres the text.}
603 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
604 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
605 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
606 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
609 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
615 int answer = wxMessageBox("Quit program?", "Confirm",
616 wxYES_NO | wxCANCEL, main_frame);
622 {\it message} may contain newline characters, in which case the
623 message will be split into separate lines, to cater for large messages.
625 Under Windows, the native MessageBox function is used unless wxCENTRE
626 is specified in the style, in which case a generic function is used.
627 This is because the native MessageBox function cannot centre text.
628 The symbols are not shown when the generic function is used.
630 \wxheading{Include files}
634 \membersection{::wxShowTip}\label{wxshowtip}
636 \func{bool}{wxShowTip}{
637 \param{wxWindow *}{parent},
638 \param{wxTipProvider *}{tipProvider},
639 \param{bool }{showAtStartup = TRUE}}
641 This function shows a "startup tip" to the user.
643 \docparam{parent}{The parent window for the modal dialog}
645 \docparam{tipProvider}{An object which is used to get the text of the tips.
646 It may be created with
647 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
649 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
650 otherwise. This is used as the initial value for "Show tips at startup"
651 checkbox which is shown in the tips dialog.}
653 \wxheading{See also:}
655 \helpref{Tips overview}{tipsoverview}
657 \wxheading{Include files}
661 \section{GDI functions}\label{gdifunctions}
663 The following are relevant to the GDI (Graphics Device Interface).
665 \wxheading{Include files}
669 \membersection{::wxColourDisplay}
671 \func{bool}{wxColourDisplay}{\void}
673 Returns TRUE if the display is colour, FALSE otherwise.
675 \membersection{::wxDisplayDepth}
677 \func{int}{wxDisplayDepth}{\void}
679 Returns the depth of the display (a value of 1 denotes a monochrome display).
681 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
683 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
684 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
686 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
687 makes it into a placeable metafile by prepending a header containing the given
688 bounding box. The bounding box may be obtained from a device context after drawing
689 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
691 In addition to adding the placeable metafile header, this function adds
692 the equivalent of the following code to the start of the metafile data:
695 SetMapMode(dc, MM_ANISOTROPIC);
696 SetWindowOrg(dc, minX, minY);
697 SetWindowExt(dc, maxX - minX, maxY - minY);
700 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
702 Placeable metafiles may be imported by many Windows applications, and can be
703 used in RTF (Rich Text Format) files.
705 {\it scale} allows the specification of scale for the metafile.
707 This function is only available under Windows.
709 \membersection{::wxSetCursor}\label{wxsetcursor}
711 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
713 Globally sets the cursor; only has an effect in Windows and GTK.
714 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
716 \section{Printer settings}\label{printersettings}
718 These routines are obsolete and should no longer be used!
720 The following functions are used to control PostScript printing. Under
721 Windows, PostScript output can only be sent to a file.
723 \wxheading{Include files}
727 \membersection{::wxGetPrinterCommand}
729 \func{wxString}{wxGetPrinterCommand}{\void}
731 Gets the printer command used to print a file. The default is {\tt lpr}.
733 \membersection{::wxGetPrinterFile}
735 \func{wxString}{wxGetPrinterFile}{\void}
737 Gets the PostScript output filename.
739 \membersection{::wxGetPrinterMode}
741 \func{int}{wxGetPrinterMode}{\void}
743 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
744 The default is PS\_PREVIEW.
746 \membersection{::wxGetPrinterOptions}
748 \func{wxString}{wxGetPrinterOptions}{\void}
750 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
752 \membersection{::wxGetPrinterOrientation}
754 \func{int}{wxGetPrinterOrientation}{\void}
756 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
758 \membersection{::wxGetPrinterPreviewCommand}
760 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
762 Gets the command used to view a PostScript file. The default depends on the platform.
764 \membersection{::wxGetPrinterScaling}
766 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
768 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
770 \membersection{::wxGetPrinterTranslation}
772 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
774 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
776 \membersection{::wxSetPrinterCommand}
778 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
780 Sets the printer command used to print a file. The default is {\tt lpr}.
782 \membersection{::wxSetPrinterFile}
784 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
786 Sets the PostScript output filename.
788 \membersection{::wxSetPrinterMode}
790 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
792 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
793 The default is PS\_PREVIEW.
795 \membersection{::wxSetPrinterOptions}
797 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
799 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
801 \membersection{::wxSetPrinterOrientation}
803 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
805 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
807 \membersection{::wxSetPrinterPreviewCommand}
809 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
811 Sets the command used to view a PostScript file. The default depends on the platform.
813 \membersection{::wxSetPrinterScaling}
815 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
817 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
819 \membersection{::wxSetPrinterTranslation}
821 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
823 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
825 \section{Clipboard functions}\label{clipsboard}
827 These clipboard functions are implemented for Windows only.
829 \wxheading{Include files}
833 \membersection{::wxClipboardOpen}
835 \func{bool}{wxClipboardOpen}{\void}
837 Returns TRUE if this application has already opened the clipboard.
839 \membersection{::wxCloseClipboard}
841 \func{bool}{wxCloseClipboard}{\void}
843 Closes the clipboard to allow other applications to use it.
845 \membersection{::wxEmptyClipboard}
847 \func{bool}{wxEmptyClipboard}{\void}
849 Empties the clipboard.
851 \membersection{::wxEnumClipboardFormats}
853 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
855 Enumerates the formats found in a list of available formats that belong
856 to the clipboard. Each call to this function specifies a known
857 available format; the function returns the format that appears next in
860 {\it dataFormat} specifies a known format. If this parameter is zero,
861 the function returns the first format in the list.
863 The return value specifies the next known clipboard data format if the
864 function is successful. It is zero if the {\it dataFormat} parameter specifies
865 the last format in the list of available formats, or if the clipboard
868 Before it enumerates the formats function, an application must open the clipboard by using the
869 wxOpenClipboard function.
871 \membersection{::wxGetClipboardData}
873 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
875 Gets data from the clipboard.
877 {\it dataFormat} may be one of:
879 \begin{itemize}\itemsep=0pt
880 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
881 \item wxCF\_BITMAP: returns a new wxBitmap.
884 The clipboard must have previously been opened for this call to succeed.
886 \membersection{::wxGetClipboardFormatName}
888 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
890 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
891 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
893 \membersection{::wxIsClipboardFormatAvailable}
895 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
897 Returns TRUE if the given data format is available on the clipboard.
899 \membersection{::wxOpenClipboard}
901 \func{bool}{wxOpenClipboard}{\void}
903 Opens the clipboard for passing data to it or getting data from it.
905 \membersection{::wxRegisterClipboardFormat}
907 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
909 Registers the clipboard data format name and returns an identifier.
911 \membersection{::wxSetClipboardData}
913 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
915 Passes data to the clipboard.
917 {\it dataFormat} may be one of:
919 \begin{itemize}\itemsep=0pt
920 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
921 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
922 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
923 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
926 The clipboard must have previously been opened for this call to succeed.
928 \section{Miscellaneous functions}\label{miscellany}
930 \membersection{::wxNewId}
932 \func{long}{wxNewId}{\void}
934 Generates an integer identifier unique to this run of the program.
936 \wxheading{Include files}
940 \membersection{::wxRegisterId}
942 \func{void}{wxRegisterId}{\param{long}{ id}}
944 Ensures that ids subsequently generated by {\bf NewId} do not clash with
947 \wxheading{Include files}
951 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
953 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
955 Changes the cursor to the given cursor for all windows in the application.
956 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
957 to its previous state. These two calls can be nested, and a counter
958 ensures that only the outer calls take effect.
960 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
962 \wxheading{Include files}
966 \membersection{::wxBell}
968 \func{void}{wxBell}{\void}
970 Ring the system bell.
972 \wxheading{Include files}
976 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
978 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
980 Creates and returns an object of the given class, if the class has been
981 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
983 \membersection{::wxDDECleanUp}\label{wxddecleanup}
985 \func{void}{wxDDECleanUp}{\void}
987 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
988 called by the application.
990 See also helpref{wxDDEInitialize}{wxddeinitialize}.
992 \wxheading{Include files}
996 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
998 \func{void}{wxDDEInitialize}{\void}
1000 Initializes the DDE system. May be called multiple times without harm.
1002 This no longer needs to be called by the application: it will be called
1003 by wxWindows if necessary.
1005 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1006 \helpref{wxDDECleanUp}{wxddecleanup}.
1008 \wxheading{Include files}
1012 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1014 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1016 Display a debugging message; under Windows, this will appear on the
1017 debugger command window, and under Unix, it will be written to standard
1020 The syntax is identical to {\bf printf}: pass a format string and a
1021 variable list of arguments.
1023 Note that under Windows, you can see the debugging messages without a
1024 debugger if you have the DBWIN debug log application that comes with
1027 {\bf Tip:} under Windows, if your application crashes before the
1028 message appears in the debugging window, put a wxYield call after
1029 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1030 (at least for Watcom C++): preformat your messages and use OutputDebugString
1033 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1035 \wxheading{Include files}
1039 \membersection{::wxDisplaySize}
1041 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1043 Gets the physical size of the display in pixels.
1045 \wxheading{Include files}
1049 \membersection{::wxEntry}\label{wxentry}
1051 This initializes wxWindows in a platform-dependent way. Use this if you
1052 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1053 you can initialize wxWindows from an Microsoft Foundation Classes application using
1056 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1057 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1059 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1060 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1061 message loop will be entered.
1063 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1064 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1066 wxWindows initialization under Windows (for applications constructed as a DLL).
1068 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1070 wxWindows initialization under Unix.
1074 To clean up wxWindows, call wxApp::OnExit followed by the static function
1075 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1078 int CTheApp::ExitInstance()
1080 // OnExit isn't called by CleanUp so must be called explicitly.
1084 return CWinApp::ExitInstance();
1088 \wxheading{Include files}
1092 \membersection{::wxError}\label{wxerror}
1094 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1096 Displays {\it msg} and continues. This writes to standard error under
1097 Unix, and pops up a message box under Windows. Used for internal
1098 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1100 \wxheading{Include files}
1104 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1106 \func{void}{wxEndBusyCursor}{\void}
1108 Changes the cursor back to the original cursor, for all windows in the application.
1109 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1111 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1113 \wxheading{Include files}
1117 \membersection{::wxExecute}\label{wxexecute}
1119 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1121 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1123 Executes another program in Unix or Windows.
1125 The first form takes a command string, such as {\tt "emacs file.txt"}.
1127 The second form takes an array of values: a command, any number of
1128 arguments, terminated by NULL.
1130 If {\it sync} is FALSE (the default), flow of control immediately returns.
1131 If TRUE, the current application waits until the other program has terminated.
1133 In the case of synchronous execution, the return value is the exit code of
1134 the process (which terminates by the moment the function returns) and will be
1135 $-1$ if the process couldn't be started and typically 0 if the process
1136 terminated successfully. Also, while waiting for the process to
1137 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1138 should ensure that this can cause no recursion, in the simples case by
1139 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1141 For asynchronous execution, however, the return value is the process id and
1142 zero value indicates that the command could not be executed.
1144 If callback isn't NULL and if execution is asynchronous (note that callback
1145 parameter can not be non NULL for synchronous execution),
1146 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1147 the process finishes.
1149 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1151 \wxheading{Include files}
1155 \membersection{::wxExit}\label{wxexit}
1157 \func{void}{wxExit}{\void}
1159 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1160 Should only be used in an emergency: normally the top-level frame
1161 should be deleted (after deleting all other frames) to terminate the
1162 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1164 \wxheading{Include files}
1168 \membersection{::wxFatalError}\label{wxfatalerror}
1170 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1172 Displays {\it msg} and exits. This writes to standard error under Unix,
1173 and pops up a message box under Windows. Used for fatal internal
1174 wxWindows errors. See also \helpref{wxError}{wxerror}.
1176 \wxheading{Include files}
1180 \membersection{::wxFindMenuItemId}
1182 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1184 Find a menu item identifier associated with the given frame's menu bar.
1186 \wxheading{Include files}
1190 \membersection{::wxFindWindowByLabel}
1192 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1194 Find a window by its label. Depending on the type of window, the label may be a window title
1195 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1196 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1197 The search is recursive in both cases.
1199 \wxheading{Include files}
1203 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1205 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1207 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1208 If {\it parent} is NULL, the search will start from all top-level
1209 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1210 The search is recursive in both cases.
1212 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1214 \wxheading{Include files}
1218 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1220 \func{wxWindow *}{wxGetActiveWindow}{\void}
1222 Gets the currently active window (Windows only).
1224 \wxheading{Include files}
1228 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1230 \func{wxString}{wxGetDisplayName}{\void}
1232 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1234 \wxheading{Include files}
1238 \membersection{::wxGetHomeDir}
1240 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1242 Fills the buffer with a string representing the user's home directory (Unix only).
1244 \wxheading{Include files}
1248 \membersection{::wxGetHostName}
1250 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1252 Copies the host name of the machine the program is running on into the
1253 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1254 successful. Under Unix, this will return a machine name. Under Windows,
1255 this returns ``windows''.
1257 \wxheading{Include files}
1261 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1263 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1265 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1267 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1270 See also \helpref{wxTimer}{wxtimer}.
1272 \wxheading{Include files}
1276 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1278 \func{long}{wxGetFreeMemory}{\void}
1280 Returns the amount of free memory in Kbytes under environments which
1281 support it, and -1 if not supported. Currently, returns a positive value
1282 under Windows, and -1 under Unix.
1284 \wxheading{Include files}
1288 \membersection{::wxGetMousePosition}
1290 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1292 Returns the mouse position in screen coordinates.
1294 \wxheading{Include files}
1298 \membersection{::wxGetOsVersion}
1300 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1302 Gets operating system version information.
1304 \begin{twocollist}\itemsep=0pt
1305 \twocolitemruled{Platform}{Return tyes}
1306 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1307 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1308 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1309 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1310 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1311 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1312 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1313 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1314 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1317 \wxheading{Include files}
1321 \membersection{::wxGetResource}\label{wxgetresource}
1323 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1324 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1326 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1327 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1329 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1330 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1332 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1333 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1335 Gets a resource value from the resource database (for example, WIN.INI, or
1336 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1337 otherwise the specified file is used.
1339 Under X, if an application class (wxApp::GetClassName) has been defined,
1340 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1341 an applications default file when merging all resource databases.
1343 The reason for passing the result in an argument is that it
1344 can be convenient to define a default value, which gets overridden
1345 if the value exists in the resource file. It saves a separate
1346 test for that resource's existence, and it also allows
1347 the overloading of the function for different types.
1349 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1351 \wxheading{Include files}
1355 \membersection{::wxGetUserId}
1357 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1359 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1360 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1361 Under Windows, this returns ``user''.
1363 \wxheading{Include files}
1367 \membersection{::wxGetUserName}
1369 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1371 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1372 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1373 Under Windows, this returns ``unknown''.
1375 \wxheading{Include files}
1379 \membersection{::wxKill}\label{wxkill}
1381 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1383 Under Unix (the only supported platform), equivalent to the Unix kill function.
1384 Returns 0 on success, -1 on failure.
1386 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1387 It does not raise a signal in the receiving process.
1389 \wxheading{Include files}
1393 \membersection{::wxIsBusy}\label{wxisbusy}
1395 \func{bool}{wxIsBusy}{\void}
1397 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1398 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1400 See also \helpref{wxBusyCursor}{wxbusycursor}.
1402 \wxheading{Include files}
1406 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1408 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1410 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1411 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1413 The resource must be defined in the {\tt .rc} file using the following syntax:
1416 myResource TEXT file.ext
1419 where {\tt file.ext} is a file that the resource compiler can find.
1421 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1422 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1423 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1425 This function is available under Windows only.
1427 \wxheading{Include files}
1431 \membersection{::wxNow}\label{wxnow}
1433 \func{wxString}{wxNow}{\void}
1435 Returns a string representing the current date and time.
1437 \wxheading{Include files}
1441 \membersection{::wxPostDelete}\label{wxpostdelete}
1443 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1445 Tells the system to delete the specified object when
1446 all other events have been processed. In some environments, it is
1447 necessary to use this instead of deleting a frame directly with the
1448 delete operator, because some GUIs will still send events to a deleted window.
1450 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1452 \wxheading{Include files}
1456 \membersection{::wxSafeYield}\label{wxsafeyield}
1458 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1460 This function is similar to wxYield, except that it disables the user input to
1461 all program windows before calling wxYield and re-enables it again
1462 afterwards. If {\it win} is not NULL, this window will remain enabled,
1463 allowing the implementation of some limited user interaction.
1465 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1467 \wxheading{Include files}
1471 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1473 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1475 This function enables or disables all top level windows. It is used by
1476 \helpref{::wxSafeYield}{wxsafeyield}.
1478 \wxheading{Include files}
1483 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1485 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1487 Under X only, sets the current display name. This is the X host and display name such
1488 as ``colonsay:0.0", and the function indicates which display should be used for creating
1489 windows from this point on. Setting the display within an application allows multiple
1490 displays to be used.
1492 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1494 \wxheading{Include files}
1498 \membersection{::wxShell}\label{wxshell}
1500 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1502 Executes a command in an interactive shell window. If no command is
1503 specified, then just the shell is spawned.
1505 See also \helpref{wxExecute}{wxexecute}.
1507 \wxheading{Include files}
1511 \membersection{::wxSleep}\label{wxsleep}
1513 \func{void}{wxSleep}{\param{int}{ secs}}
1515 Sleeps for the specified number of seconds.
1517 \wxheading{Include files}
1521 \membersection{::wxStripMenuCodes}
1523 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1525 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1527 Strips any menu codes from {\it in} and places the result
1528 in {\it out} (or returns the new string, in the first form).
1530 Menu codes include \& (mark the next character with an underline
1531 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1533 \wxheading{Include files}
1537 \membersection{::wxStartTimer}\label{wxstarttimer}
1539 \func{void}{wxStartTimer}{\void}
1541 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1543 See also \helpref{wxTimer}{wxtimer}.
1545 \wxheading{Include files}
1549 \membersection{::wxToLower}\label{wxtolower}
1551 \func{char}{wxToLower}{\param{char }{ch}}
1553 Converts the character to lower case. This is implemented as a macro for efficiency.
1555 \wxheading{Include files}
1559 \membersection{::wxToUpper}\label{wxtoupper}
1561 \func{char}{wxToUpper}{\param{char }{ch}}
1563 Converts the character to upper case. This is implemented as a macro for efficiency.
1565 \wxheading{Include files}
1569 \membersection{::wxTrace}\label{wxtrace}
1571 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1573 Takes printf-style variable argument syntax. Output
1574 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1576 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1578 \wxheading{Include files}
1582 \membersection{::wxTraceLevel}\label{wxtracelevel}
1584 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1586 Takes printf-style variable argument syntax. Output
1587 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1588 The first argument should be the level at which this information is appropriate.
1589 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1592 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1594 \wxheading{Include files}
1598 \membersection{::wxUsleep}\label{wxusleep}
1600 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1602 Sleeps for the specified number of milliseconds. Notice that usage of this
1603 function is encouraged instead of calling usleep(3) directly because the
1604 standard usleep() function is not MT safe.
1606 \wxheading{Include files}
1610 \membersection{::wxWriteResource}\label{wxwriteresource}
1612 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1613 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1615 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1616 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1618 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1619 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1621 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1622 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1624 Writes a resource value into the resource database (for example, WIN.INI, or
1625 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1626 otherwise the specified file is used.
1628 Under X, the resource databases are cached until the internal function
1629 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1630 all updated resource databases are written to their files.
1632 Note that it is considered bad manners to write to the .Xdefaults
1633 file under Unix, although the WIN.INI file is fair game under Windows.
1635 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1637 \wxheading{Include files}
1641 \membersection{::wxYield}\label{wxyield}
1643 \func{bool}{wxYield}{\void}
1645 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1646 time-consuming process writes to a text window. Without an occasional
1647 yield, the text window will not be updated properly, and (since Windows
1648 multitasking is cooperative) other processes will not respond.
1650 Caution should be exercised, however, since yielding may allow the
1651 user to perform actions which are not compatible with the current task.
1652 Disabling menu items or whole menus during processing can avoid unwanted
1653 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1656 \wxheading{Include files}
1660 \section{Macros}\label{macros}
1662 These macros are defined in wxWindows.
1664 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1666 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1668 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1670 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1672 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1674 This macro will swap the bytes of the {\it value} variable from little
1675 endian to big endian or vice versa.
1677 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1679 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1681 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1683 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1685 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1687 This macro will swap the bytes of the {\it value} variable from little
1688 endian to big endian or vice versa if the program is compiled on a
1689 big-endian architecture (such as Sun work stations). If the program has
1690 been compiled on a little-endian architecture, the value will be unchanged.
1692 Use these macros to read data from and write data to a file that stores
1693 data in little endian (Intel i386) format.
1695 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1697 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1699 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1701 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1703 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1705 This macro will swap the bytes of the {\it value} variable from little
1706 endian to big endian or vice versa if the program is compiled on a
1707 little-endian architecture (such as Intel PCs). If the program has
1708 been compiled on a big-endian architecture, the value will be unchanged.
1710 Use these macros to read data from and write data to a file that stores
1711 data in big endian format.
1713 \membersection{CLASSINFO}\label{classinfo}
1715 \func{wxClassInfo *}{CLASSINFO}{className}
1717 Returns a pointer to the wxClassInfo object associated with this class.
1719 \wxheading{Include files}
1723 \membersection{DECLARE\_ABSTRACT\_CLASS}
1725 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1727 Used inside a class declaration to declare that the class should be
1728 made known to the class hierarchy, but objects of this class cannot be created
1729 dynamically. The same as DECLARE\_CLASS.
1734 class wxCommand: public wxObject
1736 DECLARE_ABSTRACT_CLASS(wxCommand)
1745 \wxheading{Include files}
1749 \membersection{DECLARE\_APP}\label{declareapp}
1751 \func{}{DECLARE\_APP}{className}
1753 This is used in headers to create a forward declaration of the wxGetApp function implemented
1754 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1762 \wxheading{Include files}
1766 \membersection{DECLARE\_CLASS}
1768 \func{}{DECLARE\_CLASS}{className}
1770 Used inside a class declaration to declare that the class should be
1771 made known to the class hierarchy, but objects of this class cannot be created
1772 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1774 \wxheading{Include files}
1778 \membersection{DECLARE\_DYNAMIC\_CLASS}
1780 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1782 Used inside a class declaration to declare that the objects of this class should be dynamically
1783 createable from run-time type information.
1788 class wxFrame: public wxWindow
1790 DECLARE_DYNAMIC_CLASS(wxFrame)
1793 const wxString\& frameTitle;
1799 \wxheading{Include files}
1803 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1805 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1807 Used in a C++ implementation file to complete the declaration of
1808 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1813 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1815 wxCommand::wxCommand(void)
1821 \wxheading{Include files}
1825 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1827 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1829 Used in a C++ implementation file to complete the declaration of
1830 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1832 \wxheading{Include files}
1836 \membersection{IMPLEMENT\_APP}\label{implementapp}
1838 \func{}{IMPLEMENT\_APP}{className}
1840 This is used in the application class implementation file to make the application class known to
1841 wxWindows for dynamic construction. You use this instead of
1852 IMPLEMENT_APP(MyApp)
1855 See also \helpref{DECLARE\_APP}{declareapp}.
1857 \wxheading{Include files}
1861 \membersection{IMPLEMENT\_CLASS}
1863 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1865 Used in a C++ implementation file to complete the declaration of
1866 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1868 \wxheading{Include files}
1872 \membersection{IMPLEMENT\_CLASS2}
1874 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1876 Used in a C++ implementation file to complete the declaration of a
1877 class that has run-time type information and two base classes. The
1878 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1880 \wxheading{Include files}
1884 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1886 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1888 Used in a C++ implementation file to complete the declaration of
1889 a class that has run-time type information, and whose instances
1890 can be created dynamically.
1895 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1897 wxFrame::wxFrame(void)
1903 \wxheading{Include files}
1907 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1909 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1911 Used in a C++ implementation file to complete the declaration of
1912 a class that has run-time type information, and whose instances
1913 can be created dynamically. Use this for classes derived from two
1916 \wxheading{Include files}
1920 \membersection{WXDEBUG\_NEW}\label{debugnew}
1922 \func{}{WXDEBUG\_NEW}{arg}
1924 This is defined in debug mode to be call the redefined new operator
1925 with filename and line number arguments. The definition is:
1928 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1931 In non-debug mode, this is defined as the normal new operator.
1933 \wxheading{Include files}
1937 \membersection{wxDynamicCast}\label{wxdynamiccast}
1939 \func{}{wxDynamicCast}{ptr, classname}
1941 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1942 the pointer is of this type (the check is done during the run-time) or NULL
1943 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1946 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1951 wxWindow *win = wxWindow::FindFocus();
1952 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1955 // a text control has the focus...
1959 // no window has the focus or it's not a text control
1963 \wxheading{See also}
1965 \helpref{RTTI overview}{runtimeclassoverview}
1967 \membersection{WXTRACE}\label{trace}
1969 \wxheading{Include files}
1973 \func{}{WXTRACE}{formatString, ...}
1975 Calls wxTrace with printf-style variable argument syntax. Output
1976 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1978 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1980 \wxheading{Include files}
1984 \membersection{WXTRACELEVEL}\label{tracelevel}
1986 \func{}{WXTRACELEVEL}{level, formatString, ...}
1988 Calls wxTraceLevel with printf-style variable argument syntax. Output
1989 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1990 The first argument should be the level at which this information is appropriate.
1991 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1994 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1996 \wxheading{Include files}
2000 \section{wxWindows resource functions}\label{resourcefuncs}
2002 \overview{wxWindows resource system}{resourceformats}
2004 This section details functions for manipulating wxWindows (.WXR) resource
2005 files and loading user interface elements from resources.
2007 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2008 about initialisation file resource reading and writing, using such functions
2009 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2011 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2013 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2014 loading from resource data.
2016 {\bf Warning:} this needs updating for wxWindows 2.
2018 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2020 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2022 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2023 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2024 perhaps for implementing resource functionality for interpreted languages.
2026 \membersection{::wxResourceClear}
2028 \func{void}{wxResourceClear}{\void}
2030 Clears the wxWindows resource table.
2032 \membersection{::wxResourceCreateBitmap}
2034 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2036 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2037 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2041 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2042 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2043 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2046 then this function can be called as follows:
2049 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2052 \membersection{::wxResourceCreateIcon}
2054 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2056 Creates a new icon from a file, static data, or Windows resource, given a valid
2057 wxWindows icon resource identifier. For example, if the .WXR file contains
2061 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2062 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2063 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2066 then this function can be called as follows:
2069 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2072 \membersection{::wxResourceCreateMenuBar}
2074 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2076 Creates a new menu bar given a valid wxWindows menubar resource
2077 identifier. For example, if the .WXR file contains the following:
2080 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2084 ['&Open File', 2, 'Open a file'],\
2085 ['&Save File', 3, 'Save a file'],\
2087 ['E&xit', 4, 'Exit program']\
2090 ['&About', 6, 'About this program']\
2095 then this function can be called as follows:
2098 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2102 \membersection{::wxResourceGetIdentifier}
2104 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2106 Used for retrieving the integer value associated with an identifier.
2107 A zero value indicates that the identifier was not found.
2109 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2111 \membersection{::wxResourceParseData}\label{wxresourcedata}
2113 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2115 Parses a string containing one or more wxWindows resource objects. If
2116 the resource objects are global static data that are included into the
2117 C++ program, then this function must be called for each variable
2118 containing the resource data, to make it known to wxWindows.
2120 {\it resource} should contain data in the following form:
2123 dialog(name = 'dialog1',
2124 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2125 title = 'Test dialog box',
2126 x = 312, y = 234, width = 400, height = 300,
2128 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2129 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2130 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2131 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2132 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2133 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2136 This function will typically be used after including a {\tt .wxr} file into
2137 a C++ program as follows:
2140 #include "dialog1.wxr"
2143 Each of the contained resources will declare a new C++ variable, and each
2144 of these variables should be passed to wxResourceParseData.
2146 \membersection{::wxResourceParseFile}
2148 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2150 Parses a file containing one or more wxWindows resource objects
2151 in C++-compatible syntax. Use this function to dynamically load
2152 wxWindows resource data.
2154 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2156 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2158 Parses a string containing one or more wxWindows resource objects. If
2159 the resource objects are global static data that are included into the
2160 C++ program, then this function must be called for each variable
2161 containing the resource data, to make it known to wxWindows.
2163 {\it resource} should contain data with the following form:
2166 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2167 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2168 title = 'Test dialog box',\
2169 x = 312, y = 234, width = 400, height = 300,\
2171 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2172 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2173 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2174 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2175 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2176 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2179 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2180 load an entire {\tt .wxr file} into a string.
2182 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2184 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2185 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2187 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2189 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2190 This is required if other resources will use the bitmap data, since otherwise there
2191 is no connection between names used in resources, and the global bitmap data.
2193 \membersection{::wxResourceRegisterIconData}
2195 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2197 \section{Log functions}\label{logfunctions}
2199 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2200 further information.
2202 \wxheading{Include files}
2206 \membersection{::wxLogError}\label{wxlogerror}
2208 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2210 The function to use for error messages, i.e. the
2211 messages that must be shown to the user. The default processing is to pop up a
2212 message box to inform the user about it.
2214 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2216 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2218 Like \helpref{wxLogError}{wxlogerror}, but also
2219 terminates the program with the exit code 3. Using {\it abort()} standard
2220 function also terminates the program with this exit code.
2222 \membersection{::wxLogWarning}\label{wxlogwarning}
2224 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2226 For warnings - they are also normally shown to the
2227 user, but don't interrupt the program work.
2229 \membersection{::wxLogMessage}\label{wxlogmessage}
2231 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2233 for all normal, informational messages. They also
2234 appear in a message box by default (but it can be changed). Notice
2235 that the standard behaviour is to not show informational messages if there are
2236 any errors later - the logic being that the later error messages make the
2237 informational messages preceding them meaningless.
2239 \membersection{::wxLogVerbose}\label{wxlogverbose}
2241 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2243 For verbose output. Normally, it's suppressed, but
2244 might be activated if the user wishes to know more details about the program
2245 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2247 \membersection{::wxLogStatus}\label{wxlogstatus}
2249 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2251 For status messages - they will go into the status
2252 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2254 \membersection{::wxLogSysError}\label{wxlogsyserror}
2256 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2258 Mostly used by wxWindows itself, but might be
2259 handy for logging errors after system call (API function) failure. It logs the
2260 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2261 on the platform) and the corresponding error
2262 message. The second form of this function takes the error code explitly as the
2265 \membersection{::wxLogDebug}\label{wxlogdebug}
2267 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2269 The right function for debug output. It only
2270 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2271 and expands to nothing in release mode (otherwise).
2273 \membersection{::wxLogTrace}\label{wxlogtrace}
2275 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2277 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2279 As {\bf wxLogDebug}, only does something in debug
2280 build. The reason for making it a separate function from it is that usually
2281 there are a lot of trace messages, so it might make sense to separate them
2282 from other debug messages which would be flooded in them. Moreover, the second
2283 version of this function takes a trace mask as the first argument which allows
2284 to further restrict the amount of messages generated. The value of {\it mask} can be:
2286 \begin{itemize}\itemsep=0pt
2287 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2288 \item wxTraceMessages: trace window messages/X callbacks
2289 \item wxTraceResAlloc: trace GDI resource allocation
2290 \item wxTraceRefCount: trace various ref counting operations
2293 \section{Debugging macros and functions}\label{debugmacros}
2295 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2296 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2299 \wxheading{Include files}
2303 \membersection{::wxOnAssert}\label{wxonassert}
2305 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2307 This function may be redefined to do something non trivial and is called
2308 whenever one of debugging macros fails (i.e. condition is false in an
2310 % TODO: this should probably be an overridable in wxApp.
2312 \membersection{wxASSERT}\label{wxassert}
2314 \func{}{wxASSERT}{\param{}{condition}}
2316 Assert macro. An error message will be generated if the condition is FALSE in
2317 debug mode, but nothing will be done in the release build.
2319 Please note that the condition in wxASSERT() should have no side effects
2320 because it will not be executed in release mode at all.
2322 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2324 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2326 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2328 Assert macro with message. An error message will be generated if the condition is FALSE.
2330 See also: \helpref{wxASSERT}{wxassert}
2332 \membersection{wxFAIL}\label{wxfail}
2334 \func{}{wxFAIL}{\void}
2336 Will always generate an assert error if this code is reached (in debug mode).
2338 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2340 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2342 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2344 Will always generate an assert error with specified message if this code is reached (in debug mode).
2346 This macro is useful for marking unreachable" code areas, for example
2347 it may be used in the "default:" branch of a switch statement if all possible
2348 cases are processed above.
2350 See also: \helpref{wxFAIL}{wxfail}
2352 \membersection{wxCHECK}\label{wxcheck}
2354 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2356 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2357 This check is done even in release mode.
2359 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2361 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2363 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2364 This check is done even in release mode.
2366 This macro may be only used in non void functions, see also
2367 \helpref{wxCHECK\_RET}{wxcheckret}.
2369 \membersection{wxCHECK\_RET}\label{wxcheckret}
2371 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2373 Checks that the condition is true, and returns if not (FAILs with given error
2374 message in debug mode). This check is done even in release mode.
2376 This macro should be used in void functions instead of
2377 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2379 \membersection{wxCHECK2}\label{wxcheck2}
2381 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2383 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2384 {\it operation} if it is not. This is a generalisation of
2385 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2386 returning from the function must be done when the {\it condition} is false.
2388 This check is done even in release mode.
2390 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2392 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2394 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2395 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2396 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob