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.
57 The returned filename is a pointer to static memory so should
63 wxString f = wxFindFirstFile("/home/project/*.*");
71 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
73 \func{wxString
}{wxFindFirstFile
}{\void}
75 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
77 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
79 \func{wxString
}{wxGetOSDirectory
}{\void}
81 Returns the Windows directory under Windows; on other platforms returns the empty string.
83 \membersection{::wxIsAbsolutePath
}
85 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
87 Returns TRUE if the argument is an absolute filename, i.e. with a slash
88 or drive name at the beginning.
90 \membersection{::wxPathOnly
}
92 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
94 Returns the directory part of the filename.
96 \membersection{::wxUnix2DosFilename
}
98 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
100 Converts a Unix to a DOS filename by replacing forward
101 slashes with backslashes.
103 \membersection{::wxConcatFiles
}
105 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
106 \param{const wxString\&
}{file3
}}
108 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
111 \membersection{::wxCopyFile
}
113 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
115 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
117 \membersection{::wxGetCwd
}\label{wxgetcwd
}
119 \func{wxString
}{wxGetCwd
}{\void}
121 Returns a string containing the current (or working) directory.
123 \membersection{::wxGetHostName
}\label{wxgethostname
}
125 \func{bool
}{wxGetHostName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
127 Copies the current host machine's name into the supplied buffer.
129 Under Windows or NT, this function first looks in the environment
130 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
131 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
133 Returns TRUE if successful, FALSE otherwise.
135 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
137 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
139 Copies the user's email address into the supplied buffer, by
140 concatenating the values returned by
\helpref{wxGetHostName
}{wxgethostname
}\rtfsp
141 and
\helpref{wxGetUserId
}{wxgetuserid
}.
143 Returns TRUE if successful, FALSE otherwise.
145 \membersection{::wxGetUserId
}\label{wxgetuserid
}
147 \func{bool
}{wxGetUserId
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
149 Copies the current user id into the supplied buffer.
151 Under Windows or NT, this function first looks in the environment
152 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
153 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
155 Returns TRUE if successful, FALSE otherwise.
157 \membersection{::wxGetUserName
}\label{wxgetusername
}
159 \func{bool
}{wxGetUserName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
161 Copies the current user name into the supplied buffer.
163 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
164 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
165 is running, the entry
{\bf Current
} in the section
{\bf User
} of
166 the PENWIN.INI file is used.
168 Returns TRUE if successful, FALSE otherwise.
170 \membersection{::wxGetWorkingDirectory
}
172 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
174 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
176 Copies the current working directory into the buffer if supplied, or
177 copies the working directory into new storage (which you must delete yourself)
178 if the buffer is NULL.
180 {\it sz
} is the size of the buffer if supplied.
182 \membersection{::wxGetTempFileName
}
184 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
186 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
187 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
188 is allocated for the temporary filename using
{\it new
}.
190 Under Windows, the filename will include the drive and name of the
191 directory allocated for temporary files (usually the contents of the
192 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
194 It is the application's responsibility to create and delete the file.
196 \membersection{::wxIsWild
}\label{wxiswild
}
198 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
200 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
202 \membersection{::wxMatchWild
}\label{wxmatchwild
}
204 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
206 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
207 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
208 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
210 \membersection{::wxMkdir
}
212 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
}}
214 Makes the directory
{\it dir
}, returning TRUE if successful.
216 \membersection{::wxRemoveFile
}
218 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
220 Removes
{\it file
}, returning TRUE if successful.
222 \membersection{::wxRenameFile
}
224 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
226 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
228 \membersection{::wxRmdir
}
230 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
232 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
234 The
{\it flags
} parameter is reserved for future use.
236 \membersection{::wxSetWorkingDirectory
}
238 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
240 Sets the current working directory, returning TRUE if the operation succeeded.
241 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
243 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
245 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
247 This function splits a full file name into components: the path (including possible disk/drive
248 specification under Windows), the base name and the extension. Any of the output parameters
249 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
250 a particular component.
252 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
253 Windows, however it will not consider backslashes as path separators under Unix (where backslash
254 is a valid character in a filename).
256 On entry,
{\it fullname
} should be non NULL (it may be empty though).
258 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
259 contains the file name and
{\it ext
} contains the file extension without leading dot. All
260 three of them may be empty if the corresponding component is. The old contents of the
261 strings pointed to by these parameters will be overwritten in any case (if the pointers
264 \section{String functions
}
266 \membersection{::copystring
}
268 \func{char*
}{copystring
}{\param{const char*
}{s
}}
270 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
271 deleted with the
{\it delete
} operator.
273 \membersection{::wxStringMatch
}
275 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
276 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
278 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
279 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
280 no substring matching is done.
282 \membersection{::wxStringEq
}\label{wxstringeq
}
284 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
289 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
292 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
294 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
296 Copies the given file to
{\it stream
}. Useful when converting an old application to
297 use streams (within the
document/view framework, for example).
299 Use of this function requires the file wx
\_doc.h to be included.
301 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
303 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
305 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
306 use streams (within the
document/view framework, for example).
308 Use of this function requires the file wx
\_doc.h to be included.
310 \section{Dialog functions
}\label{dialogfunctions
}
312 Below are a number of convenience functions for getting input from the
313 user or displaying messages. Note that in these functions the last three
314 parameters are optional. However, it is recommended to pass a parent frame
315 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
316 the front when the dialog box is popped up.
318 \membersection{::wxFileSelector
}\label{wxfileselector
}
320 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = NULL
},\\
321 \param{const wxString\&
}{default
\_filename = NULL
},
\param{const wxString\&
}{default
\_extension = NULL
},\\
322 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
323 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
325 Pops up a file selector box. In Windows, this is the common file selector
326 dialog. In X, this is a file selector box with somewhat less functionality.
327 The path and filename are distinct elements of a full file pathname.
328 If path is NULL, the current directory will be used. If filename is NULL,
329 no default filename will be supplied. The wildcard determines what files
330 are displayed in the file selector, and file extension supplies a type
331 extension for the required filename. Flags may be a combination of wxOPEN,
332 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
333 at present in Windows.
335 Both the X and Windows versions implement a wildcard filter. Typing a
336 filename containing wildcards
(*, ?) in the filename text item, and
337 clicking on Ok, will result in only those files matching the pattern being
338 displayed. In the X version, supplying no default name will result in the
339 wildcard filter being inserted in the filename text item; the filter is
340 ignored if a default name is supplied.
342 Under Windows (only), the wildcard may be a specification for multiple
343 types of file with a description for each, such as:
346 "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
349 The application must check for a NULL return value (the user pressed
350 Cancel). For example:
353 const wxString\& s = wxFileSelector("Choose a file to open");
360 Remember that the returned pointer is temporary and should be copied
361 if other wxWindows calls will be made before the value is to be used.
363 \wxheading{Include files}
367 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
369 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
370 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
371 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
373 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
374 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
375 or press Cancel to return the empty string.
377 If {\it centre} is TRUE, the message text (which may include new line characters)
378 is centred; if FALSE, the message is left-justified.
380 \wxheading{Include files}
384 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
386 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
387 \param{int }{nsel}, \param{int *}{selection},
388 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
389 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
391 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
392 listbox. The user may choose one or more item(s) and press OK or Cancel.
394 The number of initially selected choices, and array of the selected indices,
395 are passed in; this array will contain the user selections on exit, with
396 the function returning the number of selections. {\it selection} must be
397 as big as the number of choices, in case all are selected.
399 If Cancel is pressed, -1 is returned.
401 {\it choices} is an array of {\it n} strings for the listbox.
403 If {\it centre} is TRUE, the message text (which may include new line characters)
404 is centred; if FALSE, the message is left-justified.
406 \wxheading{Include files}
410 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
412 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
413 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
414 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
416 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
417 listbox. The user may choose an item and press OK to return a string or
418 Cancel to return the empty string.
420 {\it choices} is an array of {\it n} strings for the listbox.
422 If {\it centre} is TRUE, the message text (which may include new line characters)
423 is centred; if FALSE, the message is left-justified.
425 \wxheading{Include files}
429 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
431 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
432 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
433 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
435 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
436 If the user pressed cancel, -1 is returned.
438 \wxheading{Include files}
442 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
444 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
445 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
446 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
448 As {\bf wxGetSingleChoice} but takes an array of client data pointers
449 corresponding to the strings, and returns one of these pointers.
451 \wxheading{Include files}
455 \membersection{::wxMessageBox}\label{wxmessagebox}
457 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
458 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
460 General purpose message dialog. {\it style} may be a bit list of the
461 following identifiers:
463 \begin{twocollist}\itemsep=0pt
464 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
466 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
468 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
469 \twocolitem{wxCENTRE}{Centres the text.}
470 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
471 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
472 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
473 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
476 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
482 int answer = wxMessageBox("Quit program?", "Confirm",
483 wxYES_NO | wxCANCEL, main_frame);
489 {\it message} may contain newline characters, in which case the
490 message will be split into separate lines, to cater for large messages.
492 Under Windows, the native MessageBox function is used unless wxCENTRE
493 is specified in the style, in which case a generic function is used.
494 This is because the native MessageBox function cannot centre text.
495 The symbols are not shown when the generic function is used.
497 \wxheading{Include files}
501 \section{GDI functions}\label{gdifunctions}
503 The following are relevant to the GDI (Graphics Device Interface).
505 \wxheading{Include files}
509 \membersection{::wxColourDisplay}
511 \func{bool}{wxColourDisplay}{\void}
513 Returns TRUE if the display is colour, FALSE otherwise.
515 \membersection{::wxDisplayDepth}
517 \func{int}{wxDisplayDepth}{\void}
519 Returns the depth of the display (a value of 1 denotes a monochrome display).
521 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
523 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
524 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
526 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
527 makes it into a placeable metafile by prepending a header containing the given
528 bounding box. The bounding box may be obtained from a device context after drawing
529 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
531 In addition to adding the placeable metafile header, this function adds
532 the equivalent of the following code to the start of the metafile data:
535 SetMapMode(dc, MM_ANISOTROPIC);
536 SetWindowOrg(dc, minX, minY);
537 SetWindowExt(dc, maxX - minX, maxY - minY);
540 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
542 Placeable metafiles may be imported by many Windows applications, and can be
543 used in RTF (Rich Text Format) files.
545 {\it scale} allows the specification of scale for the metafile.
547 This function is only available under Windows.
549 \membersection{::wxSetCursor}\label{wxsetcursor}
551 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
553 Globally sets the cursor; only has an effect in MS Windows.
554 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
556 \section{Printer settings}\label{printersettings}
558 The following functions are used to control PostScript printing. Under
559 Windows, PostScript output can only be sent to a file.
561 \wxheading{Include files}
565 \membersection{::wxGetPrinterCommand}
567 \func{wxString}{wxGetPrinterCommand}{\void}
569 Gets the printer command used to print a file. The default is {\tt lpr}.
571 \membersection{::wxGetPrinterFile}
573 \func{wxString}{wxGetPrinterFile}{\void}
575 Gets the PostScript output filename.
577 \membersection{::wxGetPrinterMode}
579 \func{int}{wxGetPrinterMode}{\void}
581 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
582 The default is PS\_PREVIEW.
584 \membersection{::wxGetPrinterOptions}
586 \func{wxString}{wxGetPrinterOptions}{\void}
588 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
590 \membersection{::wxGetPrinterOrientation}
592 \func{int}{wxGetPrinterOrientation}{\void}
594 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
596 \membersection{::wxGetPrinterPreviewCommand}
598 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
600 Gets the command used to view a PostScript file. The default depends on the platform.
602 \membersection{::wxGetPrinterScaling}
604 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
606 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
608 \membersection{::wxGetPrinterTranslation}
610 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
612 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
614 \membersection{::wxSetPrinterCommand}
616 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
618 Sets the printer command used to print a file. The default is {\tt lpr}.
620 \membersection{::wxSetPrinterFile}
622 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
624 Sets the PostScript output filename.
626 \membersection{::wxSetPrinterMode}
628 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
630 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
631 The default is PS\_PREVIEW.
633 \membersection{::wxSetPrinterOptions}
635 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
637 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
639 \membersection{::wxSetPrinterOrientation}
641 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
643 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
645 \membersection{::wxSetPrinterPreviewCommand}
647 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
649 Sets the command used to view a PostScript file. The default depends on the platform.
651 \membersection{::wxSetPrinterScaling}
653 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
655 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
657 \membersection{::wxSetPrinterTranslation}
659 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
661 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
663 \section{Clipboard functions}\label{clipsboard}
665 These clipboard functions are implemented for Windows only.
667 \wxheading{Include files}
671 \membersection{::wxClipboardOpen}
673 \func{bool}{wxClipboardOpen}{\void}
675 Returns TRUE if this application has already opened the clipboard.
677 \membersection{::wxCloseClipboard}
679 \func{bool}{wxCloseClipboard}{\void}
681 Closes the clipboard to allow other applications to use it.
683 \membersection{::wxEmptyClipboard}
685 \func{bool}{wxEmptyClipboard}{\void}
687 Empties the clipboard.
689 \membersection{::wxEnumClipboardFormats}
691 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
693 Enumerates the formats found in a list of available formats that belong
694 to the clipboard. Each call to this function specifies a known
695 available format; the function returns the format that appears next in
698 {\it dataFormat} specifies a known format. If this parameter is zero,
699 the function returns the first format in the list.
701 The return value specifies the next known clipboard data format if the
702 function is successful. It is zero if the {\it dataFormat} parameter specifies
703 the last format in the list of available formats, or if the clipboard
706 Before it enumerates the formats function, an application must open the clipboard by using the
707 wxOpenClipboard function.
709 \membersection{::wxGetClipboardData}
711 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
713 Gets data from the clipboard.
715 {\it dataFormat} may be one of:
717 \begin{itemize}\itemsep=0pt
718 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
719 \item wxCF\_BITMAP: returns a new wxBitmap.
722 The clipboard must have previously been opened for this call to succeed.
724 \membersection{::wxGetClipboardFormatName}
726 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
728 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
729 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
731 \membersection{::wxIsClipboardFormatAvailable}
733 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
735 Returns TRUE if the given data format is available on the clipboard.
737 \membersection{::wxOpenClipboard}
739 \func{bool}{wxOpenClipboard}{\void}
741 Opens the clipboard for passing data to it or getting data from it.
743 \membersection{::wxRegisterClipboardFormat}
745 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
747 Registers the clipboard data format name and returns an identifier.
749 \membersection{::wxSetClipboardData}
751 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
753 Passes data to the clipboard.
755 {\it dataFormat} may be one of:
757 \begin{itemize}\itemsep=0pt
758 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
759 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
760 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
761 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
764 The clipboard must have previously been opened for this call to succeed.
766 \section{Miscellaneous functions}\label{miscellany}
768 \membersection{::wxNewId}
770 \func{long}{wxNewId}{\void}
772 Generates an integer identifier unique to this run of the program.
774 \wxheading{Include files}
778 \membersection{::wxRegisterId}
780 \func{void}{wxRegisterId}{\param{long}{ id}}
782 Ensures that ids subsequently generated by {\bf NewId} do not clash with
785 \wxheading{Include files}
789 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
791 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
793 Changes the cursor to the given cursor for all windows in the application.
794 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
795 to its previous state. These two calls can be nested, and a counter
796 ensures that only the outer calls take effect.
798 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
800 \wxheading{Include files}
804 \membersection{::wxBell}
806 \func{void}{wxBell}{\void}
808 Ring the system bell.
810 \wxheading{Include files}
814 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
816 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
818 Creates and returns an object of the given class, if the class has been
819 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
821 \membersection{::wxDDECleanUp}\label{wxddecleanup}
823 \func{void}{wxDDECleanUp}{\void}
825 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
826 called by the application.
828 See also helpref{wxDDEInitialize}{wxddeinitialize}.
830 \wxheading{Include files}
834 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
836 \func{void}{wxDDEInitialize}{\void}
838 Initializes the DDE system. May be called multiple times without harm.
840 This no longer needs to be called by the application: it will be called
841 by wxWindows if necessary.
843 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
844 \helpref{wxDDECleanUp}{wxddecleanup}.
846 \wxheading{Include files}
850 \membersection{::wxDebugMsg}\label{wxdebugmsg}
852 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
854 Display a debugging message; under Windows, this will appear on the
855 debugger command window, and under Unix, it will be written to standard
858 The syntax is identical to {\bf printf}: pass a format string and a
859 variable list of arguments.
861 Note that under Windows, you can see the debugging messages without a
862 debugger if you have the DBWIN debug log application that comes with
865 {\bf Tip:} under Windows, if your application crashes before the
866 message appears in the debugging window, put a wxYield call after
867 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
868 (at least for Watcom C++): preformat your messages and use OutputDebugString
871 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
873 \wxheading{Include files}
877 \membersection{::wxDisplaySize}
879 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
881 Gets the physical size of the display in pixels.
883 \wxheading{Include files}
887 \membersection{::wxEntry}\label{wxentry}
889 This initializes wxWindows in a platform-dependent way. Use this if you
890 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
891 you can initialize wxWindows from an Microsoft Foundation Classes application using
894 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
895 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
897 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
898 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
899 message loop will be entered.
901 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
902 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
904 wxWindows initialization under Windows (for applications constructed as a DLL).
906 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
908 wxWindows initialization under Unix.
912 To clean up wxWindows, call wxApp::OnExit followed by the static function
913 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
916 int CTheApp::ExitInstance()
918 // OnExit isn't called by CleanUp so must be called explicitly.
922 return CWinApp::ExitInstance();
926 \wxheading{Include files}
930 \membersection{::wxError}\label{wxerror}
932 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
934 Displays {\it msg} and continues. This writes to standard error under
935 Unix, and pops up a message box under Windows. Used for internal
936 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
938 \wxheading{Include files}
942 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
944 \func{void}{wxEndBusyCursor}{\void}
946 Changes the cursor back to the original cursor, for all windows in the application.
947 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
949 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
951 \wxheading{Include files}
955 \membersection{::wxExecute}\label{wxexecute}
957 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
959 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
961 Executes another program in Unix or Windows.
963 The first form takes a command string, such as {\tt "emacs file.txt"}.
965 The second form takes an array of values: a command, any number of
966 arguments, terminated by NULL.
968 If {\it sync} is FALSE (the default), flow of control immediately returns.
969 If TRUE, the current application waits until the other program has terminated.
971 In the case of synchronous execution, the return value is trhe exit code of
972 the process (which terminates by the moment the function returns) and will be
973 $-1$ if the process couldn't be started and typically 0 if the process
974 terminated successfully.
976 For asynchronous execution, however, the return value is the process id and
977 zero value indicates that the command could not be executed.
979 If callback isn't NULL and if execution is asynchronous (note that callback
980 parameter can not be non NULL for synchronous execution),
981 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
982 the process finishes.
984 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
986 \wxheading{Include files}
990 \membersection{::wxExit}\label{wxexit}
992 \func{void}{wxExit}{\void}
994 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
995 Should only be used in an emergency: normally the top-level frame
996 should be deleted (after deleting all other frames) to terminate the
997 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
999 \wxheading{Include files}
1003 \membersection{::wxFatalError}\label{wxfatalerror}
1005 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1007 Displays {\it msg} and exits. This writes to standard error under Unix,
1008 and pops up a message box under Windows. Used for fatal internal
1009 wxWindows errors. See also \helpref{wxError}{wxerror}.
1011 \wxheading{Include files}
1015 \membersection{::wxFindMenuItemId}
1017 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1019 Find a menu item identifier associated with the given frame's menu bar.
1021 \wxheading{Include files}
1025 \membersection{::wxFindWindowByLabel}
1027 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1029 Find a window by its label. Depending on the type of window, the label may be a window title
1030 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1031 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1032 The search is recursive in both cases.
1034 \wxheading{Include files}
1038 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1040 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1042 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1043 If {\it parent} is NULL, the search will start from all top-level
1044 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1045 The search is recursive in both cases.
1047 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1049 \wxheading{Include files}
1053 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1055 \func{wxWindow *}{wxGetActiveWindow}{\void}
1057 Gets the currently active window (Windows only).
1059 \wxheading{Include files}
1063 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1065 \func{wxString}{wxGetDisplayName}{\void}
1067 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1069 \wxheading{Include files}
1073 \membersection{::wxGetHomeDir}
1075 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1077 Fills the buffer with a string representing the user's home directory (Unix only).
1079 \wxheading{Include files}
1083 \membersection{::wxGetHostName}
1085 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1087 Copies the host name of the machine the program is running on into the
1088 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1089 successful. Under Unix, this will return a machine name. Under Windows,
1090 this returns ``windows''.
1092 \wxheading{Include files}
1096 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1098 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1100 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1102 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1105 See also \helpref{wxTimer}{wxtimer}.
1107 \wxheading{Include files}
1111 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1113 \func{long}{wxGetFreeMemory}{\void}
1115 Returns the amount of free memory in Kbytes under environments which
1116 support it, and -1 if not supported. Currently, returns a positive value
1117 under Windows, and -1 under Unix.
1119 \wxheading{Include files}
1123 \membersection{::wxGetMousePosition}
1125 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1127 Returns the mouse position in screen coordinates.
1129 \wxheading{Include files}
1133 \membersection{::wxGetOsVersion}
1135 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1137 Gets operating system version information.
1139 \begin{twocollist}\itemsep=0pt
1140 \twocolitemruled{Platform}{Return tyes}
1141 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1142 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1143 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1144 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1145 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1146 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1147 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1148 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1149 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1152 \wxheading{Include files}
1156 \membersection{::wxGetResource}\label{wxgetresource}
1158 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1159 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1161 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1162 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1164 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1165 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1167 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1168 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1170 Gets a resource value from the resource database (for example, WIN.INI, or
1171 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1172 otherwise the specified file is used.
1174 Under X, if an application class (wxApp::GetClassName) has been defined,
1175 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1176 an applications default file when merging all resource databases.
1178 The reason for passing the result in an argument is that it
1179 can be convenient to define a default value, which gets overridden
1180 if the value exists in the resource file. It saves a separate
1181 test for that resource's existence, and it also allows
1182 the overloading of the function for different types.
1184 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1186 \wxheading{Include files}
1190 \membersection{::wxGetUserId}
1192 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1194 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1195 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1196 Under Windows, this returns ``user''.
1198 \wxheading{Include files}
1202 \membersection{::wxGetUserName}
1204 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1206 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1207 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1208 Under Windows, this returns ``unknown''.
1210 \wxheading{Include files}
1214 \membersection{::wxKill}\label{wxkill}
1216 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1218 Under Unix (the only supported platform), equivalent to the Unix kill function.
1219 Returns 0 on success, -1 on failure.
1221 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1222 It does not raise a signal in the receiving process.
1224 \wxheading{Include files}
1228 \membersection{::wxIsBusy}\label{wxisbusy}
1230 \func{bool}{wxIsBusy}{\void}
1232 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1233 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1235 See also \helpref{wxBusyCursor}{wxbusycursor}.
1237 \wxheading{Include files}
1241 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1243 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1245 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1246 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1248 The resource must be defined in the {\tt .rc} file using the following syntax:
1251 myResource TEXT file.ext
1254 where {\tt file.ext} is a file that the resource compiler can find.
1256 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1257 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1258 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1260 This function is available under Windows only.
1262 \wxheading{Include files}
1266 \membersection{::wxNow}\label{wxnow}
1268 \func{wxString}{wxNow}{\void}
1270 Returns a string representing the current date and time.
1272 \wxheading{Include files}
1276 \membersection{::wxPostDelete}\label{wxpostdelete}
1278 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1280 Tells the system to delete the specified object when
1281 all other events have been processed. In some environments, it is
1282 necessary to use this instead of deleting a frame directly with the
1283 delete operator, because some GUIs will still send events to a deleted window.
1285 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1287 \wxheading{Include files}
1291 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1293 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1295 Under X only, sets the current display name. This is the X host and display name such
1296 as ``colonsay:0.0", and the function indicates which display should be used for creating
1297 windows from this point on. Setting the display within an application allows multiple
1298 displays to be used.
1300 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1302 \wxheading{Include files}
1306 \membersection{::wxShell}\label{wxshell}
1308 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1310 Executes a command in an interactive shell window. If no command is
1311 specified, then just the shell is spawned.
1313 See also \helpref{wxExecute}{wxexecute}.
1315 \wxheading{Include files}
1319 \membersection{::wxSleep}\label{wxsleep}
1321 \func{void}{wxSleep}{\param{int}{ secs}}
1323 Sleeps for the specified number of seconds.
1325 \wxheading{Include files}
1329 \membersection{::wxStripMenuCodes}
1331 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1333 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1335 Strips any menu codes from {\it in} and places the result
1336 in {\it out} (or returns the new string, in the first form).
1338 Menu codes include \& (mark the next character with an underline
1339 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1341 \wxheading{Include files}
1345 \membersection{::wxStartTimer}\label{wxstarttimer}
1347 \func{void}{wxStartTimer}{\void}
1349 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1351 See also \helpref{wxTimer}{wxtimer}.
1353 \wxheading{Include files}
1357 \membersection{::wxToLower}\label{wxtolower}
1359 \func{char}{wxToLower}{\param{char }{ch}}
1361 Converts the character to lower case. This is implemented as a macro for efficiency.
1363 \wxheading{Include files}
1367 \membersection{::wxToUpper}\label{wxtoupper}
1369 \func{char}{wxToUpper}{\param{char }{ch}}
1371 Converts the character to upper case. This is implemented as a macro for efficiency.
1373 \wxheading{Include files}
1377 \membersection{::wxTrace}\label{wxtrace}
1379 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1381 Takes printf-style variable argument syntax. Output
1382 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1384 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1386 \wxheading{Include files}
1390 \membersection{::wxTraceLevel}\label{wxtracelevel}
1392 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1394 Takes printf-style variable argument syntax. Output
1395 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1396 The first argument should be the level at which this information is appropriate.
1397 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1400 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1402 \wxheading{Include files}
1406 \membersection{::wxWriteResource}\label{wxwriteresource}
1408 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1409 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1411 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1412 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1414 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1415 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1417 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1418 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1420 Writes a resource value into the resource database (for example, WIN.INI, or
1421 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1422 otherwise the specified file is used.
1424 Under X, the resource databases are cached until the internal function
1425 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1426 all updated resource databases are written to their files.
1428 Note that it is considered bad manners to write to the .Xdefaults
1429 file under Unix, although the WIN.INI file is fair game under Windows.
1431 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1433 \wxheading{Include files}
1437 \membersection{::wxYield}\label{wxyield}
1439 \func{bool}{wxYield}{\void}
1441 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1442 time-consuming process writes to a text window. Without an occasional
1443 yield, the text window will not be updated properly, and (since Windows
1444 multitasking is cooperative) other processes will not respond.
1446 Caution should be exercised, however, since yielding may allow the
1447 user to perform actions which are not compatible with the current task.
1448 Disabling menu items or whole menus during processing can avoid unwanted
1451 \wxheading{Include files}
1455 \section{Macros}\label{macros}
1457 These macros are defined in wxWindows.
1459 \membersection{CLASSINFO}\label{classinfo}
1461 \func{wxClassInfo *}{CLASSINFO}{className}
1463 Returns a pointer to the wxClassInfo object associated with this class.
1465 \wxheading{Include files}
1469 \membersection{WXDEBUG\_NEW}\label{debugnew}
1471 \func{}{WXDEBUG\_NEW}{arg}
1473 This is defined in debug mode to be call the redefined new operator
1474 with filename and line number arguments. The definition is:
1477 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1480 In non-debug mode, this is defined as the normal new operator.
1482 \wxheading{Include files}
1486 \membersection{DECLARE\_ABSTRACT\_CLASS}
1488 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1490 Used inside a class declaration to declare that the class should be
1491 made known to the class hierarchy, but objects of this class cannot be created
1492 dynamically. The same as DECLARE\_CLASS.
1497 class wxCommand: public wxObject
1499 DECLARE_ABSTRACT_CLASS(wxCommand)
1508 \wxheading{Include files}
1512 \membersection{DECLARE\_APP}\label{declareapp}
1514 \func{}{DECLARE\_APP}{className}
1516 This is used in headers to create a forward declaration of the wxGetApp function implemented
1517 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1525 \wxheading{Include files}
1529 \membersection{DECLARE\_CLASS}
1531 \func{}{DECLARE\_CLASS}{className}
1533 Used inside a class declaration to declare that the class should be
1534 made known to the class hierarchy, but objects of this class cannot be created
1535 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1537 \wxheading{Include files}
1541 \membersection{DECLARE\_DYNAMIC\_CLASS}
1543 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1545 Used inside a class declaration to declare that the objects of this class should be dynamically
1546 createable from run-time type information.
1551 class wxFrame: public wxWindow
1553 DECLARE_DYNAMIC_CLASS(wxFrame)
1556 const wxString\& frameTitle;
1562 \wxheading{Include files}
1566 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1568 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1570 Used in a C++ implementation file to complete the declaration of
1571 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1576 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1578 wxCommand::wxCommand(void)
1584 \wxheading{Include files}
1588 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1590 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1592 Used in a C++ implementation file to complete the declaration of
1593 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1595 \wxheading{Include files}
1599 \membersection{IMPLEMENT\_APP}\label{implementapp}
1601 \func{}{IMPLEMENT\_APP}{className}
1603 This is used in the application class implementation file to make the application class known to
1604 wxWindows for dynamic construction. You use this instead of
1615 IMPLEMENT_APP(MyApp)
1618 See also \helpref{DECLARE\_APP}{declareapp}.
1620 \wxheading{Include files}
1624 \membersection{IMPLEMENT\_CLASS}
1626 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1628 Used in a C++ implementation file to complete the declaration of
1629 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1631 \wxheading{Include files}
1635 \membersection{IMPLEMENT\_CLASS2}
1637 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1639 Used in a C++ implementation file to complete the declaration of a
1640 class that has run-time type information and two base classes. The
1641 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1643 \wxheading{Include files}
1647 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1649 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1651 Used in a C++ implementation file to complete the declaration of
1652 a class that has run-time type information, and whose instances
1653 can be created dynamically.
1658 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1660 wxFrame::wxFrame(void)
1666 \wxheading{Include files}
1670 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1672 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1674 Used in a C++ implementation file to complete the declaration of
1675 a class that has run-time type information, and whose instances
1676 can be created dynamically. Use this for classes derived from two
1679 \wxheading{Include files}
1683 \membersection{WXTRACE}\label{trace}
1685 \func{}{WXTRACE}{formatString, ...}
1687 Calls wxTrace with printf-style variable argument syntax. Output
1688 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1690 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1692 \wxheading{Include files}
1696 \membersection{WXTRACELEVEL}\label{tracelevel}
1698 \func{}{WXTRACELEVEL}{level, formatString, ...}
1700 Calls wxTraceLevel with printf-style variable argument syntax. Output
1701 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1702 The first argument should be the level at which this information is appropriate.
1703 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1706 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1708 \wxheading{Include files}
1712 \section{wxWindows resource functions}\label{resourcefuncs}
1714 \overview{wxWindows resource system}{resourceformats}
1716 This section details functions for manipulating wxWindows (.WXR) resource
1717 files and loading user interface elements from resources.
1719 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1720 about initialisation file resource reading and writing, using such functions
1721 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1723 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1725 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1726 loading from resource data.
1728 {\bf Warning:} this needs updating for wxWindows 2.
1730 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1732 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1734 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1735 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1736 perhaps for implementing resource functionality for interpreted languages.
1738 \membersection{::wxResourceClear}
1740 \func{void}{wxResourceClear}{\void}
1742 Clears the wxWindows resource table.
1744 \membersection{::wxResourceCreateBitmap}
1746 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1748 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1749 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1753 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1754 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1755 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1758 then this function can be called as follows:
1761 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1764 \membersection{::wxResourceCreateIcon}
1766 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1768 Creates a new icon from a file, static data, or Windows resource, given a valid
1769 wxWindows icon resource identifier. For example, if the .WXR file contains
1773 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1774 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1775 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1778 then this function can be called as follows:
1781 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1784 \membersection{::wxResourceCreateMenuBar}
1786 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1788 Creates a new menu bar given a valid wxWindows menubar resource
1789 identifier. For example, if the .WXR file contains the following:
1792 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1796 ['&Open File', 2, 'Open a file'],\
1797 ['&Save File', 3, 'Save a file'],\
1799 ['E&xit', 4, 'Exit program']\
1802 ['&About', 6, 'About this program']\
1807 then this function can be called as follows:
1810 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1814 \membersection{::wxResourceGetIdentifier}
1816 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1818 Used for retrieving the integer value associated with an identifier.
1819 A zero value indicates that the identifier was not found.
1821 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1823 \membersection{::wxResourceParseData}\label{wxresourcedata}
1825 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1827 Parses a string containing one or more wxWindows resource objects. If
1828 the resource objects are global static data that are included into the
1829 C++ program, then this function must be called for each variable
1830 containing the resource data, to make it known to wxWindows.
1832 {\it resource} should contain data in the following form:
1835 dialog(name = 'dialog1',
1836 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1837 title = 'Test dialog box',
1838 x = 312, y = 234, width = 400, height = 300,
1840 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1841 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1842 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1843 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1844 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1845 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1848 This function will typically be used after including a {\tt .wxr} file into
1849 a C++ program as follows:
1852 #include "dialog1.wxr"
1855 Each of the contained resources will declare a new C++ variable, and each
1856 of these variables should be passed to wxResourceParseData.
1858 \membersection{::wxResourceParseFile}
1860 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1862 Parses a file containing one or more wxWindows resource objects
1863 in C++-compatible syntax. Use this function to dynamically load
1864 wxWindows resource data.
1866 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1868 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1870 Parses a string containing one or more wxWindows resource objects. If
1871 the resource objects are global static data that are included into the
1872 C++ program, then this function must be called for each variable
1873 containing the resource data, to make it known to wxWindows.
1875 {\it resource} should contain data with the following form:
1878 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
1879 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
1880 title = 'Test dialog box',\
1881 x = 312, y = 234, width = 400, height = 300,\
1883 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
1884 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
1885 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
1886 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
1887 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
1888 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
1891 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
1892 load an entire {\tt .wxr file} into a string.
1894 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
1896 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
1897 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
1899 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
1901 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
1902 This is required if other resources will use the bitmap data, since otherwise there
1903 is no connection between names used in resources, and the global bitmap data.
1905 \membersection{::wxResourceRegisterIconData}
1907 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
1909 \section{Log functions}\label{logfunctions}
1911 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
1912 further information.
1914 \wxheading{Include files}
1918 \membersection{::wxLogError}\label{wxlogerror}
1920 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
1922 The function to use for error messages, i.e. the
1923 messages that must be shown to the user. The default processing is to pop up a
1924 message box to inform the user about it.
1926 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
1928 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
1930 Like \helpref{wxLogError}{wxlogerror}, but also
1931 terminates the program with the exit code 3. Using {\it abort()} standard
1932 function also terminates the program with this exit code.
1934 \membersection{::wxLogWarning}\label{wxlogwarning}
1936 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
1938 For warnings - they are also normally shown to the
1939 user, but don't interrupt the program work.
1941 \membersection{::wxLogMessage}\label{wxlogmessage}
1943 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
1945 for all normal, informational messages. They also
1946 appear in a message box by default (but it can be changed). Notice
1947 that the standard behaviour is to not show informational messages if there are
1948 any errors later - the logic being that the later error messages make the
1949 informational messages preceding them meaningless.
1951 \membersection{::wxLogVerbose}\label{wxlogverbose}
1953 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
1955 For verbose output. Normally, it's suppressed, but
1956 might be activated if the user wishes to know more details about the program
1957 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
1959 \membersection{::wxLogStatus}\label{wxlogstatus}
1961 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
1963 For status messages - they will go into the status
1964 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
1966 \membersection{::wxLogSysError}\label{wxlogsyserror}
1968 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
1970 Mostly used by wxWindows itself, but might be
1971 handy for logging errors after system call (API function) failure. It logs the
1972 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
1973 on the platform) and the corresponding error
1974 message. The second form of this function takes the error code explitly as the
1977 \membersection{::wxLogDebug}\label{wxlogdebug}
1979 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
1981 The right function for debug output. It only
1982 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
1983 and expands to nothing in release mode (otherwise).
1985 \membersection{::wxLogTrace}\label{wxlogtrace}
1987 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
1989 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
1991 As {\bf wxLogDebug}, only does something in debug
1992 build. The reason for making it a separate function from it is that usually
1993 there are a lot of trace messages, so it might make sense to separate them
1994 from other debug messages which would be flooded in them. Moreover, the second
1995 version of this function takes a trace mask as the first argument which allows
1996 to further restrict the amount of messages generated. The value of {\it mask} can be:
1998 \begin{itemize}\itemsep=0pt
1999 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2000 \item wxTraceMessages: trace window messages/X callbacks
2001 \item wxTraceResAlloc: trace GDI resource allocation
2002 \item wxTraceRefCount: trace various ref counting operations
2005 \section{Debugging macros and functions}\label{debugmacros}
2007 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2008 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2011 \wxheading{Include files}
2015 \membersection{::wxOnAssert}\label{wxonassert}
2017 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2019 This function may be redefined to do something non trivial and is called
2020 whenever one of debugging macros fails (i.e. condition is false in an
2022 % TODO: this should probably be an overridable in wxApp.
2024 \membersection{wxASSERT}\label{wxassert}
2026 \func{}{wxASSERT}{\param{}{condition}}
2028 Assert macro. An error message will be generated if the condition is FALSE.
2030 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2032 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2034 Assert macro with message. An error message will be generated if the condition is FALSE.
2036 \membersection{wxFAIL}\label{wxfail}
2038 \func{}{wxFAIL}{\param{}{condition}}
2040 Will always generate an assert error if this code is reached (in debug mode).
2042 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2044 \func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
2046 Will always generate an assert error with specified message if this code is reached (in debug mode).
2048 \membersection{wxCHECK}\label{wxcheck}
2050 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2052 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2053 This check is done even in release mode.
2055 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2057 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2059 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2060 This check is done even in release mode.