]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/function.tex
Some doc corrections; removed wxDocument arg from wxView constructor;
[wxWidgets.git] / docs / latex / wx / function.tex
1 \chapter{Functions}\label{functions}
2 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
4
5 The functions defined in wxWindows are described here.
6
7 \section{File functions}\label{filefunctions}
8
9 \wxheading{Include files}
10
11 <wx/utils.h>
12
13 \wxheading{See also}
14
15 \helpref{wxPathList}{wxpathlist}
16
17 \membersection{::wxDirExists}
18
19 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
20
21 Returns TRUE if the directory exists.
22
23 \membersection{::wxDos2UnixFilename}
24
25 \func{void}{Dos2UnixFilename}{\param{const wxString\& }{s}}
26
27 Converts a DOS to a Unix filename by replacing backslashes with forward
28 slashes.
29
30 \membersection{::wxFileExists}
31
32 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
33
34 Returns TRUE if the file exists.
35
36 \membersection{::wxFileNameFromPath}
37
38 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
39
40 Returns a temporary pointer to the filename for a full path.
41 Copy this pointer for long-term use.
42
43 \membersection{::wxFindFirstFile}\label{wxfindfirstfile}
44
45 \func{wxString}{wxFindFirstFile}{\param{const wxString\& }{spec}, \param{int}{ flags = 0}}
46
47 This function does directory searching; returns the first file
48 that matches the path {\it spec}, or NULL. Use \helpref{wxFindNextFile}{wxfindnextfile} to
49 get the next matching file.
50
51 {\it spec} may contain wildcards.
52
53 {\it flags} is reserved for future use.
54
55 The returned filename is a pointer to static memory so should
56 not be freed.
57
58 For example:
59
60 \begin{verbatim}
61 wxString f = wxFindFirstFile("/home/project/*.*");
62 while (f)
63 {
64 ...
65 f = wxFindNextFile();
66 }
67 \end{verbatim}
68
69 \membersection{::wxFindNextFile}\label{wxfindnextfile}
70
71 \func{wxString}{wxFindFirstFile}{\void}
72
73 Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
74
75 \membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
76
77 \func{wxString}{wxGetOSDirectory}{\void}
78
79 Returns the Windows directory under Windows; on other platforms returns the empty string.
80
81 \membersection{::wxIsAbsolutePath}
82
83 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
84
85 Returns TRUE if the argument is an absolute filename, i.e. with a slash
86 or drive name at the beginning.
87
88 \membersection{::wxPathOnly}
89
90 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
91
92 Returns a temporary pointer to the directory part of the filename. Copy this
93 pointer for long-term use.
94
95 \membersection{::wxUnix2DosFilename}
96
97 \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
98
99 Converts a Unix to a DOS filename by replacing forward
100 slashes with backslashes.
101
102 \membersection{::wxConcatFiles}
103
104 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
105 \param{const wxString\& }{file3}}
106
107 Concatenates {\it file1} and {\it file2} to {\it file3}, returning
108 TRUE if successful.
109
110 \membersection{::wxCopyFile}
111
112 \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
113
114 Copies {\it file1} to {\it file2}, returning TRUE if successful.
115
116 \membersection{::wxGetCwd}\label{wxgetcwd}
117
118 \func{wxString}{wxGetCwd}{\void}
119
120 Returns a string containing the current (or working) directory.
121
122 \membersection{::wxGetHostName}\label{wxgethostname}
123
124 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int }{sz}}
125
126 Copies the current host machine's name into the supplied buffer.
127
128 Under Windows or NT, this function first looks in the environment
129 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
130 in the {\bf wxWindows} section of the WIN.INI file is tried.
131
132 Returns TRUE if successful, FALSE otherwise.
133
134 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
135
136 \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
137
138 Copies the user's email address into the supplied buffer, by
139 concatenating the values returned by \helpref{wxGetHostName}{wxgethostname}\rtfsp
140 and \helpref{wxGetUserId}{wxgetuserid}.
141
142 Returns TRUE if successful, FALSE otherwise.
143
144 \membersection{::wxGetUserId}\label{wxgetuserid}
145
146 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int }{sz}}
147
148 Copies the current user id into the supplied buffer.
149
150 Under Windows or NT, this function first looks in the environment
151 variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
152 in the {\bf wxWindows} section of the WIN.INI file is tried.
153
154 Returns TRUE if successful, FALSE otherwise.
155
156 \membersection{::wxGetUserName}\label{wxgetusername}
157
158 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int }{sz}}
159
160 Copies the current user name into the supplied buffer.
161
162 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
163 in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
164 is running, the entry {\bf Current} in the section {\bf User} of
165 the PENWIN.INI file is used.
166
167 Returns TRUE if successful, FALSE otherwise.
168
169 \membersection{::wxGetWorkingDirectory}
170
171 \func{wxString}{wxGetWorkingDirectory}{\param{const wxString\& }{buf=NULL}, \param{int }{sz=1000}}
172
173 This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
174
175 Copies the current working directory into the buffer if supplied, or
176 copies the working directory into new storage (which you must delete yourself)
177 if the buffer is NULL.
178
179 {\it sz} is the size of the buffer if supplied.
180
181 \membersection{::wxGetTempFileName}
182
183 \func{wxString}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{const wxString\& }{buf=NULL}}
184
185 Makes a temporary filename based on {\it prefix}, opens and closes the file,
186 and places the name in {\it buf}. If {\it buf} is NULL, new store
187 is allocated for the temporary filename using {\it new}.
188
189 Under Windows, the filename will include the drive and name of the
190 directory allocated for temporary files (usually the contents of the
191 TEMP variable). Under Unix, the {\tt /tmp} directory is used.
192
193 It is the application's responsibility to create and delete the file.
194
195 \membersection{::wxIsWild}\label{wxiswild}
196
197 \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
198
199 Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
200
201 \membersection{::wxMatchWild}\label{wxmatchwild}
202
203 \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
204
205 Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it
206 dot\_special}\/ is TRUE, filenames beginning with a dot are not matched
207 with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
208
209 \membersection{::wxMkdir}
210
211 \func{bool}{wxMkdir}{\param{const wxString\& }{dir}}
212
213 Makes the directory {\it dir}, returning TRUE if successful.
214
215 \membersection{::wxRemoveFile}
216
217 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
218
219 Removes {\it file}, returning TRUE if successful.
220
221 \membersection{::wxRenameFile}
222
223 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
224
225 Renames {\it file1} to {\it file2}, returning TRUE if successful.
226
227 \membersection{::wxRmdir}
228
229 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
230
231 Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
232
233 The {\it flags} parameter is reserved for future use.
234
235 \membersection{::wxSetWorkingDirectory}
236
237 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
238
239 Sets the current working directory, returning TRUE if the operation succeeded.
240 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
241
242 \section{String functions}
243
244 \membersection{::copystring}
245
246 \func{char*}{copystring}{\param{const char* }{s}}
247
248 Makes a copy of the string {\it s} using the C++ new operator, so it can be
249 deleted with the {\it delete} operator.
250
251 \membersection{::wxStringMatch}
252
253 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
254 \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
255
256 Returns TRUE if the substring {\it s1} is found within {\it s2},
257 ignoring case if {\it exact} is FALSE. If {\it subString} is FALSE,
258 no substring matching is done.
259
260 \membersection{::wxStringEq}\label{wxstringeq}
261
262 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
263
264 A macro defined as:
265
266 \begin{verbatim}
267 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
268 \end{verbatim}
269
270 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
271
272 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
273
274 Copies the given file to {\it stream}. Useful when converting an old application to
275 use streams (within the document/view framework, for example).
276
277 Use of this function requires the file wx\_doc.h to be included.
278
279 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
280
281 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
282
283 Copies the given stream to the file {\it filename}. Useful when converting an old application to
284 use streams (within the document/view framework, for example).
285
286 Use of this function requires the file wx\_doc.h to be included.
287
288 \section{Dialog functions}\label{dialogfunctions}
289
290 Below are a number of convenience functions for getting input from the
291 user or displaying messages. Note that in these functions the last three
292 parameters are optional. However, it is recommended to pass a parent frame
293 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
294 the front when the dialog box is popped up.
295
296 \membersection{::wxFileSelector}\label{wxfileselector}
297
298 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = NULL},\\
299 \param{const wxString\& }{default\_filename = NULL}, \param{const wxString\& }{default\_extension = NULL},\\
300 \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
301 \param{int}{ x = -1}, \param{int}{ y = -1}}
302
303 Pops up a file selector box. In Windows, this is the common file selector
304 dialog. In X, this is a file selector box with somewhat less functionality.
305 The path and filename are distinct elements of a full file pathname.
306 If path is NULL, the current directory will be used. If filename is NULL,
307 no default filename will be supplied. The wildcard determines what files
308 are displayed in the file selector, and file extension supplies a type
309 extension for the required filename. Flags may be a combination of wxOPEN,
310 wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant
311 at present in Windows.
312
313 Both the X and Windows versions implement a wildcard filter. Typing a
314 filename containing wildcards (*, ?) in the filename text item, and
315 clicking on Ok, will result in only those files matching the pattern being
316 displayed. In the X version, supplying no default name will result in the
317 wildcard filter being inserted in the filename text item; the filter is
318 ignored if a default name is supplied.
319
320 Under Windows (only), the wildcard may be a specification for multiple
321 types of file with a description for each, such as:
322
323 \begin{verbatim}
324 "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
325 \end{verbatim}
326
327 The application must check for a NULL return value (the user pressed
328 Cancel). For example:
329
330 \begin{verbatim}
331 const wxString\& s = wxFileSelector("Choose a file to open");
332 if (s)
333 {
334 ...
335 }
336 \end{verbatim}
337
338 Remember that the returned pointer is temporary and should be copied
339 if other wxWindows calls will be made before the value is to be used.
340
341 \wxheading{Include files}
342
343 <wx/filedlg.h>
344
345 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
346
347 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
348 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
349 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
350
351 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
352 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
353 or press Cancel to return NULL.
354
355 If {\it centre} is TRUE, the message text (which may include new line characters)
356 is centred; if FALSE, the message is left-justified.
357
358 \wxheading{Include files}
359
360 <wx/textdlg.h>
361
362 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
363
364 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
365 \param{int }{nsel}, \param{int *}{selection},
366 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
367 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
368
369 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
370 listbox. The user may choose one or more item(s) and press OK or Cancel.
371
372 The number of initially selected choices, and array of the selected indices,
373 are passed in; this array will contain the user selections on exit, with
374 the function returning the number of selections. {\it selection} must be
375 as big as the number of choices, in case all are selected.
376
377 If Cancel is pressed, -1 is returned.
378
379 {\it choices} is an array of {\it n} strings for the listbox.
380
381 If {\it centre} is TRUE, the message text (which may include new line characters)
382 is centred; if FALSE, the message is left-justified.
383
384 \wxheading{Include files}
385
386 <wx/choicdlg.h>
387
388 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
389
390 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
391 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
392 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
393
394 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
395 listbox. The user may choose an item and press OK to return a string or
396 Cancel to return NULL.
397
398 {\it choices} is an array of {\it n} strings for the listbox.
399
400 If {\it centre} is TRUE, the message text (which may include new line characters)
401 is centred; if FALSE, the message is left-justified.
402
403 \wxheading{Include files}
404
405 <wx/choicdlg.h>
406
407 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
408
409 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
410 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
411 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
412
413 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
414 If the user pressed cancel, -1 is returned.
415
416 \wxheading{Include files}
417
418 <wx/choicdlg.h>
419
420 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
421
422 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
423 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
424 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
425
426 As {\bf wxGetSingleChoice} but takes an array of client data pointers
427 corresponding to the strings, and returns one of these pointers.
428
429 \wxheading{Include files}
430
431 <wx/choicdlg.h>
432
433 \membersection{::wxMessageBox}\label{wxmessagebox}
434
435 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
436 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
437
438 General purpose message dialog. {\it style} may be a bit list of the
439 following identifiers:
440
441 \begin{twocollist}\itemsep=0pt
442 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
443 wxCANCEL.}
444 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
445 wxYES\_NO or wxOK.}
446 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
447 \twocolitem{wxCENTRE}{Centres the text.}
448 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
449 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
450 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
451 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
452 \end{twocollist}
453
454 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
455
456 For example:
457
458 \begin{verbatim}
459 ...
460 int answer = wxMessageBox("Quit program?", "Confirm",
461 wxYES_NO | wxCANCEL, main_frame);
462 if (answer == wxYES)
463 delete main_frame;
464 ...
465 \end{verbatim}
466
467 {\it message} may contain newline characters, in which case the
468 message will be split into separate lines, to cater for large messages.
469
470 Under Windows, the native MessageBox function is used unless wxCENTRE
471 is specified in the style, in which case a generic function is used.
472 This is because the native MessageBox function cannot centre text.
473 The symbols are not shown when the generic function is used.
474
475 \wxheading{Include files}
476
477 <wx/msgdlg.h>
478
479 \section{GDI functions}\label{gdifunctions}
480
481 The following are relevant to the GDI (Graphics Device Interface).
482
483 \wxheading{Include files}
484
485 <wx/gdicmn.h>
486
487 \membersection{::wxColourDisplay}
488
489 \func{bool}{wxColourDisplay}{\void}
490
491 Returns TRUE if the display is colour, FALSE otherwise.
492
493 \membersection{::wxDisplayDepth}
494
495 \func{int}{wxDisplayDepth}{\void}
496
497 Returns the depth of the display (a value of 1 denotes a monochrome display).
498
499 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
500
501 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
502 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
503
504 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
505 makes it into a placeable metafile by prepending a header containing the given
506 bounding box. The bounding box may be obtained from a device context after drawing
507 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
508
509 In addition to adding the placeable metafile header, this function adds
510 the equivalent of the following code to the start of the metafile data:
511
512 \begin{verbatim}
513 SetMapMode(dc, MM_ANISOTROPIC);
514 SetWindowOrg(dc, minX, minY);
515 SetWindowExt(dc, maxX - minX, maxY - minY);
516 \end{verbatim}
517
518 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
519
520 Placeable metafiles may be imported by many Windows applications, and can be
521 used in RTF (Rich Text Format) files.
522
523 {\it scale} allows the specification of scale for the metafile.
524
525 This function is only available under Windows.
526
527 \membersection{::wxSetCursor}\label{wxsetcursor}
528
529 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
530
531 Globally sets the cursor; only has an effect in MS Windows.
532 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
533
534 \section{Printer settings}\label{printersettings}
535
536 The following functions are used to control PostScript printing. Under
537 Windows, PostScript output can only be sent to a file.
538
539 \wxheading{Include files}
540
541 <wx/dcps.h>
542
543 \membersection{::wxGetPrinterCommand}
544
545 \func{wxString}{wxGetPrinterCommand}{\void}
546
547 Gets the printer command used to print a file. The default is {\tt lpr}.
548
549 \membersection{::wxGetPrinterFile}
550
551 \func{wxString}{wxGetPrinterFile}{\void}
552
553 Gets the PostScript output filename.
554
555 \membersection{::wxGetPrinterMode}
556
557 \func{int}{wxGetPrinterMode}{\void}
558
559 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
560 The default is PS\_PREVIEW.
561
562 \membersection{::wxGetPrinterOptions}
563
564 \func{wxString}{wxGetPrinterOptions}{\void}
565
566 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
567
568 \membersection{::wxGetPrinterOrientation}
569
570 \func{int}{wxGetPrinterOrientation}{\void}
571
572 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
573
574 \membersection{::wxGetPrinterPreviewCommand}
575
576 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
577
578 Gets the command used to view a PostScript file. The default depends on the platform.
579
580 \membersection{::wxGetPrinterScaling}
581
582 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
583
584 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
585
586 \membersection{::wxGetPrinterTranslation}
587
588 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
589
590 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
591
592 \membersection{::wxSetPrinterCommand}
593
594 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
595
596 Sets the printer command used to print a file. The default is {\tt lpr}.
597
598 \membersection{::wxSetPrinterFile}
599
600 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
601
602 Sets the PostScript output filename.
603
604 \membersection{::wxSetPrinterMode}
605
606 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
607
608 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
609 The default is PS\_PREVIEW.
610
611 \membersection{::wxSetPrinterOptions}
612
613 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
614
615 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
616
617 \membersection{::wxSetPrinterOrientation}
618
619 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
620
621 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
622
623 \membersection{::wxSetPrinterPreviewCommand}
624
625 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
626
627 Sets the command used to view a PostScript file. The default depends on the platform.
628
629 \membersection{::wxSetPrinterScaling}
630
631 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
632
633 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
634
635 \membersection{::wxSetPrinterTranslation}
636
637 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
638
639 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
640
641 \section{Clipboard functions}\label{clipsboard}
642
643 These clipboard functions are implemented for Windows only.
644
645 \wxheading{Include files}
646
647 <wx/clipbrd.h>
648
649 \membersection{::wxClipboardOpen}
650
651 \func{bool}{wxClipboardOpen}{\void}
652
653 Returns TRUE if this application has already opened the clipboard.
654
655 \membersection{::wxCloseClipboard}
656
657 \func{bool}{wxCloseClipboard}{\void}
658
659 Closes the clipboard to allow other applications to use it.
660
661 \membersection{::wxEmptyClipboard}
662
663 \func{bool}{wxEmptyClipboard}{\void}
664
665 Empties the clipboard.
666
667 \membersection{::wxEnumClipboardFormats}
668
669 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
670
671 Enumerates the formats found in a list of available formats that belong
672 to the clipboard. Each call to this function specifies a known
673 available format; the function returns the format that appears next in
674 the list.
675
676 {\it dataFormat} specifies a known format. If this parameter is zero,
677 the function returns the first format in the list.
678
679 The return value specifies the next known clipboard data format if the
680 function is successful. It is zero if the {\it dataFormat} parameter specifies
681 the last format in the list of available formats, or if the clipboard
682 is not open.
683
684 Before it enumerates the formats function, an application must open the clipboard by using the
685 wxOpenClipboard function.
686
687 \membersection{::wxGetClipboardData}
688
689 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
690
691 Gets data from the clipboard.
692
693 {\it dataFormat} may be one of:
694
695 \begin{itemize}\itemsep=0pt
696 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
697 \item wxCF\_BITMAP: returns a new wxBitmap.
698 \end{itemize}
699
700 The clipboard must have previously been opened for this call to succeed.
701
702 \membersection{::wxGetClipboardFormatName}
703
704 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
705
706 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
707 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
708
709 \membersection{::wxIsClipboardFormatAvailable}
710
711 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
712
713 Returns TRUE if the given data format is available on the clipboard.
714
715 \membersection{::wxOpenClipboard}
716
717 \func{bool}{wxOpenClipboard}{\void}
718
719 Opens the clipboard for passing data to it or getting data from it.
720
721 \membersection{::wxRegisterClipboardFormat}
722
723 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
724
725 Registers the clipboard data format name and returns an identifier.
726
727 \membersection{::wxSetClipboardData}
728
729 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
730
731 Passes data to the clipboard.
732
733 {\it dataFormat} may be one of:
734
735 \begin{itemize}\itemsep=0pt
736 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
737 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
738 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
739 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
740 \end{itemize}
741
742 The clipboard must have previously been opened for this call to succeed.
743
744 \section{Miscellaneous functions}\label{miscellany}
745
746 \membersection{::wxNewId}
747
748 \func{long}{wxNewId}{\void}
749
750 Generates an integer identifier unique to this run of the program.
751
752 \wxheading{Include files}
753
754 <wx/utils.h>
755
756 \membersection{::wxRegisterId}
757
758 \func{void}{wxRegisterId}{\param{long}{ id}}
759
760 Ensures that ids subsequently generated by {\bf NewId} do not clash with
761 the given {\bf id}.
762
763 \wxheading{Include files}
764
765 <wx/utils.h>
766
767 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
768
769 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
770
771 Changes the cursor to the given cursor for all windows in the application.
772 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
773 to its previous state. These two calls can be nested, and a counter
774 ensures that only the outer calls take effect.
775
776 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
777
778 \wxheading{Include files}
779
780 <wx/utils.h>
781
782 \membersection{::wxBell}
783
784 \func{void}{wxBell}{\void}
785
786 Ring the system bell.
787
788 \wxheading{Include files}
789
790 <wx/utils.h>
791
792 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
793
794 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
795
796 Creates and returns an object of the given class, if the class has been
797 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
798
799 \membersection{::wxDDECleanUp}\label{wxddecleanup}
800
801 \func{void}{wxDDECleanUp}{\void}
802
803 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
804 called by the application.
805
806 See also helpref{wxDDEInitialize}{wxddeinitialize}.
807
808 \wxheading{Include files}
809
810 <wx/dde.h>
811
812 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
813
814 \func{void}{wxDDEInitialize}{\void}
815
816 Initializes the DDE system. May be called multiple times without harm.
817
818 This no longer needs to be called by the application: it will be called
819 by wxWindows if necessary.
820
821 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
822 \helpref{wxDDECleanUp}{wxddecleanup}.
823
824 \wxheading{Include files}
825
826 <wx/dde.h>
827
828 \membersection{::wxDebugMsg}\label{wxdebugmsg}
829
830 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
831
832 Display a debugging message; under Windows, this will appear on the
833 debugger command window, and under Unix, it will be written to standard
834 error.
835
836 The syntax is identical to {\bf printf}: pass a format string and a
837 variable list of arguments.
838
839 Note that under Windows, you can see the debugging messages without a
840 debugger if you have the DBWIN debug log application that comes with
841 Microsoft C++.
842
843 {\bf Tip:} under Windows, if your application crashes before the
844 message appears in the debugging window, put a wxYield call after
845 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
846 (at least for Watcom C++): preformat your messages and use OutputDebugString
847 instead.
848
849 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
850
851 \wxheading{Include files}
852
853 <wx/utils.h>
854
855 \membersection{::wxDisplaySize}
856
857 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
858
859 Gets the physical size of the display in pixels.
860
861 \wxheading{Include files}
862
863 <wx/gdicmn.h>
864
865 \membersection{::wxEntry}\label{wxentry}
866
867 This initializes wxWindows in a platform-dependent way. Use this if you
868 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
869 you can initialize wxWindows from an Microsoft Foundation Classes application using
870 this function.
871
872 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
873 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
874
875 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
876 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
877 message loop will be entered.
878
879 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
880 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
881
882 wxWindows initialization under Windows (for applications constructed as a DLL).
883
884 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
885
886 wxWindows initialization under Unix.
887
888 \wxheading{Remarks}
889
890 To clean up wxWindows, call wxApp::OnExit followed by the static function
891 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
892
893 \begin{verbatim}
894 int CTheApp::ExitInstance()
895 {
896 // OnExit isn't called by CleanUp so must be called explicitly.
897 wxTheApp->OnExit();
898 wxApp::CleanUp();
899
900 return CWinApp::ExitInstance();
901 }
902 \end{verbatim}
903
904 \wxheading{Include files}
905
906 <wx/app.h>
907
908 \membersection{::wxError}\label{wxerror}
909
910 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
911
912 Displays {\it msg} and continues. This writes to standard error under
913 Unix, and pops up a message box under Windows. Used for internal
914 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
915
916 \wxheading{Include files}
917
918 <wx/utils.h>
919
920 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
921
922 \func{void}{wxEndBusyCursor}{\void}
923
924 Changes the cursor back to the original cursor, for all windows in the application.
925 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
926
927 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
928
929 \wxheading{Include files}
930
931 <wx/utils.h>
932
933 \membersection{::wxExecute}\label{wxexecute}
934
935 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
936
937 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
938
939 Executes another program in Unix or Windows.
940
941 The first form takes a command string, such as {\tt "emacs file.txt"}.
942
943 The second form takes an array of values: a command, any number of
944 arguments, terminated by NULL.
945
946 If {\it sync} is FALSE (the default), flow of control immediately returns.
947 If TRUE, the current application waits until the other program has terminated.
948
949 If execution is asynchronous, the return value is the process id,
950 otherwise it is a status value. A zero value indicates that the command could not
951 be executed.
952
953 If callback isn't NULL and if execution is asynchronous,
954 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
955 the process finishes.
956
957 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
958
959 \wxheading{Include files}
960
961 <wx/utils.h>
962
963 \membersection{::wxExit}\label{wxexit}
964
965 \func{void}{wxExit}{\void}
966
967 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
968 Should only be used in an emergency: normally the top-level frame
969 should be deleted (after deleting all other frames) to terminate the
970 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
971
972 \wxheading{Include files}
973
974 <wx/app.h>
975
976 \membersection{::wxFatalError}\label{wxfatalerror}
977
978 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
979
980 Displays {\it msg} and exits. This writes to standard error under Unix,
981 and pops up a message box under Windows. Used for fatal internal
982 wxWindows errors. See also \helpref{wxError}{wxerror}.
983
984 \wxheading{Include files}
985
986 <wx/utils.h>
987
988 \membersection{::wxFindMenuItemId}
989
990 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
991
992 Find a menu item identifier associated with the given frame's menu bar.
993
994 \wxheading{Include files}
995
996 <wx/utils.h>
997
998 \membersection{::wxFindWindowByLabel}
999
1000 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1001
1002 Find a window by its label. Depending on the type of window, the label may be a window title
1003 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1004 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1005 The search is recursive in both cases.
1006
1007 \wxheading{Include files}
1008
1009 <wx/utils.h>
1010
1011 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1012
1013 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1014
1015 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1016 If {\it parent} is NULL, the search will start from all top-level
1017 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1018 The search is recursive in both cases.
1019
1020 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1021
1022 \wxheading{Include files}
1023
1024 <wx/utils.h>
1025
1026 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1027
1028 \func{wxWindow *}{wxGetActiveWindow}{\void}
1029
1030 Gets the currently active window (Windows only).
1031
1032 \wxheading{Include files}
1033
1034 <wx/windows.h>
1035
1036 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1037
1038 \func{wxString}{wxGetDisplayName}{\void}
1039
1040 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1041
1042 \wxheading{Include files}
1043
1044 <wx/utils.h>
1045
1046 \membersection{::wxGetHomeDir}
1047
1048 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1049
1050 Fills the buffer with a string representing the user's home directory (Unix only).
1051
1052 \wxheading{Include files}
1053
1054 <wx/utils.h>
1055
1056 \membersection{::wxGetHostName}
1057
1058 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1059
1060 Copies the host name of the machine the program is running on into the
1061 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1062 successful. Under Unix, this will return a machine name. Under Windows,
1063 this returns ``windows''.
1064
1065 \wxheading{Include files}
1066
1067 <wx/utils.h>
1068
1069 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1070
1071 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1072
1073 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1074
1075 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1076 by this call.
1077
1078 See also \helpref{wxTimer}{wxtimer}.
1079
1080 \wxheading{Include files}
1081
1082 <wx/timer.h>
1083
1084 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1085
1086 \func{long}{wxGetFreeMemory}{\void}
1087
1088 Returns the amount of free memory in Kbytes under environments which
1089 support it, and -1 if not supported. Currently, returns a positive value
1090 under Windows, and -1 under Unix.
1091
1092 \wxheading{Include files}
1093
1094 <wx/utils.h>
1095
1096 \membersection{::wxGetMousePosition}
1097
1098 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1099
1100 Returns the mouse position in screen coordinates.
1101
1102 \wxheading{Include files}
1103
1104 <wx/utils.h>
1105
1106 \membersection{::wxGetOsVersion}
1107
1108 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1109
1110 Gets operating system version information.
1111
1112 \begin{twocollist}\itemsep=0pt
1113 \twocolitemruled{Platform}{Return tyes}
1114 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1115 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1116 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1117 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1118 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1119 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1120 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1121 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1122 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1123 \end{twocollist}
1124
1125 \wxheading{Include files}
1126
1127 <wx/utils.h>
1128
1129 \membersection{::wxGetResource}\label{wxgetresource}
1130
1131 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1132 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1133
1134 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1135 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1136
1137 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1138 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1139
1140 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1141 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1142
1143 Gets a resource value from the resource database (for example, WIN.INI, or
1144 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1145 otherwise the specified file is used.
1146
1147 Under X, if an application class (wxApp::GetClassName) has been defined,
1148 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1149 an applications default file when merging all resource databases.
1150
1151 The reason for passing the result in an argument is that it
1152 can be convenient to define a default value, which gets overridden
1153 if the value exists in the resource file. It saves a separate
1154 test for that resource's existence, and it also allows
1155 the overloading of the function for different types.
1156
1157 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1158
1159 \wxheading{Include files}
1160
1161 <wx/utils.h>
1162
1163 \membersection{::wxGetUserId}
1164
1165 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1166
1167 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1168 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1169 Under Windows, this returns ``user''.
1170
1171 \wxheading{Include files}
1172
1173 <wx/utils.h>
1174
1175 \membersection{::wxGetUserName}
1176
1177 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1178
1179 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1180 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1181 Under Windows, this returns ``unknown''.
1182
1183 \wxheading{Include files}
1184
1185 <wx/utils.h>
1186
1187 \membersection{::wxKill}\label{wxkill}
1188
1189 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1190
1191 Under Unix (the only supported platform), equivalent to the Unix kill function.
1192 Returns 0 on success, -1 on failure.
1193
1194 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1195 It does not raise a signal in the receiving process.
1196
1197 \wxheading{Include files}
1198
1199 <wx/utils.h>
1200
1201 \membersection{::wxIsBusy}\label{wxisbusy}
1202
1203 \func{bool}{wxIsBusy}{\void}
1204
1205 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1206 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1207
1208 See also \helpref{wxBusyCursor}{wxbusycursor}.
1209
1210 \wxheading{Include files}
1211
1212 <wx/utils.h>
1213
1214 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1215
1216 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1217
1218 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1219 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1220
1221 The resource must be defined in the {\tt .rc} file using the following syntax:
1222
1223 \begin{verbatim}
1224 myResource TEXT file.ext
1225 \end{verbatim}
1226
1227 where {\tt file.ext} is a file that the resource compiler can find.
1228
1229 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1230 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1231 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1232
1233 This function is available under Windows only.
1234
1235 \wxheading{Include files}
1236
1237 <wx/utils.h>
1238
1239 \membersection{::wxNow}\label{wxnow}
1240
1241 \func{wxString}{wxNow}{\void}
1242
1243 Returns a string representing the current date and time.
1244
1245 \wxheading{Include files}
1246
1247 <wx/utils.h>
1248
1249 \membersection{::wxPostDelete}\label{wxpostdelete}
1250
1251 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1252
1253 Tells the system to delete the specified object when
1254 all other events have been processed. In some environments, it is
1255 necessary to use this instead of deleting a frame directly with the
1256 delete operator, because some GUIs will still send events to a deleted window.
1257
1258 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1259
1260 \wxheading{Include files}
1261
1262 <wx/utils.h>
1263
1264 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1265
1266 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1267
1268 Under X only, sets the current display name. This is the X host and display name such
1269 as ``colonsay:0.0", and the function indicates which display should be used for creating
1270 windows from this point on. Setting the display within an application allows multiple
1271 displays to be used.
1272
1273 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1274
1275 \wxheading{Include files}
1276
1277 <wx/utils.h>
1278
1279 \membersection{::wxShell}\label{wxshell}
1280
1281 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1282
1283 Executes a command in an interactive shell window. If no command is
1284 specified, then just the shell is spawned.
1285
1286 See also \helpref{wxExecute}{wxexecute}.
1287
1288 \wxheading{Include files}
1289
1290 <wx/utils.h>
1291
1292 \membersection{::wxSleep}\label{wxsleep}
1293
1294 \func{void}{wxSleep}{\param{int}{ secs}}
1295
1296 Sleeps for the specified number of seconds.
1297
1298 \wxheading{Include files}
1299
1300 <wx/utils.h>
1301
1302 \membersection{::wxStripMenuCodes}
1303
1304 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1305
1306 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1307
1308 Strips any menu codes from {\it in} and places the result
1309 in {\it out} (or returns the new string, in the first form).
1310
1311 Menu codes include \& (mark the next character with an underline
1312 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1313
1314 \wxheading{Include files}
1315
1316 <wx/utils.h>
1317
1318 \membersection{::wxStartTimer}\label{wxstarttimer}
1319
1320 \func{void}{wxStartTimer}{\void}
1321
1322 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1323
1324 See also \helpref{wxTimer}{wxtimer}.
1325
1326 \wxheading{Include files}
1327
1328 <wx/timer.h>
1329
1330 \membersection{::wxToLower}\label{wxtolower}
1331
1332 \func{char}{wxToLower}{\param{char }{ch}}
1333
1334 Converts the character to lower case. This is implemented as a macro for efficiency.
1335
1336 \wxheading{Include files}
1337
1338 <wx/utils.h>
1339
1340 \membersection{::wxToUpper}\label{wxtoupper}
1341
1342 \func{char}{wxToUpper}{\param{char }{ch}}
1343
1344 Converts the character to upper case. This is implemented as a macro for efficiency.
1345
1346 \wxheading{Include files}
1347
1348 <wx/utils.h>
1349
1350 \membersection{::wxTrace}\label{wxtrace}
1351
1352 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1353
1354 Takes printf-style variable argument syntax. Output
1355 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1356
1357 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1358
1359 \wxheading{Include files}
1360
1361 <wx/memory.h>
1362
1363 \membersection{::wxTraceLevel}\label{wxtracelevel}
1364
1365 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1366
1367 Takes printf-style variable argument syntax. Output
1368 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1369 The first argument should be the level at which this information is appropriate.
1370 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1371 this value.
1372
1373 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1374
1375 \wxheading{Include files}
1376
1377 <wx/memory.h>
1378
1379 \membersection{::wxWriteResource}\label{wxwriteresource}
1380
1381 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1382 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1383
1384 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1385 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1386
1387 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1388 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1389
1390 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1391 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1392
1393 Writes a resource value into the resource database (for example, WIN.INI, or
1394 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1395 otherwise the specified file is used.
1396
1397 Under X, the resource databases are cached until the internal function
1398 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1399 all updated resource databases are written to their files.
1400
1401 Note that it is considered bad manners to write to the .Xdefaults
1402 file under Unix, although the WIN.INI file is fair game under Windows.
1403
1404 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1405
1406 \wxheading{Include files}
1407
1408 <wx/utils.h>
1409
1410 \membersection{::wxYield}
1411
1412 \func{bool}{wxYield}{\void}
1413
1414 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1415 time-consuming process writes to a text window. Without an occasional
1416 yield, the text window will not be updated properly, and (since Windows
1417 multitasking is cooperative) other processes will not respond.
1418
1419 Caution should be exercised, however, since yielding may allow the
1420 user to perform actions which are not compatible with the current task.
1421 Disabling menu items or whole menus during processing can avoid unwanted
1422 reentrance of code.
1423
1424 \wxheading{Include files}
1425
1426 <wx/utils.h>
1427
1428 \section{Macros}\label{macros}
1429
1430 These macros are defined in wxWindows.
1431
1432 \membersection{CLASSINFO}\label{classinfo}
1433
1434 \func{wxClassInfo *}{CLASSINFO}{className}
1435
1436 Returns a pointer to the wxClassInfo object associated with this class.
1437
1438 \wxheading{Include files}
1439
1440 <wx/object.h>
1441
1442 \membersection{WXDEBUG\_NEW}\label{debugnew}
1443
1444 \func{}{WXDEBUG\_NEW}{arg}
1445
1446 This is defined in debug mode to be call the redefined new operator
1447 with filename and line number arguments. The definition is:
1448
1449 \begin{verbatim}
1450 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1451 \end{verbatim}
1452
1453 In non-debug mode, this is defined as the normal new operator.
1454
1455 \wxheading{Include files}
1456
1457 <wx/object.h>
1458
1459 \membersection{DECLARE\_ABSTRACT\_CLASS}
1460
1461 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1462
1463 Used inside a class declaration to declare that the class should be
1464 made known to the class hierarchy, but objects of this class cannot be created
1465 dynamically. The same as DECLARE\_CLASS.
1466
1467 Example:
1468
1469 \begin{verbatim}
1470 class wxCommand: public wxObject
1471 {
1472 DECLARE_ABSTRACT_CLASS(wxCommand)
1473
1474 private:
1475 ...
1476 public:
1477 ...
1478 };
1479 \end{verbatim}
1480
1481 \wxheading{Include files}
1482
1483 <wx/object.h>
1484
1485 \membersection{DECLARE\_APP}\label{declareapp}
1486
1487 \func{}{DECLARE\_APP}{className}
1488
1489 This is used in headers to create a forward declaration of the wxGetApp function implemented
1490 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1491
1492 Example:
1493
1494 \begin{verbatim}
1495 DECLARE_APP(MyApp)
1496 \end{verbatim}
1497
1498 \wxheading{Include files}
1499
1500 <wx/app.h>
1501
1502 \membersection{DECLARE\_CLASS}
1503
1504 \func{}{DECLARE\_CLASS}{className}
1505
1506 Used inside a class declaration to declare that the class should be
1507 made known to the class hierarchy, but objects of this class cannot be created
1508 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1509
1510 \wxheading{Include files}
1511
1512 <wx/object.h>
1513
1514 \membersection{DECLARE\_DYNAMIC\_CLASS}
1515
1516 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1517
1518 Used inside a class declaration to declare that the objects of this class should be dynamically
1519 createable from run-time type information.
1520
1521 Example:
1522
1523 \begin{verbatim}
1524 class wxFrame: public wxWindow
1525 {
1526 DECLARE_DYNAMIC_CLASS(wxFrame)
1527
1528 private:
1529 const wxString\& frameTitle;
1530 public:
1531 ...
1532 };
1533 \end{verbatim}
1534
1535 \wxheading{Include files}
1536
1537 <wx/object.h>
1538
1539 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1540
1541 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1542
1543 Used in a C++ implementation file to complete the declaration of
1544 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1545
1546 Example:
1547
1548 \begin{verbatim}
1549 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1550
1551 wxCommand::wxCommand(void)
1552 {
1553 ...
1554 }
1555 \end{verbatim}
1556
1557 \wxheading{Include files}
1558
1559 <wx/object.h>
1560
1561 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1562
1563 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1564
1565 Used in a C++ implementation file to complete the declaration of
1566 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1567
1568 \wxheading{Include files}
1569
1570 <wx/object.h>
1571
1572 \membersection{IMPLEMENT\_APP}\label{implementapp}
1573
1574 \func{}{IMPLEMENT\_APP}{className}
1575
1576 This is used in the application class implementation file to make the application class known to
1577 wxWindows for dynamic construction. You use this instead of
1578
1579 Old form:
1580
1581 \begin{verbatim}
1582 MyApp myApp;
1583 \end{verbatim}
1584
1585 New form:
1586
1587 \begin{verbatim}
1588 IMPLEMENT_APP(MyApp)
1589 \end{verbatim}
1590
1591 See also \helpref{DECLARE\_APP}{declareapp}.
1592
1593 \wxheading{Include files}
1594
1595 <wx/app.h>
1596
1597 \membersection{IMPLEMENT\_CLASS}
1598
1599 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1600
1601 Used in a C++ implementation file to complete the declaration of
1602 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1603
1604 \wxheading{Include files}
1605
1606 <wx/object.h>
1607
1608 \membersection{IMPLEMENT\_CLASS2}
1609
1610 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1611
1612 Used in a C++ implementation file to complete the declaration of a
1613 class that has run-time type information and two base classes. The
1614 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1615
1616 \wxheading{Include files}
1617
1618 <wx/object.h>
1619
1620 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1621
1622 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1623
1624 Used in a C++ implementation file to complete the declaration of
1625 a class that has run-time type information, and whose instances
1626 can be created dynamically.
1627
1628 Example:
1629
1630 \begin{verbatim}
1631 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1632
1633 wxFrame::wxFrame(void)
1634 {
1635 ...
1636 }
1637 \end{verbatim}
1638
1639 \wxheading{Include files}
1640
1641 <wx/object.h>
1642
1643 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1644
1645 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1646
1647 Used in a C++ implementation file to complete the declaration of
1648 a class that has run-time type information, and whose instances
1649 can be created dynamically. Use this for classes derived from two
1650 base classes.
1651
1652 \wxheading{Include files}
1653
1654 <wx/object.h>
1655
1656 \membersection{WXTRACE}\label{trace}
1657
1658 \func{}{WXTRACE}{formatString, ...}
1659
1660 Calls wxTrace with printf-style variable argument syntax. Output
1661 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1662
1663 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1664
1665 \wxheading{Include files}
1666
1667 <wx/memory.h>
1668
1669 \membersection{WXTRACELEVEL}\label{tracelevel}
1670
1671 \func{}{WXTRACELEVEL}{level, formatString, ...}
1672
1673 Calls wxTraceLevel with printf-style variable argument syntax. Output
1674 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1675 The first argument should be the level at which this information is appropriate.
1676 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1677 this value.
1678
1679 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1680
1681 \wxheading{Include files}
1682
1683 <wx/memory.h>
1684
1685 \section{wxWindows resource functions}\label{resourcefuncs}
1686
1687 \overview{wxWindows resource system}{resourceformats}
1688
1689 This section details functions for manipulating wxWindows (.WXR) resource
1690 files and loading user interface elements from resources.
1691
1692 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1693 about initialisation file resource reading and writing, using such functions
1694 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1695
1696 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1697
1698 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1699 loading from resource data.
1700
1701 {\bf Warning:} this needs updating for wxWindows 2.
1702
1703 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1704
1705 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1706
1707 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1708 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1709 perhaps for implementing resource functionality for interpreted languages.
1710
1711 \membersection{::wxResourceClear}
1712
1713 \func{void}{wxResourceClear}{\void}
1714
1715 Clears the wxWindows resource table.
1716
1717 \membersection{::wxResourceCreateBitmap}
1718
1719 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1720
1721 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1722 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1723 the following:
1724
1725 \begin{verbatim}
1726 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1727 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1728 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1729 \end{verbatim}
1730
1731 then this function can be called as follows:
1732
1733 \begin{verbatim}
1734 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1735 \end{verbatim}
1736
1737 \membersection{::wxResourceCreateIcon}
1738
1739 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1740
1741 Creates a new icon from a file, static data, or Windows resource, given a valid
1742 wxWindows icon resource identifier. For example, if the .WXR file contains
1743 the following:
1744
1745 \begin{verbatim}
1746 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1747 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1748 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1749 \end{verbatim}
1750
1751 then this function can be called as follows:
1752
1753 \begin{verbatim}
1754 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1755 \end{verbatim}
1756
1757 \membersection{::wxResourceCreateMenuBar}
1758
1759 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1760
1761 Creates a new menu bar given a valid wxWindows menubar resource
1762 identifier. For example, if the .WXR file contains the following:
1763
1764 \begin{verbatim}
1765 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1766 menu = \
1767 [\
1768 ['&File', 1, '', \
1769 ['&Open File', 2, 'Open a file'],\
1770 ['&Save File', 3, 'Save a file'],\
1771 [],\
1772 ['E&xit', 4, 'Exit program']\
1773 ],\
1774 ['&Help', 5, '', \
1775 ['&About', 6, 'About this program']\
1776 ]\
1777 ]).";
1778 \end{verbatim}
1779
1780 then this function can be called as follows:
1781
1782 \begin{verbatim}
1783 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1784 \end{verbatim}
1785
1786
1787 \membersection{::wxResourceGetIdentifier}
1788
1789 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1790
1791 Used for retrieving the integer value associated with an identifier.
1792 A zero value indicates that the identifier was not found.
1793
1794 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1795
1796 \membersection{::wxResourceParseData}\label{wxresourcedata}
1797
1798 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1799
1800 Parses a string containing one or more wxWindows resource objects. If
1801 the resource objects are global static data that are included into the
1802 C++ program, then this function must be called for each variable
1803 containing the resource data, to make it known to wxWindows.
1804
1805 {\it resource} should contain data in the following form:
1806
1807 \begin{verbatim}
1808 dialog(name = 'dialog1',
1809 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1810 title = 'Test dialog box',
1811 x = 312, y = 234, width = 400, height = 300,
1812 modal = 0,
1813 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1814 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1815 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1816 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1817 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1818 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1819 \end{verbatim}
1820
1821 This function will typically be used after including a {\tt .wxr} file into
1822 a C++ program as follows:
1823
1824 \begin{verbatim}
1825 #include "dialog1.wxr"
1826 \end{verbatim}
1827
1828 Each of the contained resources will declare a new C++ variable, and each
1829 of these variables should be passed to wxResourceParseData.
1830
1831 \membersection{::wxResourceParseFile}
1832
1833 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1834
1835 Parses a file containing one or more wxWindows resource objects
1836 in C++-compatible syntax. Use this function to dynamically load
1837 wxWindows resource data.
1838
1839 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1840
1841 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1842
1843 Parses a string containing one or more wxWindows resource objects. If
1844 the resource objects are global static data that are included into the
1845 C++ program, then this function must be called for each variable
1846 containing the resource data, to make it known to wxWindows.
1847
1848 {\it resource} should contain data with the following form:
1849
1850 \begin{verbatim}
1851 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
1852 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
1853 title = 'Test dialog box',\
1854 x = 312, y = 234, width = 400, height = 300,\
1855 modal = 0,\
1856 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
1857 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
1858 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
1859 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
1860 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
1861 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
1862 \end{verbatim}
1863
1864 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
1865 load an entire {\tt .wxr file} into a string.
1866
1867 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
1868
1869 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
1870 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
1871
1872 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
1873
1874 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
1875 This is required if other resources will use the bitmap data, since otherwise there
1876 is no connection between names used in resources, and the global bitmap data.
1877
1878 \membersection{::wxResourceRegisterIconData}
1879
1880 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
1881
1882 \section{Log functions}\label{logfunctions}
1883
1884 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
1885 further information.
1886
1887 \wxheading{Include files}
1888
1889 <wx/log.h>
1890
1891 \membersection{::wxLogError}\label{wxlogerror}
1892
1893 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
1894
1895 The function to use for error messages, i.e. the
1896 messages that must be shown to the user. The default processing is to pop up a
1897 message box to inform the user about it.
1898
1899 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
1900
1901 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
1902
1903 Like \helpref{wxLogError}{wxlogerror}, but also
1904 terminates the program with the exit code 3. Using {\it abort()} standard
1905 function also terminates the program with this exit code.
1906
1907 \membersection{::wxLogWarning}\label{wxlogwarning}
1908
1909 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
1910
1911 For warnings - they are also normally shown to the
1912 user, but don't interrupt the program work.
1913
1914 \membersection{::wxLogMessage}\label{wxlogmessage}
1915
1916 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
1917
1918 for all normal, informational messages. They also
1919 appear in a message box by default (but it can be changed). Notice
1920 that the standard behaviour is to not show informational messages if there are
1921 any errors later - the logic being that the later error messages make the
1922 informational messages preceding them meaningless.
1923
1924 \membersection{::wxLogVerbose}\label{wxlogverbose}
1925
1926 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
1927
1928 For verbose output. Normally, it's suppressed, but
1929 might be activated if the user wishes to know more details about the program
1930 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
1931
1932 \membersection{::wxLogStatus}\label{wxlogstatus}
1933
1934 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
1935
1936 For status messages - they will go into the status
1937 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
1938
1939 \membersection{::wxLogSysError}\label{wxlogsyserror}
1940
1941 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
1942
1943 Mostly used by wxWindows itself, but might be
1944 handy for logging errors after system call (API function) failure. It logs the
1945 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
1946 on the platform) and the corresponding error
1947 message. The second form of this function takes the error code explitly as the
1948 first argument.
1949
1950 \membersection{::wxLogDebug}\label{wxlogdebug}
1951
1952 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
1953
1954 The right function for debug output. It only
1955 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
1956 and expands to nothing in release mode (otherwise).
1957
1958 \membersection{::wxLogTrace}\label{wxlogtrace}
1959
1960 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
1961
1962 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
1963
1964 As {\bf wxLogDebug}, only does something in debug
1965 build. The reason for making it a separate function from it is that usually
1966 there are a lot of trace messages, so it might make sense to separate them
1967 from other debug messages which would be flooded in them. Moreover, the second
1968 version of this function takes a trace mask as the first argument which allows
1969 to further restrict the amount of messages generated. The value of {\it mask} can be:
1970
1971 \begin{itemize}\itemsep=0pt
1972 \item wxTraceMemAlloc: trace memory allocation (new/delete)
1973 \item wxTraceMessages: trace window messages/X callbacks
1974 \item wxTraceResAlloc: trace GDI resource allocation
1975 \item wxTraceRefCount: trace various ref counting operations
1976 \end{itemize}
1977
1978 \section{Debugging macros and functions}\label{debugmacros}
1979
1980 Useful macros and functins for error checking and defensive programming. ASSERTs are only
1981 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
1982 builds.
1983
1984 \wxheading{Include files}
1985
1986 <wx/debug.h>
1987
1988 \membersection{::wxOnAssert}\label{wxonassert}
1989
1990 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
1991
1992 This function may be redefined to do something non trivial and is called
1993 whenever one of debugging macros fails (i.e. condition is false in an
1994 assertion).
1995 % TODO: this should probably be an overridable in wxApp.
1996
1997 \membersection{wxASSERT}\label{wxassert}
1998
1999 \func{}{wxASSERT}{\param{}{condition}}
2000
2001 Assert macro. An error message will be generated if the condition is FALSE.
2002
2003 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2004
2005 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2006
2007 Assert macro with message. An error message will be generated if the condition is FALSE.
2008
2009 \membersection{wxFAIL}\label{wxfail}
2010
2011 \func{}{wxFAIL}{\param{}{condition}}
2012
2013 Will always generate an assert error if this code is reached (in debug mode).
2014
2015 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2016
2017 \func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
2018
2019 Will always generate an assert error with specified message if this code is reached (in debug mode).
2020
2021 \membersection{wxCHECK}\label{wxcheck}
2022
2023 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2024
2025 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2026 This check is done even in release mode.
2027
2028 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2029
2030 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2031
2032 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2033 This check is done even in release mode.
2034