1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions defined in wxWindows are described here.
7 \section{File functions
}\label{filefunctions
}
9 \wxheading{Include files
}
15 \helpref{wxPathList
}{wxpathlist
}
17 \membersection{::wxDirExists
}
19 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
21 Returns TRUE if the directory exists.
23 \membersection{::wxDos2UnixFilename
}
25 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
27 Converts a DOS to a Unix filename by replacing backslashes with forward
30 \membersection{::wxFileExists
}
32 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
34 Returns TRUE if the file exists.
36 \membersection{::wxFileNameFromPath
}
38 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
40 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
42 Returns the filename for a full path. The second form returns a pointer to
43 temporary storage that should not be deallocated.
45 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
47 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
49 This function does directory searching; returns the first file
50 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
51 get the next matching file. Neither will
report the current directory "." or the
52 parent directory "..".
54 {\it spec
} may contain wildcards.
56 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
61 wxString f = wxFindFirstFile("/home/project/*.*");
62 while ( !f.IsEmpty() )
69 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
71 \func{wxString
}{wxFindNextFile
}{\void}
73 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
75 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
77 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
79 \func{wxString
}{wxGetOSDirectory
}{\void}
81 Returns the Windows directory under Windows; on other platforms returns the empty string.
83 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
85 \func{void
}{wxInitAllImageHandlers
}{\void}
87 Adds some common image format handlers, which, depending on wxWindows
88 configuration, can be handlers for BMP (loading) (always installed), GIF
89 (loading and saving), PCX (loading and saving), PNM (loading and saving as raw
90 rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
92 See also:
\helpref{wxImage
}{wximage
} \helpref{wxImageHandler
}{wximagehandler
}
94 \membersection{::wxIsAbsolutePath
}
96 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
98 Returns TRUE if the argument is an absolute filename, i.e. with a slash
99 or drive name at the beginning.
101 \membersection{::wxPathOnly
}
103 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
105 Returns the directory part of the filename.
107 \membersection{::wxUnix2DosFilename
}
109 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
111 Converts a Unix to a DOS filename by replacing forward
112 slashes with backslashes.
114 \membersection{::wxConcatFiles
}
116 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
117 \param{const wxString\&
}{file3
}}
119 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
122 \membersection{::wxCopyFile
}
124 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
126 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
128 \membersection{::wxGetCwd
}\label{wxgetcwd
}
130 \func{wxString
}{wxGetCwd
}{\void}
132 Returns a string containing the current (or working) directory.
134 \membersection{::wxGetWorkingDirectory
}
136 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
138 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
140 Copies the current working directory into the buffer if supplied, or
141 copies the working directory into new storage (which you must delete yourself)
142 if the buffer is NULL.
144 {\it sz
} is the size of the buffer if supplied.
146 \membersection{::wxGetTempFileName
}
148 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
150 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
151 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
152 is allocated for the temporary filename using
{\it new
}.
154 Under Windows, the filename will include the drive and name of the
155 directory allocated for temporary files (usually the contents of the
156 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
158 It is the application's responsibility to create and delete the file.
160 \membersection{::wxIsWild
}\label{wxiswild
}
162 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
164 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
166 \membersection{::wxMatchWild
}\label{wxmatchwild
}
168 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
170 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
171 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
172 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
174 \membersection{::wxMkdir
}
176 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
178 Makes the directory
{\it dir
}, returning TRUE if successful.
180 {\it perm
} is the access mask for the directory for the systems on which it is
181 supported (Unix) and doesn't have effect for the other ones.
183 \membersection{::wxRemoveFile
}
185 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
187 Removes
{\it file
}, returning TRUE if successful.
189 \membersection{::wxRenameFile
}
191 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
193 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
195 \membersection{::wxRmdir
}
197 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
199 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
201 The
{\it flags
} parameter is reserved for future use.
203 \membersection{::wxSetWorkingDirectory
}
205 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
207 Sets the current working directory, returning TRUE if the operation succeeded.
208 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
210 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
212 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
214 This function splits a full file name into components: the path (including possible disk/drive
215 specification under Windows), the base name and the extension. Any of the output parameters
216 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
217 a particular component.
219 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
220 Windows, however it will not consider backslashes as path separators under Unix (where backslash
221 is a valid character in a filename).
223 On entry,
{\it fullname
} should be non NULL (it may be empty though).
225 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
226 contains the file name and
{\it ext
} contains the file extension without leading dot. All
227 three of them may be empty if the corresponding component is. The old contents of the
228 strings pointed to by these parameters will be overwritten in any case (if the pointers
231 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
233 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
235 Copies the given file to
{\it stream
}. Useful when converting an old application to
236 use streams (within the
document/view framework, for example).
238 Use of this function requires the file wx
\_doc.h to be included.
240 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
242 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
244 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
245 use streams (within the
document/view framework, for example).
247 Use of this function requires the file wx
\_doc.h to be included.
249 \section{Network functions
}\label{networkfunctions
}
251 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
253 \func{wxString
}{wxGetFullHostName
}{\void}
255 Returns the FQDN (fully qualified domain host name) or an empty string on
258 See also:
\helpref{wxGetHostName
}{wxgethostname
}
260 \wxheading{Include files
}
264 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
266 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
268 Copies the user's email address into the supplied buffer, by
269 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
270 and
\helpref{wxGetUserId
}{wxgetuserid
}.
272 Returns TRUE if successful, FALSE otherwise.
274 \wxheading{Include files
}
278 \membersection{::wxGetHostName
}\label{wxgethostname
}
280 \func{wxString
}{wxGetHostName
}{\void}
281 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
283 Copies the current host machine's name into the supplied buffer. Please note
284 that the returned name is
{\it not
} fully qualified, i.e. it does not include
287 Under Windows or NT, this function first looks in the environment
288 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
289 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
291 The first variant of this function returns the hostname if successful or an
292 empty string otherwise. The second (deprecated) function returns TRUE
293 if successful, FALSE otherwise.
295 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
297 \wxheading{Include files
}
301 \section{User identification
}\label{useridfunctions
}
303 \membersection{::wxGetUserId
}\label{wxgetuserid
}
305 \func{wxString
}{wxGetUserId
}{\void}
306 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
308 This function returns the "user id" also known as "login name" under Unix i.e.
309 something like "jsmith". It uniquely identifies the current user (on this system).
311 Under Windows or NT, this function first looks in the environment
312 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
313 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
315 The first variant of this function returns the login name if successful or an
316 empty string otherwise. The second (deprecated) function returns TRUE
317 if successful, FALSE otherwise.
319 See also:
\helpref{wxGetUserName
}{wxgetusername
}
321 \wxheading{Include files
}
325 \membersection{::wxGetUserName
}\label{wxgetusername
}
327 \func{wxString
}{wxGetUserName
}{\void}
328 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
330 This function returns the full user name (something like "Mr. John Smith").
332 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
333 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
334 is running, the entry
{\bf Current
} in the section
{\bf User
} of
335 the PENWIN.INI file is used.
337 The first variant of this function returns the user name if successful or an
338 empty string otherwise. The second (deprecated) function returns TRUE
339 if successful, FALSE otherwise.
341 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
343 \wxheading{Include files
}
347 \section{String functions
}
349 \membersection{::copystring
}
351 \func{char*
}{copystring
}{\param{const char*
}{s
}}
353 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
354 deleted with the
{\it delete
} operator.
356 \membersection{::wxStringMatch
}
358 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
359 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
361 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
362 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
363 no substring matching is done.
365 \membersection{::wxStringEq
}\label{wxstringeq
}
367 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
372 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
375 \membersection{::IsEmpty
}\label{isempty
}
377 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
379 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
380 pointer to this function and it will return TRUE for it.
382 \membersection{::Stricmp
}\label{stricmp
}
384 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
386 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
387 to or greater than
{\it p2
}. The comparison is case-insensitive.
389 This function complements the standard C function
{\it strcmp()
} which performs
390 case-sensitive comparison.
392 \membersection{::Strlen
}\label{strlen
}
394 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
396 This is a safe version of standard function
{\it strlen()
}: it does exactly the
397 same thing (i.e. returns the length of the string) except that it returns
0 if
398 {\it p
} is the NULL pointer.
400 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
402 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
404 This function returns the translation of string
{\it str
} in the current
405 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
406 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
407 original string is returned. In debug build, an error message is logged - this
408 should help to find the strings which were not yet translated. As this function
409 is used very often, an alternative syntax is provided: the
\_() macro is
410 defined as wxGetTranslation().
412 \section{Dialog functions
}\label{dialogfunctions
}
414 Below are a number of convenience functions for getting input from the
415 user or displaying messages. Note that in these functions the last three
416 parameters are optional. However, it is recommended to pass a parent frame
417 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
418 the front when the dialog box is popped up.
420 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
422 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{
423 \param{const wxString\&
}{filename
},
424 \param{size
\_t }{currentTip
}}
426 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
427 used with
\helpref{wxShowTip
}{wxshowtip
}.
429 \docparam{filename
}{The name of the file containing the tips, one per line
}
430 \docparam{currentTip
}{The index of the first tip to show - normally this index
431 is remembered between the
2 program runs.
}
433 \wxheading{See also:
}
435 \helpref{Tips overview
}{tipsoverview
}
437 \wxheading{Include files
}
441 \membersection{::wxFileSelector
}\label{wxfileselector
}
443 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
444 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
445 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
446 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
448 Pops up a file selector box. In Windows, this is the common file selector
449 dialog. In X, this is a file selector box with somewhat less functionality.
450 The path and filename are distinct elements of a full file pathname.
451 If path is empty, the current directory will be used. If filename is empty,
452 no default filename will be supplied. The wildcard determines what files
453 are displayed in the file selector, and file extension supplies a type
454 extension for the required filename. Flags may be a combination of wxOPEN,
455 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0.
457 Both the Unix and Windows versions implement a wildcard filter. Typing a
458 filename containing wildcards
(*, ?) in the filename text item, and
459 clicking on Ok, will result in only those files matching the pattern being
462 The wildcard may be a specification for multiple types of file
463 with a description for each, such as:
466 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
469 The application must check for an empty return value (the user pressed
470 Cancel). For example:
473 const wxString& s = wxFileSelector("Choose a file to open");
480 \wxheading{Include files}
484 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
486 \func{long}{wxGetNumberFromUser}{
487 \param{const wxString\& }{message},
488 \param{const wxString\& }{prompt},
489 \param{const wxString\& }{caption},
490 \param{long }{value},
491 \param{long }{min = 0},
492 \param{long }{max = 100},
493 \param{wxWindow *}{parent = NULL},
494 \param{const wxPoint\& }{pos = wxDefaultPosition}}
496 Shows a dialog asking the user for numeric input. The dialogs title is set to
497 {\it caption}, it contains a (possibly) multiline {\it message} above the
498 single line {\it prompt} and the zone for entering the number.
500 The number entered must be in the range {\it min}..{\it max} (both of which
501 should be positive) and {\it value} is the initial value of it. If the user
502 enters an invalid value or cancels the dialog, the function will return -1.
504 Dialog is centered on its {\it parent} unless an explicit position is given in
507 \wxheading{Include files}
511 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
513 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
514 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
515 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
517 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
518 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
519 or press Cancel to return the empty string.
521 If {\it centre} is TRUE, the message text (which may include new line characters)
522 is centred; if FALSE, the message is left-justified.
524 \wxheading{Include files}
528 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
530 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
531 \param{int }{nsel}, \param{int *}{selection},
532 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
533 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
535 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
536 listbox. The user may choose one or more item(s) and press OK or Cancel.
538 The number of initially selected choices, and array of the selected indices,
539 are passed in; this array will contain the user selections on exit, with
540 the function returning the number of selections. {\it selection} must be
541 as big as the number of choices, in case all are selected.
543 If Cancel is pressed, -1 is returned.
545 {\it choices} is an array of {\it n} strings for the listbox.
547 If {\it centre} is TRUE, the message text (which may include new line characters)
548 is centred; if FALSE, the message is left-justified.
550 \wxheading{Include files}
554 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
556 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
557 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
558 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
560 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
561 listbox. The user may choose an item and press OK to return a string or
562 Cancel to return the empty string.
564 {\it choices} is an array of {\it n} strings for the listbox.
566 If {\it centre} is TRUE, the message text (which may include new line characters)
567 is centred; if FALSE, the message is left-justified.
569 \wxheading{Include files}
573 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
575 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
576 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
577 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
579 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
580 If the user pressed cancel, -1 is returned.
582 \wxheading{Include files}
586 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
588 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
589 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
590 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
592 As {\bf wxGetSingleChoice} but takes an array of client data pointers
593 corresponding to the strings, and returns one of these pointers.
595 \wxheading{Include files}
599 \membersection{::wxMessageBox}\label{wxmessagebox}
601 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
602 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
604 General purpose message dialog. {\it style} may be a bit list of the
605 following identifiers:
607 \begin{twocollist}\itemsep=0pt
608 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
610 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
612 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
613 \twocolitem{wxCENTRE}{Centres the text.}
614 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
615 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
616 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
617 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
620 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
626 int answer = wxMessageBox("Quit program?", "Confirm",
627 wxYES_NO | wxCANCEL, main_frame);
633 {\it message} may contain newline characters, in which case the
634 message will be split into separate lines, to cater for large messages.
636 Under Windows, the native MessageBox function is used unless wxCENTRE
637 is specified in the style, in which case a generic function is used.
638 This is because the native MessageBox function cannot centre text.
639 The symbols are not shown when the generic function is used.
641 \wxheading{Include files}
645 \membersection{::wxShowTip}\label{wxshowtip}
647 \func{bool}{wxShowTip}{
648 \param{wxWindow *}{parent},
649 \param{wxTipProvider *}{tipProvider},
650 \param{bool }{showAtStartup = TRUE}}
652 This function shows a "startup tip" to the user.
654 \docparam{parent}{The parent window for the modal dialog}
656 \docparam{tipProvider}{An object which is used to get the text of the tips.
657 It may be created with
658 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
660 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
661 otherwise. This is used as the initial value for "Show tips at startup"
662 checkbox which is shown in the tips dialog.}
664 \wxheading{See also:}
666 \helpref{Tips overview}{tipsoverview}
668 \wxheading{Include files}
672 \section{GDI functions}\label{gdifunctions}
674 The following are relevant to the GDI (Graphics Device Interface).
676 \wxheading{Include files}
680 \membersection{::wxColourDisplay}
682 \func{bool}{wxColourDisplay}{\void}
684 Returns TRUE if the display is colour, FALSE otherwise.
686 \membersection{::wxDisplayDepth}
688 \func{int}{wxDisplayDepth}{\void}
690 Returns the depth of the display (a value of 1 denotes a monochrome display).
692 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
694 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
695 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
697 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
698 makes it into a placeable metafile by prepending a header containing the given
699 bounding box. The bounding box may be obtained from a device context after drawing
700 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
702 In addition to adding the placeable metafile header, this function adds
703 the equivalent of the following code to the start of the metafile data:
706 SetMapMode(dc, MM_ANISOTROPIC);
707 SetWindowOrg(dc, minX, minY);
708 SetWindowExt(dc, maxX - minX, maxY - minY);
711 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
713 Placeable metafiles may be imported by many Windows applications, and can be
714 used in RTF (Rich Text Format) files.
716 {\it scale} allows the specification of scale for the metafile.
718 This function is only available under Windows.
720 \membersection{::wxSetCursor}\label{wxsetcursor}
722 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
724 Globally sets the cursor; only has an effect in Windows and GTK.
725 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
727 \section{Printer settings}\label{printersettings}
729 These routines are obsolete and should no longer be used!
731 The following functions are used to control PostScript printing. Under
732 Windows, PostScript output can only be sent to a file.
734 \wxheading{Include files}
738 \membersection{::wxGetPrinterCommand}
740 \func{wxString}{wxGetPrinterCommand}{\void}
742 Gets the printer command used to print a file. The default is {\tt lpr}.
744 \membersection{::wxGetPrinterFile}
746 \func{wxString}{wxGetPrinterFile}{\void}
748 Gets the PostScript output filename.
750 \membersection{::wxGetPrinterMode}
752 \func{int}{wxGetPrinterMode}{\void}
754 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
755 The default is PS\_PREVIEW.
757 \membersection{::wxGetPrinterOptions}
759 \func{wxString}{wxGetPrinterOptions}{\void}
761 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
763 \membersection{::wxGetPrinterOrientation}
765 \func{int}{wxGetPrinterOrientation}{\void}
767 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
769 \membersection{::wxGetPrinterPreviewCommand}
771 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
773 Gets the command used to view a PostScript file. The default depends on the platform.
775 \membersection{::wxGetPrinterScaling}
777 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
779 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
781 \membersection{::wxGetPrinterTranslation}
783 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
785 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
787 \membersection{::wxSetPrinterCommand}
789 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
791 Sets the printer command used to print a file. The default is {\tt lpr}.
793 \membersection{::wxSetPrinterFile}
795 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
797 Sets the PostScript output filename.
799 \membersection{::wxSetPrinterMode}
801 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
803 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
804 The default is PS\_PREVIEW.
806 \membersection{::wxSetPrinterOptions}
808 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
810 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
812 \membersection{::wxSetPrinterOrientation}
814 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
816 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
818 \membersection{::wxSetPrinterPreviewCommand}
820 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
822 Sets the command used to view a PostScript file. The default depends on the platform.
824 \membersection{::wxSetPrinterScaling}
826 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
828 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
830 \membersection{::wxSetPrinterTranslation}
832 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
834 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
836 \section{Clipboard functions}\label{clipsboard}
838 These clipboard functions are implemented for Windows only.
840 \wxheading{Include files}
844 \membersection{::wxClipboardOpen}
846 \func{bool}{wxClipboardOpen}{\void}
848 Returns TRUE if this application has already opened the clipboard.
850 \membersection{::wxCloseClipboard}
852 \func{bool}{wxCloseClipboard}{\void}
854 Closes the clipboard to allow other applications to use it.
856 \membersection{::wxEmptyClipboard}
858 \func{bool}{wxEmptyClipboard}{\void}
860 Empties the clipboard.
862 \membersection{::wxEnumClipboardFormats}
864 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
866 Enumerates the formats found in a list of available formats that belong
867 to the clipboard. Each call to this function specifies a known
868 available format; the function returns the format that appears next in
871 {\it dataFormat} specifies a known format. If this parameter is zero,
872 the function returns the first format in the list.
874 The return value specifies the next known clipboard data format if the
875 function is successful. It is zero if the {\it dataFormat} parameter specifies
876 the last format in the list of available formats, or if the clipboard
879 Before it enumerates the formats function, an application must open the clipboard by using the
880 wxOpenClipboard function.
882 \membersection{::wxGetClipboardData}
884 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
886 Gets data from the clipboard.
888 {\it dataFormat} may be one of:
890 \begin{itemize}\itemsep=0pt
891 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
892 \item wxCF\_BITMAP: returns a new wxBitmap.
895 The clipboard must have previously been opened for this call to succeed.
897 \membersection{::wxGetClipboardFormatName}
899 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
901 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
902 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
904 \membersection{::wxIsClipboardFormatAvailable}
906 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
908 Returns TRUE if the given data format is available on the clipboard.
910 \membersection{::wxOpenClipboard}
912 \func{bool}{wxOpenClipboard}{\void}
914 Opens the clipboard for passing data to it or getting data from it.
916 \membersection{::wxRegisterClipboardFormat}
918 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
920 Registers the clipboard data format name and returns an identifier.
922 \membersection{::wxSetClipboardData}
924 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
926 Passes data to the clipboard.
928 {\it dataFormat} may be one of:
930 \begin{itemize}\itemsep=0pt
931 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
932 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
933 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
934 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
937 The clipboard must have previously been opened for this call to succeed.
939 \section{Miscellaneous functions}\label{miscellany}
941 \membersection{::wxNewId}
943 \func{long}{wxNewId}{\void}
945 Generates an integer identifier unique to this run of the program.
947 \wxheading{Include files}
951 \membersection{::wxRegisterId}
953 \func{void}{wxRegisterId}{\param{long}{ id}}
955 Ensures that ids subsequently generated by {\bf NewId} do not clash with
958 \wxheading{Include files}
962 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
964 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
966 Changes the cursor to the given cursor for all windows in the application.
967 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
968 to its previous state. These two calls can be nested, and a counter
969 ensures that only the outer calls take effect.
971 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
973 \wxheading{Include files}
977 \membersection{::wxBell}
979 \func{void}{wxBell}{\void}
981 Ring the system bell.
983 \wxheading{Include files}
987 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
989 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
991 Creates and returns an object of the given class, if the class has been
992 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
994 \membersection{::wxDDECleanUp}\label{wxddecleanup}
996 \func{void}{wxDDECleanUp}{\void}
998 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
999 called by the application.
1001 See also helpref{wxDDEInitialize}{wxddeinitialize}.
1003 \wxheading{Include files}
1007 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
1009 \func{void}{wxDDEInitialize}{\void}
1011 Initializes the DDE system. May be called multiple times without harm.
1013 This no longer needs to be called by the application: it will be called
1014 by wxWindows if necessary.
1016 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
1017 \helpref{wxDDECleanUp}{wxddecleanup}.
1019 \wxheading{Include files}
1023 \membersection{::wxDebugMsg}\label{wxdebugmsg}
1025 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
1027 Display a debugging message; under Windows, this will appear on the
1028 debugger command window, and under Unix, it will be written to standard
1031 The syntax is identical to {\bf printf}: pass a format string and a
1032 variable list of arguments.
1034 Note that under Windows, you can see the debugging messages without a
1035 debugger if you have the DBWIN debug log application that comes with
1038 {\bf Tip:} under Windows, if your application crashes before the
1039 message appears in the debugging window, put a wxYield call after
1040 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1041 (at least for Watcom C++): preformat your messages and use OutputDebugString
1044 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1046 \wxheading{Include files}
1050 \membersection{::wxDisplaySize}
1052 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1054 Gets the physical size of the display in pixels.
1056 \wxheading{Include files}
1060 \membersection{::wxEntry}\label{wxentry}
1062 This initializes wxWindows in a platform-dependent way. Use this if you
1063 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1064 you can initialize wxWindows from an Microsoft Foundation Classes application using
1067 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1068 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1070 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1071 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1072 message loop will be entered.
1074 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1075 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1077 wxWindows initialization under Windows (for applications constructed as a DLL).
1079 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1081 wxWindows initialization under Unix.
1085 To clean up wxWindows, call wxApp::OnExit followed by the static function
1086 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1089 int CTheApp::ExitInstance()
1091 // OnExit isn't called by CleanUp so must be called explicitly.
1095 return CWinApp::ExitInstance();
1099 \wxheading{Include files}
1103 \membersection{::wxError}\label{wxerror}
1105 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1107 Displays {\it msg} and continues. This writes to standard error under
1108 Unix, and pops up a message box under Windows. Used for internal
1109 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
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{::wxExecute}\label{wxexecute}
1130 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1132 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1134 Executes another program in Unix or Windows.
1136 The first form takes a command string, such as {\tt "emacs file.txt"}.
1138 The second form takes an array of values: a command, any number of
1139 arguments, terminated by NULL.
1141 If {\it sync} is FALSE (the default), flow of control immediately returns.
1142 If TRUE, the current application waits until the other program has terminated.
1144 In the case of synchronous execution, the return value is the exit code of
1145 the process (which terminates by the moment the function returns) and will be
1146 $-1$ if the process couldn't be started and typically 0 if the process
1147 terminated successfully. Also, while waiting for the process to
1148 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1149 should ensure that this can cause no recursion, in the simples case by
1150 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1152 For asynchronous execution, however, the return value is the process id and
1153 zero value indicates that the command could not be executed.
1155 If callback isn't NULL and if execution is asynchronous (note that callback
1156 parameter can not be non NULL for synchronous execution),
1157 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1158 the process finishes.
1160 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1162 \wxheading{Include files}
1166 \membersection{::wxExit}\label{wxexit}
1168 \func{void}{wxExit}{\void}
1170 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1171 Should only be used in an emergency: normally the top-level frame
1172 should be deleted (after deleting all other frames) to terminate the
1173 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1175 \wxheading{Include files}
1179 \membersection{::wxFatalError}\label{wxfatalerror}
1181 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1183 Displays {\it msg} and exits. This writes to standard error under Unix,
1184 and pops up a message box under Windows. Used for fatal internal
1185 wxWindows errors. See also \helpref{wxError}{wxerror}.
1187 \wxheading{Include files}
1191 \membersection{::wxFindMenuItemId}
1193 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1195 Find a menu item identifier associated with the given frame's menu bar.
1197 \wxheading{Include files}
1201 \membersection{::wxFindWindowByLabel}
1203 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1205 Find a window by its label. Depending on the type of window, the label may be a window title
1206 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1207 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1208 The search is recursive in both cases.
1210 \wxheading{Include files}
1214 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1216 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1218 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1219 If {\it parent} is NULL, the search will start from all top-level
1220 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1221 The search is recursive in both cases.
1223 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1225 \wxheading{Include files}
1229 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1231 \func{wxWindow *}{wxGetActiveWindow}{\void}
1233 Gets the currently active window (Windows only).
1235 \wxheading{Include files}
1239 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1241 \func{wxString}{wxGetDisplayName}{\void}
1243 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1245 \wxheading{Include files}
1249 \membersection{::wxGetHomeDir}
1251 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1253 Fills the buffer with a string representing the user's home directory (Unix only).
1255 \wxheading{Include files}
1259 \membersection{::wxGetHostName}
1261 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1263 Copies the host name of the machine the program is running on into the
1264 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1265 successful. Under Unix, this will return a machine name. Under Windows,
1266 this returns ``windows''.
1268 \wxheading{Include files}
1272 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1274 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1276 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1278 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1281 See also \helpref{wxTimer}{wxtimer}.
1283 \wxheading{Include files}
1287 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1289 \func{long}{wxGetFreeMemory}{\void}
1291 Returns the amount of free memory in Kbytes under environments which
1292 support it, and -1 if not supported. Currently, returns a positive value
1293 under Windows, and -1 under Unix.
1295 \wxheading{Include files}
1299 \membersection{::wxGetMousePosition}
1301 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1303 Returns the mouse position in screen coordinates.
1305 \wxheading{Include files}
1309 \membersection{::wxGetOsVersion}
1311 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1313 Gets operating system version information.
1315 \begin{twocollist}\itemsep=0pt
1316 \twocolitemruled{Platform}{Return tyes}
1317 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1318 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1319 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1320 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1321 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1322 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1323 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1324 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1325 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1328 \wxheading{Include files}
1332 \membersection{::wxGetResource}\label{wxgetresource}
1334 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1335 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1337 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1338 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1340 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1341 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1343 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1344 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1346 Gets a resource value from the resource database (for example, WIN.INI, or
1347 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1348 otherwise the specified file is used.
1350 Under X, if an application class (wxApp::GetClassName) has been defined,
1351 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1352 an applications default file when merging all resource databases.
1354 The reason for passing the result in an argument is that it
1355 can be convenient to define a default value, which gets overridden
1356 if the value exists in the resource file. It saves a separate
1357 test for that resource's existence, and it also allows
1358 the overloading of the function for different types.
1360 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1362 \wxheading{Include files}
1366 \membersection{::wxGetUserId}
1368 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1370 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1371 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1372 Under Windows, this returns ``user''.
1374 \wxheading{Include files}
1378 \membersection{::wxGetUserName}
1380 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1382 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1383 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1384 Under Windows, this returns ``unknown''.
1386 \wxheading{Include files}
1390 \membersection{::wxKill}\label{wxkill}
1392 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1394 Under Unix (the only supported platform), equivalent to the Unix kill function.
1395 Returns 0 on success, -1 on failure.
1397 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1398 It does not raise a signal in the receiving process.
1400 \wxheading{Include files}
1404 \membersection{::wxIsBusy}\label{wxisbusy}
1406 \func{bool}{wxIsBusy}{\void}
1408 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1409 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1411 See also \helpref{wxBusyCursor}{wxbusycursor}.
1413 \wxheading{Include files}
1417 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1419 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1421 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1422 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1424 The resource must be defined in the {\tt .rc} file using the following syntax:
1427 myResource TEXT file.ext
1430 where {\tt file.ext} is a file that the resource compiler can find.
1432 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1433 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1434 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1436 This function is available under Windows only.
1438 \wxheading{Include files}
1442 \membersection{::wxNow}\label{wxnow}
1444 \func{wxString}{wxNow}{\void}
1446 Returns a string representing the current date and time.
1448 \wxheading{Include files}
1452 \membersection{::wxPostDelete}\label{wxpostdelete}
1454 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1456 Tells the system to delete the specified object when
1457 all other events have been processed. In some environments, it is
1458 necessary to use this instead of deleting a frame directly with the
1459 delete operator, because some GUIs will still send events to a deleted window.
1461 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1463 \wxheading{Include files}
1467 \membersection{::wxSafeYield}\label{wxsafeyield}
1469 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1471 This function is similar to wxYield, except that it disables the user input to
1472 all program windows before calling wxYield and re-enables it again
1473 afterwards. If {\it win} is not NULL, this window will remain enabled,
1474 allowing the implementation of some limited user interaction.
1476 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1478 \wxheading{Include files}
1482 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1484 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1486 This function enables or disables all top level windows. It is used by
1487 \helpref{::wxSafeYield}{wxsafeyield}.
1489 \wxheading{Include files}
1494 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1496 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1498 Under X only, sets the current display name. This is the X host and display name such
1499 as ``colonsay:0.0", and the function indicates which display should be used for creating
1500 windows from this point on. Setting the display within an application allows multiple
1501 displays to be used.
1503 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1505 \wxheading{Include files}
1509 \membersection{::wxShell}\label{wxshell}
1511 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1513 Executes a command in an interactive shell window. If no command is
1514 specified, then just the shell is spawned.
1516 See also \helpref{wxExecute}{wxexecute}.
1518 \wxheading{Include files}
1522 \membersection{::wxSleep}\label{wxsleep}
1524 \func{void}{wxSleep}{\param{int}{ secs}}
1526 Sleeps for the specified number of seconds.
1528 \wxheading{Include files}
1532 \membersection{::wxStripMenuCodes}
1534 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1536 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1538 Strips any menu codes from {\it in} and places the result
1539 in {\it out} (or returns the new string, in the first form).
1541 Menu codes include \& (mark the next character with an underline
1542 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1544 \wxheading{Include files}
1548 \membersection{::wxStartTimer}\label{wxstarttimer}
1550 \func{void}{wxStartTimer}{\void}
1552 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1554 See also \helpref{wxTimer}{wxtimer}.
1556 \wxheading{Include files}
1560 \membersection{::wxToLower}\label{wxtolower}
1562 \func{char}{wxToLower}{\param{char }{ch}}
1564 Converts the character to lower case. This is implemented as a macro for efficiency.
1566 \wxheading{Include files}
1570 \membersection{::wxToUpper}\label{wxtoupper}
1572 \func{char}{wxToUpper}{\param{char }{ch}}
1574 Converts the character to upper case. This is implemented as a macro for efficiency.
1576 \wxheading{Include files}
1580 \membersection{::wxTrace}\label{wxtrace}
1582 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1584 Takes printf-style variable argument syntax. Output
1585 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1587 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1589 \wxheading{Include files}
1593 \membersection{::wxTraceLevel}\label{wxtracelevel}
1595 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1597 Takes printf-style variable argument syntax. Output
1598 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1599 The first argument should be the level at which this information is appropriate.
1600 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1603 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1605 \wxheading{Include files}
1609 \membersection{::wxUsleep}\label{wxusleep}
1611 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1613 Sleeps for the specified number of milliseconds. Notice that usage of this
1614 function is encouraged instead of calling usleep(3) directly because the
1615 standard usleep() function is not MT safe.
1617 \wxheading{Include files}
1621 \membersection{::wxWriteResource}\label{wxwriteresource}
1623 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1624 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1626 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1627 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1629 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1630 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1632 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1633 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1635 Writes a resource value into the resource database (for example, WIN.INI, or
1636 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1637 otherwise the specified file is used.
1639 Under X, the resource databases are cached until the internal function
1640 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1641 all updated resource databases are written to their files.
1643 Note that it is considered bad manners to write to the .Xdefaults
1644 file under Unix, although the WIN.INI file is fair game under Windows.
1646 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1648 \wxheading{Include files}
1652 \membersection{::wxYield}\label{wxyield}
1654 \func{bool}{wxYield}{\void}
1656 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1657 time-consuming process writes to a text window. Without an occasional
1658 yield, the text window will not be updated properly, and (since Windows
1659 multitasking is cooperative) other processes will not respond.
1661 Caution should be exercised, however, since yielding may allow the
1662 user to perform actions which are not compatible with the current task.
1663 Disabling menu items or whole menus during processing can avoid unwanted
1664 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1667 \wxheading{Include files}
1671 \section{Macros}\label{macros}
1673 These macros are defined in wxWindows.
1675 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1677 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1679 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1681 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1683 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1685 This macro will swap the bytes of the {\it value} variable from little
1686 endian to big endian or vice versa.
1688 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1690 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1692 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1694 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1696 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1698 This macro will swap the bytes of the {\it value} variable from little
1699 endian to big endian or vice versa if the program is compiled on a
1700 big-endian architecture (such as Sun work stations). If the program has
1701 been compiled on a little-endian architecture, the value will be unchanged.
1703 Use these macros to read data from and write data to a file that stores
1704 data in little endian (Intel i386) format.
1706 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1708 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1710 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1712 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1714 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1716 This macro will swap the bytes of the {\it value} variable from little
1717 endian to big endian or vice versa if the program is compiled on a
1718 little-endian architecture (such as Intel PCs). If the program has
1719 been compiled on a big-endian architecture, the value will be unchanged.
1721 Use these macros to read data from and write data to a file that stores
1722 data in big endian format.
1724 \membersection{CLASSINFO}\label{classinfo}
1726 \func{wxClassInfo *}{CLASSINFO}{className}
1728 Returns a pointer to the wxClassInfo object associated with this class.
1730 \wxheading{Include files}
1734 \membersection{DECLARE\_ABSTRACT\_CLASS}
1736 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1738 Used inside a class declaration to declare that the class should be
1739 made known to the class hierarchy, but objects of this class cannot be created
1740 dynamically. The same as DECLARE\_CLASS.
1745 class wxCommand: public wxObject
1747 DECLARE_ABSTRACT_CLASS(wxCommand)
1756 \wxheading{Include files}
1760 \membersection{DECLARE\_APP}\label{declareapp}
1762 \func{}{DECLARE\_APP}{className}
1764 This is used in headers to create a forward declaration of the wxGetApp function implemented
1765 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1773 \wxheading{Include files}
1777 \membersection{DECLARE\_CLASS}
1779 \func{}{DECLARE\_CLASS}{className}
1781 Used inside a class declaration to declare that the class should be
1782 made known to the class hierarchy, but objects of this class cannot be created
1783 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1785 \wxheading{Include files}
1789 \membersection{DECLARE\_DYNAMIC\_CLASS}
1791 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1793 Used inside a class declaration to declare that the objects of this class should be dynamically
1794 createable from run-time type information.
1799 class wxFrame: public wxWindow
1801 DECLARE_DYNAMIC_CLASS(wxFrame)
1804 const wxString\& frameTitle;
1810 \wxheading{Include files}
1814 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1816 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1818 Used in a C++ implementation file to complete the declaration of
1819 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1824 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1826 wxCommand::wxCommand(void)
1832 \wxheading{Include files}
1836 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1838 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1840 Used in a C++ implementation file to complete the declaration of
1841 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1843 \wxheading{Include files}
1847 \membersection{IMPLEMENT\_APP}\label{implementapp}
1849 \func{}{IMPLEMENT\_APP}{className}
1851 This is used in the application class implementation file to make the application class known to
1852 wxWindows for dynamic construction. You use this instead of
1863 IMPLEMENT_APP(MyApp)
1866 See also \helpref{DECLARE\_APP}{declareapp}.
1868 \wxheading{Include files}
1872 \membersection{IMPLEMENT\_CLASS}
1874 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1876 Used in a C++ implementation file to complete the declaration of
1877 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1879 \wxheading{Include files}
1883 \membersection{IMPLEMENT\_CLASS2}
1885 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1887 Used in a C++ implementation file to complete the declaration of a
1888 class that has run-time type information and two base classes. The
1889 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1891 \wxheading{Include files}
1895 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1897 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1899 Used in a C++ implementation file to complete the declaration of
1900 a class that has run-time type information, and whose instances
1901 can be created dynamically.
1906 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1908 wxFrame::wxFrame(void)
1914 \wxheading{Include files}
1918 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1920 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1922 Used in a C++ implementation file to complete the declaration of
1923 a class that has run-time type information, and whose instances
1924 can be created dynamically. Use this for classes derived from two
1927 \wxheading{Include files}
1931 \membersection{wxBITMAP}\label{wxbitmap}
1933 \func{}{wxBITMAP}{bitmapName}
1935 This macro loads a bitmap from either application resources (on the platforms
1936 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
1937 avoid using {\tt #ifdef}s when creating bitmaps.
1939 \wxheading{See also}
1941 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
1942 \helpref{wxICON}{wxicon}
1944 \wxheading{Include files}
1948 \membersection{WXDEBUG\_NEW}\label{debugnew}
1950 \func{}{WXDEBUG\_NEW}{arg}
1952 This is defined in debug mode to be call the redefined new operator
1953 with filename and line number arguments. The definition is:
1956 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1959 In non-debug mode, this is defined as the normal new operator.
1961 \wxheading{Include files}
1965 \membersection{wxDynamicCast}\label{wxdynamiccast}
1967 \func{}{wxDynamicCast}{ptr, classname}
1969 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1970 the pointer is of this type (the check is done during the run-time) or NULL
1971 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1974 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1979 wxWindow *win = wxWindow::FindFocus();
1980 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1983 // a text control has the focus...
1987 // no window has the focus or it's not a text control
1991 \wxheading{See also}
1993 \helpref{RTTI overview}{runtimeclassoverview}
1995 \membersection{wxICON}\label{wxicon}
1997 \func{}{wxICON}{iconName}
1999 This macro loads an icon from either application resources (on the platforms
2000 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2001 avoid using {\tt #ifdef}s when creating icons.
2003 \wxheading{See also}
2005 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2006 \helpref{wxBITMAP}{wxbitmap}
2008 \wxheading{Include files}
2012 \membersection{WXTRACE}\label{trace}
2014 \wxheading{Include files}
2018 \func{}{WXTRACE}{formatString, ...}
2020 Calls wxTrace with printf-style variable argument syntax. Output
2021 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2023 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2025 \wxheading{Include files}
2029 \membersection{WXTRACELEVEL}\label{tracelevel}
2031 \func{}{WXTRACELEVEL}{level, formatString, ...}
2033 Calls wxTraceLevel with printf-style variable argument syntax. Output
2034 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
2035 The first argument should be the level at which this information is appropriate.
2036 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
2039 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
2041 \wxheading{Include files}
2045 \section{wxWindows resource functions}\label{resourcefuncs}
2047 \overview{wxWindows resource system}{resourceformats}
2049 This section details functions for manipulating wxWindows (.WXR) resource
2050 files and loading user interface elements from resources.
2052 \normalbox{Please note that this use of the word `resource' is different from that used when talking
2053 about initialisation file resource reading and writing, using such functions
2054 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
2056 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
2058 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
2059 loading from resource data.
2061 {\bf Warning:} this needs updating for wxWindows 2.
2063 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
2065 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
2067 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
2068 \verb$#$defining a name to an integer). Unlikely to be used by an application except
2069 perhaps for implementing resource functionality for interpreted languages.
2071 \membersection{::wxResourceClear}
2073 \func{void}{wxResourceClear}{\void}
2075 Clears the wxWindows resource table.
2077 \membersection{::wxResourceCreateBitmap}
2079 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2081 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2082 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2086 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2087 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2088 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2091 then this function can be called as follows:
2094 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2097 \membersection{::wxResourceCreateIcon}
2099 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2101 Creates a new icon from a file, static data, or Windows resource, given a valid
2102 wxWindows icon resource identifier. For example, if the .WXR file contains
2106 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2107 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2108 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2111 then this function can be called as follows:
2114 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2117 \membersection{::wxResourceCreateMenuBar}
2119 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2121 Creates a new menu bar given a valid wxWindows menubar resource
2122 identifier. For example, if the .WXR file contains the following:
2125 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2129 ['&Open File', 2, 'Open a file'],\
2130 ['&Save File', 3, 'Save a file'],\
2132 ['E&xit', 4, 'Exit program']\
2135 ['&About', 6, 'About this program']\
2140 then this function can be called as follows:
2143 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2147 \membersection{::wxResourceGetIdentifier}
2149 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2151 Used for retrieving the integer value associated with an identifier.
2152 A zero value indicates that the identifier was not found.
2154 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2156 \membersection{::wxResourceParseData}\label{wxresourcedata}
2158 \func{bool}{wxResourceParseData}{\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 in the following form:
2168 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 including a {\tt .wxr} file into
2182 a C++ program as follows:
2185 #include "dialog1.wxr"
2188 Each of the contained resources will declare a new C++ variable, and each
2189 of these variables should be passed to wxResourceParseData.
2191 \membersection{::wxResourceParseFile}
2193 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2195 Parses a file containing one or more wxWindows resource objects
2196 in C++-compatible syntax. Use this function to dynamically load
2197 wxWindows resource data.
2199 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2201 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2203 Parses a string containing one or more wxWindows resource objects. If
2204 the resource objects are global static data that are included into the
2205 C++ program, then this function must be called for each variable
2206 containing the resource data, to make it known to wxWindows.
2208 {\it resource} should contain data with the following form:
2211 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2212 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2213 title = 'Test dialog box',\
2214 x = 312, y = 234, width = 400, height = 300,\
2216 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2217 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2218 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2219 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2220 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2221 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2224 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2225 load an entire {\tt .wxr file} into a string.
2227 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2229 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2230 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2232 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2234 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2235 This is required if other resources will use the bitmap data, since otherwise there
2236 is no connection between names used in resources, and the global bitmap data.
2238 \membersection{::wxResourceRegisterIconData}
2240 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2242 \section{Log functions}\label{logfunctions}
2244 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2245 further information.
2247 \wxheading{Include files}
2251 \membersection{::wxLogError}\label{wxlogerror}
2253 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2255 The function to use for error messages, i.e. the
2256 messages that must be shown to the user. The default processing is to pop up a
2257 message box to inform the user about it.
2259 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2261 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2263 Like \helpref{wxLogError}{wxlogerror}, but also
2264 terminates the program with the exit code 3. Using {\it abort()} standard
2265 function also terminates the program with this exit code.
2267 \membersection{::wxLogWarning}\label{wxlogwarning}
2269 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2271 For warnings - they are also normally shown to the
2272 user, but don't interrupt the program work.
2274 \membersection{::wxLogMessage}\label{wxlogmessage}
2276 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2278 for all normal, informational messages. They also
2279 appear in a message box by default (but it can be changed). Notice
2280 that the standard behaviour is to not show informational messages if there are
2281 any errors later - the logic being that the later error messages make the
2282 informational messages preceding them meaningless.
2284 \membersection{::wxLogVerbose}\label{wxlogverbose}
2286 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2288 For verbose output. Normally, it's suppressed, but
2289 might be activated if the user wishes to know more details about the program
2290 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2292 \membersection{::wxLogStatus}\label{wxlogstatus}
2294 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2296 For status messages - they will go into the status
2297 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2299 \membersection{::wxLogSysError}\label{wxlogsyserror}
2301 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2303 Mostly used by wxWindows itself, but might be
2304 handy for logging errors after system call (API function) failure. It logs the
2305 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2306 on the platform) and the corresponding error
2307 message. The second form of this function takes the error code explitly as the
2310 \membersection{::wxLogDebug}\label{wxlogdebug}
2312 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2314 The right function for debug output. It only
2315 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2316 and expands to nothing in release mode (otherwise).
2318 \membersection{::wxLogTrace}\label{wxlogtrace}
2320 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2322 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2324 As {\bf wxLogDebug}, only does something in debug
2325 build. The reason for making it a separate function from it is that usually
2326 there are a lot of trace messages, so it might make sense to separate them
2327 from other debug messages which would be flooded in them. Moreover, the second
2328 version of this function takes a trace mask as the first argument which allows
2329 to further restrict the amount of messages generated. The value of {\it mask} can be:
2331 \begin{itemize}\itemsep=0pt
2332 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2333 \item wxTraceMessages: trace window messages/X callbacks
2334 \item wxTraceResAlloc: trace GDI resource allocation
2335 \item wxTraceRefCount: trace various ref counting operations
2338 \section{Debugging macros and functions}\label{debugmacros}
2340 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2341 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2344 \wxheading{Include files}
2348 \membersection{::wxOnAssert}\label{wxonassert}
2350 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2352 This function may be redefined to do something non trivial and is called
2353 whenever one of debugging macros fails (i.e. condition is false in an
2355 % TODO: this should probably be an overridable in wxApp.
2357 \membersection{wxASSERT}\label{wxassert}
2359 \func{}{wxASSERT}{\param{}{condition}}
2361 Assert macro. An error message will be generated if the condition is FALSE in
2362 debug mode, but nothing will be done in the release build.
2364 Please note that the condition in wxASSERT() should have no side effects
2365 because it will not be executed in release mode at all.
2367 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2369 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2371 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2373 Assert macro with message. An error message will be generated if the condition is FALSE.
2375 See also: \helpref{wxASSERT}{wxassert}
2377 \membersection{wxFAIL}\label{wxfail}
2379 \func{}{wxFAIL}{\void}
2381 Will always generate an assert error if this code is reached (in debug mode).
2383 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2385 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2387 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2389 Will always generate an assert error with specified message if this code is reached (in debug mode).
2391 This macro is useful for marking unreachable" code areas, for example
2392 it may be used in the "default:" branch of a switch statement if all possible
2393 cases are processed above.
2395 See also: \helpref{wxFAIL}{wxfail}
2397 \membersection{wxCHECK}\label{wxcheck}
2399 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2401 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2402 This check is done even in release mode.
2404 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2406 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2408 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2409 This check is done even in release mode.
2411 This macro may be only used in non void functions, see also
2412 \helpref{wxCHECK\_RET}{wxcheckret}.
2414 \membersection{wxCHECK\_RET}\label{wxcheckret}
2416 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2418 Checks that the condition is true, and returns if not (FAILs with given error
2419 message in debug mode). This check is done even in release mode.
2421 This macro should be used in void functions instead of
2422 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2424 \membersection{wxCHECK2}\label{wxcheck2}
2426 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2428 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2429 {\it operation} if it is not. This is a generalisation of
2430 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2431 returning from the function must be done when the {\it condition} is false.
2433 This check is done even in release mode.
2435 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2437 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2439 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2440 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2441 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob