1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions defined in wxWindows are described here.
7 \section{File functions
}\label{filefunctions
}
9 \wxheading{Include files
}
15 \helpref{wxPathList
}{wxpathlist
}
17 \membersection{::wxDirExists
}
19 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
21 Returns TRUE if the directory exists.
23 \membersection{::wxDos2UnixFilename
}
25 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
27 Converts a DOS to a Unix filename by replacing backslashes with forward
30 \membersection{::wxFileExists
}
32 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
34 Returns TRUE if the file exists. It also returns TRUE if the file is
37 \membersection{::wxFileNameFromPath
}
39 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
41 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
43 Returns the filename for a full path. The second form returns a pointer to
44 temporary storage that should not be deallocated.
46 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
48 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
50 This function does directory searching; returns the first file
51 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
52 get the next matching file. Neither will
report the current directory "." or the
53 parent directory "..".
55 {\it spec
} may contain wildcards.
57 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
62 wxString f = wxFindFirstFile("/home/project/*.*");
63 while ( !f.IsEmpty() )
70 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
72 \func{wxString
}{wxFindNextFile
}{\void}
74 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
76 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
78 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
80 \func{wxString
}{wxGetOSDirectory
}{\void}
82 Returns the Windows directory under Windows; on other platforms returns the empty string.
84 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
86 \func{void
}{wxInitAllImageHandlers
}{\void}
88 Adds some common image format handlers, which, depending on wxWindows
89 configuration, can be handlers for BMP (loading) (always installed), GIF
90 (loading and saving), PCX (loading and saving), PNM (loading and saving as raw
91 rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
93 See also:
\helpref{wxImage
}{wximage
} \helpref{wxImageHandler
}{wximagehandler
}
95 \membersection{::wxIsAbsolutePath
}
97 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
99 Returns TRUE if the argument is an absolute filename, i.e. with a slash
100 or drive name at the beginning.
102 \membersection{::wxPathOnly
}
104 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
106 Returns the directory part of the filename.
108 \membersection{::wxUnix2DosFilename
}
110 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
112 Converts a Unix to a DOS filename by replacing forward
113 slashes with backslashes.
115 \membersection{::wxConcatFiles
}
117 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
118 \param{const wxString\&
}{file3
}}
120 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
123 \membersection{::wxCopyFile
}
125 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
127 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
129 \membersection{::wxGetCwd
}\label{wxgetcwd
}
131 \func{wxString
}{wxGetCwd
}{\void}
133 Returns a string containing the current (or working) directory.
135 \membersection{::wxGetWorkingDirectory
}
137 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
139 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
141 Copies the current working directory into the buffer if supplied, or
142 copies the working directory into new storage (which you must delete yourself)
143 if the buffer is NULL.
145 {\it sz
} is the size of the buffer if supplied.
147 \membersection{::wxGetTempFileName
}
149 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
151 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
152 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
153 is allocated for the temporary filename using
{\it new
}.
155 Under Windows, the filename will include the drive and name of the
156 directory allocated for temporary files (usually the contents of the
157 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
159 It is the application's responsibility to create and delete the file.
161 \membersection{::wxIsWild
}\label{wxiswild
}
163 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
165 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
167 \membersection{::wxMatchWild
}\label{wxmatchwild
}
169 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
171 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
172 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
173 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
175 \membersection{::wxMkdir
}
177 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
179 Makes the directory
{\it dir
}, returning TRUE if successful.
181 {\it perm
} is the access mask for the directory for the systems on which it is
182 supported (Unix) and doesn't have effect for the other ones.
184 \membersection{::wxRemoveFile
}
186 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
188 Removes
{\it file
}, returning TRUE if successful.
190 \membersection{::wxRenameFile
}
192 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
194 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
196 \membersection{::wxRmdir
}
198 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
200 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
202 The
{\it flags
} parameter is reserved for future use.
204 \membersection{::wxSetWorkingDirectory
}
206 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
208 Sets the current working directory, returning TRUE if the operation succeeded.
209 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
211 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
213 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
215 This function splits a full file name into components: the path (including possible disk/drive
216 specification under Windows), the base name and the extension. Any of the output parameters
217 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
218 a particular component.
220 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
221 Windows, however it will not consider backslashes as path separators under Unix (where backslash
222 is a valid character in a filename).
224 On entry,
{\it fullname
} should be non NULL (it may be empty though).
226 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
227 contains the file name and
{\it ext
} contains the file extension without leading dot. All
228 three of them may be empty if the corresponding component is. The old contents of the
229 strings pointed to by these parameters will be overwritten in any case (if the pointers
232 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
234 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
236 Copies the given file to
{\it stream
}. Useful when converting an old application to
237 use streams (within the
document/view framework, for example).
239 Use of this function requires the file wx
\_doc.h to be included.
241 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
243 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
245 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
246 use streams (within the
document/view framework, for example).
248 Use of this function requires the file wx
\_doc.h to be included.
250 \section{Network functions
}\label{networkfunctions
}
252 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
254 \func{wxString
}{wxGetFullHostName
}{\void}
256 Returns the FQDN (fully qualified domain host name) or an empty string on
259 See also:
\helpref{wxGetHostName
}{wxgethostname
}
261 \wxheading{Include files
}
265 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
267 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
269 Copies the user's email address into the supplied buffer, by
270 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
271 and
\helpref{wxGetUserId
}{wxgetuserid
}.
273 Returns TRUE if successful, FALSE otherwise.
275 \wxheading{Include files
}
279 \membersection{::wxGetHostName
}\label{wxgethostname
}
281 \func{wxString
}{wxGetHostName
}{\void}
282 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
284 Copies the current host machine's name into the supplied buffer. Please note
285 that the returned name is
{\it not
} fully qualified, i.e. it does not include
288 Under Windows or NT, this function first looks in the environment
289 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
290 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
292 The first variant of this function returns the hostname if successful or an
293 empty string otherwise. The second (deprecated) function returns TRUE
294 if successful, FALSE otherwise.
296 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
298 \wxheading{Include files
}
302 \section{User identification
}\label{useridfunctions
}
304 \membersection{::wxGetUserId
}\label{wxgetuserid
}
306 \func{wxString
}{wxGetUserId
}{\void}
307 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
309 This function returns the "user id" also known as "login name" under Unix i.e.
310 something like "jsmith". It uniquely identifies the current user (on this system).
312 Under Windows or NT, this function first looks in the environment
313 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
314 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
316 The first variant of this function returns the login name if successful or an
317 empty string otherwise. The second (deprecated) function returns TRUE
318 if successful, FALSE otherwise.
320 See also:
\helpref{wxGetUserName
}{wxgetusername
}
322 \wxheading{Include files
}
326 \membersection{::wxGetUserName
}\label{wxgetusername
}
328 \func{wxString
}{wxGetUserName
}{\void}
329 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
331 This function returns the full user name (something like "Mr. John Smith").
333 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
334 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
335 is running, the entry
{\bf Current
} in the section
{\bf User
} of
336 the PENWIN.INI file is used.
338 The first variant of this function returns the user name if successful or an
339 empty string otherwise. The second (deprecated) function returns TRUE
340 if successful, FALSE otherwise.
342 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
344 \wxheading{Include files
}
348 \section{String functions
}
350 \membersection{::copystring
}
352 \func{char*
}{copystring
}{\param{const char*
}{s
}}
354 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
355 deleted with the
{\it delete
} operator.
357 \membersection{::wxStringMatch
}
359 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
360 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
362 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
363 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
364 no substring matching is done.
366 \membersection{::wxStringEq
}\label{wxstringeq
}
368 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
373 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
376 \membersection{::IsEmpty
}\label{isempty
}
378 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
380 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
381 pointer to this function and it will return TRUE for it.
383 \membersection{::Stricmp
}\label{stricmp
}
385 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
387 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
388 to or greater than
{\it p2
}. The comparison is case-insensitive.
390 This function complements the standard C function
{\it strcmp()
} which performs
391 case-sensitive comparison.
393 \membersection{::Strlen
}\label{strlen
}
395 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
397 This is a safe version of standard function
{\it strlen()
}: it does exactly the
398 same thing (i.e. returns the length of the string) except that it returns
0 if
399 {\it p
} is the NULL pointer.
401 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
403 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
405 This function returns the translation of string
{\it str
} in the current
406 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
407 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
408 original string is returned. In debug build, an error message is logged - this
409 should help to find the strings which were not yet translated. As this function
410 is used very often, an alternative syntax is provided: the
\_() macro is
411 defined as wxGetTranslation().
413 \section{Dialog functions
}\label{dialogfunctions
}
415 Below are a number of convenience functions for getting input from the
416 user or displaying messages. Note that in these functions the last three
417 parameters are optional. However, it is recommended to pass a parent frame
418 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
419 the front when the dialog box is popped up.
421 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
423 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{
424 \param{const wxString\&
}{filename
},
425 \param{size
\_t }{currentTip
}}
427 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
428 used with
\helpref{wxShowTip
}{wxshowtip
}.
430 \docparam{filename
}{The name of the file containing the tips, one per line
}
431 \docparam{currentTip
}{The index of the first tip to show - normally this index
432 is remembered between the
2 program runs.
}
434 \wxheading{See also:
}
436 \helpref{Tips overview
}{tipsoverview
}
438 \wxheading{Include files
}
442 \membersection{::wxFileSelector
}\label{wxfileselector
}
444 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
445 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
446 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
447 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
449 Pops up a file selector box. In Windows, this is the common file selector
450 dialog. In X, this is a file selector box with somewhat less functionality.
451 The path and filename are distinct elements of a full file pathname.
452 If path is empty, the current directory will be used. If filename is empty,
453 no default filename will be supplied. The wildcard determines what files
454 are displayed in the file selector, and file extension supplies a type
455 extension for the required filename. Flags may be a combination of wxOPEN,
456 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0.
458 Both the Unix and Windows versions implement a wildcard filter. Typing a
459 filename containing wildcards
(*, ?) in the filename text item, and
460 clicking on Ok, will result in only those files matching the pattern being
463 The wildcard may be a specification for multiple types of file
464 with a description for each, such as:
467 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
470 The application must check for an empty return value (the user pressed
471 Cancel). For example:
474 const wxString& s = wxFileSelector("Choose a file to open");
481 \wxheading{Include files}
485 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
487 \func{long}{wxGetNumberFromUser}{
488 \param{const wxString\& }{message},
489 \param{const wxString\& }{prompt},
490 \param{const wxString\& }{caption},
491 \param{long }{value},
492 \param{long }{min = 0},
493 \param{long }{max = 100},
494 \param{wxWindow *}{parent = NULL},
495 \param{const wxPoint\& }{pos = wxDefaultPosition}}
497 Shows a dialog asking the user for numeric input. The dialogs title is set to
498 {\it caption}, it contains a (possibly) multiline {\it message} above the
499 single line {\it prompt} and the zone for entering the number.
501 The number entered must be in the range {\it min}..{\it max} (both of which
502 should be positive) and {\it value} is the initial value of it. If the user
503 enters an invalid value or cancels the dialog, the function will return -1.
505 Dialog is centered on its {\it parent} unless an explicit position is given in
508 \wxheading{Include files}
512 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
514 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
515 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
516 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
518 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
519 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
520 or press Cancel to return the empty string.
522 If {\it centre} is TRUE, the message text (which may include new line characters)
523 is centred; if FALSE, the message is left-justified.
525 \wxheading{Include files}
529 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
531 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
532 \param{int }{nsel}, \param{int *}{selection},
533 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
534 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
536 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
537 listbox. The user may choose one or more item(s) and press OK or Cancel.
539 The number of initially selected choices, and array of the selected indices,
540 are passed in; this array will contain the user selections on exit, with
541 the function returning the number of selections. {\it selection} must be
542 as big as the number of choices, in case all are selected.
544 If Cancel is pressed, -1 is returned.
546 {\it choices} is an array of {\it n} strings for the listbox.
548 If {\it centre} is TRUE, the message text (which may include new line characters)
549 is centred; if FALSE, the message is left-justified.
551 \wxheading{Include files}
555 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
557 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
558 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
559 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
561 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
562 listbox. The user may choose an item and press OK to return a string or
563 Cancel to return the empty string.
565 {\it choices} is an array of {\it n} strings for the listbox.
567 If {\it centre} is TRUE, the message text (which may include new line characters)
568 is centred; if FALSE, the message is left-justified.
570 \wxheading{Include files}
574 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
576 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
577 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
578 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
580 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
581 If the user pressed cancel, -1 is returned.
583 \wxheading{Include files}
587 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
589 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
590 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
591 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
593 As {\bf wxGetSingleChoice} but takes an array of client data pointers
594 corresponding to the strings, and returns one of these pointers.
596 \wxheading{Include files}
600 \membersection{::wxMessageBox}\label{wxmessagebox}
602 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
603 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
605 General purpose message dialog. {\it style} may be a bit list of the
606 following identifiers:
608 \begin{twocollist}\itemsep=0pt
609 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
611 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
613 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
614 \twocolitem{wxCENTRE}{Centres the text.}
615 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
616 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
617 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
618 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
621 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
627 int answer = wxMessageBox("Quit program?", "Confirm",
628 wxYES_NO | wxCANCEL, main_frame);
634 {\it message} may contain newline characters, in which case the
635 message will be split into separate lines, to cater for large messages.
637 Under Windows, the native MessageBox function is used unless wxCENTRE
638 is specified in the style, in which case a generic function is used.
639 This is because the native MessageBox function cannot centre text.
640 The symbols are not shown when the generic function is used.
642 \wxheading{Include files}
646 \membersection{::wxShowTip}\label{wxshowtip}
648 \func{bool}{wxShowTip}{
649 \param{wxWindow *}{parent},
650 \param{wxTipProvider *}{tipProvider},
651 \param{bool }{showAtStartup = TRUE}}
653 This function shows a "startup tip" to the user.
655 \docparam{parent}{The parent window for the modal dialog}
657 \docparam{tipProvider}{An object which is used to get the text of the tips.
658 It may be created with
659 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
661 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
662 otherwise. This is used as the initial value for "Show tips at startup"
663 checkbox which is shown in the tips dialog.}
665 \wxheading{See also:}
667 \helpref{Tips overview}{tipsoverview}
669 \wxheading{Include files}
673 \section{GDI functions}\label{gdifunctions}
675 The following are relevant to the GDI (Graphics Device Interface).
677 \wxheading{Include files}
681 \membersection{::wxColourDisplay}
683 \func{bool}{wxColourDisplay}{\void}
685 Returns TRUE if the display is colour, FALSE otherwise.
687 \membersection{::wxDisplayDepth}
689 \func{int}{wxDisplayDepth}{\void}
691 Returns the depth of the display (a value of 1 denotes a monochrome display).
693 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
695 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
696 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
698 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
699 makes it into a placeable metafile by prepending a header containing the given
700 bounding box. The bounding box may be obtained from a device context after drawing
701 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
703 In addition to adding the placeable metafile header, this function adds
704 the equivalent of the following code to the start of the metafile data:
707 SetMapMode(dc, MM_ANISOTROPIC);
708 SetWindowOrg(dc, minX, minY);
709 SetWindowExt(dc, maxX - minX, maxY - minY);
712 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
714 Placeable metafiles may be imported by many Windows applications, and can be
715 used in RTF (Rich Text Format) files.
717 {\it scale} allows the specification of scale for the metafile.
719 This function is only available under Windows.
721 \membersection{::wxSetCursor}\label{wxsetcursor}
723 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
725 Globally sets the cursor; only has an effect in Windows and GTK.
726 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
728 \section{Printer settings}\label{printersettings}
730 These routines are obsolete and should no longer be used!
732 The following functions are used to control PostScript printing. Under
733 Windows, PostScript output can only be sent to a file.
735 \wxheading{Include files}
739 \membersection{::wxGetPrinterCommand}
741 \func{wxString}{wxGetPrinterCommand}{\void}
743 Gets the printer command used to print a file. The default is {\tt lpr}.
745 \membersection{::wxGetPrinterFile}
747 \func{wxString}{wxGetPrinterFile}{\void}
749 Gets the PostScript output filename.
751 \membersection{::wxGetPrinterMode}
753 \func{int}{wxGetPrinterMode}{\void}
755 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
756 The default is PS\_PREVIEW.
758 \membersection{::wxGetPrinterOptions}
760 \func{wxString}{wxGetPrinterOptions}{\void}
762 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
764 \membersection{::wxGetPrinterOrientation}
766 \func{int}{wxGetPrinterOrientation}{\void}
768 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
770 \membersection{::wxGetPrinterPreviewCommand}
772 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
774 Gets the command used to view a PostScript file. The default depends on the platform.
776 \membersection{::wxGetPrinterScaling}
778 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
780 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
782 \membersection{::wxGetPrinterTranslation}
784 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
786 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
788 \membersection{::wxSetPrinterCommand}
790 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
792 Sets the printer command used to print a file. The default is {\tt lpr}.
794 \membersection{::wxSetPrinterFile}
796 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
798 Sets the PostScript output filename.
800 \membersection{::wxSetPrinterMode}
802 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
804 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
805 The default is PS\_PREVIEW.
807 \membersection{::wxSetPrinterOptions}
809 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
811 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
813 \membersection{::wxSetPrinterOrientation}
815 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
817 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
819 \membersection{::wxSetPrinterPreviewCommand}
821 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
823 Sets the command used to view a PostScript file. The default depends on the platform.
825 \membersection{::wxSetPrinterScaling}
827 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
829 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
831 \membersection{::wxSetPrinterTranslation}
833 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
835 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
837 \section{Clipboard functions}\label{clipsboard}
839 These clipboard functions are implemented for Windows only.
841 \wxheading{Include files}
845 \membersection{::wxClipboardOpen}
847 \func{bool}{wxClipboardOpen}{\void}
849 Returns TRUE if this application has already opened the clipboard.
851 \membersection{::wxCloseClipboard}
853 \func{bool}{wxCloseClipboard}{\void}
855 Closes the clipboard to allow other applications to use it.
857 \membersection{::wxEmptyClipboard}
859 \func{bool}{wxEmptyClipboard}{\void}
861 Empties the clipboard.
863 \membersection{::wxEnumClipboardFormats}
865 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
867 Enumerates the formats found in a list of available formats that belong
868 to the clipboard. Each call to this function specifies a known
869 available format; the function returns the format that appears next in
872 {\it dataFormat} specifies a known format. If this parameter is zero,
873 the function returns the first format in the list.
875 The return value specifies the next known clipboard data format if the
876 function is successful. It is zero if the {\it dataFormat} parameter specifies
877 the last format in the list of available formats, or if the clipboard
880 Before it enumerates the formats function, an application must open the clipboard by using the
881 wxOpenClipboard function.
883 \membersection{::wxGetClipboardData}
885 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
887 Gets data from the clipboard.
889 {\it dataFormat} may be one of:
891 \begin{itemize}\itemsep=0pt
892 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
893 \item wxCF\_BITMAP: returns a new wxBitmap.
896 The clipboard must have previously been opened for this call to succeed.
898 \membersection{::wxGetClipboardFormatName}
900 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
902 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
903 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
905 \membersection{::wxIsClipboardFormatAvailable}
907 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
909 Returns TRUE if the given data format is available on the clipboard.
911 \membersection{::wxOpenClipboard}
913 \func{bool}{wxOpenClipboard}{\void}
915 Opens the clipboard for passing data to it or getting data from it.
917 \membersection{::wxRegisterClipboardFormat}
919 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
921 Registers the clipboard data format name and returns an identifier.
923 \membersection{::wxSetClipboardData}
925 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
927 Passes data to the clipboard.
929 {\it dataFormat} may be one of:
931 \begin{itemize}\itemsep=0pt
932 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
933 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
934 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
935 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
938 The clipboard must have previously been opened for this call to succeed.
940 \section{Miscellaneous functions}\label{miscellany}
942 \membersection{::wxNewId}
944 \func{long}{wxNewId}{\void}
946 Generates an integer identifier unique to this run of the program.
948 \wxheading{Include files}
952 \membersection{::wxRegisterId}
954 \func{void}{wxRegisterId}{\param{long}{ id}}
956 Ensures that ids subsequently generated by {\bf NewId} do not clash with
959 \wxheading{Include files}
963 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
965 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
967 Changes the cursor to the given cursor for all windows in the application.
968 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
969 to its previous state. These two calls can be nested, and a counter
970 ensures that only the outer calls take effect.
972 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
974 \wxheading{Include files}
978 \membersection{::wxBell}
980 \func{void}{wxBell}{\void}
982 Ring the system bell.
984 \wxheading{Include files}
988 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
990 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
992 Creates and returns an object of the given class, if the class has been
993 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
995 \membersection{::wxDDECleanUp}\label{wxddecleanup}
997 \func{void}{wxDDECleanUp}{\void}
999 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
1000 called by the application.
1002 See also helpref{wxDDEInitialize}{wxddeinitialize}.
1004 \wxheading{Include files}
1008 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1010 \func{void}{wxDDEInitialize}{\void}
1012 Initializes the DDE system. May be called multiple times without harm.
1014 This no longer needs to be called by the application: it will be called
1015 by wxWindows if necessary.
1017 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1018 \helpref{wxDDECleanUp}{wxddecleanup}.
1020 \wxheading{Include files}
1024 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1026 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1028 Display a debugging message; under Windows, this will appear on the
1029 debugger command window, and under Unix, it will be written to standard
1032 The syntax is identical to {\bf printf}: pass a format string and a
1033 variable list of arguments.
1035 Note that under Windows, you can see the debugging messages without a
1036 debugger if you have the DBWIN debug log application that comes with
1039 {\bf Tip:} under Windows, if your application crashes before the
1040 message appears in the debugging window, put a wxYield call after
1041 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1042 (at least for Watcom C++): preformat your messages and use OutputDebugString
1045 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1047 \wxheading{Include files}
1051 \membersection{::wxDisplaySize}
1053 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1055 Gets the physical size of the display in pixels.
1057 \wxheading{Include files}
1061 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1063 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1065 This function enables or disables all top level windows. It is used by
1066 \helpref{::wxSafeYield}{wxsafeyield}.
1068 \wxheading{Include files}
1072 \membersection{::wxEntry}\label{wxentry}
1074 This initializes wxWindows in a platform-dependent way. Use this if you
1075 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1076 you can initialize wxWindows from an Microsoft Foundation Classes application using
1079 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1080 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1082 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1083 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1084 message loop will be entered.
1086 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1087 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1089 wxWindows initialization under Windows (for applications constructed as a DLL).
1091 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1093 wxWindows initialization under Unix.
1097 To clean up wxWindows, call wxApp::OnExit followed by the static function
1098 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1101 int CTheApp::ExitInstance()
1103 // OnExit isn't called by CleanUp so must be called explicitly.
1107 return CWinApp::ExitInstance();
1111 \wxheading{Include files}
1115 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1117 \func{void}{wxEndBusyCursor}{\void}
1119 Changes the cursor back to the original cursor, for all windows in the application.
1120 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1122 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1124 \wxheading{Include files}
1128 \membersection{::wxError}\label{wxerror}
1130 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1132 Displays {\it msg} and continues. This writes to standard error under
1133 Unix, and pops up a message box under Windows. Used for internal
1134 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1136 \wxheading{Include files}
1140 \membersection{::wxExecute}\label{wxexecute}
1142 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1144 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1146 Executes another program in Unix or Windows.
1148 The first form takes a command string, such as {\tt "emacs file.txt"}.
1150 The second form takes an array of values: a command, any number of
1151 arguments, terminated by NULL.
1153 If {\it sync} is FALSE (the default), flow of control immediately returns.
1154 If TRUE, the current application waits until the other program has terminated.
1156 In the case of synchronous execution, the return value is the exit code of
1157 the process (which terminates by the moment the function returns) and will be
1158 $-1$ if the process couldn't be started and typically 0 if the process
1159 terminated successfully. Also, while waiting for the process to
1160 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1161 should ensure that this can cause no recursion, in the simples case by
1162 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1164 For asynchronous execution, however, the return value is the process id and
1165 zero value indicates that the command could not be executed.
1167 If callback isn't NULL and if execution is asynchronous (note that callback
1168 parameter can not be non NULL for synchronous execution),
1169 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1170 the process finishes.
1172 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1174 \wxheading{Include files}
1178 \membersection{::wxExit}\label{wxexit}
1180 \func{void}{wxExit}{\void}
1182 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1183 Should only be used in an emergency: normally the top-level frame
1184 should be deleted (after deleting all other frames) to terminate the
1185 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1187 \wxheading{Include files}
1191 \membersection{::wxFatalError}\label{wxfatalerror}
1193 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1195 Displays {\it msg} and exits. This writes to standard error under Unix,
1196 and pops up a message box under Windows. Used for fatal internal
1197 wxWindows errors. See also \helpref{wxError}{wxerror}.
1199 \wxheading{Include files}
1203 \membersection{::wxFindMenuItemId}
1205 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1207 Find a menu item identifier associated with the given frame's menu bar.
1209 \wxheading{Include files}
1213 \membersection{::wxFindWindowByLabel}
1215 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1217 Find a window by its label. Depending on the type of window, the label may be a window title
1218 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1219 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1220 The search is recursive in both cases.
1222 \wxheading{Include files}
1226 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1228 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1230 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1231 If {\it parent} is NULL, the search will start from all top-level
1232 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1233 The search is recursive in both cases.
1235 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1237 \wxheading{Include files}
1241 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1243 \func{wxWindow *}{wxGetActiveWindow}{\void}
1245 Gets the currently active window (Windows only).
1247 \wxheading{Include files}
1251 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1253 \func{wxString}{wxGetDisplayName}{\void}
1255 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1257 \wxheading{Include files}
1261 \membersection{::wxGetHomeDir}
1263 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1265 Fills the buffer with a string representing the user's home directory (Unix only).
1267 \wxheading{Include files}
1271 \membersection{::wxGetHostName}
1273 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1275 Copies the host name of the machine the program is running on into the
1276 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1277 successful. Under Unix, this will return a machine name. Under Windows,
1278 this returns ``windows''.
1280 \wxheading{Include files}
1284 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1286 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1288 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1290 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1293 See also \helpref{wxTimer}{wxtimer}.
1295 \wxheading{Include files}
1299 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1301 \func{long}{wxGetFreeMemory}{\void}
1303 Returns the amount of free memory in Kbytes under environments which
1304 support it, and -1 if not supported. Currently, returns a positive value
1305 under Windows, and -1 under Unix.
1307 \wxheading{Include files}
1311 \membersection{::wxGetMousePosition}
1313 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1315 Returns the mouse position in screen coordinates.
1317 \wxheading{Include files}
1321 \membersection{::wxGetOsVersion}
1323 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1325 Gets operating system version information.
1327 \begin{twocollist}\itemsep=0pt
1328 \twocolitemruled{Platform}{Return tyes}
1329 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1330 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1331 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1332 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1333 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1334 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1335 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1336 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1337 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1340 \wxheading{Include files}
1344 \membersection{::wxGetResource}\label{wxgetresource}
1346 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1347 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1349 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1350 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1352 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1353 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1355 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1356 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1358 Gets a resource value from the resource database (for example, WIN.INI, or
1359 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1360 otherwise the specified file is used.
1362 Under X, if an application class (wxApp::GetClassName) has been defined,
1363 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1364 an applications default file when merging all resource databases.
1366 The reason for passing the result in an argument is that it
1367 can be convenient to define a default value, which gets overridden
1368 if the value exists in the resource file. It saves a separate
1369 test for that resource's existence, and it also allows
1370 the overloading of the function for different types.
1372 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1374 \wxheading{Include files}
1378 \membersection{::wxGetUserId}
1380 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1382 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1383 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1384 Under Windows, this returns ``user''.
1386 \wxheading{Include files}
1390 \membersection{::wxGetUserName}
1392 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1394 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1395 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1396 Under Windows, this returns ``unknown''.
1398 \wxheading{Include files}
1402 \membersection{::wxKill}\label{wxkill}
1404 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1406 Under Unix (the only supported platform), equivalent to the Unix kill function.
1407 Returns 0 on success, -1 on failure.
1409 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1410 It does not raise a signal in the receiving process.
1412 \wxheading{Include files}
1416 \membersection{::wxIsBusy}\label{wxisbusy}
1418 \func{bool}{wxIsBusy}{\void}
1420 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1421 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1423 See also \helpref{wxBusyCursor}{wxbusycursor}.
1425 \wxheading{Include files}
1429 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1431 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1433 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1434 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1436 The resource must be defined in the {\tt .rc} file using the following syntax:
1439 myResource TEXT file.ext
1442 where {\tt file.ext} is a file that the resource compiler can find.
1444 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1445 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1446 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1448 This function is available under Windows only.
1450 \wxheading{Include files}
1454 \membersection{::wxNow}\label{wxnow}
1456 \func{wxString}{wxNow}{\void}
1458 Returns a string representing the current date and time.
1460 \wxheading{Include files}
1464 \membersection{::wxPostDelete}\label{wxpostdelete}
1466 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1468 Tells the system to delete the specified object when
1469 all other events have been processed. In some environments, it is
1470 necessary to use this instead of deleting a frame directly with the
1471 delete operator, because some GUIs will still send events to a deleted window.
1473 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1475 \wxheading{Include files}
1479 \membersection{::wxPostEvent}\label{wxpostevent}
1481 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
1483 This function posts the event to the specified {\it dest} object. The
1484 difference between sending an event and posting it is that in the first case
1485 the event is processed before the function returns (in wxWindows, event sending
1486 is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
1487 the second, the function returns immediately and the event will be processed
1488 sometime later - usually during the next even loop iteration.
1490 Note that a copy of the {\it event} is made by the function, so the original
1491 copy can be deleted as soon as function returns. This function can also be used
1492 to send events between different threads safely.
1494 \wxheading{Include files}
1498 \membersection{::wxSafeYield}\label{wxsafeyield}
1500 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1502 This function is similar to wxYield, except that it disables the user input to
1503 all program windows before calling wxYield and re-enables it again
1504 afterwards. If {\it win} is not NULL, this window will remain enabled,
1505 allowing the implementation of some limited user interaction.
1507 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1509 \wxheading{Include files}
1513 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1515 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1517 Under X only, sets the current display name. This is the X host and display name such
1518 as ``colonsay:0.0", and the function indicates which display should be used for creating
1519 windows from this point on. Setting the display within an application allows multiple
1520 displays to be used.
1522 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1524 \wxheading{Include files}
1528 \membersection{::wxShell}\label{wxshell}
1530 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1532 Executes a command in an interactive shell window. If no command is
1533 specified, then just the shell is spawned.
1535 See also \helpref{wxExecute}{wxexecute}.
1537 \wxheading{Include files}
1541 \membersection{::wxSleep}\label{wxsleep}
1543 \func{void}{wxSleep}{\param{int}{ secs}}
1545 Sleeps for the specified number of seconds.
1547 \wxheading{Include files}
1551 \membersection{::wxStripMenuCodes}
1553 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1555 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1557 Strips any menu codes from {\it in} and places the result
1558 in {\it out} (or returns the new string, in the first form).
1560 Menu codes include \& (mark the next character with an underline
1561 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1563 \wxheading{Include files}
1567 \membersection{::wxStartTimer}\label{wxstarttimer}
1569 \func{void}{wxStartTimer}{\void}
1571 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1573 See also \helpref{wxTimer}{wxtimer}.
1575 \wxheading{Include files}
1579 \membersection{::wxToLower}\label{wxtolower}
1581 \func{char}{wxToLower}{\param{char }{ch}}
1583 Converts the character to lower case. This is implemented as a macro for efficiency.
1585 \wxheading{Include files}
1589 \membersection{::wxToUpper}\label{wxtoupper}
1591 \func{char}{wxToUpper}{\param{char }{ch}}
1593 Converts the character to upper case. This is implemented as a macro for efficiency.
1595 \wxheading{Include files}
1599 \membersection{::wxTrace}\label{wxtrace}
1601 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1603 Takes printf-style variable argument syntax. Output
1604 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1606 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1608 \wxheading{Include files}
1612 \membersection{::wxTraceLevel}\label{wxtracelevel}
1614 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1616 Takes printf-style variable argument syntax. Output
1617 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1618 The first argument should be the level at which this information is appropriate.
1619 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1622 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1624 \wxheading{Include files}
1628 \membersection{::wxUsleep}\label{wxusleep}
1630 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1632 Sleeps for the specified number of milliseconds. Notice that usage of this
1633 function is encouraged instead of calling usleep(3) directly because the
1634 standard usleep() function is not MT safe.
1636 \wxheading{Include files}
1640 \membersection{::wxWriteResource}\label{wxwriteresource}
1642 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1643 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1645 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1646 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1648 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1649 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1651 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1652 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1654 Writes a resource value into the resource database (for example, WIN.INI, or
1655 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1656 otherwise the specified file is used.
1658 Under X, the resource databases are cached until the internal function
1659 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1660 all updated resource databases are written to their files.
1662 Note that it is considered bad manners to write to the .Xdefaults
1663 file under Unix, although the WIN.INI file is fair game under Windows.
1665 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1667 \wxheading{Include files}
1671 \membersection{::wxYield}\label{wxyield}
1673 \func{bool}{wxYield}{\void}
1675 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1676 time-consuming process writes to a text window. Without an occasional
1677 yield, the text window will not be updated properly, and (since Windows
1678 multitasking is cooperative) other processes will not respond.
1680 Caution should be exercised, however, since yielding may allow the
1681 user to perform actions which are not compatible with the current task.
1682 Disabling menu items or whole menus during processing can avoid unwanted
1683 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1686 \wxheading{Include files}
1688 <wx/app.h> or <wx/utils.h>
1690 \section{Macros}\label{macros}
1692 These macros are defined in wxWindows.
1694 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1696 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1698 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1700 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1702 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1704 This macro will swap the bytes of the {\it value} variable from little
1705 endian to big endian or vice versa.
1707 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1709 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1711 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1713 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1715 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1717 This macro will swap the bytes of the {\it value} variable from little
1718 endian to big endian or vice versa if the program is compiled on a
1719 big-endian architecture (such as Sun work stations). If the program has
1720 been compiled on a little-endian architecture, the value will be unchanged.
1722 Use these macros to read data from and write data to a file that stores
1723 data in little endian (Intel i386) format.
1725 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1727 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1729 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1731 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1733 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1735 This macro will swap the bytes of the {\it value} variable from little
1736 endian to big endian or vice versa if the program is compiled on a
1737 little-endian architecture (such as Intel PCs). If the program has
1738 been compiled on a big-endian architecture, the value will be unchanged.
1740 Use these macros to read data from and write data to a file that stores
1741 data in big endian format.
1743 \membersection{CLASSINFO}\label{classinfo}
1745 \func{wxClassInfo *}{CLASSINFO}{className}
1747 Returns a pointer to the wxClassInfo object associated with this class.
1749 \wxheading{Include files}
1753 \membersection{DECLARE\_ABSTRACT\_CLASS}
1755 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1757 Used inside a class declaration to declare that the class should be
1758 made known to the class hierarchy, but objects of this class cannot be created
1759 dynamically. The same as DECLARE\_CLASS.
1764 class wxCommand: public wxObject
1766 DECLARE_ABSTRACT_CLASS(wxCommand)
1775 \wxheading{Include files}
1779 \membersection{DECLARE\_APP}\label{declareapp}
1781 \func{}{DECLARE\_APP}{className}
1783 This is used in headers to create a forward declaration of the wxGetApp function implemented
1784 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1792 \wxheading{Include files}
1796 \membersection{DECLARE\_CLASS}
1798 \func{}{DECLARE\_CLASS}{className}
1800 Used inside a class declaration to declare that the class should be
1801 made known to the class hierarchy, but objects of this class cannot be created
1802 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1804 \wxheading{Include files}
1808 \membersection{DECLARE\_DYNAMIC\_CLASS}
1810 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1812 Used inside a class declaration to declare that the objects of this class should be dynamically
1813 createable from run-time type information.
1818 class wxFrame: public wxWindow
1820 DECLARE_DYNAMIC_CLASS(wxFrame)
1823 const wxString\& frameTitle;
1829 \wxheading{Include files}
1833 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1835 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1837 Used in a C++ implementation file to complete the declaration of
1838 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1843 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1845 wxCommand::wxCommand(void)
1851 \wxheading{Include files}
1855 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1857 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1859 Used in a C++ implementation file to complete the declaration of
1860 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1862 \wxheading{Include files}
1866 \membersection{IMPLEMENT\_APP}\label{implementapp}
1868 \func{}{IMPLEMENT\_APP}{className}
1870 This is used in the application class implementation file to make the application class known to
1871 wxWindows for dynamic construction. You use this instead of
1882 IMPLEMENT_APP(MyApp)
1885 See also \helpref{DECLARE\_APP}{declareapp}.
1887 \wxheading{Include files}
1891 \membersection{IMPLEMENT\_CLASS}
1893 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1895 Used in a C++ implementation file to complete the declaration of
1896 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1898 \wxheading{Include files}
1902 \membersection{IMPLEMENT\_CLASS2}
1904 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1906 Used in a C++ implementation file to complete the declaration of a
1907 class that has run-time type information and two base classes. The
1908 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1910 \wxheading{Include files}
1914 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1916 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1918 Used in a C++ implementation file to complete the declaration of
1919 a class that has run-time type information, and whose instances
1920 can be created dynamically.
1925 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1927 wxFrame::wxFrame(void)
1933 \wxheading{Include files}
1937 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1939 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1941 Used in a C++ implementation file to complete the declaration of
1942 a class that has run-time type information, and whose instances
1943 can be created dynamically. Use this for classes derived from two
1946 \wxheading{Include files}
1950 \membersection{wxBITMAP}\label{wxbitmapmacro}
1952 \func{}{wxBITMAP}{bitmapName}
1954 This macro loads a bitmap from either application resources (on the platforms
1955 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
1956 avoid using {\tt #ifdef}s when creating bitmaps.
1958 \wxheading{See also}
1960 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
1961 \helpref{wxICON}{wxiconmacro}
1963 \wxheading{Include files}
1967 \membersection{WXDEBUG\_NEW}\label{debugnew}
1969 \func{}{WXDEBUG\_NEW}{arg}
1971 This is defined in debug mode to be call the redefined new operator
1972 with filename and line number arguments. The definition is:
1975 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1978 In non-debug mode, this is defined as the normal new operator.
1980 \wxheading{Include files}
1984 \membersection{wxDynamicCast}\label{wxdynamiccast}
1986 \func{}{wxDynamicCast}{ptr, classname}
1988 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1989 the pointer is of this type (the check is done during the run-time) or NULL
1990 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1993 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1998 wxWindow *win = wxWindow::FindFocus();
1999 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
2002 // a text control has the focus...
2006 // no window has the focus or it's not a text control
2010 \wxheading{See also}
2012 \helpref{RTTI overview}{runtimeclassoverview}
2014 \membersection{wxICON}\label{wxiconmacro}
2016 \func{}{wxICON}{iconName}
2018 This macro loads an icon from either application resources (on the platforms
2019 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2020 avoid using {\tt #ifdef}s when creating icons.
2022 \wxheading{See also}
2024 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2025 \helpref{wxBITMAP}{wxbitmapmacro}
2027 \wxheading{Include files}
2031 \membersection{WXTRACE}\label{trace}
2033 \wxheading{Include files}
2037 \func{}{WXTRACE}{formatString, ...}
2039 Calls wxTrace with printf-style variable argument syntax. Output
2040 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2042 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2044 \wxheading{Include files}
2048 \membersection{WXTRACELEVEL}\label{tracelevel}
2050 \func{}{WXTRACELEVEL}{level, formatString, ...}
2052 Calls wxTraceLevel with printf-style variable argument syntax. Output
2053 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2054 The first argument should be the level at which this information is appropriate.
2055 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2058 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2060 \wxheading{Include files}
2064 \section{wxWindows resource functions}\label{resourcefuncs}
2066 \overview{wxWindows resource system}{resourceformats}
2068 This section details functions for manipulating wxWindows (.WXR) resource
2069 files and loading user interface elements from resources.
2071 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2072 about initialisation file resource reading and writing, using such functions
2073 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2075 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2077 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2078 loading from resource data.
2080 {\bf Warning:} this needs updating for wxWindows 2.
2082 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2084 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2086 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2087 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2088 perhaps for implementing resource functionality for interpreted languages.
2090 \membersection{::wxResourceClear}
2092 \func{void}{wxResourceClear}{\void}
2094 Clears the wxWindows resource table.
2096 \membersection{::wxResourceCreateBitmap}
2098 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2100 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2101 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2105 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2106 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2107 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2110 then this function can be called as follows:
2113 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2116 \membersection{::wxResourceCreateIcon}
2118 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2120 Creates a new icon from a file, static data, or Windows resource, given a valid
2121 wxWindows icon resource identifier. For example, if the .WXR file contains
2125 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2126 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2127 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2130 then this function can be called as follows:
2133 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2136 \membersection{::wxResourceCreateMenuBar}
2138 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2140 Creates a new menu bar given a valid wxWindows menubar resource
2141 identifier. For example, if the .WXR file contains the following:
2144 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2148 ['&Open File', 2, 'Open a file'],\
2149 ['&Save File', 3, 'Save a file'],\
2151 ['E&xit', 4, 'Exit program']\
2154 ['&About', 6, 'About this program']\
2159 then this function can be called as follows:
2162 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2166 \membersection{::wxResourceGetIdentifier}
2168 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2170 Used for retrieving the integer value associated with an identifier.
2171 A zero value indicates that the identifier was not found.
2173 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2175 \membersection{::wxResourceParseData}\label{wxresourcedata}
2177 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2179 Parses a string containing one or more wxWindows resource objects. If
2180 the resource objects are global static data that are included into the
2181 C++ program, then this function must be called for each variable
2182 containing the resource data, to make it known to wxWindows.
2184 {\it resource} should contain data in the following form:
2187 dialog(name = 'dialog1',
2188 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2189 title = 'Test dialog box',
2190 x = 312, y = 234, width = 400, height = 300,
2192 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2193 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2194 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2195 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2196 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2197 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2200 This function will typically be used after including a {\tt .wxr} file into
2201 a C++ program as follows:
2204 #include "dialog1.wxr"
2207 Each of the contained resources will declare a new C++ variable, and each
2208 of these variables should be passed to wxResourceParseData.
2210 \membersection{::wxResourceParseFile}
2212 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2214 Parses a file containing one or more wxWindows resource objects
2215 in C++-compatible syntax. Use this function to dynamically load
2216 wxWindows resource data.
2218 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2220 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2222 Parses a string containing one or more wxWindows resource objects. If
2223 the resource objects are global static data that are included into the
2224 C++ program, then this function must be called for each variable
2225 containing the resource data, to make it known to wxWindows.
2227 {\it resource} should contain data with the following form:
2230 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2231 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2232 title = 'Test dialog box',\
2233 x = 312, y = 234, width = 400, height = 300,\
2235 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2236 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2237 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2238 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2239 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2240 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2243 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2244 load an entire {\tt .wxr file} into a string.
2246 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2248 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2249 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2251 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2253 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2254 This is required if other resources will use the bitmap data, since otherwise there
2255 is no connection between names used in resources, and the global bitmap data.
2257 \membersection{::wxResourceRegisterIconData}
2259 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2261 \section{Log functions}\label{logfunctions}
2263 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2264 further information.
2266 \wxheading{Include files}
2270 \membersection{::wxLogError}\label{wxlogerror}
2272 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2274 The function to use for error messages, i.e. the
2275 messages that must be shown to the user. The default processing is to pop up a
2276 message box to inform the user about it.
2278 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2280 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2282 Like \helpref{wxLogError}{wxlogerror}, but also
2283 terminates the program with the exit code 3. Using {\it abort()} standard
2284 function also terminates the program with this exit code.
2286 \membersection{::wxLogWarning}\label{wxlogwarning}
2288 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2290 For warnings - they are also normally shown to the
2291 user, but don't interrupt the program work.
2293 \membersection{::wxLogMessage}\label{wxlogmessage}
2295 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2297 for all normal, informational messages. They also
2298 appear in a message box by default (but it can be changed). Notice
2299 that the standard behaviour is to not show informational messages if there are
2300 any errors later - the logic being that the later error messages make the
2301 informational messages preceding them meaningless.
2303 \membersection{::wxLogVerbose}\label{wxlogverbose}
2305 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2307 For verbose output. Normally, it's suppressed, but
2308 might be activated if the user wishes to know more details about the program
2309 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2311 \membersection{::wxLogStatus}\label{wxlogstatus}
2313 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2315 For status messages - they will go into the status
2316 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2318 \membersection{::wxLogSysError}\label{wxlogsyserror}
2320 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2322 Mostly used by wxWindows itself, but might be
2323 handy for logging errors after system call (API function) failure. It logs the
2324 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2325 on the platform) and the corresponding error
2326 message. The second form of this function takes the error code explitly as the
2329 \membersection{::wxLogDebug}\label{wxlogdebug}
2331 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2333 The right function for debug output. It only
2334 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2335 and expands to nothing in release mode (otherwise).
2337 \membersection{::wxLogTrace}\label{wxlogtrace}
2339 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2341 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2343 As {\bf wxLogDebug}, only does something in debug
2344 build. The reason for making it a separate function from it is that usually
2345 there are a lot of trace messages, so it might make sense to separate them
2346 from other debug messages which would be flooded in them. Moreover, the second
2347 version of this function takes a trace mask as the first argument which allows
2348 to further restrict the amount of messages generated. The value of {\it mask} can be:
2350 \begin{itemize}\itemsep=0pt
2351 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2352 \item wxTraceMessages: trace window messages/X callbacks
2353 \item wxTraceResAlloc: trace GDI resource allocation
2354 \item wxTraceRefCount: trace various ref counting operations
2357 \section{Debugging macros and functions}\label{debugmacros}
2359 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2360 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2363 \wxheading{Include files}
2367 \membersection{::wxOnAssert}\label{wxonassert}
2369 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2371 This function may be redefined to do something non trivial and is called
2372 whenever one of debugging macros fails (i.e. condition is false in an
2374 % TODO: this should probably be an overridable in wxApp.
2376 \membersection{wxASSERT}\label{wxassert}
2378 \func{}{wxASSERT}{\param{}{condition}}
2380 Assert macro. An error message will be generated if the condition is FALSE in
2381 debug mode, but nothing will be done in the release build.
2383 Please note that the condition in wxASSERT() should have no side effects
2384 because it will not be executed in release mode at all.
2386 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2388 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2390 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2392 Assert macro with message. An error message will be generated if the condition is FALSE.
2394 See also: \helpref{wxASSERT}{wxassert}
2396 \membersection{wxFAIL}\label{wxfail}
2398 \func{}{wxFAIL}{\void}
2400 Will always generate an assert error if this code is reached (in debug mode).
2402 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2404 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2406 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2408 Will always generate an assert error with specified message if this code is reached (in debug mode).
2410 This macro is useful for marking unreachable" code areas, for example
2411 it may be used in the "default:" branch of a switch statement if all possible
2412 cases are processed above.
2414 See also: \helpref{wxFAIL}{wxfail}
2416 \membersection{wxCHECK}\label{wxcheck}
2418 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2420 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2421 This check is done even in release mode.
2423 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2425 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2427 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2428 This check is done even in release mode.
2430 This macro may be only used in non void functions, see also
2431 \helpref{wxCHECK\_RET}{wxcheckret}.
2433 \membersection{wxCHECK\_RET}\label{wxcheckret}
2435 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2437 Checks that the condition is true, and returns if not (FAILs with given error
2438 message in debug mode). This check is done even in release mode.
2440 This macro should be used in void functions instead of
2441 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2443 \membersection{wxCHECK2}\label{wxcheck2}
2445 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2447 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2448 {\it operation} if it is not. This is a generalisation of
2449 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2450 returning from the function must be done when the {\it condition} is false.
2452 This check is done even in release mode.
2454 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2456 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2458 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2459 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2460 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob