1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions defined in wxWindows are described here.
7 \section{File functions
}\label{filefunctions
}
9 \wxheading{Include files
}
15 \helpref{wxPathList
}{wxpathlist
}
17 \membersection{::wxDirExists
}
19 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
21 Returns TRUE if the directory exists.
23 \membersection{::wxDos2UnixFilename
}
25 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
27 Converts a DOS to a Unix filename by replacing backslashes with forward
30 \membersection{::wxFileExists
}
32 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
34 Returns TRUE if the file exists.
36 \membersection{::wxFileNameFromPath
}
38 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
40 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
42 Returns the filename for a full path. The second form returns a pointer to
43 temporary storage that should not be deallocated.
45 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
47 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
49 This function does directory searching; returns the first file
50 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
51 get the next matching file.
53 {\it spec
} may contain wildcards.
55 {\it flags
} is reserved for future use.
60 wxString f = wxFindFirstFile("/home/project/*.*");
61 while ( !f.IsEmpty() )
68 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
70 \func{wxString
}{wxFindNextFile
}{\void}
72 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
74 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
76 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
78 \func{wxString
}{wxGetOSDirectory
}{\void}
80 Returns the Windows directory under Windows; on other platforms returns the empty string.
82 \membersection{::wxIsAbsolutePath
}
84 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
86 Returns TRUE if the argument is an absolute filename, i.e. with a slash
87 or drive name at the beginning.
89 \membersection{::wxPathOnly
}
91 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
93 Returns the directory part of the filename.
95 \membersection{::wxUnix2DosFilename
}
97 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
99 Converts a Unix to a DOS filename by replacing forward
100 slashes with backslashes.
102 \membersection{::wxConcatFiles
}
104 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
105 \param{const wxString\&
}{file3
}}
107 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
110 \membersection{::wxCopyFile
}
112 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
114 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
116 \membersection{::wxGetCwd
}\label{wxgetcwd
}
118 \func{wxString
}{wxGetCwd
}{\void}
120 Returns a string containing the current (or working) directory.
122 \membersection{::wxGetWorkingDirectory
}
124 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
126 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
128 Copies the current working directory into the buffer if supplied, or
129 copies the working directory into new storage (which you must delete yourself)
130 if the buffer is NULL.
132 {\it sz
} is the size of the buffer if supplied.
134 \membersection{::wxGetTempFileName
}
136 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
138 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
139 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
140 is allocated for the temporary filename using
{\it new
}.
142 Under Windows, the filename will include the drive and name of the
143 directory allocated for temporary files (usually the contents of the
144 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
146 It is the application's responsibility to create and delete the file.
148 \membersection{::wxIsWild
}\label{wxiswild
}
150 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
152 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
154 \membersection{::wxMatchWild
}\label{wxmatchwild
}
156 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
158 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
159 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
160 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
162 \membersection{::wxMkdir
}
164 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
166 Makes the directory
{\it dir
}, returning TRUE if successful.
168 {\it perm
} is the access mask for the directory for the systems on which it is
169 supported (Unix) and doesn't have effect for the other ones.
171 \membersection{::wxRemoveFile
}
173 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
175 Removes
{\it file
}, returning TRUE if successful.
177 \membersection{::wxRenameFile
}
179 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
181 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
183 \membersection{::wxRmdir
}
185 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
187 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
189 The
{\it flags
} parameter is reserved for future use.
191 \membersection{::wxSetWorkingDirectory
}
193 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
195 Sets the current working directory, returning TRUE if the operation succeeded.
196 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
198 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
200 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
202 This function splits a full file name into components: the path (including possible disk/drive
203 specification under Windows), the base name and the extension. Any of the output parameters
204 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
205 a particular component.
207 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
208 Windows, however it will not consider backslashes as path separators under Unix (where backslash
209 is a valid character in a filename).
211 On entry,
{\it fullname
} should be non NULL (it may be empty though).
213 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
214 contains the file name and
{\it ext
} contains the file extension without leading dot. All
215 three of them may be empty if the corresponding component is. The old contents of the
216 strings pointed to by these parameters will be overwritten in any case (if the pointers
219 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
221 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
223 Copies the given file to
{\it stream
}. Useful when converting an old application to
224 use streams (within the
document/view framework, for example).
226 Use of this function requires the file wx
\_doc.h to be included.
228 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
230 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
232 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
233 use streams (within the
document/view framework, for example).
235 Use of this function requires the file wx
\_doc.h to be included.
237 \section{Network functions
}\label{networkfunctions
}
239 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
241 \func{wxString
}{wxGetFullHostName
}{\void}
243 Returns the FQDN (fully qualified domain host name) or an empty string on
246 See also:
\helpref{wxGetHostName
}{wxgethostname
}
248 \wxheading{Include files
}
252 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
254 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
256 Copies the user's email address into the supplied buffer, by
257 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
258 and
\helpref{wxGetUserId
}{wxgetuserid
}.
260 Returns TRUE if successful, FALSE otherwise.
262 \wxheading{Include files
}
266 \membersection{::wxGetHostName
}\label{wxgethostname
}
268 \func{wxString
}{wxGetHostName
}{\void}
269 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
271 Copies the current host machine's name into the supplied buffer. Please note
272 that the returned name is
{\it not
} fully qualified, i.e. it does not include
275 Under Windows or NT, this function first looks in the environment
276 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
277 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
279 The first variant of this function returns the hostname if successful or an
280 empty string otherwise. The second (deprecated) function returns TRUE
281 if successful, FALSE otherwise.
283 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
285 \wxheading{Include files
}
289 \section{User identification
}\label{useridfunctions
}
291 \membersection{::wxGetUserId
}\label{wxgetuserid
}
293 \func{wxString
}{wxGetUserId
}{\void}
294 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
296 This function returns the "user id" also known as "login name" under Unix i.e.
297 something like "jsmith". It uniquely identifies the current user (on this system).
299 Under Windows or NT, this function first looks in the environment
300 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
301 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
303 The first variant of this function returns the login name if successful or an
304 empty string otherwise. The second (deprecated) function returns TRUE
305 if successful, FALSE otherwise.
307 See also:
\helpref{wxGetUserName
}{wxgetusername
}
309 \wxheading{Include files
}
313 \membersection{::wxGetUserName
}\label{wxgetusername
}
315 \func{wxString
}{wxGetUserName
}{\void}
316 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
318 This function returns the full user name (something like "Mr. John Smith").
320 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
321 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
322 is running, the entry
{\bf Current
} in the section
{\bf User
} of
323 the PENWIN.INI file is used.
325 The first variant of this function returns the user name if successful or an
326 empty string otherwise. The second (deprecated) function returns TRUE
327 if successful, FALSE otherwise.
329 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
331 \wxheading{Include files
}
335 \section{String functions
}
337 \membersection{::copystring
}
339 \func{char*
}{copystring
}{\param{const char*
}{s
}}
341 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
342 deleted with the
{\it delete
} operator.
344 \membersection{::wxStringMatch
}
346 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
347 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
349 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
350 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
351 no substring matching is done.
353 \membersection{::wxStringEq
}\label{wxstringeq
}
355 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
360 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
363 \membersection{::IsEmpty
}\label{isempty
}
365 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
367 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
368 pointer to this function and it will return TRUE for it.
370 \membersection{::Stricmp
}\label{stricmp
}
372 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
374 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
375 to or greater than
{\it p2
}. The comparison is case-insensitive.
377 This function complements the standard C function
{\it strcmp()
} which performs
378 case-sensitive comparison.
380 \membersection{::Strlen
}\label{strlen
}
382 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
384 This is a safe version of standard function
{\it strlen()
}: it does exactly the
385 same thing (i.e. returns the length of the string) except that it returns
0 if
386 {\it p
} is the NULL pointer.
388 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
390 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
392 This function returns the translation of string
{\it str
} in the current
393 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
394 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
395 original string is returned. In debug build, an error message is logged - this
396 should help to find the strings which were not yet translated. As this function
397 is used very often, an alternative syntax is provided: the
\_() macro is
398 defined as wxGetTranslation().
400 \section{Dialog functions
}\label{dialogfunctions
}
402 Below are a number of convenience functions for getting input from the
403 user or displaying messages. Note that in these functions the last three
404 parameters are optional. However, it is recommended to pass a parent frame
405 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
406 the front when the dialog box is popped up.
408 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
410 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{
411 \param{const wxString\&
}{filename
},
412 \param{size
\_t }{currentTip
}}
414 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
415 used with
\helpref{wxShowTip
}{wxshowtip
}.
417 \docparam{filename
}{The name of the file containing the tips, one per line
}
418 \docparam{currentTip
}{The index of the first tip to show - normally this index
419 is remembered between the
2 program runs.
}
421 \wxheading{See also:
}
423 \helpref{Tips overview
}{tipsoverview
}
425 \wxheading{Include files
}
429 \membersection{::wxFileSelector
}\label{wxfileselector
}
431 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
432 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
433 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
434 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
436 Pops up a file selector box. In Windows, this is the common file selector
437 dialog. In X, this is a file selector box with somewhat less functionality.
438 The path and filename are distinct elements of a full file pathname.
439 If path is empty, the current directory will be used. If filename is empty,
440 no default filename will be supplied. The wildcard determines what files
441 are displayed in the file selector, and file extension supplies a type
442 extension for the required filename. Flags may be a combination of wxOPEN,
443 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
444 at present in Windows.
446 Both the X and Windows versions implement a wildcard filter. Typing a
447 filename containing wildcards
(*, ?) in the filename text item, and
448 clicking on Ok, will result in only those files matching the pattern being
449 displayed. In the X version, supplying no default name will result in the
450 wildcard filter being inserted in the filename text item; the filter is
451 ignored if a default name is supplied.
453 Under Windows (only), the wildcard may be a specification for multiple
454 types of file with a description for each, such as:
457 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
460 The application must check for an empty return value (the user pressed
461 Cancel). For example:
464 const wxString& s = wxFileSelector("Choose a file to open");
471 \wxheading{Include files}
475 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
477 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
478 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
479 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
481 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
482 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
483 or press Cancel to return the empty string.
485 If {\it centre} is TRUE, the message text (which may include new line characters)
486 is centred; if FALSE, the message is left-justified.
488 \wxheading{Include files}
492 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
494 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
495 \param{int }{nsel}, \param{int *}{selection},
496 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
497 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
499 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
500 listbox. The user may choose one or more item(s) and press OK or Cancel.
502 The number of initially selected choices, and array of the selected indices,
503 are passed in; this array will contain the user selections on exit, with
504 the function returning the number of selections. {\it selection} must be
505 as big as the number of choices, in case all are selected.
507 If Cancel is pressed, -1 is returned.
509 {\it choices} is an array of {\it n} strings for the listbox.
511 If {\it centre} is TRUE, the message text (which may include new line characters)
512 is centred; if FALSE, the message is left-justified.
514 \wxheading{Include files}
518 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
520 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
521 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
522 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
524 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
525 listbox. The user may choose an item and press OK to return a string or
526 Cancel to return the empty string.
528 {\it choices} is an array of {\it n} strings for the listbox.
530 If {\it centre} is TRUE, the message text (which may include new line characters)
531 is centred; if FALSE, the message is left-justified.
533 \wxheading{Include files}
537 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
539 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
540 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
541 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
543 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
544 If the user pressed cancel, -1 is returned.
546 \wxheading{Include files}
550 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
552 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
553 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
554 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
556 As {\bf wxGetSingleChoice} but takes an array of client data pointers
557 corresponding to the strings, and returns one of these pointers.
559 \wxheading{Include files}
563 \membersection{::wxMessageBox}\label{wxmessagebox}
565 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
566 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
568 General purpose message dialog. {\it style} may be a bit list of the
569 following identifiers:
571 \begin{twocollist}\itemsep=0pt
572 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
574 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
576 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
577 \twocolitem{wxCENTRE}{Centres the text.}
578 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
579 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
580 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
581 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
584 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
590 int answer = wxMessageBox("Quit program?", "Confirm",
591 wxYES_NO | wxCANCEL, main_frame);
597 {\it message} may contain newline characters, in which case the
598 message will be split into separate lines, to cater for large messages.
600 Under Windows, the native MessageBox function is used unless wxCENTRE
601 is specified in the style, in which case a generic function is used.
602 This is because the native MessageBox function cannot centre text.
603 The symbols are not shown when the generic function is used.
605 \wxheading{Include files}
609 \membersection{::wxShowTip}\label{wxshowtip}
611 \func{bool}{wxShowTip}{
612 \param{wxWindow *}{parent},
613 \parent{wxTipProvider *}{tipProvider},
614 \param{bool }{showAtStartup = TRUE}}
616 This function shows a "startup tip" to the user.
618 \docparam{parent}{The parent window for the modal dialog}
620 \docparam{tipProvider}{An object which is used to get the text of the tips.
621 It may be created with
622 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
624 \docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
625 otherwise. This is used as the initial value for "Show tips at startup"
626 checkbox which is shown in the tips dialog.}
628 \wxheading{See also:}
630 \helpref{Tips overview}{tipsoverview}
632 \wxheading{Include files}
636 \section{GDI functions}\label{gdifunctions}
638 The following are relevant to the GDI (Graphics Device Interface).
640 \wxheading{Include files}
644 \membersection{::wxColourDisplay}
646 \func{bool}{wxColourDisplay}{\void}
648 Returns TRUE if the display is colour, FALSE otherwise.
650 \membersection{::wxDisplayDepth}
652 \func{int}{wxDisplayDepth}{\void}
654 Returns the depth of the display (a value of 1 denotes a monochrome display).
656 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
658 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
659 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
661 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
662 makes it into a placeable metafile by prepending a header containing the given
663 bounding box. The bounding box may be obtained from a device context after drawing
664 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
666 In addition to adding the placeable metafile header, this function adds
667 the equivalent of the following code to the start of the metafile data:
670 SetMapMode(dc, MM_ANISOTROPIC);
671 SetWindowOrg(dc, minX, minY);
672 SetWindowExt(dc, maxX - minX, maxY - minY);
675 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
677 Placeable metafiles may be imported by many Windows applications, and can be
678 used in RTF (Rich Text Format) files.
680 {\it scale} allows the specification of scale for the metafile.
682 This function is only available under Windows.
684 \membersection{::wxSetCursor}\label{wxsetcursor}
686 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
688 Globally sets the cursor; only has an effect in Windows and GTK.
689 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
691 \section{Printer settings}\label{printersettings}
693 These routines are obsolete and should no longer be used!
695 The following functions are used to control PostScript printing. Under
696 Windows, PostScript output can only be sent to a file.
698 \wxheading{Include files}
702 \membersection{::wxGetPrinterCommand}
704 \func{wxString}{wxGetPrinterCommand}{\void}
706 Gets the printer command used to print a file. The default is {\tt lpr}.
708 \membersection{::wxGetPrinterFile}
710 \func{wxString}{wxGetPrinterFile}{\void}
712 Gets the PostScript output filename.
714 \membersection{::wxGetPrinterMode}
716 \func{int}{wxGetPrinterMode}{\void}
718 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
719 The default is PS\_PREVIEW.
721 \membersection{::wxGetPrinterOptions}
723 \func{wxString}{wxGetPrinterOptions}{\void}
725 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
727 \membersection{::wxGetPrinterOrientation}
729 \func{int}{wxGetPrinterOrientation}{\void}
731 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
733 \membersection{::wxGetPrinterPreviewCommand}
735 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
737 Gets the command used to view a PostScript file. The default depends on the platform.
739 \membersection{::wxGetPrinterScaling}
741 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
743 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
745 \membersection{::wxGetPrinterTranslation}
747 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
749 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
751 \membersection{::wxSetPrinterCommand}
753 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
755 Sets the printer command used to print a file. The default is {\tt lpr}.
757 \membersection{::wxSetPrinterFile}
759 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
761 Sets the PostScript output filename.
763 \membersection{::wxSetPrinterMode}
765 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
767 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
768 The default is PS\_PREVIEW.
770 \membersection{::wxSetPrinterOptions}
772 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
774 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
776 \membersection{::wxSetPrinterOrientation}
778 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
780 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
782 \membersection{::wxSetPrinterPreviewCommand}
784 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
786 Sets the command used to view a PostScript file. The default depends on the platform.
788 \membersection{::wxSetPrinterScaling}
790 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
792 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
794 \membersection{::wxSetPrinterTranslation}
796 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
798 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
800 \section{Clipboard functions}\label{clipsboard}
802 These clipboard functions are implemented for Windows only.
804 \wxheading{Include files}
808 \membersection{::wxClipboardOpen}
810 \func{bool}{wxClipboardOpen}{\void}
812 Returns TRUE if this application has already opened the clipboard.
814 \membersection{::wxCloseClipboard}
816 \func{bool}{wxCloseClipboard}{\void}
818 Closes the clipboard to allow other applications to use it.
820 \membersection{::wxEmptyClipboard}
822 \func{bool}{wxEmptyClipboard}{\void}
824 Empties the clipboard.
826 \membersection{::wxEnumClipboardFormats}
828 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
830 Enumerates the formats found in a list of available formats that belong
831 to the clipboard. Each call to this function specifies a known
832 available format; the function returns the format that appears next in
835 {\it dataFormat} specifies a known format. If this parameter is zero,
836 the function returns the first format in the list.
838 The return value specifies the next known clipboard data format if the
839 function is successful. It is zero if the {\it dataFormat} parameter specifies
840 the last format in the list of available formats, or if the clipboard
843 Before it enumerates the formats function, an application must open the clipboard by using the
844 wxOpenClipboard function.
846 \membersection{::wxGetClipboardData}
848 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
850 Gets data from the clipboard.
852 {\it dataFormat} may be one of:
854 \begin{itemize}\itemsep=0pt
855 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
856 \item wxCF\_BITMAP: returns a new wxBitmap.
859 The clipboard must have previously been opened for this call to succeed.
861 \membersection{::wxGetClipboardFormatName}
863 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
865 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
866 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
868 \membersection{::wxIsClipboardFormatAvailable}
870 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
872 Returns TRUE if the given data format is available on the clipboard.
874 \membersection{::wxOpenClipboard}
876 \func{bool}{wxOpenClipboard}{\void}
878 Opens the clipboard for passing data to it or getting data from it.
880 \membersection{::wxRegisterClipboardFormat}
882 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
884 Registers the clipboard data format name and returns an identifier.
886 \membersection{::wxSetClipboardData}
888 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
890 Passes data to the clipboard.
892 {\it dataFormat} may be one of:
894 \begin{itemize}\itemsep=0pt
895 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
896 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
897 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
898 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
901 The clipboard must have previously been opened for this call to succeed.
903 \section{Miscellaneous functions}\label{miscellany}
905 \membersection{::wxNewId}
907 \func{long}{wxNewId}{\void}
909 Generates an integer identifier unique to this run of the program.
911 \wxheading{Include files}
915 \membersection{::wxRegisterId}
917 \func{void}{wxRegisterId}{\param{long}{ id}}
919 Ensures that ids subsequently generated by {\bf NewId} do not clash with
922 \wxheading{Include files}
926 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
928 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
930 Changes the cursor to the given cursor for all windows in the application.
931 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
932 to its previous state. These two calls can be nested, and a counter
933 ensures that only the outer calls take effect.
935 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
937 \wxheading{Include files}
941 \membersection{::wxBell}
943 \func{void}{wxBell}{\void}
945 Ring the system bell.
947 \wxheading{Include files}
951 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
953 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
955 Creates and returns an object of the given class, if the class has been
956 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
958 \membersection{::wxDDECleanUp}\label{wxddecleanup}
960 \func{void}{wxDDECleanUp}{\void}
962 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
963 called by the application.
965 See also helpref{wxDDEInitialize}{wxddeinitialize}.
967 \wxheading{Include files}
971 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
973 \func{void}{wxDDEInitialize}{\void}
975 Initializes the DDE system. May be called multiple times without harm.
977 This no longer needs to be called by the application: it will be called
978 by wxWindows if necessary.
980 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
981 \helpref{wxDDECleanUp}{wxddecleanup}.
983 \wxheading{Include files}
987 \membersection{::wxDebugMsg}\label{wxdebugmsg}
989 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
991 Display a debugging message; under Windows, this will appear on the
992 debugger command window, and under Unix, it will be written to standard
995 The syntax is identical to {\bf printf}: pass a format string and a
996 variable list of arguments.
998 Note that under Windows, you can see the debugging messages without a
999 debugger if you have the DBWIN debug log application that comes with
1002 {\bf Tip:} under Windows, if your application crashes before the
1003 message appears in the debugging window, put a wxYield call after
1004 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
1005 (at least for Watcom C++): preformat your messages and use OutputDebugString
1008 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1010 \wxheading{Include files}
1014 \membersection{::wxDisplaySize}
1016 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1018 Gets the physical size of the display in pixels.
1020 \wxheading{Include files}
1024 \membersection{::wxEntry}\label{wxentry}
1026 This initializes wxWindows in a platform-dependent way. Use this if you
1027 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
1028 you can initialize wxWindows from an Microsoft Foundation Classes application using
1031 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1032 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
1034 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
1035 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
1036 message loop will be entered.
1038 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
1039 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
1041 wxWindows initialization under Windows (for applications constructed as a DLL).
1043 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
1045 wxWindows initialization under Unix.
1049 To clean up wxWindows, call wxApp::OnExit followed by the static function
1050 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1053 int CTheApp::ExitInstance()
1055 // OnExit isn't called by CleanUp so must be called explicitly.
1059 return CWinApp::ExitInstance();
1063 \wxheading{Include files}
1067 \membersection{::wxError}\label{wxerror}
1069 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1071 Displays {\it msg} and continues. This writes to standard error under
1072 Unix, and pops up a message box under Windows. Used for internal
1073 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1075 \wxheading{Include files}
1079 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1081 \func{void}{wxEndBusyCursor}{\void}
1083 Changes the cursor back to the original cursor, for all windows in the application.
1084 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1086 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1088 \wxheading{Include files}
1092 \membersection{::wxExecute}\label{wxexecute}
1094 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1096 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1098 Executes another program in Unix or Windows.
1100 The first form takes a command string, such as {\tt "emacs file.txt"}.
1102 The second form takes an array of values: a command, any number of
1103 arguments, terminated by NULL.
1105 If {\it sync} is FALSE (the default), flow of control immediately returns.
1106 If TRUE, the current application waits until the other program has terminated.
1108 In the case of synchronous execution, the return value is the exit code of
1109 the process (which terminates by the moment the function returns) and will be
1110 $-1$ if the process couldn't be started and typically 0 if the process
1111 terminated successfully. Also, while waiting for the process to
1112 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1113 should ensure that this can cause no recursion, in the simples case by
1114 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1116 For asynchronous execution, however, the return value is the process id and
1117 zero value indicates that the command could not be executed.
1119 If callback isn't NULL and if execution is asynchronous (note that callback
1120 parameter can not be non NULL for synchronous execution),
1121 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1122 the process finishes.
1124 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1126 \wxheading{Include files}
1130 \membersection{::wxExit}\label{wxexit}
1132 \func{void}{wxExit}{\void}
1134 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1135 Should only be used in an emergency: normally the top-level frame
1136 should be deleted (after deleting all other frames) to terminate the
1137 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1139 \wxheading{Include files}
1143 \membersection{::wxFatalError}\label{wxfatalerror}
1145 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1147 Displays {\it msg} and exits. This writes to standard error under Unix,
1148 and pops up a message box under Windows. Used for fatal internal
1149 wxWindows errors. See also \helpref{wxError}{wxerror}.
1151 \wxheading{Include files}
1155 \membersection{::wxFindMenuItemId}
1157 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1159 Find a menu item identifier associated with the given frame's menu bar.
1161 \wxheading{Include files}
1165 \membersection{::wxFindWindowByLabel}
1167 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1169 Find a window by its label. Depending on the type of window, the label may be a window title
1170 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1171 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1172 The search is recursive in both cases.
1174 \wxheading{Include files}
1178 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1180 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1182 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1183 If {\it parent} is NULL, the search will start from all top-level
1184 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1185 The search is recursive in both cases.
1187 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1189 \wxheading{Include files}
1193 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1195 \func{wxWindow *}{wxGetActiveWindow}{\void}
1197 Gets the currently active window (Windows only).
1199 \wxheading{Include files}
1203 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1205 \func{wxString}{wxGetDisplayName}{\void}
1207 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1209 \wxheading{Include files}
1213 \membersection{::wxGetHomeDir}
1215 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1217 Fills the buffer with a string representing the user's home directory (Unix only).
1219 \wxheading{Include files}
1223 \membersection{::wxGetHostName}
1225 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1227 Copies the host name of the machine the program is running on into the
1228 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1229 successful. Under Unix, this will return a machine name. Under Windows,
1230 this returns ``windows''.
1232 \wxheading{Include files}
1236 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1238 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1240 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1242 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1245 See also \helpref{wxTimer}{wxtimer}.
1247 \wxheading{Include files}
1251 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1253 \func{long}{wxGetFreeMemory}{\void}
1255 Returns the amount of free memory in Kbytes under environments which
1256 support it, and -1 if not supported. Currently, returns a positive value
1257 under Windows, and -1 under Unix.
1259 \wxheading{Include files}
1263 \membersection{::wxGetMousePosition}
1265 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1267 Returns the mouse position in screen coordinates.
1269 \wxheading{Include files}
1273 \membersection{::wxGetOsVersion}
1275 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1277 Gets operating system version information.
1279 \begin{twocollist}\itemsep=0pt
1280 \twocolitemruled{Platform}{Return tyes}
1281 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1282 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1283 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1284 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1285 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1286 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1287 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1288 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1289 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1292 \wxheading{Include files}
1296 \membersection{::wxGetResource}\label{wxgetresource}
1298 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1299 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1301 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1302 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1304 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1305 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1307 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1308 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1310 Gets a resource value from the resource database (for example, WIN.INI, or
1311 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1312 otherwise the specified file is used.
1314 Under X, if an application class (wxApp::GetClassName) has been defined,
1315 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1316 an applications default file when merging all resource databases.
1318 The reason for passing the result in an argument is that it
1319 can be convenient to define a default value, which gets overridden
1320 if the value exists in the resource file. It saves a separate
1321 test for that resource's existence, and it also allows
1322 the overloading of the function for different types.
1324 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1326 \wxheading{Include files}
1330 \membersection{::wxGetUserId}
1332 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1334 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1335 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1336 Under Windows, this returns ``user''.
1338 \wxheading{Include files}
1342 \membersection{::wxGetUserName}
1344 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1346 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1347 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1348 Under Windows, this returns ``unknown''.
1350 \wxheading{Include files}
1354 \membersection{::wxKill}\label{wxkill}
1356 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1358 Under Unix (the only supported platform), equivalent to the Unix kill function.
1359 Returns 0 on success, -1 on failure.
1361 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1362 It does not raise a signal in the receiving process.
1364 \wxheading{Include files}
1368 \membersection{::wxIsBusy}\label{wxisbusy}
1370 \func{bool}{wxIsBusy}{\void}
1372 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1373 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1375 See also \helpref{wxBusyCursor}{wxbusycursor}.
1377 \wxheading{Include files}
1381 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1383 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1385 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1386 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1388 The resource must be defined in the {\tt .rc} file using the following syntax:
1391 myResource TEXT file.ext
1394 where {\tt file.ext} is a file that the resource compiler can find.
1396 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1397 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1398 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1400 This function is available under Windows only.
1402 \wxheading{Include files}
1406 \membersection{::wxNow}\label{wxnow}
1408 \func{wxString}{wxNow}{\void}
1410 Returns a string representing the current date and time.
1412 \wxheading{Include files}
1416 \membersection{::wxPostDelete}\label{wxpostdelete}
1418 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1420 Tells the system to delete the specified object when
1421 all other events have been processed. In some environments, it is
1422 necessary to use this instead of deleting a frame directly with the
1423 delete operator, because some GUIs will still send events to a deleted window.
1425 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1427 \wxheading{Include files}
1431 \membersection{::wxSafeYield}\label{wxsafeyield}
1433 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1435 This function is similar to wxYield, except that it disables the user input to
1436 all program windows before calling wxYield and re-enables it again
1437 afterwards. If {\it win} is not NULL, this window will remain enabled,
1438 allowing the implementation of some limited user interaction.
1440 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1442 \wxheading{Include files}
1446 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1448 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1450 This function enables or disables all top level windows. It is used by
1451 \helpref{::wxSafeYield}{wxsafeyield}.
1453 \wxheading{Include files}
1458 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1460 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1462 Under X only, sets the current display name. This is the X host and display name such
1463 as ``colonsay:0.0", and the function indicates which display should be used for creating
1464 windows from this point on. Setting the display within an application allows multiple
1465 displays to be used.
1467 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1469 \wxheading{Include files}
1473 \membersection{::wxShell}\label{wxshell}
1475 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1477 Executes a command in an interactive shell window. If no command is
1478 specified, then just the shell is spawned.
1480 See also \helpref{wxExecute}{wxexecute}.
1482 \wxheading{Include files}
1486 \membersection{::wxSleep}\label{wxsleep}
1488 \func{void}{wxSleep}{\param{int}{ secs}}
1490 Sleeps for the specified number of seconds.
1492 \wxheading{Include files}
1496 \membersection{::wxStripMenuCodes}
1498 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1500 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1502 Strips any menu codes from {\it in} and places the result
1503 in {\it out} (or returns the new string, in the first form).
1505 Menu codes include \& (mark the next character with an underline
1506 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1508 \wxheading{Include files}
1512 \membersection{::wxStartTimer}\label{wxstarttimer}
1514 \func{void}{wxStartTimer}{\void}
1516 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1518 See also \helpref{wxTimer}{wxtimer}.
1520 \wxheading{Include files}
1524 \membersection{::wxToLower}\label{wxtolower}
1526 \func{char}{wxToLower}{\param{char }{ch}}
1528 Converts the character to lower case. This is implemented as a macro for efficiency.
1530 \wxheading{Include files}
1534 \membersection{::wxToUpper}\label{wxtoupper}
1536 \func{char}{wxToUpper}{\param{char }{ch}}
1538 Converts the character to upper case. This is implemented as a macro for efficiency.
1540 \wxheading{Include files}
1544 \membersection{::wxTrace}\label{wxtrace}
1546 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1548 Takes printf-style variable argument syntax. Output
1549 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1551 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1553 \wxheading{Include files}
1557 \membersection{::wxTraceLevel}\label{wxtracelevel}
1559 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1561 Takes printf-style variable argument syntax. Output
1562 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1563 The first argument should be the level at which this information is appropriate.
1564 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1567 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1569 \wxheading{Include files}
1573 \membersection{::wxUsleep}\label{wxusleep}
1575 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1577 Sleeps for the specified number of milliseconds. Notice that usage of this
1578 function is encouraged instead of calling usleep(3) directly because the
1579 standard usleep() function is not MT safe.
1581 \wxheading{Include files}
1585 \membersection{::wxWriteResource}\label{wxwriteresource}
1587 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1588 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1590 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1591 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1593 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1594 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1596 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1597 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1599 Writes a resource value into the resource database (for example, WIN.INI, or
1600 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1601 otherwise the specified file is used.
1603 Under X, the resource databases are cached until the internal function
1604 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1605 all updated resource databases are written to their files.
1607 Note that it is considered bad manners to write to the .Xdefaults
1608 file under Unix, although the WIN.INI file is fair game under Windows.
1610 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1612 \wxheading{Include files}
1616 \membersection{::wxYield}\label{wxyield}
1618 \func{bool}{wxYield}{\void}
1620 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1621 time-consuming process writes to a text window. Without an occasional
1622 yield, the text window will not be updated properly, and (since Windows
1623 multitasking is cooperative) other processes will not respond.
1625 Caution should be exercised, however, since yielding may allow the
1626 user to perform actions which are not compatible with the current task.
1627 Disabling menu items or whole menus during processing can avoid unwanted
1628 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1631 \wxheading{Include files}
1635 \section{Macros}\label{macros}
1637 These macros are defined in wxWindows.
1639 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1641 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1643 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1645 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1647 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1649 This macro will swap the bytes of the {\it value} variable from little
1650 endian to big endian or vice versa.
1652 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1654 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1656 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1658 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1660 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1662 This macro will swap the bytes of the {\it value} variable from little
1663 endian to big endian or vice versa if the program is compiled on a
1664 big-endian architecture (such as Sun work stations). If the program has
1665 been compiled on a little-endian architecture, the value will be unchanged.
1667 Use these macros to read data from and write data to a file that stores
1668 data in little endian (Intel i386) format.
1670 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1672 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1674 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1676 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1678 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1680 This macro will swap the bytes of the {\it value} variable from little
1681 endian to big endian or vice versa if the program is compiled on a
1682 little-endian architecture (such as Intel PCs). If the program has
1683 been compiled on a big-endian architecture, the value will be unchanged.
1685 Use these macros to read data from and write data to a file that stores
1686 data in big endian format.
1688 \membersection{CLASSINFO}\label{classinfo}
1690 \func{wxClassInfo *}{CLASSINFO}{className}
1692 Returns a pointer to the wxClassInfo object associated with this class.
1694 \wxheading{Include files}
1698 \membersection{DECLARE\_ABSTRACT\_CLASS}
1700 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1702 Used inside a class declaration to declare that the class should be
1703 made known to the class hierarchy, but objects of this class cannot be created
1704 dynamically. The same as DECLARE\_CLASS.
1709 class wxCommand: public wxObject
1711 DECLARE_ABSTRACT_CLASS(wxCommand)
1720 \wxheading{Include files}
1724 \membersection{DECLARE\_APP}\label{declareapp}
1726 \func{}{DECLARE\_APP}{className}
1728 This is used in headers to create a forward declaration of the wxGetApp function implemented
1729 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1737 \wxheading{Include files}
1741 \membersection{DECLARE\_CLASS}
1743 \func{}{DECLARE\_CLASS}{className}
1745 Used inside a class declaration to declare that the class should be
1746 made known to the class hierarchy, but objects of this class cannot be created
1747 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1749 \wxheading{Include files}
1753 \membersection{DECLARE\_DYNAMIC\_CLASS}
1755 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1757 Used inside a class declaration to declare that the objects of this class should be dynamically
1758 createable from run-time type information.
1763 class wxFrame: public wxWindow
1765 DECLARE_DYNAMIC_CLASS(wxFrame)
1768 const wxString\& frameTitle;
1774 \wxheading{Include files}
1778 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1780 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1782 Used in a C++ implementation file to complete the declaration of
1783 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1788 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1790 wxCommand::wxCommand(void)
1796 \wxheading{Include files}
1800 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1802 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1804 Used in a C++ implementation file to complete the declaration of
1805 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1807 \wxheading{Include files}
1811 \membersection{IMPLEMENT\_APP}\label{implementapp}
1813 \func{}{IMPLEMENT\_APP}{className}
1815 This is used in the application class implementation file to make the application class known to
1816 wxWindows for dynamic construction. You use this instead of
1827 IMPLEMENT_APP(MyApp)
1830 See also \helpref{DECLARE\_APP}{declareapp}.
1832 \wxheading{Include files}
1836 \membersection{IMPLEMENT\_CLASS}
1838 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1840 Used in a C++ implementation file to complete the declaration of
1841 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1843 \wxheading{Include files}
1847 \membersection{IMPLEMENT\_CLASS2}
1849 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1851 Used in a C++ implementation file to complete the declaration of a
1852 class that has run-time type information and two base classes. The
1853 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1855 \wxheading{Include files}
1859 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1861 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1863 Used in a C++ implementation file to complete the declaration of
1864 a class that has run-time type information, and whose instances
1865 can be created dynamically.
1870 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1872 wxFrame::wxFrame(void)
1878 \wxheading{Include files}
1882 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1884 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1886 Used in a C++ implementation file to complete the declaration of
1887 a class that has run-time type information, and whose instances
1888 can be created dynamically. Use this for classes derived from two
1891 \wxheading{Include files}
1895 \membersection{WXDEBUG\_NEW}\label{debugnew}
1897 \func{}{WXDEBUG\_NEW}{arg}
1899 This is defined in debug mode to be call the redefined new operator
1900 with filename and line number arguments. The definition is:
1903 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1906 In non-debug mode, this is defined as the normal new operator.
1908 \wxheading{Include files}
1912 \membersection{wxDynamicCast}\label{wxdynamiccast}
1914 \func{}{wxDynamicCast}{ptr, classname}
1916 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1917 the pointer is of this type (the check is done during the run-time) or NULL
1918 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1921 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1926 wxWindow *win = wxWindow::FindFocus();
1927 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1930 // a text control has the focus...
1934 // no window has the focus or it's not a text control
1938 \wxheading{See also}
1940 \helpref{RTTI overview}{runtimeclassoverview}
1942 \membersection{WXTRACE}\label{trace}
1944 \wxheading{Include files}
1948 \func{}{WXTRACE}{formatString, ...}
1950 Calls wxTrace with printf-style variable argument syntax. Output
1951 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1953 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1955 \wxheading{Include files}
1959 \membersection{WXTRACELEVEL}\label{tracelevel}
1961 \func{}{WXTRACELEVEL}{level, formatString, ...}
1963 Calls wxTraceLevel with printf-style variable argument syntax. Output
1964 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1965 The first argument should be the level at which this information is appropriate.
1966 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1969 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1971 \wxheading{Include files}
1975 \section{wxWindows resource functions}\label{resourcefuncs}
1977 \overview{wxWindows resource system}{resourceformats}
1979 This section details functions for manipulating wxWindows (.WXR) resource
1980 files and loading user interface elements from resources.
1982 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1983 about initialisation file resource reading and writing, using such functions
1984 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1986 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1988 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1989 loading from resource data.
1991 {\bf Warning:} this needs updating for wxWindows 2.
1993 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1995 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1997 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1998 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1999 perhaps for implementing resource functionality for interpreted languages.
2001 \membersection{::wxResourceClear}
2003 \func{void}{wxResourceClear}{\void}
2005 Clears the wxWindows resource table.
2007 \membersection{::wxResourceCreateBitmap}
2009 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
2011 Creates a new bitmap from a file, static data, or Windows resource, given a valid
2012 wxWindows bitmap resource identifier. For example, if the .WXR file contains
2016 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
2017 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
2018 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
2021 then this function can be called as follows:
2024 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
2027 \membersection{::wxResourceCreateIcon}
2029 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
2031 Creates a new icon from a file, static data, or Windows resource, given a valid
2032 wxWindows icon resource identifier. For example, if the .WXR file contains
2036 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
2037 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
2038 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
2041 then this function can be called as follows:
2044 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
2047 \membersection{::wxResourceCreateMenuBar}
2049 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2051 Creates a new menu bar given a valid wxWindows menubar resource
2052 identifier. For example, if the .WXR file contains the following:
2055 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2059 ['&Open File', 2, 'Open a file'],\
2060 ['&Save File', 3, 'Save a file'],\
2062 ['E&xit', 4, 'Exit program']\
2065 ['&About', 6, 'About this program']\
2070 then this function can be called as follows:
2073 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2077 \membersection{::wxResourceGetIdentifier}
2079 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2081 Used for retrieving the integer value associated with an identifier.
2082 A zero value indicates that the identifier was not found.
2084 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2086 \membersection{::wxResourceParseData}\label{wxresourcedata}
2088 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2090 Parses a string containing one or more wxWindows resource objects. If
2091 the resource objects are global static data that are included into the
2092 C++ program, then this function must be called for each variable
2093 containing the resource data, to make it known to wxWindows.
2095 {\it resource} should contain data in the following form:
2098 dialog(name = 'dialog1',
2099 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2100 title = 'Test dialog box',
2101 x = 312, y = 234, width = 400, height = 300,
2103 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2104 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2105 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2106 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2107 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2108 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2111 This function will typically be used after including a {\tt .wxr} file into
2112 a C++ program as follows:
2115 #include "dialog1.wxr"
2118 Each of the contained resources will declare a new C++ variable, and each
2119 of these variables should be passed to wxResourceParseData.
2121 \membersection{::wxResourceParseFile}
2123 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2125 Parses a file containing one or more wxWindows resource objects
2126 in C++-compatible syntax. Use this function to dynamically load
2127 wxWindows resource data.
2129 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2131 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2133 Parses a string containing one or more wxWindows resource objects. If
2134 the resource objects are global static data that are included into the
2135 C++ program, then this function must be called for each variable
2136 containing the resource data, to make it known to wxWindows.
2138 {\it resource} should contain data with the following form:
2141 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2142 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2143 title = 'Test dialog box',\
2144 x = 312, y = 234, width = 400, height = 300,\
2146 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2147 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2148 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2149 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2150 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2151 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2154 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2155 load an entire {\tt .wxr file} into a string.
2157 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2159 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2160 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2162 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2164 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2165 This is required if other resources will use the bitmap data, since otherwise there
2166 is no connection between names used in resources, and the global bitmap data.
2168 \membersection{::wxResourceRegisterIconData}
2170 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2172 \section{Log functions}\label{logfunctions}
2174 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2175 further information.
2177 \wxheading{Include files}
2181 \membersection{::wxLogError}\label{wxlogerror}
2183 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2185 The function to use for error messages, i.e. the
2186 messages that must be shown to the user. The default processing is to pop up a
2187 message box to inform the user about it.
2189 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2191 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2193 Like \helpref{wxLogError}{wxlogerror}, but also
2194 terminates the program with the exit code 3. Using {\it abort()} standard
2195 function also terminates the program with this exit code.
2197 \membersection{::wxLogWarning}\label{wxlogwarning}
2199 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2201 For warnings - they are also normally shown to the
2202 user, but don't interrupt the program work.
2204 \membersection{::wxLogMessage}\label{wxlogmessage}
2206 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2208 for all normal, informational messages. They also
2209 appear in a message box by default (but it can be changed). Notice
2210 that the standard behaviour is to not show informational messages if there are
2211 any errors later - the logic being that the later error messages make the
2212 informational messages preceding them meaningless.
2214 \membersection{::wxLogVerbose}\label{wxlogverbose}
2216 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2218 For verbose output. Normally, it's suppressed, but
2219 might be activated if the user wishes to know more details about the program
2220 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2222 \membersection{::wxLogStatus}\label{wxlogstatus}
2224 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2226 For status messages - they will go into the status
2227 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2229 \membersection{::wxLogSysError}\label{wxlogsyserror}
2231 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2233 Mostly used by wxWindows itself, but might be
2234 handy for logging errors after system call (API function) failure. It logs the
2235 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2236 on the platform) and the corresponding error
2237 message. The second form of this function takes the error code explitly as the
2240 \membersection{::wxLogDebug}\label{wxlogdebug}
2242 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2244 The right function for debug output. It only
2245 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2246 and expands to nothing in release mode (otherwise).
2248 \membersection{::wxLogTrace}\label{wxlogtrace}
2250 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2252 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2254 As {\bf wxLogDebug}, only does something in debug
2255 build. The reason for making it a separate function from it is that usually
2256 there are a lot of trace messages, so it might make sense to separate them
2257 from other debug messages which would be flooded in them. Moreover, the second
2258 version of this function takes a trace mask as the first argument which allows
2259 to further restrict the amount of messages generated. The value of {\it mask} can be:
2261 \begin{itemize}\itemsep=0pt
2262 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2263 \item wxTraceMessages: trace window messages/X callbacks
2264 \item wxTraceResAlloc: trace GDI resource allocation
2265 \item wxTraceRefCount: trace various ref counting operations
2268 \section{Debugging macros and functions}\label{debugmacros}
2270 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2271 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2274 \wxheading{Include files}
2278 \membersection{::wxOnAssert}\label{wxonassert}
2280 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2282 This function may be redefined to do something non trivial and is called
2283 whenever one of debugging macros fails (i.e. condition is false in an
2285 % TODO: this should probably be an overridable in wxApp.
2287 \membersection{wxASSERT}\label{wxassert}
2289 \func{}{wxASSERT}{\param{}{condition}}
2291 Assert macro. An error message will be generated if the condition is FALSE in
2292 debug mode, but nothing will be done in the release build.
2294 Please note that the condition in wxASSERT() should have no side effects
2295 because it will not be executed in release mode at all.
2297 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2299 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2301 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2303 Assert macro with message. An error message will be generated if the condition is FALSE.
2305 See also: \helpref{wxASSERT}{wxassert}
2307 \membersection{wxFAIL}\label{wxfail}
2309 \func{}{wxFAIL}{\void}
2311 Will always generate an assert error if this code is reached (in debug mode).
2313 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2315 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2317 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2319 Will always generate an assert error with specified message if this code is reached (in debug mode).
2321 This macro is useful for marking unreachable" code areas, for example
2322 it may be used in the "default:" branch of a switch statement if all possible
2323 cases are processed above.
2325 See also: \helpref{wxFAIL}{wxfail}
2327 \membersection{wxCHECK}\label{wxcheck}
2329 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2331 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2332 This check is done even in release mode.
2334 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2336 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2338 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2339 This check is done even in release mode.
2341 This macro may be only used in non void functions, see also
2342 \helpref{wxCHECK\_RET}{wxcheckret}.
2344 \membersection{wxCHECK\_RET}\label{wxcheckret}
2346 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2348 Checks that the condition is true, and returns if not (FAILs with given error
2349 message in debug mode). This check is done even in release mode.
2351 This macro should be used in void functions instead of
2352 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2354 \membersection{wxCHECK2}\label{wxcheck2}
2356 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2358 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2359 {\it operation} if it is not. This is a generalisation of
2360 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2361 returning from the function must be done when the {\it condition} is false.
2363 This check is done even in release mode.
2365 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2367 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2369 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2370 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2371 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob