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{::wxFileSelector
}\label{wxfileselector
}
410 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
411 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
412 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
413 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
415 Pops up a file selector box. In Windows, this is the common file selector
416 dialog. In X, this is a file selector box with somewhat less functionality.
417 The path and filename are distinct elements of a full file pathname.
418 If path is empty, the current directory will be used. If filename is empty,
419 no default filename will be supplied. The wildcard determines what files
420 are displayed in the file selector, and file extension supplies a type
421 extension for the required filename. Flags may be a combination of wxOPEN,
422 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
423 at present in Windows.
425 Both the X and Windows versions implement a wildcard filter. Typing a
426 filename containing wildcards
(*, ?) in the filename text item, and
427 clicking on Ok, will result in only those files matching the pattern being
428 displayed. In the X version, supplying no default name will result in the
429 wildcard filter being inserted in the filename text item; the filter is
430 ignored if a default name is supplied.
432 Under Windows (only), the wildcard may be a specification for multiple
433 types of file with a description for each, such as:
436 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
439 The application must check for an empty return value (the user pressed
440 Cancel). For example:
443 const wxString& s = wxFileSelector("Choose a file to open");
450 \wxheading{Include files}
454 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
456 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
457 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
458 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
460 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
461 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
462 or press Cancel to return the empty string.
464 If {\it centre} is TRUE, the message text (which may include new line characters)
465 is centred; if FALSE, the message is left-justified.
467 \wxheading{Include files}
471 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
473 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
474 \param{int }{nsel}, \param{int *}{selection},
475 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
476 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
478 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
479 listbox. The user may choose one or more item(s) and press OK or Cancel.
481 The number of initially selected choices, and array of the selected indices,
482 are passed in; this array will contain the user selections on exit, with
483 the function returning the number of selections. {\it selection} must be
484 as big as the number of choices, in case all are selected.
486 If Cancel is pressed, -1 is returned.
488 {\it choices} is an array of {\it n} strings for the listbox.
490 If {\it centre} is TRUE, the message text (which may include new line characters)
491 is centred; if FALSE, the message is left-justified.
493 \wxheading{Include files}
497 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
499 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
500 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
501 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
503 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
504 listbox. The user may choose an item and press OK to return a string or
505 Cancel to return the empty string.
507 {\it choices} is an array of {\it n} strings for the listbox.
509 If {\it centre} is TRUE, the message text (which may include new line characters)
510 is centred; if FALSE, the message is left-justified.
512 \wxheading{Include files}
516 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
518 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
519 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
520 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
522 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
523 If the user pressed cancel, -1 is returned.
525 \wxheading{Include files}
529 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
531 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
532 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
533 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
535 As {\bf wxGetSingleChoice} but takes an array of client data pointers
536 corresponding to the strings, and returns one of these pointers.
538 \wxheading{Include files}
542 \membersection{::wxMessageBox}\label{wxmessagebox}
544 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
545 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
547 General purpose message dialog. {\it style} may be a bit list of the
548 following identifiers:
550 \begin{twocollist}\itemsep=0pt
551 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
553 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
555 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
556 \twocolitem{wxCENTRE}{Centres the text.}
557 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
558 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
559 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
560 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
563 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
569 int answer = wxMessageBox("Quit program?", "Confirm",
570 wxYES_NO | wxCANCEL, main_frame);
576 {\it message} may contain newline characters, in which case the
577 message will be split into separate lines, to cater for large messages.
579 Under Windows, the native MessageBox function is used unless wxCENTRE
580 is specified in the style, in which case a generic function is used.
581 This is because the native MessageBox function cannot centre text.
582 The symbols are not shown when the generic function is used.
584 \wxheading{Include files}
588 \section{GDI functions}\label{gdifunctions}
590 The following are relevant to the GDI (Graphics Device Interface).
592 \wxheading{Include files}
596 \membersection{::wxColourDisplay}
598 \func{bool}{wxColourDisplay}{\void}
600 Returns TRUE if the display is colour, FALSE otherwise.
602 \membersection{::wxDisplayDepth}
604 \func{int}{wxDisplayDepth}{\void}
606 Returns the depth of the display (a value of 1 denotes a monochrome display).
608 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
610 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
611 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
613 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
614 makes it into a placeable metafile by prepending a header containing the given
615 bounding box. The bounding box may be obtained from a device context after drawing
616 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
618 In addition to adding the placeable metafile header, this function adds
619 the equivalent of the following code to the start of the metafile data:
622 SetMapMode(dc, MM_ANISOTROPIC);
623 SetWindowOrg(dc, minX, minY);
624 SetWindowExt(dc, maxX - minX, maxY - minY);
627 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
629 Placeable metafiles may be imported by many Windows applications, and can be
630 used in RTF (Rich Text Format) files.
632 {\it scale} allows the specification of scale for the metafile.
634 This function is only available under Windows.
636 \membersection{::wxSetCursor}\label{wxsetcursor}
638 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
640 Globally sets the cursor; only has an effect in Windows and GTK.
641 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
643 \section{Printer settings}\label{printersettings}
645 These routines are obsolete and should no longer be used!
647 The following functions are used to control PostScript printing. Under
648 Windows, PostScript output can only be sent to a file.
650 \wxheading{Include files}
654 \membersection{::wxGetPrinterCommand}
656 \func{wxString}{wxGetPrinterCommand}{\void}
658 Gets the printer command used to print a file. The default is {\tt lpr}.
660 \membersection{::wxGetPrinterFile}
662 \func{wxString}{wxGetPrinterFile}{\void}
664 Gets the PostScript output filename.
666 \membersection{::wxGetPrinterMode}
668 \func{int}{wxGetPrinterMode}{\void}
670 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
671 The default is PS\_PREVIEW.
673 \membersection{::wxGetPrinterOptions}
675 \func{wxString}{wxGetPrinterOptions}{\void}
677 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
679 \membersection{::wxGetPrinterOrientation}
681 \func{int}{wxGetPrinterOrientation}{\void}
683 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
685 \membersection{::wxGetPrinterPreviewCommand}
687 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
689 Gets the command used to view a PostScript file. The default depends on the platform.
691 \membersection{::wxGetPrinterScaling}
693 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
695 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
697 \membersection{::wxGetPrinterTranslation}
699 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
701 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
703 \membersection{::wxSetPrinterCommand}
705 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
707 Sets the printer command used to print a file. The default is {\tt lpr}.
709 \membersection{::wxSetPrinterFile}
711 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
713 Sets the PostScript output filename.
715 \membersection{::wxSetPrinterMode}
717 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
719 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
720 The default is PS\_PREVIEW.
722 \membersection{::wxSetPrinterOptions}
724 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
726 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
728 \membersection{::wxSetPrinterOrientation}
730 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
732 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
734 \membersection{::wxSetPrinterPreviewCommand}
736 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
738 Sets the command used to view a PostScript file. The default depends on the platform.
740 \membersection{::wxSetPrinterScaling}
742 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
744 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
746 \membersection{::wxSetPrinterTranslation}
748 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
750 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
752 \section{Clipboard functions}\label{clipsboard}
754 These clipboard functions are implemented for Windows only.
756 \wxheading{Include files}
760 \membersection{::wxClipboardOpen}
762 \func{bool}{wxClipboardOpen}{\void}
764 Returns TRUE if this application has already opened the clipboard.
766 \membersection{::wxCloseClipboard}
768 \func{bool}{wxCloseClipboard}{\void}
770 Closes the clipboard to allow other applications to use it.
772 \membersection{::wxEmptyClipboard}
774 \func{bool}{wxEmptyClipboard}{\void}
776 Empties the clipboard.
778 \membersection{::wxEnumClipboardFormats}
780 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
782 Enumerates the formats found in a list of available formats that belong
783 to the clipboard. Each call to this function specifies a known
784 available format; the function returns the format that appears next in
787 {\it dataFormat} specifies a known format. If this parameter is zero,
788 the function returns the first format in the list.
790 The return value specifies the next known clipboard data format if the
791 function is successful. It is zero if the {\it dataFormat} parameter specifies
792 the last format in the list of available formats, or if the clipboard
795 Before it enumerates the formats function, an application must open the clipboard by using the
796 wxOpenClipboard function.
798 \membersection{::wxGetClipboardData}
800 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
802 Gets data from the clipboard.
804 {\it dataFormat} may be one of:
806 \begin{itemize}\itemsep=0pt
807 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
808 \item wxCF\_BITMAP: returns a new wxBitmap.
811 The clipboard must have previously been opened for this call to succeed.
813 \membersection{::wxGetClipboardFormatName}
815 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
817 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
818 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
820 \membersection{::wxIsClipboardFormatAvailable}
822 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
824 Returns TRUE if the given data format is available on the clipboard.
826 \membersection{::wxOpenClipboard}
828 \func{bool}{wxOpenClipboard}{\void}
830 Opens the clipboard for passing data to it or getting data from it.
832 \membersection{::wxRegisterClipboardFormat}
834 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
836 Registers the clipboard data format name and returns an identifier.
838 \membersection{::wxSetClipboardData}
840 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
842 Passes data to the clipboard.
844 {\it dataFormat} may be one of:
846 \begin{itemize}\itemsep=0pt
847 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
848 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
849 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
850 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
853 The clipboard must have previously been opened for this call to succeed.
855 \section{Miscellaneous functions}\label{miscellany}
857 \membersection{::wxNewId}
859 \func{long}{wxNewId}{\void}
861 Generates an integer identifier unique to this run of the program.
863 \wxheading{Include files}
867 \membersection{::wxRegisterId}
869 \func{void}{wxRegisterId}{\param{long}{ id}}
871 Ensures that ids subsequently generated by {\bf NewId} do not clash with
874 \wxheading{Include files}
878 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
880 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
882 Changes the cursor to the given cursor for all windows in the application.
883 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
884 to its previous state. These two calls can be nested, and a counter
885 ensures that only the outer calls take effect.
887 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
889 \wxheading{Include files}
893 \membersection{::wxBell}
895 \func{void}{wxBell}{\void}
897 Ring the system bell.
899 \wxheading{Include files}
903 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
905 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
907 Creates and returns an object of the given class, if the class has been
908 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
910 \membersection{::wxDDECleanUp}\label{wxddecleanup}
912 \func{void}{wxDDECleanUp}{\void}
914 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
915 called by the application.
917 See also helpref{wxDDEInitialize}{wxddeinitialize}.
919 \wxheading{Include files}
923 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
925 \func{void}{wxDDEInitialize}{\void}
927 Initializes the DDE system. May be called multiple times without harm.
929 This no longer needs to be called by the application: it will be called
930 by wxWindows if necessary.
932 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
933 \helpref{wxDDECleanUp}{wxddecleanup}.
935 \wxheading{Include files}
939 \membersection{::wxDebugMsg}\label{wxdebugmsg}
941 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
943 Display a debugging message; under Windows, this will appear on the
944 debugger command window, and under Unix, it will be written to standard
947 The syntax is identical to {\bf printf}: pass a format string and a
948 variable list of arguments.
950 Note that under Windows, you can see the debugging messages without a
951 debugger if you have the DBWIN debug log application that comes with
954 {\bf Tip:} under Windows, if your application crashes before the
955 message appears in the debugging window, put a wxYield call after
956 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
957 (at least for Watcom C++): preformat your messages and use OutputDebugString
960 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
962 \wxheading{Include files}
966 \membersection{::wxDisplaySize}
968 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
970 Gets the physical size of the display in pixels.
972 \wxheading{Include files}
976 \membersection{::wxEntry}\label{wxentry}
978 This initializes wxWindows in a platform-dependent way. Use this if you
979 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
980 you can initialize wxWindows from an Microsoft Foundation Classes application using
983 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
984 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
986 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
987 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
988 message loop will be entered.
990 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
991 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
993 wxWindows initialization under Windows (for applications constructed as a DLL).
995 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
997 wxWindows initialization under Unix.
1001 To clean up wxWindows, call wxApp::OnExit followed by the static function
1002 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1005 int CTheApp::ExitInstance()
1007 // OnExit isn't called by CleanUp so must be called explicitly.
1011 return CWinApp::ExitInstance();
1015 \wxheading{Include files}
1019 \membersection{::wxError}\label{wxerror}
1021 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1023 Displays {\it msg} and continues. This writes to standard error under
1024 Unix, and pops up a message box under Windows. Used for internal
1025 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1027 \wxheading{Include files}
1031 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1033 \func{void}{wxEndBusyCursor}{\void}
1035 Changes the cursor back to the original cursor, for all windows in the application.
1036 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1038 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1040 \wxheading{Include files}
1044 \membersection{::wxExecute}\label{wxexecute}
1046 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1048 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1050 Executes another program in Unix or Windows.
1052 The first form takes a command string, such as {\tt "emacs file.txt"}.
1054 The second form takes an array of values: a command, any number of
1055 arguments, terminated by NULL.
1057 If {\it sync} is FALSE (the default), flow of control immediately returns.
1058 If TRUE, the current application waits until the other program has terminated.
1060 In the case of synchronous execution, the return value is the exit code of
1061 the process (which terminates by the moment the function returns) and will be
1062 $-1$ if the process couldn't be started and typically 0 if the process
1063 terminated successfully. Also, while waiting for the process to
1064 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
1065 should ensure that this can cause no recursion, in the simples case by
1066 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
1068 For asynchronous execution, however, the return value is the process id and
1069 zero value indicates that the command could not be executed.
1071 If callback isn't NULL and if execution is asynchronous (note that callback
1072 parameter can not be non NULL for synchronous execution),
1073 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1074 the process finishes.
1076 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1078 \wxheading{Include files}
1082 \membersection{::wxExit}\label{wxexit}
1084 \func{void}{wxExit}{\void}
1086 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1087 Should only be used in an emergency: normally the top-level frame
1088 should be deleted (after deleting all other frames) to terminate the
1089 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1091 \wxheading{Include files}
1095 \membersection{::wxFatalError}\label{wxfatalerror}
1097 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1099 Displays {\it msg} and exits. This writes to standard error under Unix,
1100 and pops up a message box under Windows. Used for fatal internal
1101 wxWindows errors. See also \helpref{wxError}{wxerror}.
1103 \wxheading{Include files}
1107 \membersection{::wxFindMenuItemId}
1109 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1111 Find a menu item identifier associated with the given frame's menu bar.
1113 \wxheading{Include files}
1117 \membersection{::wxFindWindowByLabel}
1119 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1121 Find a window by its label. Depending on the type of window, the label may be a window title
1122 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1123 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1124 The search is recursive in both cases.
1126 \wxheading{Include files}
1130 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1132 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1134 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1135 If {\it parent} is NULL, the search will start from all top-level
1136 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1137 The search is recursive in both cases.
1139 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1141 \wxheading{Include files}
1145 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1147 \func{wxWindow *}{wxGetActiveWindow}{\void}
1149 Gets the currently active window (Windows only).
1151 \wxheading{Include files}
1155 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1157 \func{wxString}{wxGetDisplayName}{\void}
1159 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1161 \wxheading{Include files}
1165 \membersection{::wxGetHomeDir}
1167 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1169 Fills the buffer with a string representing the user's home directory (Unix only).
1171 \wxheading{Include files}
1175 \membersection{::wxGetHostName}
1177 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1179 Copies the host name of the machine the program is running on into the
1180 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1181 successful. Under Unix, this will return a machine name. Under Windows,
1182 this returns ``windows''.
1184 \wxheading{Include files}
1188 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1190 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1192 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1194 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1197 See also \helpref{wxTimer}{wxtimer}.
1199 \wxheading{Include files}
1203 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1205 \func{long}{wxGetFreeMemory}{\void}
1207 Returns the amount of free memory in Kbytes under environments which
1208 support it, and -1 if not supported. Currently, returns a positive value
1209 under Windows, and -1 under Unix.
1211 \wxheading{Include files}
1215 \membersection{::wxGetMousePosition}
1217 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1219 Returns the mouse position in screen coordinates.
1221 \wxheading{Include files}
1225 \membersection{::wxGetOsVersion}
1227 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1229 Gets operating system version information.
1231 \begin{twocollist}\itemsep=0pt
1232 \twocolitemruled{Platform}{Return tyes}
1233 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1234 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1235 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1236 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1237 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1238 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1239 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1240 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1241 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1244 \wxheading{Include files}
1248 \membersection{::wxGetResource}\label{wxgetresource}
1250 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1251 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1253 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1254 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1256 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1257 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1259 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1260 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1262 Gets a resource value from the resource database (for example, WIN.INI, or
1263 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1264 otherwise the specified file is used.
1266 Under X, if an application class (wxApp::GetClassName) has been defined,
1267 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1268 an applications default file when merging all resource databases.
1270 The reason for passing the result in an argument is that it
1271 can be convenient to define a default value, which gets overridden
1272 if the value exists in the resource file. It saves a separate
1273 test for that resource's existence, and it also allows
1274 the overloading of the function for different types.
1276 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1278 \wxheading{Include files}
1282 \membersection{::wxGetUserId}
1284 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1286 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1287 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1288 Under Windows, this returns ``user''.
1290 \wxheading{Include files}
1294 \membersection{::wxGetUserName}
1296 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1298 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1299 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1300 Under Windows, this returns ``unknown''.
1302 \wxheading{Include files}
1306 \membersection{::wxKill}\label{wxkill}
1308 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1310 Under Unix (the only supported platform), equivalent to the Unix kill function.
1311 Returns 0 on success, -1 on failure.
1313 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1314 It does not raise a signal in the receiving process.
1316 \wxheading{Include files}
1320 \membersection{::wxIsBusy}\label{wxisbusy}
1322 \func{bool}{wxIsBusy}{\void}
1324 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1325 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1327 See also \helpref{wxBusyCursor}{wxbusycursor}.
1329 \wxheading{Include files}
1333 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1335 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1337 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1338 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1340 The resource must be defined in the {\tt .rc} file using the following syntax:
1343 myResource TEXT file.ext
1346 where {\tt file.ext} is a file that the resource compiler can find.
1348 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1349 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1350 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1352 This function is available under Windows only.
1354 \wxheading{Include files}
1358 \membersection{::wxNow}\label{wxnow}
1360 \func{wxString}{wxNow}{\void}
1362 Returns a string representing the current date and time.
1364 \wxheading{Include files}
1368 \membersection{::wxPostDelete}\label{wxpostdelete}
1370 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1372 Tells the system to delete the specified object when
1373 all other events have been processed. In some environments, it is
1374 necessary to use this instead of deleting a frame directly with the
1375 delete operator, because some GUIs will still send events to a deleted window.
1377 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1379 \wxheading{Include files}
1383 \membersection{::wxSafeYield}\label{wxsafeyield}
1385 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1387 This function is similar to wxYield, except that it disables the user input to
1388 all program windows before calling wxYield and re-enables it again
1389 afterwards. If {\it win} is not NULL, this window will remain enabled,
1390 allowing the implementation of some limited user interaction.
1392 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1394 \wxheading{Include files}
1398 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
1400 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1402 This function enables or disables all top level windows. It is used by
1403 \helpref{::wxSafeYield}{wxsafeyield}.
1405 \wxheading{Include files}
1410 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1412 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1414 Under X only, sets the current display name. This is the X host and display name such
1415 as ``colonsay:0.0", and the function indicates which display should be used for creating
1416 windows from this point on. Setting the display within an application allows multiple
1417 displays to be used.
1419 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1421 \wxheading{Include files}
1425 \membersection{::wxShell}\label{wxshell}
1427 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1429 Executes a command in an interactive shell window. If no command is
1430 specified, then just the shell is spawned.
1432 See also \helpref{wxExecute}{wxexecute}.
1434 \wxheading{Include files}
1438 \membersection{::wxSleep}\label{wxsleep}
1440 \func{void}{wxSleep}{\param{int}{ secs}}
1442 Sleeps for the specified number of seconds.
1444 \wxheading{Include files}
1448 \membersection{::wxStripMenuCodes}
1450 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1452 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1454 Strips any menu codes from {\it in} and places the result
1455 in {\it out} (or returns the new string, in the first form).
1457 Menu codes include \& (mark the next character with an underline
1458 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1460 \wxheading{Include files}
1464 \membersection{::wxStartTimer}\label{wxstarttimer}
1466 \func{void}{wxStartTimer}{\void}
1468 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1470 See also \helpref{wxTimer}{wxtimer}.
1472 \wxheading{Include files}
1476 \membersection{::wxToLower}\label{wxtolower}
1478 \func{char}{wxToLower}{\param{char }{ch}}
1480 Converts the character to lower case. This is implemented as a macro for efficiency.
1482 \wxheading{Include files}
1486 \membersection{::wxToUpper}\label{wxtoupper}
1488 \func{char}{wxToUpper}{\param{char }{ch}}
1490 Converts the character to upper case. This is implemented as a macro for efficiency.
1492 \wxheading{Include files}
1496 \membersection{::wxTrace}\label{wxtrace}
1498 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1500 Takes printf-style variable argument syntax. Output
1501 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1503 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1505 \wxheading{Include files}
1509 \membersection{::wxTraceLevel}\label{wxtracelevel}
1511 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1513 Takes printf-style variable argument syntax. Output
1514 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1515 The first argument should be the level at which this information is appropriate.
1516 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1519 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1521 \wxheading{Include files}
1525 \membersection{::wxUsleep}\label{wxusleep}
1527 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1529 Sleeps for the specified number of milliseconds. Notice that usage of this
1530 function is encouraged instead of calling usleep(3) directly because the
1531 standard usleep() function is not MT safe.
1533 \wxheading{Include files}
1537 \membersection{::wxWriteResource}\label{wxwriteresource}
1539 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1540 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1542 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1543 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1545 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1546 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1548 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1549 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1551 Writes a resource value into the resource database (for example, WIN.INI, or
1552 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1553 otherwise the specified file is used.
1555 Under X, the resource databases are cached until the internal function
1556 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1557 all updated resource databases are written to their files.
1559 Note that it is considered bad manners to write to the .Xdefaults
1560 file under Unix, although the WIN.INI file is fair game under Windows.
1562 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1564 \wxheading{Include files}
1568 \membersection{::wxYield}\label{wxyield}
1570 \func{bool}{wxYield}{\void}
1572 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1573 time-consuming process writes to a text window. Without an occasional
1574 yield, the text window will not be updated properly, and (since Windows
1575 multitasking is cooperative) other processes will not respond.
1577 Caution should be exercised, however, since yielding may allow the
1578 user to perform actions which are not compatible with the current task.
1579 Disabling menu items or whole menus during processing can avoid unwanted
1580 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1583 \wxheading{Include files}
1587 \section{Macros}\label{macros}
1589 These macros are defined in wxWindows.
1591 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
1593 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
1595 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
1597 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
1599 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
1601 This macro will swap the bytes of the {\it value} variable from little
1602 endian to big endian or vice versa.
1604 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
1606 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
1608 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
1610 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
1612 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
1614 This macro will swap the bytes of the {\it value} variable from little
1615 endian to big endian or vice versa if the program is compiled on a
1616 big-endian architecture (such as Sun work stations). If the program has
1617 been compiled on a little-endian architecture, the value will be unchanged.
1619 Use these macros to read data from and write data to a file that stores
1620 data in little endian (Intel i386) format.
1622 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
1624 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
1626 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
1628 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
1630 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
1632 This macro will swap the bytes of the {\it value} variable from little
1633 endian to big endian or vice versa if the program is compiled on a
1634 little-endian architecture (such as Intel PCs). If the program has
1635 been compiled on a big-endian architecture, the value will be unchanged.
1637 Use these macros to read data from and write data to a file that stores
1638 data in big endian format.
1640 \membersection{CLASSINFO}\label{classinfo}
1642 \func{wxClassInfo *}{CLASSINFO}{className}
1644 Returns a pointer to the wxClassInfo object associated with this class.
1646 \wxheading{Include files}
1650 \membersection{DECLARE\_ABSTRACT\_CLASS}
1652 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1654 Used inside a class declaration to declare that the class should be
1655 made known to the class hierarchy, but objects of this class cannot be created
1656 dynamically. The same as DECLARE\_CLASS.
1661 class wxCommand: public wxObject
1663 DECLARE_ABSTRACT_CLASS(wxCommand)
1672 \wxheading{Include files}
1676 \membersection{DECLARE\_APP}\label{declareapp}
1678 \func{}{DECLARE\_APP}{className}
1680 This is used in headers to create a forward declaration of the wxGetApp function implemented
1681 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1689 \wxheading{Include files}
1693 \membersection{DECLARE\_CLASS}
1695 \func{}{DECLARE\_CLASS}{className}
1697 Used inside a class declaration to declare that the class should be
1698 made known to the class hierarchy, but objects of this class cannot be created
1699 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1701 \wxheading{Include files}
1705 \membersection{DECLARE\_DYNAMIC\_CLASS}
1707 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1709 Used inside a class declaration to declare that the objects of this class should be dynamically
1710 createable from run-time type information.
1715 class wxFrame: public wxWindow
1717 DECLARE_DYNAMIC_CLASS(wxFrame)
1720 const wxString\& frameTitle;
1726 \wxheading{Include files}
1730 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1732 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1734 Used in a C++ implementation file to complete the declaration of
1735 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1740 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1742 wxCommand::wxCommand(void)
1748 \wxheading{Include files}
1752 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1754 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1756 Used in a C++ implementation file to complete the declaration of
1757 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1759 \wxheading{Include files}
1763 \membersection{IMPLEMENT\_APP}\label{implementapp}
1765 \func{}{IMPLEMENT\_APP}{className}
1767 This is used in the application class implementation file to make the application class known to
1768 wxWindows for dynamic construction. You use this instead of
1779 IMPLEMENT_APP(MyApp)
1782 See also \helpref{DECLARE\_APP}{declareapp}.
1784 \wxheading{Include files}
1788 \membersection{IMPLEMENT\_CLASS}
1790 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1792 Used in a C++ implementation file to complete the declaration of
1793 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1795 \wxheading{Include files}
1799 \membersection{IMPLEMENT\_CLASS2}
1801 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1803 Used in a C++ implementation file to complete the declaration of a
1804 class that has run-time type information and two base classes. The
1805 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1807 \wxheading{Include files}
1811 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1813 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1815 Used in a C++ implementation file to complete the declaration of
1816 a class that has run-time type information, and whose instances
1817 can be created dynamically.
1822 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1824 wxFrame::wxFrame(void)
1830 \wxheading{Include files}
1834 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1836 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1838 Used in a C++ implementation file to complete the declaration of
1839 a class that has run-time type information, and whose instances
1840 can be created dynamically. Use this for classes derived from two
1843 \wxheading{Include files}
1847 \membersection{WXDEBUG\_NEW}\label{debugnew}
1849 \func{}{WXDEBUG\_NEW}{arg}
1851 This is defined in debug mode to be call the redefined new operator
1852 with filename and line number arguments. The definition is:
1855 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1858 In non-debug mode, this is defined as the normal new operator.
1860 \wxheading{Include files}
1864 \membersection{wxDynamicCast}\label{wxdynamiccast}
1866 \func{}{wxDynamicCast}{ptr, classname}
1868 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
1869 the pointer is of this type (the check is done during the run-time) or NULL
1870 otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
1873 The {\it ptr} argument may be NULL, in which case NULL will be returned.
1878 wxWindow *win = wxWindow::FindFocus();
1879 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
1882 // a text control has the focus...
1886 // no window has the focus or it's not a text control
1890 \wxheading{See also}
1892 \helpref{RTTI overview}{runtimeclassoverview}
1894 \membersection{WXTRACE}\label{trace}
1896 \wxheading{Include files}
1900 \func{}{WXTRACE}{formatString, ...}
1902 Calls wxTrace with printf-style variable argument syntax. Output
1903 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1905 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1907 \wxheading{Include files}
1911 \membersection{WXTRACELEVEL}\label{tracelevel}
1913 \func{}{WXTRACELEVEL}{level, formatString, ...}
1915 Calls wxTraceLevel with printf-style variable argument syntax. Output
1916 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1917 The first argument should be the level at which this information is appropriate.
1918 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1921 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1923 \wxheading{Include files}
1927 \section{wxWindows resource functions}\label{resourcefuncs}
1929 \overview{wxWindows resource system}{resourceformats}
1931 This section details functions for manipulating wxWindows (.WXR) resource
1932 files and loading user interface elements from resources.
1934 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1935 about initialisation file resource reading and writing, using such functions
1936 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1938 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1940 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1941 loading from resource data.
1943 {\bf Warning:} this needs updating for wxWindows 2.
1945 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1947 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1949 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1950 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1951 perhaps for implementing resource functionality for interpreted languages.
1953 \membersection{::wxResourceClear}
1955 \func{void}{wxResourceClear}{\void}
1957 Clears the wxWindows resource table.
1959 \membersection{::wxResourceCreateBitmap}
1961 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1963 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1964 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1968 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1969 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1970 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1973 then this function can be called as follows:
1976 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1979 \membersection{::wxResourceCreateIcon}
1981 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1983 Creates a new icon from a file, static data, or Windows resource, given a valid
1984 wxWindows icon resource identifier. For example, if the .WXR file contains
1988 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1989 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1990 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1993 then this function can be called as follows:
1996 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1999 \membersection{::wxResourceCreateMenuBar}
2001 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
2003 Creates a new menu bar given a valid wxWindows menubar resource
2004 identifier. For example, if the .WXR file contains the following:
2007 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
2011 ['&Open File', 2, 'Open a file'],\
2012 ['&Save File', 3, 'Save a file'],\
2014 ['E&xit', 4, 'Exit program']\
2017 ['&About', 6, 'About this program']\
2022 then this function can be called as follows:
2025 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
2029 \membersection{::wxResourceGetIdentifier}
2031 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
2033 Used for retrieving the integer value associated with an identifier.
2034 A zero value indicates that the identifier was not found.
2036 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
2038 \membersection{::wxResourceParseData}\label{wxresourcedata}
2040 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2042 Parses a string containing one or more wxWindows resource objects. If
2043 the resource objects are global static data that are included into the
2044 C++ program, then this function must be called for each variable
2045 containing the resource data, to make it known to wxWindows.
2047 {\it resource} should contain data in the following form:
2050 dialog(name = 'dialog1',
2051 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
2052 title = 'Test dialog box',
2053 x = 312, y = 234, width = 400, height = 300,
2055 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
2056 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
2057 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
2058 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
2059 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
2060 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
2063 This function will typically be used after including a {\tt .wxr} file into
2064 a C++ program as follows:
2067 #include "dialog1.wxr"
2070 Each of the contained resources will declare a new C++ variable, and each
2071 of these variables should be passed to wxResourceParseData.
2073 \membersection{::wxResourceParseFile}
2075 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
2077 Parses a file containing one or more wxWindows resource objects
2078 in C++-compatible syntax. Use this function to dynamically load
2079 wxWindows resource data.
2081 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
2083 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
2085 Parses a string containing one or more wxWindows resource objects. If
2086 the resource objects are global static data that are included into the
2087 C++ program, then this function must be called for each variable
2088 containing the resource data, to make it known to wxWindows.
2090 {\it resource} should contain data with the following form:
2093 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2094 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2095 title = 'Test dialog box',\
2096 x = 312, y = 234, width = 400, height = 300,\
2098 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2099 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2100 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2101 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2102 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2103 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2106 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2107 load an entire {\tt .wxr file} into a string.
2109 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2111 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2112 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2114 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2116 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2117 This is required if other resources will use the bitmap data, since otherwise there
2118 is no connection between names used in resources, and the global bitmap data.
2120 \membersection{::wxResourceRegisterIconData}
2122 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2124 \section{Log functions}\label{logfunctions}
2126 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2127 further information.
2129 \wxheading{Include files}
2133 \membersection{::wxLogError}\label{wxlogerror}
2135 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2137 The function to use for error messages, i.e. the
2138 messages that must be shown to the user. The default processing is to pop up a
2139 message box to inform the user about it.
2141 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2143 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2145 Like \helpref{wxLogError}{wxlogerror}, but also
2146 terminates the program with the exit code 3. Using {\it abort()} standard
2147 function also terminates the program with this exit code.
2149 \membersection{::wxLogWarning}\label{wxlogwarning}
2151 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2153 For warnings - they are also normally shown to the
2154 user, but don't interrupt the program work.
2156 \membersection{::wxLogMessage}\label{wxlogmessage}
2158 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2160 for all normal, informational messages. They also
2161 appear in a message box by default (but it can be changed). Notice
2162 that the standard behaviour is to not show informational messages if there are
2163 any errors later - the logic being that the later error messages make the
2164 informational messages preceding them meaningless.
2166 \membersection{::wxLogVerbose}\label{wxlogverbose}
2168 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2170 For verbose output. Normally, it's suppressed, but
2171 might be activated if the user wishes to know more details about the program
2172 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2174 \membersection{::wxLogStatus}\label{wxlogstatus}
2176 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2178 For status messages - they will go into the status
2179 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2181 \membersection{::wxLogSysError}\label{wxlogsyserror}
2183 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2185 Mostly used by wxWindows itself, but might be
2186 handy for logging errors after system call (API function) failure. It logs the
2187 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2188 on the platform) and the corresponding error
2189 message. The second form of this function takes the error code explitly as the
2192 \membersection{::wxLogDebug}\label{wxlogdebug}
2194 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2196 The right function for debug output. It only
2197 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2198 and expands to nothing in release mode (otherwise).
2200 \membersection{::wxLogTrace}\label{wxlogtrace}
2202 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2204 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2206 As {\bf wxLogDebug}, only does something in debug
2207 build. The reason for making it a separate function from it is that usually
2208 there are a lot of trace messages, so it might make sense to separate them
2209 from other debug messages which would be flooded in them. Moreover, the second
2210 version of this function takes a trace mask as the first argument which allows
2211 to further restrict the amount of messages generated. The value of {\it mask} can be:
2213 \begin{itemize}\itemsep=0pt
2214 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2215 \item wxTraceMessages: trace window messages/X callbacks
2216 \item wxTraceResAlloc: trace GDI resource allocation
2217 \item wxTraceRefCount: trace various ref counting operations
2220 \section{Debugging macros and functions}\label{debugmacros}
2222 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2223 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2226 \wxheading{Include files}
2230 \membersection{::wxOnAssert}\label{wxonassert}
2232 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2234 This function may be redefined to do something non trivial and is called
2235 whenever one of debugging macros fails (i.e. condition is false in an
2237 % TODO: this should probably be an overridable in wxApp.
2239 \membersection{wxASSERT}\label{wxassert}
2241 \func{}{wxASSERT}{\param{}{condition}}
2243 Assert macro. An error message will be generated if the condition is FALSE in
2244 debug mode, but nothing will be done in the release build.
2246 Please note that the condition in wxASSERT() should have no side effects
2247 because it will not be executed in release mode at all.
2249 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2251 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2253 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2255 Assert macro with message. An error message will be generated if the condition is FALSE.
2257 See also: \helpref{wxASSERT}{wxassert}
2259 \membersection{wxFAIL}\label{wxfail}
2261 \func{}{wxFAIL}{\void}
2263 Will always generate an assert error if this code is reached (in debug mode).
2265 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2267 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2269 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2271 Will always generate an assert error with specified message if this code is reached (in debug mode).
2273 This macro is useful for marking unreachable" code areas, for example
2274 it may be used in the "default:" branch of a switch statement if all possible
2275 cases are processed above.
2277 See also: \helpref{wxFAIL}{wxfail}
2279 \membersection{wxCHECK}\label{wxcheck}
2281 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2283 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2284 This check is done even in release mode.
2286 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2288 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2290 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2291 This check is done even in release mode.
2293 This macro may be only used in non void functions, see also
2294 \helpref{wxCHECK\_RET}{wxcheckret}.
2296 \membersection{wxCHECK\_RET}\label{wxcheckret}
2298 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2300 Checks that the condition is true, and returns if not (FAILs with given error
2301 message in debug mode). This check is done even in release mode.
2303 This macro should be used in void functions instead of
2304 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2306 \membersection{wxCHECK2}\label{wxcheck2}
2308 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2310 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2311 {\it operation} if it is not. This is a generalisation of
2312 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2313 returning from the function must be done when the {\it condition} is false.
2315 This check is done even in release mode.
2317 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2319 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2321 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2322 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2323 instead of wxFAIL() if the {\it condition} is false.
projects / wxWidgets.git / blob