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.
53 {\it spec
} may contain wildcards.
55 {\it flags
} is reserved for future use.
60 wxString f = wxFindFirstFile("/home/project/*.*");
61 while ( !f.IsEmpty() )
68 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
70 \func{wxString
}{wxFindNextFile
}{\void}
72 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
74 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
76 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
78 \func{wxString
}{wxGetOSDirectory
}{\void}
80 Returns the Windows directory under Windows; on other platforms returns the empty string.
82 \membersection{::wxIsAbsolutePath
}
84 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
86 Returns TRUE if the argument is an absolute filename, i.e. with a slash
87 or drive name at the beginning.
89 \membersection{::wxPathOnly
}
91 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
93 Returns the directory part of the filename.
95 \membersection{::wxUnix2DosFilename
}
97 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
99 Converts a Unix to a DOS filename by replacing forward
100 slashes with backslashes.
102 \membersection{::wxConcatFiles
}
104 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
105 \param{const wxString\&
}{file3
}}
107 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
110 \membersection{::wxCopyFile
}
112 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
114 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
116 \membersection{::wxGetCwd
}\label{wxgetcwd
}
118 \func{wxString
}{wxGetCwd
}{\void}
120 Returns a string containing the current (or working) directory.
122 \membersection{::wxGetWorkingDirectory
}
124 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
126 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
128 Copies the current working directory into the buffer if supplied, or
129 copies the working directory into new storage (which you must delete yourself)
130 if the buffer is NULL.
132 {\it sz
} is the size of the buffer if supplied.
134 \membersection{::wxGetTempFileName
}
136 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
138 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
139 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
140 is allocated for the temporary filename using
{\it new
}.
142 Under Windows, the filename will include the drive and name of the
143 directory allocated for temporary files (usually the contents of the
144 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
146 It is the application's responsibility to create and delete the file.
148 \membersection{::wxIsWild
}\label{wxiswild
}
150 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
152 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
154 \membersection{::wxMatchWild
}\label{wxmatchwild
}
156 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
158 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
159 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
160 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
162 \membersection{::wxMkdir
}
164 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
166 Makes the directory
{\it dir
}, returning TRUE if successful.
168 {\it perm
} is the access mask for the directory for the systems on which it is
169 supported (Unix) and doesn't have effect for the other ones.
171 \membersection{::wxRemoveFile
}
173 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
175 Removes
{\it file
}, returning TRUE if successful.
177 \membersection{::wxRenameFile
}
179 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
181 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
183 \membersection{::wxRmdir
}
185 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
187 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
189 The
{\it flags
} parameter is reserved for future use.
191 \membersection{::wxSetWorkingDirectory
}
193 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
195 Sets the current working directory, returning TRUE if the operation succeeded.
196 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
198 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
200 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
202 This function splits a full file name into components: the path (including possible disk/drive
203 specification under Windows), the base name and the extension. Any of the output parameters
204 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
205 a particular component.
207 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
208 Windows, however it will not consider backslashes as path separators under Unix (where backslash
209 is a valid character in a filename).
211 On entry,
{\it fullname
} should be non NULL (it may be empty though).
213 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
214 contains the file name and
{\it ext
} contains the file extension without leading dot. All
215 three of them may be empty if the corresponding component is. The old contents of the
216 strings pointed to by these parameters will be overwritten in any case (if the pointers
219 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
221 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
223 Copies the given file to
{\it stream
}. Useful when converting an old application to
224 use streams (within the
document/view framework, for example).
226 Use of this function requires the file wx
\_doc.h to be included.
228 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
230 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
232 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
233 use streams (within the
document/view framework, for example).
235 Use of this function requires the file wx
\_doc.h to be included.
237 \section{Network functions
}\label{networkfunctions
}
239 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
241 \func{wxString
}{wxGetFullHostName
}{\void}
243 Returns the FQDN (fully qualified domain host name) or an empty string on
246 See also:
\helpref{wxGetHostName
}{wxgethostname
}
248 \wxheading{Include files
}
252 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
254 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
256 Copies the user's email address into the supplied buffer, by
257 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
258 and
\helpref{wxGetUserId
}{wxgetuserid
}.
260 Returns TRUE if successful, FALSE otherwise.
262 \wxheading{Include files
}
266 \membersection{::wxGetHostName
}\label{wxgethostname
}
268 \func{wxString
}{wxGetHostName
}{\void}
269 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
271 Copies the current host machine's name into the supplied buffer. Please note
272 that the returned name is
{\it not
} fully qualified, i.e. it does not include
275 Under Windows or NT, this function first looks in the environment
276 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
277 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
279 The first variant of this function returns the hostname if successful or an
280 empty string otherwise. The second (deprecated) function returns TRUE
281 if successful, FALSE otherwise.
283 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
285 \wxheading{Include files
}
289 \section{User identification
}\label{useridfunctions
}
291 \membersection{::wxGetUserId
}\label{wxgetuserid
}
293 \func{wxString
}{wxGetUserId
}{\void}
294 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
296 This function returns the "user id" also known as "login name" under Unix i.e.
297 something like "jsmith". It uniquely identifies the current user (on this system).
299 Under Windows or NT, this function first looks in the environment
300 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
301 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
303 The first variant of this function returns the login name if successful or an
304 empty string otherwise. The second (deprecated) function returns TRUE
305 if successful, FALSE otherwise.
307 See also:
\helpref{wxGetUserName
}{wxgetusername
}
309 \wxheading{Include files
}
313 \membersection{::wxGetUserName
}\label{wxgetusername
}
315 \func{wxString
}{wxGetUserName
}{\void}
316 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
318 This function returns the full user name (something like "Mr. John Smith").
320 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
321 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
322 is running, the entry
{\bf Current
} in the section
{\bf User
} of
323 the PENWIN.INI file is used.
325 The first variant of this function returns the user name if successful or an
326 empty string otherwise. The second (deprecated) function returns TRUE
327 if successful, FALSE otherwise.
329 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
331 \wxheading{Include files
}
335 \section{String functions
}
337 \membersection{::copystring
}
339 \func{char*
}{copystring
}{\param{const char*
}{s
}}
341 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
342 deleted with the
{\it delete
} operator.
344 \membersection{::wxStringMatch
}
346 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
347 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
349 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
350 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
351 no substring matching is done.
353 \membersection{::wxStringEq
}\label{wxstringeq
}
355 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
360 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
363 \membersection{::IsEmpty
}\label{isempty
}
365 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
367 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
368 pointer to this function and it will return TRUE for it.
370 \membersection{::Stricmp
}\label{stricmp
}
372 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
374 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
375 to or greater than
{\it p2
}. The comparison is case-insensitive.
377 This function complements the standard C function
{\it strcmp()
} which performs
378 case-sensitive comparison.
380 \membersection{::Strlen
}\label{strlen
}
382 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
384 This is a safe version of standard function
{\it strlen()
}: it does exactly the
385 same thing (i.e. returns the length of the string) except that it returns
0 if
386 {\it p
} is the NULL pointer.
388 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
390 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
392 This function returns the translation of string
{\it str
} in the current
393 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
394 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
395 original string is returned. In debug build, an error message is logged - this
396 should help to find the strings which were not yet translated. As this function
397 is used very often, an alternative syntax is provided: the
\_() macro is
398 defined as wxGetTranslation().
400 \section{Dialog functions
}\label{dialogfunctions
}
402 Below are a number of convenience functions for getting input from the
403 user or displaying messages. Note that in these functions the last three
404 parameters are optional. However, it is recommended to pass a parent frame
405 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
406 the front when the dialog box is popped up.
408 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
410 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{
411 \param{const wxString\&
}{filename
},
412 \param{size
\_t }{currentTip
}}
414 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
415 used with
\helpref{wxShowTip
}{wxshowtip
}.
417 \docparam{filename
}{The name of the file containing the tips, one per line
}
418 \docparam{currentTip
}{The index of the first tip to show - normally this index
419 is remembered between the
2 program runs.
}
421 \wxheading{See also:
}
423 \helpref{Tips overview
}{tipsoverview
}
425 \wxheading{Include files
}
429 \membersection{::wxFileSelector
}\label{wxfileselector
}
431 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
432 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
433 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
434 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
436 Pops up a file selector box. In Windows, this is the common file selector
437 dialog. In X, this is a file selector box with somewhat less functionality.
438 The path and filename are distinct elements of a full file pathname.
439 If path is empty, the current directory will be used. If filename is empty,
440 no default filename will be supplied. The wildcard determines what files
441 are displayed in the file selector, and file extension supplies a type
442 extension for the required filename. Flags may be a combination of wxOPEN,
443 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
444 at present in Windows.
446 Both the X 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
449 displayed. In the X version, supplying no default name will result in the
450 wildcard filter being inserted in the filename text item; the filter is
451 ignored if a default name is supplied.
453 Under Windows (only), the wildcard may be a specification for multiple
454 types of file with a description for each, such as:
457 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
460 The application must check for an empty return value (the user pressed
461 Cancel). For example:
464 const wxString& s = wxFileSelector("Choose a file to open");
471 \wxheading{Include files}
475 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
477 \func{long}{wxGetNumberFromUser}{
478 \param{const wxString\& }{message},
479 \param{const wxString\& }{prompt},
480 \param{const wxString\& }{caption},
481 \param{long }{value},
482 \param{long }{min = 0},
483 \param{long }{max = 100},
484 \param{wxWindow *}{parent = NULL},
485 \param{const wxPoint\& }{pos = wxDefaultPosition}}
487 Shows a dialog asking the user for numeric input. The dialogs title is set to
488 {\it caption}, it contains a (possibly) multiline {\it message} above the
489 single line {\it prompt} and the zone for entering the number.
491 The number entered must be in the range {\it min}..{\it max} (both of which
492 should be positive) and {\it value} is the initial value of it. If the user
493 enters an invalid value or cancels the dialog, the function will return -1.
495 Dialog is centered on its {\it parent} unless an explicit position is given in
498 \wxheading{Include files}
502 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
504 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
505 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
506 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
508 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
509 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
510 or press Cancel to return the empty string.
512 If {\it centre} is TRUE, the message text (which may include new line characters)
513 is centred; if FALSE, the message is left-justified.
515 \wxheading{Include files}
519 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
521 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
522 \param{int }{nsel}, \param{int *}{selection},
523 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
524 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
526 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
527 listbox. The user may choose one or more item(s) and press OK or Cancel.
529 The number of initially selected choices, and array of the selected indices,
530 are passed in; this array will contain the user selections on exit, with
531 the function returning the number of selections. {\it selection} must be
532 as big as the number of choices, in case all are selected.
534 If Cancel is pressed, -1 is returned.
536 {\it choices} is an array of {\it n} strings for the listbox.
538 If {\it centre} is TRUE, the message text (which may include new line characters)
539 is centred; if FALSE, the message is left-justified.
541 \wxheading{Include files}
545 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
547 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
548 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
549 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
551 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
552 listbox. The user may choose an item and press OK to return a string or
553 Cancel to return the empty string.
555 {\it choices} is an array of {\it n} strings for the listbox.
557 If {\it centre} is TRUE, the message text (which may include new line characters)
558 is centred; if FALSE, the message is left-justified.
560 \wxheading{Include files}
564 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
566 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
567 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
568 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
570 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
571 If the user pressed cancel, -1 is returned.
573 \wxheading{Include files}
577 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
579 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
580 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
581 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
583 As {\bf wxGetSingleChoice} but takes an array of client data pointers
584 corresponding to the strings, and returns one of these pointers.
586 \wxheading{Include files}
590 \membersection{::wxMessageBox}\label{wxmessagebox}
592 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
593 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
595 General purpose message dialog. {\it style} may be a bit list of the
596 following identifiers:
598 \begin{twocollist}\itemsep=0pt
599 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
601 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
603 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
604 \twocolitem{wxCENTRE}{Centres the text.}
605 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
606 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
607 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
608 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
611 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
617 int answer = wxMessageBox("Quit program?", "Confirm",
618 wxYES_NO | wxCANCEL, main_frame);
624 {\it message} may contain newline characters, in which case the
625 message will be split into separate lines, to cater for large messages.
627 Under Windows, the native MessageBox function is used unless wxCENTRE
628 is specified in the style, in which case a generic function is used.
629 This is because the native MessageBox function cannot centre text.
630 The symbols are not shown when the generic function is used.
632 \wxheading{Include files}
636 \membersection{::wxShowTip}\label{wxshowtip}
638 \func{bool}{wxShowTip}{
639 \param{wxWindow *}{parent},
640 \param{wxTipProvider *}{tipProvider},
641 \param{bool }{showAtStartup = TRUE}}
643 This function shows a "startup tip" to the user.
645 \docparam{parent}{The parent window for the modal dialog}
647 \docparam{tipProvider}{An object which is used to get the text of the tips.
648 It may be created with
649 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
651 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
652 otherwise. This is used as the initial value for "Show tips at startup"
653 checkbox which is shown in the tips dialog.}
655 \wxheading{See also:}
657 \helpref{Tips overview}{tipsoverview}
659 \wxheading{Include files}
663 \section{GDI functions}\label{gdifunctions}
665 The following are relevant to the GDI (Graphics Device Interface).
667 \wxheading{Include files}
671 \membersection{::wxColourDisplay}
673 \func{bool}{wxColourDisplay}{\void}
675 Returns TRUE if the display is colour, FALSE otherwise.
677 \membersection{::wxDisplayDepth}
679 \func{int}{wxDisplayDepth}{\void}
681 Returns the depth of the display (a value of 1 denotes a monochrome display).
683 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
685 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
686 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
688 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
689 makes it into a placeable metafile by prepending a header containing the given
690 bounding box. The bounding box may be obtained from a device context after drawing
691 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
693 In addition to adding the placeable metafile header, this function adds
694 the equivalent of the following code to the start of the metafile data:
697 SetMapMode(dc, MM_ANISOTROPIC);
698 SetWindowOrg(dc, minX, minY);
699 SetWindowExt(dc, maxX - minX, maxY - minY);
702 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
704 Placeable metafiles may be imported by many Windows applications, and can be
705 used in RTF (Rich Text Format) files.
707 {\it scale} allows the specification of scale for the metafile.
709 This function is only available under Windows.
711 \membersection{::wxSetCursor}\label{wxsetcursor}
713 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
715 Globally sets the cursor; only has an effect in Windows and GTK.
716 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
718 \section{Printer settings}\label{printersettings}
720 These routines are obsolete and should no longer be used!
722 The following functions are used to control PostScript printing. Under
723 Windows, PostScript output can only be sent to a file.
725 \wxheading{Include files}
729 \membersection{::wxGetPrinterCommand}
731 \func{wxString}{wxGetPrinterCommand}{\void}
733 Gets the printer command used to print a file. The default is {\tt lpr}.
735 \membersection{::wxGetPrinterFile}
737 \func{wxString}{wxGetPrinterFile}{\void}
739 Gets the PostScript output filename.
741 \membersection{::wxGetPrinterMode}
743 \func{int}{wxGetPrinterMode}{\void}
745 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
746 The default is PS\_PREVIEW.
748 \membersection{::wxGetPrinterOptions}
750 \func{wxString}{wxGetPrinterOptions}{\void}
752 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
754 \membersection{::wxGetPrinterOrientation}
756 \func{int}{wxGetPrinterOrientation}{\void}
758 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
760 \membersection{::wxGetPrinterPreviewCommand}
762 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
764 Gets the command used to view a PostScript file. The default depends on the platform.
766 \membersection{::wxGetPrinterScaling}
768 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
770 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
772 \membersection{::wxGetPrinterTranslation}
774 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
776 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
778 \membersection{::wxSetPrinterCommand}
780 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
782 Sets the printer command used to print a file. The default is {\tt lpr}.
784 \membersection{::wxSetPrinterFile}
786 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
788 Sets the PostScript output filename.
790 \membersection{::wxSetPrinterMode}
792 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
794 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
795 The default is PS\_PREVIEW.
797 \membersection{::wxSetPrinterOptions}
799 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
801 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
803 \membersection{::wxSetPrinterOrientation}
805 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
807 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
809 \membersection{::wxSetPrinterPreviewCommand}
811 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
813 Sets the command used to view a PostScript file. The default depends on the platform.
815 \membersection{::wxSetPrinterScaling}
817 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
819 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
821 \membersection{::wxSetPrinterTranslation}
823 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
825 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
827 \section{Clipboard functions}\label{clipsboard}
829 These clipboard functions are implemented for Windows only.
831 \wxheading{Include files}
835 \membersection{::wxClipboardOpen}
837 \func{bool}{wxClipboardOpen}{\void}
839 Returns TRUE if this application has already opened the clipboard.
841 \membersection{::wxCloseClipboard}
843 \func{bool}{wxCloseClipboard}{\void}
845 Closes the clipboard to allow other applications to use it.
847 \membersection{::wxEmptyClipboard}
849 \func{bool}{wxEmptyClipboard}{\void}
851 Empties the clipboard.
853 \membersection{::wxEnumClipboardFormats}
855 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
857 Enumerates the formats found in a list of available formats that belong
858 to the clipboard. Each call to this function specifies a known
859 available format; the function returns the format that appears next in
862 {\it dataFormat} specifies a known format. If this parameter is zero,
863 the function returns the first format in the list.
865 The return value specifies the next known clipboard data format if the
866 function is successful. It is zero if the {\it dataFormat} parameter specifies
867 the last format in the list of available formats, or if the clipboard
870 Before it enumerates the formats function, an application must open the clipboard by using the
871 wxOpenClipboard function.
873 \membersection{::wxGetClipboardData}
875 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
877 Gets data from the clipboard.
879 {\it dataFormat} may be one of:
881 \begin{itemize}\itemsep=0pt
882 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
883 \item wxCF\_BITMAP: returns a new wxBitmap.
886 The clipboard must have previously been opened for this call to succeed.
888 \membersection{::wxGetClipboardFormatName}
890 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
892 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
893 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
895 \membersection{::wxIsClipboardFormatAvailable}
897 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
899 Returns TRUE if the given data format is available on the clipboard.
901 \membersection{::wxOpenClipboard}
903 \func{bool}{wxOpenClipboard}{\void}
905 Opens the clipboard for passing data to it or getting data from it.
907 \membersection{::wxRegisterClipboardFormat}
909 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
911 Registers the clipboard data format name and returns an identifier.
913 \membersection{::wxSetClipboardData}
915 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
917 Passes data to the clipboard.
919 {\it dataFormat} may be one of:
921 \begin{itemize}\itemsep=0pt
922 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
923 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
924 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
925 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
928 The clipboard must have previously been opened for this call to succeed.
930 \section{Miscellaneous functions}\label{miscellany}
932 \membersection{::wxNewId}
934 \func{long}{wxNewId}{\void}
936 Generates an integer identifier unique to this run of the program.
938 \wxheading{Include files}
942 \membersection{::wxRegisterId}
944 \func{void}{wxRegisterId}{\param{long}{ id}}
946 Ensures that ids subsequently generated by {\bf NewId} do not clash with
949 \wxheading{Include files}
953 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
955 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
957 Changes the cursor to the given cursor for all windows in the application.
958 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
959 to its previous state. These two calls can be nested, and a counter
960 ensures that only the outer calls take effect.
962 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
964 \wxheading{Include files}
968 \membersection{::wxBell}
970 \func{void}{wxBell}{\void}
972 Ring the system bell.
974 \wxheading{Include files}
978 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
980 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
982 Creates and returns an object of the given class, if the class has been
983 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
985 \membersection{::wxDDECleanUp}\label{wxddecleanup}
987 \func{void}{wxDDECleanUp}{\void}
989 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
990 called by the application.
992 See also helpref{wxDDEInitialize}{wxddeinitialize}.
994 \wxheading{Include files}
998 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1000 \func{void}{wxDDEInitialize}{\void}
1002 Initializes the DDE system. May be called multiple times without harm.
1004 This no longer needs to be called by the application: it will be called
1005 by wxWindows if necessary.
1007 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1008 \helpref{wxDDECleanUp}{wxddecleanup}.
1010 \wxheading{Include files}
1014 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1016 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1018 Display a debugging message; under Windows, this will appear on the
1019 debugger command window, and under Unix, it will be written to standard
1022 The syntax is identical to {\bf printf}: pass a format string and a
1023 variable list of arguments.
1025 Note that under Windows, you can see the debugging messages without a
1026 debugger if you have the DBWIN debug log application that comes with
1029 {\bf Tip:} under Windows, if your application crashes before the
1030 message appears in the debugging window, put a wxYield call after
1031 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1032 (at least for Watcom C++): preformat your messages and use OutputDebugString
1035 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1037 \wxheading{Include files}
1041 \membersection{::wxDisplaySize}
1043 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1045 Gets the physical size of the display in pixels.
1047 \wxheading{Include files}
1051 \membersection{::wxEntry}\label{wxentry}
1053 This initializes wxWindows in a platform-dependent way. Use this if you
1054 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1055 you can initialize wxWindows from an Microsoft Foundation Classes application using
1058 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1059 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1061 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1062 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1063 message loop will be entered.
1065 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1066 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1068 wxWindows initialization under Windows (for applications constructed as a DLL).
1070 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1072 wxWindows initialization under Unix.
1076 To clean up wxWindows, call wxApp::OnExit followed by the static function
1077 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1080 int CTheApp::ExitInstance()
1082 // OnExit isn't called by CleanUp so must be called explicitly.
1086 return CWinApp::ExitInstance();
1090 \wxheading{Include files}
1094 \membersection{::wxError}\label{wxerror}
1096 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1098 Displays {\it msg} and continues. This writes to standard error under
1099 Unix, and pops up a message box under Windows. Used for internal
1100 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1102 \wxheading{Include files}
1106 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1108 \func{void}{wxEndBusyCursor}{\void}
1110 Changes the cursor back to the original cursor, for all windows in the application.
1111 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1113 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1115 \wxheading{Include files}
1119 \membersection{::wxExecute}\label{wxexecute}
1121 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1123 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1125 Executes another program in Unix or Windows.
1127 The first form takes a command string, such as {\tt "emacs file.txt"}.
1129 The second form takes an array of values: a command, any number of
1130 arguments, terminated by NULL.
1132 If {\it sync} is FALSE (the default), flow of control immediately returns.
1133 If TRUE, the current application waits until the other program has terminated.
1135 In the case of synchronous execution, the return value is the exit code of
1136 the process (which terminates by the moment the function returns) and will be
1137 $-1$ if the process couldn't be started and typically 0 if the process
1138 terminated successfully. Also, while waiting for the process to
1139 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1140 should ensure that this can cause no recursion, in the simples case by
1141 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1143 For asynchronous execution, however, the return value is the process id and
1144 zero value indicates that the command could not be executed.
1146 If callback isn't NULL and if execution is asynchronous (note that callback
1147 parameter can not be non NULL for synchronous execution),
1148 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1149 the process finishes.
1151 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1153 \wxheading{Include files}
1157 \membersection{::wxExit}\label{wxexit}
1159 \func{void}{wxExit}{\void}
1161 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1162 Should only be used in an emergency: normally the top-level frame
1163 should be deleted (after deleting all other frames) to terminate the
1164 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1166 \wxheading{Include files}
1170 \membersection{::wxFatalError}\label{wxfatalerror}
1172 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1174 Displays {\it msg} and exits. This writes to standard error under Unix,
1175 and pops up a message box under Windows. Used for fatal internal
1176 wxWindows errors. See also \helpref{wxError}{wxerror}.
1178 \wxheading{Include files}
1182 \membersection{::wxFindMenuItemId}
1184 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1186 Find a menu item identifier associated with the given frame's menu bar.
1188 \wxheading{Include files}
1192 \membersection{::wxFindWindowByLabel}
1194 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1196 Find a window by its label. Depending on the type of window, the label may be a window title
1197 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1198 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1199 The search is recursive in both cases.
1201 \wxheading{Include files}
1205 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1207 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1209 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1210 If {\it parent} is NULL, the search will start from all top-level
1211 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1212 The search is recursive in both cases.
1214 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1216 \wxheading{Include files}
1220 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1222 \func{wxWindow *}{wxGetActiveWindow}{\void}
1224 Gets the currently active window (Windows only).
1226 \wxheading{Include files}
1230 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1232 \func{wxString}{wxGetDisplayName}{\void}
1234 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1236 \wxheading{Include files}
1240 \membersection{::wxGetHomeDir}
1242 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1244 Fills the buffer with a string representing the user's home directory (Unix only).
1246 \wxheading{Include files}
1250 \membersection{::wxGetHostName}
1252 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1254 Copies the host name of the machine the program is running on into the
1255 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1256 successful. Under Unix, this will return a machine name. Under Windows,
1257 this returns ``windows''.
1259 \wxheading{Include files}
1263 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1265 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1267 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1269 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1272 See also \helpref{wxTimer}{wxtimer}.
1274 \wxheading{Include files}
1278 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1280 \func{long}{wxGetFreeMemory}{\void}
1282 Returns the amount of free memory in Kbytes under environments which
1283 support it, and -1 if not supported. Currently, returns a positive value
1284 under Windows, and -1 under Unix.
1286 \wxheading{Include files}
1290 \membersection{::wxGetMousePosition}
1292 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1294 Returns the mouse position in screen coordinates.
1296 \wxheading{Include files}
1300 \membersection{::wxGetOsVersion}
1302 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1304 Gets operating system version information.
1306 \begin{twocollist}\itemsep=0pt
1307 \twocolitemruled{Platform}{Return tyes}
1308 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1309 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1310 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1311 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1312 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1313 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1314 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1315 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1316 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1319 \wxheading{Include files}
1323 \membersection{::wxGetResource}\label{wxgetresource}
1325 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1326 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1328 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1329 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1331 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1332 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1334 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1335 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1337 Gets a resource value from the resource database (for example, WIN.INI, or
1338 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1339 otherwise the specified file is used.
1341 Under X, if an application class (wxApp::GetClassName) has been defined,
1342 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1343 an applications default file when merging all resource databases.
1345 The reason for passing the result in an argument is that it
1346 can be convenient to define a default value, which gets overridden
1347 if the value exists in the resource file. It saves a separate
1348 test for that resource's existence, and it also allows
1349 the overloading of the function for different types.
1351 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1353 \wxheading{Include files}
1357 \membersection{::wxGetUserId}
1359 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1361 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1362 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1363 Under Windows, this returns ``user''.
1365 \wxheading{Include files}
1369 \membersection{::wxGetUserName}
1371 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1373 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1374 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1375 Under Windows, this returns ``unknown''.
1377 \wxheading{Include files}
1381 \membersection{::wxKill}\label{wxkill}
1383 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1385 Under Unix (the only supported platform), equivalent to the Unix kill function.
1386 Returns 0 on success, -1 on failure.
1388 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1389 It does not raise a signal in the receiving process.
1391 \wxheading{Include files}
1395 \membersection{::wxIsBusy}\label{wxisbusy}
1397 \func{bool}{wxIsBusy}{\void}
1399 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1400 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1402 See also \helpref{wxBusyCursor}{wxbusycursor}.
1404 \wxheading{Include files}
1408 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1410 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1412 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1413 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1415 The resource must be defined in the {\tt .rc} file using the following syntax:
1418 myResource TEXT file.ext
1421 where {\tt file.ext} is a file that the resource compiler can find.
1423 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1424 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1425 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1427 This function is available under Windows only.
1429 \wxheading{Include files}
1433 \membersection{::wxNow}\label{wxnow}
1435 \func{wxString}{wxNow}{\void}
1437 Returns a string representing the current date and time.
1439 \wxheading{Include files}
1443 \membersection{::wxPostDelete}\label{wxpostdelete}
1445 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1447 Tells the system to delete the specified object when
1448 all other events have been processed. In some environments, it is
1449 necessary to use this instead of deleting a frame directly with the
1450 delete operator, because some GUIs will still send events to a deleted window.
1452 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1454 \wxheading{Include files}
1458 \membersection{::wxSafeYield}\label{wxsafeyield}
1460 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1462 This function is similar to wxYield, except that it disables the user input to
1463 all program windows before calling wxYield and re-enables it again
1464 afterwards. If {\it win} is not NULL, this window will remain enabled,
1465 allowing the implementation of some limited user interaction.
1467 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1469 \wxheading{Include files}
1473 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1475 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1477 This function enables or disables all top level windows. It is used by
1478 \helpref{::wxSafeYield}{wxsafeyield}.
1480 \wxheading{Include files}
1485 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1487 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1489 Under X only, sets the current display name. This is the X host and display name such
1490 as ``colonsay:0.0", and the function indicates which display should be used for creating
1491 windows from this point on. Setting the display within an application allows multiple
1492 displays to be used.
1494 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1496 \wxheading{Include files}
1500 \membersection{::wxShell}\label{wxshell}
1502 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1504 Executes a command in an interactive shell window. If no command is
1505 specified, then just the shell is spawned.
1507 See also \helpref{wxExecute}{wxexecute}.
1509 \wxheading{Include files}
1513 \membersection{::wxSleep}\label{wxsleep}
1515 \func{void}{wxSleep}{\param{int}{ secs}}
1517 Sleeps for the specified number of seconds.
1519 \wxheading{Include files}
1523 \membersection{::wxStripMenuCodes}
1525 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1527 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1529 Strips any menu codes from {\it in} and places the result
1530 in {\it out} (or returns the new string, in the first form).
1532 Menu codes include \& (mark the next character with an underline
1533 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1535 \wxheading{Include files}
1539 \membersection{::wxStartTimer}\label{wxstarttimer}
1541 \func{void}{wxStartTimer}{\void}
1543 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1545 See also \helpref{wxTimer}{wxtimer}.
1547 \wxheading{Include files}
1551 \membersection{::wxToLower}\label{wxtolower}
1553 \func{char}{wxToLower}{\param{char }{ch}}
1555 Converts the character to lower case. This is implemented as a macro for efficiency.
1557 \wxheading{Include files}
1561 \membersection{::wxToUpper}\label{wxtoupper}
1563 \func{char}{wxToUpper}{\param{char }{ch}}
1565 Converts the character to upper case. This is implemented as a macro for efficiency.
1567 \wxheading{Include files}
1571 \membersection{::wxTrace}\label{wxtrace}
1573 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1575 Takes printf-style variable argument syntax. Output
1576 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1578 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1580 \wxheading{Include files}
1584 \membersection{::wxTraceLevel}\label{wxtracelevel}
1586 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1588 Takes printf-style variable argument syntax. Output
1589 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1590 The first argument should be the level at which this information is appropriate.
1591 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1594 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1596 \wxheading{Include files}
1600 \membersection{::wxUsleep}\label{wxusleep}
1602 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1604 Sleeps for the specified number of milliseconds. Notice that usage of this
1605 function is encouraged instead of calling usleep(3) directly because the
1606 standard usleep() function is not MT safe.
1608 \wxheading{Include files}
1612 \membersection{::wxWriteResource}\label{wxwriteresource}
1614 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1615 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1617 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1618 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1620 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1621 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1623 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1624 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1626 Writes a resource value into the resource database (for example, WIN.INI, or
1627 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1628 otherwise the specified file is used.
1630 Under X, the resource databases are cached until the internal function
1631 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1632 all updated resource databases are written to their files.
1634 Note that it is considered bad manners to write to the .Xdefaults
1635 file under Unix, although the WIN.INI file is fair game under Windows.
1637 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1639 \wxheading{Include files}
1643 \membersection{::wxYield}\label{wxyield}
1645 \func{bool}{wxYield}{\void}
1647 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1648 time-consuming process writes to a text window. Without an occasional
1649 yield, the text window will not be updated properly, and (since Windows
1650 multitasking is cooperative) other processes will not respond.
1652 Caution should be exercised, however, since yielding may allow the
1653 user to perform actions which are not compatible with the current task.
1654 Disabling menu items or whole menus during processing can avoid unwanted
1655 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1658 \wxheading{Include files}
1662 \section{Macros}\label{macros}
1664 These macros are defined in wxWindows.
1666 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1668 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1670 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1672 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1674 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1676 This macro will swap the bytes of the {\it value} variable from little
1677 endian to big endian or vice versa.
1679 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1681 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1683 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1685 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1687 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1689 This macro will swap the bytes of the {\it value} variable from little
1690 endian to big endian or vice versa if the program is compiled on a
1691 big-endian architecture (such as Sun work stations). If the program has
1692 been compiled on a little-endian architecture, the value will be unchanged.
1694 Use these macros to read data from and write data to a file that stores
1695 data in little endian (Intel i386) format.
1697 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1699 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1701 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1703 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1705 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1707 This macro will swap the bytes of the {\it value} variable from little
1708 endian to big endian or vice versa if the program is compiled on a
1709 little-endian architecture (such as Intel PCs). If the program has
1710 been compiled on a big-endian architecture, the value will be unchanged.
1712 Use these macros to read data from and write data to a file that stores
1713 data in big endian format.
1715 \membersection{CLASSINFO}\label{classinfo}
1717 \func{wxClassInfo *}{CLASSINFO}{className}
1719 Returns a pointer to the wxClassInfo object associated with this class.
1721 \wxheading{Include files}
1725 \membersection{DECLARE\_ABSTRACT\_CLASS}
1727 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1729 Used inside a class declaration to declare that the class should be
1730 made known to the class hierarchy, but objects of this class cannot be created
1731 dynamically. The same as DECLARE\_CLASS.
1736 class wxCommand: public wxObject
1738 DECLARE_ABSTRACT_CLASS(wxCommand)
1747 \wxheading{Include files}
1751 \membersection{DECLARE\_APP}\label{declareapp}
1753 \func{}{DECLARE\_APP}{className}
1755 This is used in headers to create a forward declaration of the wxGetApp function implemented
1756 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1764 \wxheading{Include files}
1768 \membersection{DECLARE\_CLASS}
1770 \func{}{DECLARE\_CLASS}{className}
1772 Used inside a class declaration to declare that the class should be
1773 made known to the class hierarchy, but objects of this class cannot be created
1774 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1776 \wxheading{Include files}
1780 \membersection{DECLARE\_DYNAMIC\_CLASS}
1782 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1784 Used inside a class declaration to declare that the objects of this class should be dynamically
1785 createable from run-time type information.
1790 class wxFrame: public wxWindow
1792 DECLARE_DYNAMIC_CLASS(wxFrame)
1795 const wxString\& frameTitle;
1801 \wxheading{Include files}
1805 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1807 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1809 Used in a C++ implementation file to complete the declaration of
1810 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1815 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1817 wxCommand::wxCommand(void)
1823 \wxheading{Include files}
1827 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1829 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1831 Used in a C++ implementation file to complete the declaration of
1832 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1834 \wxheading{Include files}
1838 \membersection{IMPLEMENT\_APP}\label{implementapp}
1840 \func{}{IMPLEMENT\_APP}{className}
1842 This is used in the application class implementation file to make the application class known to
1843 wxWindows for dynamic construction. You use this instead of
1854 IMPLEMENT_APP(MyApp)
1857 See also \helpref{DECLARE\_APP}{declareapp}.
1859 \wxheading{Include files}
1863 \membersection{IMPLEMENT\_CLASS}
1865 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1867 Used in a C++ implementation file to complete the declaration of
1868 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1870 \wxheading{Include files}
1874 \membersection{IMPLEMENT\_CLASS2}
1876 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1878 Used in a C++ implementation file to complete the declaration of a
1879 class that has run-time type information and two base classes. The
1880 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1882 \wxheading{Include files}
1886 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1888 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1890 Used in a C++ implementation file to complete the declaration of
1891 a class that has run-time type information, and whose instances
1892 can be created dynamically.
1897 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1899 wxFrame::wxFrame(void)
1905 \wxheading{Include files}
1909 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1911 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1913 Used in a C++ implementation file to complete the declaration of
1914 a class that has run-time type information, and whose instances
1915 can be created dynamically. Use this for classes derived from two
1918 \wxheading{Include files}
1922 \membersection{WXDEBUG\_NEW}\label{debugnew}
1924 \func{}{WXDEBUG\_NEW}{arg}
1926 This is defined in debug mode to be call the redefined new operator
1927 with filename and line number arguments. The definition is:
1930 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1933 In non-debug mode, this is defined as the normal new operator.
1935 \wxheading{Include files}
1939 \membersection{wxDynamicCast}\label{wxdynamiccast}
1941 \func{}{wxDynamicCast}{ptr, classname}
1943 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1944 the pointer is of this type (the check is done during the run-time) or NULL
1945 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1948 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1953 wxWindow *win = wxWindow::FindFocus();
1954 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1957 // a text control has the focus...
1961 // no window has the focus or it's not a text control
1965 \wxheading{See also}
1967 \helpref{RTTI overview}{runtimeclassoverview}
1969 \membersection{WXTRACE}\label{trace}
1971 \wxheading{Include files}
1975 \func{}{WXTRACE}{formatString, ...}
1977 Calls wxTrace with printf-style variable argument syntax. Output
1978 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1980 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1982 \wxheading{Include files}
1986 \membersection{WXTRACELEVEL}\label{tracelevel}
1988 \func{}{WXTRACELEVEL}{level, formatString, ...}
1990 Calls wxTraceLevel with printf-style variable argument syntax. Output
1991 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1992 The first argument should be the level at which this information is appropriate.
1993 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1996 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1998 \wxheading{Include files}
2002 \section{wxWindows resource functions}\label{resourcefuncs}
2004 \overview{wxWindows resource system}{resourceformats}
2006 This section details functions for manipulating wxWindows (.WXR) resource
2007 files and loading user interface elements from resources.
2009 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2010 about initialisation file resource reading and writing, using such functions
2011 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2013 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2015 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2016 loading from resource data.
2018 {\bf Warning:} this needs updating for wxWindows 2.
2020 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2022 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2024 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2025 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2026 perhaps for implementing resource functionality for interpreted languages.
2028 \membersection{::wxResourceClear}
2030 \func{void}{wxResourceClear}{\void}
2032 Clears the wxWindows resource table.
2034 \membersection{::wxResourceCreateBitmap}
2036 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2038 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2039 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2043 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2044 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2045 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2048 then this function can be called as follows:
2051 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2054 \membersection{::wxResourceCreateIcon}
2056 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2058 Creates a new icon from a file, static data, or Windows resource, given a valid
2059 wxWindows icon resource identifier. For example, if the .WXR file contains
2063 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2064 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2065 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2068 then this function can be called as follows:
2071 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2074 \membersection{::wxResourceCreateMenuBar}
2076 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2078 Creates a new menu bar given a valid wxWindows menubar resource
2079 identifier. For example, if the .WXR file contains the following:
2082 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2086 ['&Open File', 2, 'Open a file'],\
2087 ['&Save File', 3, 'Save a file'],\
2089 ['E&xit', 4, 'Exit program']\
2092 ['&About', 6, 'About this program']\
2097 then this function can be called as follows:
2100 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2104 \membersection{::wxResourceGetIdentifier}
2106 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2108 Used for retrieving the integer value associated with an identifier.
2109 A zero value indicates that the identifier was not found.
2111 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2113 \membersection{::wxResourceParseData}\label{wxresourcedata}
2115 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2117 Parses a string containing one or more wxWindows resource objects. If
2118 the resource objects are global static data that are included into the
2119 C++ program, then this function must be called for each variable
2120 containing the resource data, to make it known to wxWindows.
2122 {\it resource} should contain data in the following form:
2125 dialog(name = 'dialog1',
2126 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2127 title = 'Test dialog box',
2128 x = 312, y = 234, width = 400, height = 300,
2130 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2131 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2132 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2133 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2134 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2135 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2138 This function will typically be used after including a {\tt .wxr} file into
2139 a C++ program as follows:
2142 #include "dialog1.wxr"
2145 Each of the contained resources will declare a new C++ variable, and each
2146 of these variables should be passed to wxResourceParseData.
2148 \membersection{::wxResourceParseFile}
2150 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2152 Parses a file containing one or more wxWindows resource objects
2153 in C++-compatible syntax. Use this function to dynamically load
2154 wxWindows resource data.
2156 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2158 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2160 Parses a string containing one or more wxWindows resource objects. If
2161 the resource objects are global static data that are included into the
2162 C++ program, then this function must be called for each variable
2163 containing the resource data, to make it known to wxWindows.
2165 {\it resource} should contain data with the following form:
2168 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2169 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2170 title = 'Test dialog box',\
2171 x = 312, y = 234, width = 400, height = 300,\
2173 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2174 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2175 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2176 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2177 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2178 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2181 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2182 load an entire {\tt .wxr file} into a string.
2184 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2186 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2187 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2189 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2191 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2192 This is required if other resources will use the bitmap data, since otherwise there
2193 is no connection between names used in resources, and the global bitmap data.
2195 \membersection{::wxResourceRegisterIconData}
2197 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2199 \section{Log functions}\label{logfunctions}
2201 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2202 further information.
2204 \wxheading{Include files}
2208 \membersection{::wxLogError}\label{wxlogerror}
2210 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2212 The function to use for error messages, i.e. the
2213 messages that must be shown to the user. The default processing is to pop up a
2214 message box to inform the user about it.
2216 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2218 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2220 Like \helpref{wxLogError}{wxlogerror}, but also
2221 terminates the program with the exit code 3. Using {\it abort()} standard
2222 function also terminates the program with this exit code.
2224 \membersection{::wxLogWarning}\label{wxlogwarning}
2226 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2228 For warnings - they are also normally shown to the
2229 user, but don't interrupt the program work.
2231 \membersection{::wxLogMessage}\label{wxlogmessage}
2233 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2235 for all normal, informational messages. They also
2236 appear in a message box by default (but it can be changed). Notice
2237 that the standard behaviour is to not show informational messages if there are
2238 any errors later - the logic being that the later error messages make the
2239 informational messages preceding them meaningless.
2241 \membersection{::wxLogVerbose}\label{wxlogverbose}
2243 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2245 For verbose output. Normally, it's suppressed, but
2246 might be activated if the user wishes to know more details about the program
2247 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2249 \membersection{::wxLogStatus}\label{wxlogstatus}
2251 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2253 For status messages - they will go into the status
2254 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2256 \membersection{::wxLogSysError}\label{wxlogsyserror}
2258 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2260 Mostly used by wxWindows itself, but might be
2261 handy for logging errors after system call (API function) failure. It logs the
2262 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2263 on the platform) and the corresponding error
2264 message. The second form of this function takes the error code explitly as the
2267 \membersection{::wxLogDebug}\label{wxlogdebug}
2269 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2271 The right function for debug output. It only
2272 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2273 and expands to nothing in release mode (otherwise).
2275 \membersection{::wxLogTrace}\label{wxlogtrace}
2277 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2279 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2281 As {\bf wxLogDebug}, only does something in debug
2282 build. The reason for making it a separate function from it is that usually
2283 there are a lot of trace messages, so it might make sense to separate them
2284 from other debug messages which would be flooded in them. Moreover, the second
2285 version of this function takes a trace mask as the first argument which allows
2286 to further restrict the amount of messages generated. The value of {\it mask} can be:
2288 \begin{itemize}\itemsep=0pt
2289 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2290 \item wxTraceMessages: trace window messages/X callbacks
2291 \item wxTraceResAlloc: trace GDI resource allocation
2292 \item wxTraceRefCount: trace various ref counting operations
2295 \section{Debugging macros and functions}\label{debugmacros}
2297 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2298 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2301 \wxheading{Include files}
2305 \membersection{::wxOnAssert}\label{wxonassert}
2307 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2309 This function may be redefined to do something non trivial and is called
2310 whenever one of debugging macros fails (i.e. condition is false in an
2312 % TODO: this should probably be an overridable in wxApp.
2314 \membersection{wxASSERT}\label{wxassert}
2316 \func{}{wxASSERT}{\param{}{condition}}
2318 Assert macro. An error message will be generated if the condition is FALSE in
2319 debug mode, but nothing will be done in the release build.
2321 Please note that the condition in wxASSERT() should have no side effects
2322 because it will not be executed in release mode at all.
2324 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2326 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2328 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2330 Assert macro with message. An error message will be generated if the condition is FALSE.
2332 See also: \helpref{wxASSERT}{wxassert}
2334 \membersection{wxFAIL}\label{wxfail}
2336 \func{}{wxFAIL}{\void}
2338 Will always generate an assert error if this code is reached (in debug mode).
2340 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2342 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2344 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2346 Will always generate an assert error with specified message if this code is reached (in debug mode).
2348 This macro is useful for marking unreachable" code areas, for example
2349 it may be used in the "default:" branch of a switch statement if all possible
2350 cases are processed above.
2352 See also: \helpref{wxFAIL}{wxfail}
2354 \membersection{wxCHECK}\label{wxcheck}
2356 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2358 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2359 This check is done even in release mode.
2361 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2363 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2365 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2366 This check is done even in release mode.
2368 This macro may be only used in non void functions, see also
2369 \helpref{wxCHECK\_RET}{wxcheckret}.
2371 \membersection{wxCHECK\_RET}\label{wxcheckret}
2373 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2375 Checks that the condition is true, and returns if not (FAILs with given error
2376 message in debug mode). This check is done even in release mode.
2378 This macro should be used in void functions instead of
2379 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2381 \membersection{wxCHECK2}\label{wxcheck2}
2383 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2385 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2386 {\it operation} if it is not. This is a generalisation of
2387 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2388 returning from the function must be done when the {\it condition} is false.
2390 This check is done even in release mode.
2392 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2394 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2396 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2397 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2398 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob