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 See also
\helpref{wxPathList
}{wxpathlist
}.
11 \membersection{::wxDirExists
}
13 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
15 Returns TRUE if the directory exists.
17 \membersection{::wxDos2UnixFilename
}
19 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
21 Converts a DOS to a Unix filename by replacing backslashes with forward
24 \membersection{::wxFileExists
}
26 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
28 Returns TRUE if the file exists.
30 \membersection{::wxFileNameFromPath
}
32 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
34 Returns a temporary pointer to the filename for a full path.
35 Copy this pointer for long-term use.
37 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
39 \func{wxString
}{wxFindFirstFile
}{\param{const wxString\&
}{spec
},
\param{int
}{ flags =
0}}
41 This function does directory searching; returns the first file
42 that matches the path
{\it spec
}, or NULL. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
43 get the next matching file.
45 {\it spec
} may contain wildcards.
47 {\it flags
} is reserved for future use.
49 The returned filename is a pointer to static memory so should
55 wxString f = wxFindFirstFile("/home/project/*.*");
63 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
65 \func{wxString
}{wxFindFirstFile
}{\void}
67 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
69 \membersection{::wxIsAbsolutePath
}
71 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
73 Returns TRUE if the argument is an absolute filename, i.e. with a slash
74 or drive name at the beginning.
76 \membersection{::wxPathOnly
}
78 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
80 Returns a temporary pointer to the directory part of the filename. Copy this
81 pointer for long-term use.
83 \membersection{::wxUnix2DosFilename
}
85 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
87 Converts a Unix to a DOS filename by replacing forward
88 slashes with backslashes.
90 \membersection{::wxConcatFiles
}
92 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
93 \param{const wxString\&
}{file3
}}
95 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
98 \membersection{::wxCopyFile
}
100 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
102 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
104 \membersection{::wxGetHostName
}\label{wxgethostname
}
106 \func{bool
}{wxGetHostName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
108 Copies the current host machine's name into the supplied buffer.
110 Under Windows or NT, this function first looks in the environment
111 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
112 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
114 Returns TRUE if successful, FALSE otherwise.
116 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
118 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
120 Copies the user's email address into the supplied buffer, by
121 concatenating the values returned by
\helpref{wxGetHostName
}{wxgethostname
}\rtfsp
122 and
\helpref{wxGetUserId
}{wxgetuserid
}.
124 Returns TRUE if successful, FALSE otherwise.
126 \membersection{::wxGetUserId
}\label{wxgetuserid
}
128 \func{bool
}{wxGetUserId
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
130 Copies the current user id into the supplied buffer.
132 Under Windows or NT, this function first looks in the environment
133 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
134 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
136 Returns TRUE if successful, FALSE otherwise.
138 \membersection{::wxGetUserName
}\label{wxgetusername
}
140 \func{bool
}{wxGetUserName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
142 Copies the current user name into the supplied buffer.
144 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
145 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
146 is running, the entry
{\bf Current
} in the section
{\bf User
} of
147 the PENWIN.INI file is used.
149 Returns TRUE if successful, FALSE otherwise.
151 \membersection{::wxGetWorkingDirectory
}
153 \func{wxString
}{wxGetWorkingDirectory
}{\param{const wxString\&
}{buf=NULL
},
\param{int
}{sz=
1000}}
155 Copies the current working directory into the buffer if supplied, or
156 copies the working directory into new storage (which you must delete yourself)
157 if the buffer is NULL.
159 {\it sz
} is the size of the buffer if supplied.
161 \membersection{::wxGetTempFileName
}
163 \func{wxString
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{const wxString\&
}{buf=NULL
}}
165 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
166 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
167 is allocated for the temporary filename using
{\it new
}.
169 Under Windows, the filename will include the drive and name of the
170 directory allocated for temporary files (usually the contents of the
171 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
173 It is the application's responsibility to create and delete the file.
175 \membersection{::wxIsWild
}\label{wxiswild
}
177 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
179 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
181 \membersection{::wxMatchWild
}\label{wxmatchwild
}
183 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
185 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
186 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
187 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
189 \membersection{::wxMkdir
}
191 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
}}
193 Makes the directory
{\it dir
}, returning TRUE if successful.
195 \membersection{::wxRemoveFile
}
197 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
199 Removes
{\it file
}, returning TRUE if successful.
201 \membersection{::wxRenameFile
}
203 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
205 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
207 \membersection{::wxRmdir
}
209 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
211 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
213 The
{\it flags
} parameter is reserved for future use.
215 \membersection{::wxSetWorkingDirectory
}
217 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
219 Sets the current working directory, returning TRUE if the operation succeeded.
220 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
222 \section{String functions
}
224 \membersection{::copystring
}
226 \func{char*
}{copystring
}{\param{const char*
}{s
}}
228 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
229 deleted with the
{\it delete
} operator.
231 \membersection{::wxStringMatch
}
233 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
234 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
236 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
237 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
238 no substring matching is done.
240 \membersection{::wxStringEq
}\label{wxstringeq
}
242 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
247 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
250 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
252 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
254 Copies the given file to
{\it stream
}. Useful when converting an old application to
255 use streams (within the
document/view framework, for example).
257 Use of this function requires the file wx
\_doc.h to be included.
259 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
261 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
263 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
264 use streams (within the
document/view framework, for example).
266 Use of this function requires the file wx
\_doc.h to be included.
268 \section{Dialog functions
}\label{dialogfunctions
}
270 Below are a number of convenience functions for getting input from the
271 user or displaying messages. Note that in these functions the last three
272 parameters are optional. However, it is recommended to pass a parent frame
273 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
274 the front when the dialog box is popped up.
276 \membersection{::wxFileSelector
}\label{wxfileselector
}
278 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = NULL
},\\
279 \param{const wxString\&
}{default
\_filename = NULL
},
\param{const wxString\&
}{default
\_extension = NULL
},\\
280 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
281 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
283 Pops up a file selector box. In Windows, this is the common file selector
284 dialog. In X, this is a file selector box with somewhat less functionality.
285 The path and filename are distinct elements of a full file pathname.
286 If path is NULL, the current directory will be used. If filename is NULL,
287 no default filename will be supplied. The wildcard determines what files
288 are displayed in the file selector, and file extension supplies a type
289 extension for the required filename. Flags may be a combination of wxOPEN,
290 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
291 at present in Windows.
293 Both the X and Windows versions implement a wildcard filter. Typing a
294 filename containing wildcards
(*, ?) in the filename text item, and
295 clicking on Ok, will result in only those files matching the pattern being
296 displayed. In the X version, supplying no default name will result in the
297 wildcard filter being inserted in the filename text item; the filter is
298 ignored if a default name is supplied.
300 Under Windows (only), the wildcard may be a specification for multiple
301 types of file with a description for each, such as:
304 "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
307 The application must check for a NULL return value (the user pressed
308 Cancel). For example:
311 const wxString\& s = wxFileSelector("Choose a file to open");
318 Remember that the returned pointer is temporary and should be copied
319 if other wxWindows calls will be made before the value is to be used.
321 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
323 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
324 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
325 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
327 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
328 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
329 or press Cancel to return NULL.
331 If {\it centre} is TRUE, the message text (which may include new line characters)
332 is centred; if FALSE, the message is left-justified.
334 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
336 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
337 \param{int }{nsel}, \param{int *}{selection},
338 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
339 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
341 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
342 listbox. The user may choose one or more item(s) and press OK or Cancel.
344 The number of initially selected choices, and array of the selected indices,
345 are passed in; this array will contain the user selections on exit, with
346 the function returning the number of selections. {\it selection} must be
347 as big as the number of choices, in case all are selected.
349 If Cancel is pressed, -1 is returned.
351 {\it choices} is an array of {\it n} strings for the listbox.
353 If {\it centre} is TRUE, the message text (which may include new line characters)
354 is centred; if FALSE, the message is left-justified.
356 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
358 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
359 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
360 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
362 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
363 listbox. The user may choose an item and press OK to return a string or
364 Cancel to return NULL.
366 {\it choices} is an array of {\it n} strings for the listbox.
368 If {\it centre} is TRUE, the message text (which may include new line characters)
369 is centred; if FALSE, the message is left-justified.
371 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
373 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
374 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
375 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
377 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
378 If the user pressed cancel, -1 is returned.
380 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
382 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
383 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
384 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
386 As {\bf wxGetSingleChoice} but takes an array of client data pointers
387 corresponding to the strings, and returns one of these pointers.
389 \membersection{::wxMessageBox}\label{wxmessagebox}
391 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
392 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
394 General purpose message dialog. {\it style} may be a bit list of the
395 following identifiers:
397 \begin{twocollist}\itemsep=0pt
398 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
400 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
402 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
403 \twocolitem{wxCENTRE}{Centres the text.}
404 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
405 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
406 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
407 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
410 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
416 int answer = wxMessageBox("Quit program?", "Confirm",
417 wxYES_NO | wxCANCEL, main_frame);
423 {\it message} may contain newline characters, in which case the
424 message will be split into separate lines, to cater for large messages.
426 Under Windows, the native MessageBox function is used unless wxCENTRE
427 is specified in the style, in which case a generic function is used.
428 This is because the native MessageBox function cannot centre text.
429 The symbols are not shown when the generic function is used.
431 \section{GDI functions}\label{gdifunctions}
433 The following are relevant to the GDI (Graphics Device Interface).
435 \membersection{::wxColourDisplay}
437 \func{bool}{wxColourDisplay}{\void}
439 Returns TRUE if the display is colour, FALSE otherwise.
441 \membersection{::wxDisplayDepth}
443 \func{int}{wxDisplayDepth}{\void}
445 Returns the depth of the display (a value of 1 denotes a monochrome display).
447 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
449 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
450 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
452 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
453 makes it into a placeable metafile by prepending a header containing the given
454 bounding box. The bounding box may be obtained from a device context after drawing
455 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
457 In addition to adding the placeable metafile header, this function adds
458 the equivalent of the following code to the start of the metafile data:
461 SetMapMode(dc, MM_ANISOTROPIC);
462 SetWindowOrg(dc, minX, minY);
463 SetWindowExt(dc, maxX - minX, maxY - minY);
466 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
468 Placeable metafiles may be imported by many Windows applications, and can be
469 used in RTF (Rich Text Format) files.
471 {\it scale} allows the specification of scale for the metafile.
473 This function is only available under Windows.
475 \membersection{::wxSetCursor}\label{wxsetcursor}
477 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
479 Globally sets the cursor; only has an effect in MS Windows.
480 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
482 \section{Printer settings}\label{printersettings}
484 The following functions are used to control PostScript printing. Under
485 Windows, PostScript output can only be sent to a file.
487 \membersection{::wxGetPrinterCommand}
489 \func{wxString}{wxGetPrinterCommand}{\void}
491 Gets the printer command used to print a file. The default is {\tt lpr}.
493 \membersection{::wxGetPrinterFile}
495 \func{wxString}{wxGetPrinterFile}{\void}
497 Gets the PostScript output filename.
499 \membersection{::wxGetPrinterMode}
501 \func{int}{wxGetPrinterMode}{\void}
503 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
504 The default is PS\_PREVIEW.
506 \membersection{::wxGetPrinterOptions}
508 \func{wxString}{wxGetPrinterOptions}{\void}
510 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
512 \membersection{::wxGetPrinterOrientation}
514 \func{int}{wxGetPrinterOrientation}{\void}
516 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
518 \membersection{::wxGetPrinterPreviewCommand}
520 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
522 Gets the command used to view a PostScript file. The default depends on the platform.
524 \membersection{::wxGetPrinterScaling}
526 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
528 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
530 \membersection{::wxGetPrinterTranslation}
532 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
534 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
536 \membersection{::wxSetPrinterCommand}
538 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
540 Sets the printer command used to print a file. The default is {\tt lpr}.
542 \membersection{::wxSetPrinterFile}
544 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
546 Sets the PostScript output filename.
548 \membersection{::wxSetPrinterMode}
550 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
552 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
553 The default is PS\_PREVIEW.
555 \membersection{::wxSetPrinterOptions}
557 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
559 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
561 \membersection{::wxSetPrinterOrientation}
563 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
565 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
567 \membersection{::wxSetPrinterPreviewCommand}
569 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
571 Sets the command used to view a PostScript file. The default depends on the platform.
573 \membersection{::wxSetPrinterScaling}
575 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
577 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
579 \membersection{::wxSetPrinterTranslation}
581 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
583 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
585 \section{Clipboard functions}\label{clipsboard}
587 These clipboard functions are implemented for Windows only.
589 \membersection{::wxClipboardOpen}
591 \func{bool}{wxClipboardOpen}{\void}
593 Returns TRUE if this application has already opened the clipboard.
595 \membersection{::wxCloseClipboard}
597 \func{bool}{wxCloseClipboard}{\void}
599 Closes the clipboard to allow other applications to use it.
601 \membersection{::wxEmptyClipboard}
603 \func{bool}{wxEmptyClipboard}{\void}
605 Empties the clipboard.
607 \membersection{::wxEnumClipboardFormats}
609 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
611 Enumerates the formats found in a list of available formats that belong
612 to the clipboard. Each call to this function specifies a known
613 available format; the function returns the format that appears next in
616 {\it dataFormat} specifies a known format. If this parameter is zero,
617 the function returns the first format in the list.
619 The return value specifies the next known clipboard data format if the
620 function is successful. It is zero if the {\it dataFormat} parameter specifies
621 the last format in the list of available formats, or if the clipboard
624 Before it enumerates the formats function, an application must open the clipboard by using the
625 wxOpenClipboard function.
627 \membersection{::wxGetClipboardData}
629 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
631 Gets data from the clipboard.
633 {\it dataFormat} may be one of:
635 \begin{itemize}\itemsep=0pt
636 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
637 \item wxCF\_BITMAP: returns a new wxBitmap.
640 The clipboard must have previously been opened for this call to succeed.
642 \membersection{::wxGetClipboardFormatName}
644 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
646 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
647 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
649 \membersection{::wxIsClipboardFormatAvailable}
651 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
653 Returns TRUE if the given data format is available on the clipboard.
655 \membersection{::wxOpenClipboard}
657 \func{bool}{wxOpenClipboard}{\void}
659 Opens the clipboard for passing data to it or getting data from it.
661 \membersection{::wxRegisterClipboardFormat}
663 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
665 Registers the clipboard data format name and returns an identifier.
667 \membersection{::wxSetClipboardData}
669 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
671 Passes data to the clipboard.
673 {\it dataFormat} may be one of:
675 \begin{itemize}\itemsep=0pt
676 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
677 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
678 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
679 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
682 The clipboard must have previously been opened for this call to succeed.
684 \section{Miscellaneous functions}\label{miscellany}
686 \membersection{::NewId}
688 \func{long}{NewId}{\void}
690 Generates an integer identifier unique to this run of the program.
692 \membersection{::RegisterId}
694 \func{void}{RegisterId}{\param{long}{ id}}
696 Ensures that ids subsequently generated by {\bf NewId} do not clash with
699 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
701 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
703 Changes the cursor to the given cursor for all windows in the application.
704 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
705 to its previous state. These two calls can be nested, and a counter
706 ensures that only the outer calls take effect.
708 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
710 \membersection{::wxBell}
712 \func{void}{wxBell}{\void}
714 Ring the system bell.
716 \membersection{::wxCleanUp}\label{wxcleanup}
718 \func{void}{wxCleanUp}{\void}
720 Normally, wxWindows will call this cleanup function for you. However, if
721 you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
722 manually, then you should also call wxCleanUp before terminating wxWindows,
723 if wxWindows does not get a chance to do it.
725 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
727 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
729 Creates and returns an object of the given class, if the class has been
730 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
732 \membersection{::wxDDECleanUp}\label{wxddecleanup}
734 \func{void}{wxDDECleanUp}{\void}
736 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
737 called by the application.
739 See also helpref{wxDDEInitialize}{wxddeinitialize}.
741 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
743 \func{void}{wxDDEInitialize}{\void}
745 Initializes the DDE system. May be called multiple times without harm.
747 This no longer needs to be called by the application: it will be called
748 by wxWindows if necessary.
750 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
751 \helpref{wxDDECleanUp}{wxddecleanup}.
753 \membersection{::wxDebugMsg}\label{wxdebugmsg}
755 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
757 Display a debugging message; under Windows, this will appear on the
758 debugger command window, and under Unix, it will be written to standard
761 The syntax is identical to {\bf printf}: pass a format string and a
762 variable list of arguments.
764 Note that under Windows, you can see the debugging messages without a
765 debugger if you have the DBWIN debug log application that comes with
768 {\bf Tip:} under Windows, if your application crashes before the
769 message appears in the debugging window, put a wxYield call after
770 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
771 (at least for Watcom C++): preformat your messages and use OutputDebugString
774 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
776 \membersection{::wxDisplaySize}
778 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
780 Gets the physical size of the display in pixels.
782 \membersection{::wxEntry}\label{wxentry}
784 This initializes wxWindows in a platform-dependent way. Use this if you
785 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
786 you can initialize wxWindows from an Microsoft Foundation Classes application using
787 this function. See also \helpref{wxCleanUp}{wxcleanup}.
789 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
790 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
792 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
793 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
794 message loop will be entered.
796 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
797 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
799 wxWindows initialization under Windows (for applications constructed as a DLL).
801 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
803 wxWindows initialization under Unix.
805 \membersection{::wxError}\label{wxerror}
807 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
809 Displays {\it msg} and continues. This writes to standard error under
810 Unix, and pops up a message box under Windows. Used for internal
811 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
813 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
815 \func{void}{wxEndBusyCursor}{\void}
817 Changes the cursor back to the original cursor, for all windows in the application.
818 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
820 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
822 \membersection{::wxExecute}\label{wxexecute}
824 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
826 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
828 Executes another program in Unix or Windows.
830 The first form takes a command string, such as {\tt "emacs file.txt"}.
832 The second form takes an array of values: a command, any number of
833 arguments, terminated by NULL.
835 If {\it sync} is FALSE (the default), flow of control immediately returns.
836 If TRUE, the current application waits until the other program has terminated.
838 If execution is asynchronous, the return value is the process id,
839 otherwise it is a status value. A zero value indicates that the command could not
842 If callback isn't NULL and if execution is asynchronous,
843 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
844 the process finishes.
846 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
848 \membersection{::wxExit}\label{wxexit}
850 \func{void}{wxExit}{\void}
852 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
853 Should only be used in an emergency: normally the top-level frame
854 should be deleted (after deleting all other frames) to terminate the
855 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
857 \membersection{::wxFatalError}\label{wxfatalerror}
859 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
861 Displays {\it msg} and exits. This writes to standard error under Unix,
862 and pops up a message box under Windows. Used for fatal internal
863 wxWindows errors. See also \helpref{wxError}{wxerror}.
865 \membersection{::wxFindMenuItemId}
867 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
869 Find a menu item identifier associated with the given frame's menu bar.
871 \membersection{::wxFindWindowByLabel}
873 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
875 Find a window by its label. Depending on the type of window, the label may be a window title
876 or panel item label. If {\it parent} is NULL, the search will start from all top-level
877 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
878 The search is recursive in both cases.
880 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
882 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
884 Find a window by its name (as given in a window constructor or {\bf Create} function call).
885 If {\it parent} is NULL, the search will start from all top-level
886 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
887 The search is recursive in both cases.
889 If no such named window is found, {\bf wxFindWindowByLabel} is called.
891 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
893 \func{wxWindow *}{wxGetActiveWindow}{\void}
895 Gets the currently active window (Windows only).
897 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
899 \func{wxString}{wxGetDisplayName}{\void}
901 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
903 \membersection{::wxGetHomeDir}
905 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
907 Fills the buffer with a string representing the user's home directory (Unix only).
909 \membersection{::wxGetHostName}
911 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
913 Copies the host name of the machine the program is running on into the
914 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
915 successful. Under Unix, this will return a machine name. Under Windows,
916 this returns ``windows''.
918 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
920 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
922 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
924 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
927 See also \helpref{wxTimer}{wxtimer}.
929 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
931 \func{long}{wxGetFreeMemory}{\void}
933 Returns the amount of free memory in Kbytes under environments which
934 support it, and -1 if not supported. Currently, returns a positive value
935 under Windows, and -1 under Unix.
937 \membersection{::wxGetMousePosition}
939 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
941 Returns the mouse position in screen coordinates.
943 \membersection{::wxGetOsVersion}
945 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
947 Gets operating system version information.
949 \begin{twocollist}\itemsep=0pt
950 \twocolitemruled{Platform}{Return tyes}
951 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
952 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
953 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
954 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
955 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
956 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
957 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
958 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
959 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
962 \membersection{::wxGetResource}\label{wxgetresource}
964 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
965 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
967 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
968 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
970 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
971 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
973 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
974 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
976 Gets a resource value from the resource database (for example, WIN.INI, or
977 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
978 otherwise the specified file is used.
980 Under X, if an application class (wxApp::GetClassName) has been defined,
981 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
982 an applications default file when merging all resource databases.
984 The reason for passing the result in an argument is that it
985 can be convenient to define a default value, which gets overridden
986 if the value exists in the resource file. It saves a separate
987 test for that resource's existence, and it also allows
988 the overloading of the function for different types.
990 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
992 \membersection{::wxGetUserId}
994 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
996 Copies the user's login identity (such as ``jacs'') into the buffer {\it
997 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
998 Under Windows, this returns ``user''.
1000 \membersection{::wxGetUserName}
1002 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1004 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1005 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1006 Under Windows, this returns ``unknown''.
1008 \membersection{::wxKill}\label{wxkill}
1010 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1012 Under Unix (the only supported platform), equivalent to the Unix kill function.
1013 Returns 0 on success, -1 on failure.
1015 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1016 It does not raise a signal in the receiving process.
1018 \membersection{::wxInitClipboard}\label{wxinitclipboard}
1020 \func{void}{wxInitClipboard}{\void}
1022 Initializes the generic clipboard system by creating an instance of
1023 the class \helpref{wxClipboard}{wxclipboard}.
1025 \membersection{::wxIsBusy}\label{wxisbusy}
1027 \func{bool}{wxIsBusy}{\void}
1029 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1030 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1032 See also \helpref{wxBusyCursor}{wxbusycursor}.
1034 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1036 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1038 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1039 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1041 The resource must be defined in the {\tt .rc} file using the following syntax:
1044 myResource TEXT file.ext
1047 where {\tt file.ext} is a file that the resource compiler can find.
1049 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1050 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1051 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1053 This function is available under Windows only.
1055 \membersection{::wxNow}\label{wxnow}
1057 \func{wxString}{wxNow}{\void}
1059 Returns a string representing the current date and time.
1061 \membersection{::wxPostDelete}\label{wxpostdelete}
1063 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1065 Under X, tells the system to delete the specified object when
1066 all other events have been processed. In some environments, it is
1067 necessary to use this instead of deleting a frame directly with the
1068 delete operator, because X will still send events to the window.
1070 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1072 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1074 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1076 Under X only, sets the current display name. This is the X host and display name such
1077 as ``colonsay:0.0", and the function indicates which display should be used for creating
1078 windows from this point on. Setting the display within an application allows multiple
1079 displays to be used.
1081 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1083 \membersection{::wxShell}\label{wxshell}
1085 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1087 Executes a command in an interactive shell window. If no command is
1088 specified, then just the shell is spawned.
1090 See also \helpref{wxExecute}{wxexecute}.
1092 \membersection{::wxSleep}\label{wxsleep}
1094 \func{void}{wxSleep}{\param{int}{ secs}}
1096 Sleeps for the specified number of seconds.
1098 \membersection{::wxStripMenuCodes}
1100 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1102 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1104 Strips any menu codes from {\it in} and places the result
1105 in {\it out} (or returns the new string, in the first form).
1107 Menu codes include \& (mark the next character with an underline
1108 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1110 \membersection{::wxStartTimer}\label{wxstarttimer}
1112 \func{void}{wxStartTimer}{\void}
1114 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1116 See also \helpref{wxTimer}{wxtimer}.
1118 \membersection{::wxToLower}\label{wxtolower}
1120 \func{char}{wxToLower}{\param{char }{ch}}
1122 Converts the character to lower case. This is implemented as a macro for efficiency.
1124 \membersection{::wxToUpper}\label{wxtoupper}
1126 \func{char}{wxToUpper}{\param{char }{ch}}
1128 Converts the character to upper case. This is implemented as a macro for efficiency.
1130 \membersection{::wxTrace}\label{wxtrace}
1132 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1134 Takes printf-style variable argument syntax. Output
1135 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1137 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1139 \membersection{::wxTraceLevel}\label{wxtracelevel}
1141 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1143 Takes printf-style variable argument syntax. Output
1144 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1145 The first argument should be the level at which this information is appropriate.
1146 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1149 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1151 \membersection{::wxWriteResource}\label{wxwriteresource}
1153 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1154 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1156 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1157 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1159 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1160 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1162 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1163 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1165 Writes a resource value into the resource database (for example, WIN.INI, or
1166 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1167 otherwise the specified file is used.
1169 Under X, the resource databases are cached until the internal function
1170 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1171 all updated resource databases are written to their files.
1173 Note that it is considered bad manners to write to the .Xdefaults
1174 file under Unix, although the WIN.INI file is fair game under Windows.
1176 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1178 \membersection{::wxYield}
1180 \func{bool}{wxYield}{\void}
1182 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1183 time-consuming process writes to a text window. Without an occasional
1184 yield, the text window will not be updated properly, and (since Windows
1185 multitasking is cooperative) other processes will not respond.
1187 Caution should be exercised, however, since yielding may allow the
1188 user to perform actions which are not compatible with the current task.
1189 Disabling menu items or whole menus during processing can avoid unwanted
1192 \section{Macros}\label{macros}
1194 These macros are defined in wxWindows.
1196 \membersection{CLASSINFO}\label{classinfo}
1198 \func{wxClassInfo *}{CLASSINFO}{className}
1200 Returns a pointer to the wxClassInfo object associated with this class.
1202 \membersection{WXDEBUG\_NEW}\label{debugnew}
1204 \func{}{WXDEBUG\_NEW}{arg}
1206 This is defined in debug mode to be call the redefined new operator
1207 with filename and line number arguments. The definition is:
1210 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1213 In non-debug mode, this is defined as the normal new operator.
1215 \membersection{DECLARE\_ABSTRACT\_CLASS}
1217 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1219 Used inside a class declaration to declare that the class should be
1220 made known to the class hierarchy, but objects of this class cannot be created
1221 dynamically. The same as DECLARE\_CLASS.
1226 class wxCommand: public wxObject
1228 DECLARE_ABSTRACT_CLASS(wxCommand)
1237 \membersection{DECLARE\_APP}\label{declareapp}
1239 \func{}{DECLARE\_APP}{className}
1241 This is used in headers to create a forward declaration of the wxGetApp function implemented
1242 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1250 \membersection{DECLARE\_CLASS}
1252 \func{}{DECLARE\_CLASS}{className}
1254 Used inside a class declaration to declare that the class should be
1255 made known to the class hierarchy, but objects of this class cannot be created
1256 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1258 \membersection{DECLARE\_DYNAMIC\_CLASS}
1260 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1262 Used inside a class declaration to declare that the objects of this class should be dynamically
1263 createable from run-time type information.
1268 class wxFrame: public wxWindow
1270 DECLARE_DYNAMIC_CLASS(wxFrame)
1273 const wxString\& frameTitle;
1279 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1281 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1283 Used in a C++ implementation file to complete the declaration of
1284 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1289 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1291 wxCommand::wxCommand(void)
1297 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1299 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1301 Used in a C++ implementation file to complete the declaration of
1302 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1304 \membersection{IMPLEMENT\_APP}\label{implementapp}
1306 \func{}{IMPLEMENT\_APP}{className}
1308 This is used in the application class implementation file to make the application class known to
1309 wxWindows for dynamic construction. You use this instead of
1320 IMPLEMENT_APP(MyApp)
1323 See also \helpref{DECLARE\_APP}{declareapp}.
1325 \membersection{IMPLEMENT\_CLASS}
1327 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1329 Used in a C++ implementation file to complete the declaration of
1330 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1332 \membersection{IMPLEMENT\_CLASS2}
1334 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1336 Used in a C++ implementation file to complete the declaration of a
1337 class that has run-time type information and two base classes. The
1338 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1340 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1342 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1344 Used in a C++ implementation file to complete the declaration of
1345 a class that has run-time type information, and whose instances
1346 can be created dynamically.
1351 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1353 wxFrame::wxFrame(void)
1359 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1361 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1363 Used in a C++ implementation file to complete the declaration of
1364 a class that has run-time type information, and whose instances
1365 can be created dynamically. Use this for classes derived from two
1368 \membersection{WXTRACE}\label{trace}
1370 \func{}{WXTRACE}{formatString, ...}
1372 Calls wxTrace with printf-style variable argument syntax. Output
1373 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1375 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1377 \membersection{WXTRACELEVEL}\label{tracelevel}
1379 \func{}{WXTRACELEVEL}{level, formatString, ...}
1381 Calls wxTraceLevel with printf-style variable argument syntax. Output
1382 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1383 The first argument should be the level at which this information is appropriate.
1384 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1387 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1389 \section{wxWindows resource functions}\label{resourcefuncs}
1391 \overview{wxWindows resource system}{resourceformats}
1393 This section details functions for manipulating wxWindows (.WXR) resource
1394 files and loading user interface elements from resources.
1396 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1397 about initialisation file resource reading and writing, using such functions
1398 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1400 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1402 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1403 loading from resource data.
1405 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1407 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1409 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1410 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1411 perhaps for implementing resource functionality for interpreted languages.
1413 \membersection{::wxResourceClear}
1415 \func{void}{wxResourceClear}{\void}
1417 Clears the wxWindows resource table.
1419 \membersection{::wxResourceCreateBitmap}
1421 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1423 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1424 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1428 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1429 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1430 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1433 then this function can be called as follows:
1436 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1439 \membersection{::wxResourceCreateIcon}
1441 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1443 Creates a new icon from a file, static data, or Windows resource, given a valid
1444 wxWindows icon resource identifier. For example, if the .WXR file contains
1448 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1449 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1450 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1453 then this function can be called as follows:
1456 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1459 \membersection{::wxResourceCreateMenuBar}
1461 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1463 Creates a new menu bar given a valid wxWindows menubar resource
1464 identifier. For example, if the .WXR file contains the following:
1467 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1471 ['&Open File', 2, 'Open a file'],\
1472 ['&Save File', 3, 'Save a file'],\
1474 ['E&xit', 4, 'Exit program']\
1477 ['&About', 6, 'About this program']\
1482 then this function can be called as follows:
1485 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1489 \membersection{::wxResourceGetIdentifier}
1491 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1493 Used for retrieving the integer value associated with an identifier.
1494 A zero value indicates that the identifier was not found.
1496 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1498 \membersection{::wxResourceParseData}\label{wxresourcedata}
1500 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1502 Parses a string containing one or more wxWindows resource objects. If
1503 the resource objects are global static data that are included into the
1504 C++ program, then this function must be called for each variable
1505 containing the resource data, to make it known to wxWindows.
1507 {\it resource} should contain data in the following form:
1510 dialog(name = 'dialog1',
1511 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1512 title = 'Test dialog box',
1513 x = 312, y = 234, width = 400, height = 300,
1515 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1516 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1517 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1518 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1519 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1520 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1523 This function will typically be used after including a {\tt .wxr} file into
1524 a C++ program as follows:
1527 #include "dialog1.wxr"
1530 Each of the contained resources will declare a new C++ variable, and each
1531 of these variables should be passed to wxResourceParseData.
1533 \membersection{::wxResourceParseFile}
1535 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1537 Parses a file containing one or more wxWindows resource objects
1538 in C++-compatible syntax. Use this function to dynamically load
1539 wxWindows resource data.
1541 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1543 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1545 Parses a string containing one or more wxWindows resource objects. If
1546 the resource objects are global static data that are included into the
1547 C++ program, then this function must be called for each variable
1548 containing the resource data, to make it known to wxWindows.
1550 {\it resource} should contain data with the following form:
1553 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
1554 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
1555 title = 'Test dialog box',\
1556 x = 312, y = 234, width = 400, height = 300,\
1558 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
1559 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
1560 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
1561 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
1562 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
1563 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
1566 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
1567 load an entire {\tt .wxr file} into a string.
1569 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
1571 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
1572 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
1574 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
1576 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
1577 This is required if other resources will use the bitmap data, since otherwise there
1578 is no connection between names used in resources, and the global bitmap data.
1580 \membersection{::wxResourceRegisterIconData}
1582 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
1584 \section{Log functions}\label{logfunctions}
1586 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
1587 further information.
1589 \membersection{::wxLogError}\label{wxlogerror}
1591 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
1593 The function to use for error messages, i.e. the
1594 messages that must be shown to the user. The default processing is to pop up a
1595 message box to inform the user about it.
1597 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
1599 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
1601 Like \helpref{wxLogError}{wxlogerror}, but also
1602 terminates the program with the exit code 3. Using {\it abort()} standard
1603 function also terminates the program with this exit code.
1605 \membersection{::wxLogWarning}\label{wxlogwarning}
1607 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
1609 For warnings - they are also normally shown to the
1610 user, but don't interrupt the program work.
1612 \membersection{::wxLogMessage}\label{wxlogmessage}
1614 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
1616 for all normal, informational messages. They also
1617 appear in a message box by default (but it can be changed). Notice
1618 that the standard behaviour is to not show informational messages if there are
1619 any errors later - the logic being that the later error messages make the
1620 informational messages preceding them meaningless.
1622 \membersection{::wxLogVerbose}\label{wxlogverbose}
1624 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
1626 For verbose output. Normally, it's suppressed, but
1627 might be activated if the user wishes to know more details about the program
1628 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
1630 \membersection{::wxLogStatus}\label{wxlogstatus}
1632 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
1634 For status messages - they will go into the status
1635 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
1637 \membersection{::wxLogSysError}\label{wxlogsyserror}
1639 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
1641 Mostly used by wxWindows itself, but might be
1642 handy for logging errors after system call (API function) failure. It logs the
1643 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
1644 on the platform) and the corresponding error
1645 message. The second form of this function takes the error code explitly as the
1648 \membersection{::wxLogDebug}\label{wxlogdebug}
1650 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
1652 The right function for debug output. It only
1653 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
1654 and expands to nothing in release mode (otherwise).
1656 \membersection{::wxLogTrace}\label{wxlogtrace}
1658 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
1660 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
1662 As {\bf wxLogDebug}, only does something in debug
1663 build. The reason for making it a separate function from it is that usually
1664 there are a lot of trace messages, so it might make sense to separate them
1665 from other debug messages which would be flooded in them. Moreover, the second
1666 version of this function takes a trace mask as the first argument which allows
1667 to further restrict the amount of messages generated. The value of {\it mask} can be:
1669 \begin{itemize}\itemsep=0pt
1670 \item wxTraceMemAlloc: trace memory allocation (new/delete)
1671 \item wxTraceMessages: trace window messages/X callbacks
1672 \item wxTraceResAlloc: trace GDI resource allocation
1673 \item wxTraceRefCount: trace various ref counting operations
1676 \section{Debugging macros and functions}\label{debugmacros}
1678 Useful macros and functins for error checking and defensive programming. ASSERTs are only
1679 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
1682 \membersection{::wxOnAssert}\label{wxonassert}
1684 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
1686 This function may be redefined to do something non trivial and is called
1687 whenever one of debugging macros fails (i.e. condition is false in an
1688 assertion). TODO: this should probably be an overridable in wxApp.
1690 \membersection{wxASSERT}\label{wxassert}
1692 \func{}{wxASSERT}{\param{}{condition}}
1694 Assert macro. An error message will be generated if the condition is FALSE.
1696 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
1698 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
1700 Assert macro with message. An error message will be generated if the condition is FALSE.
1702 \membersection{wxFAIL}\label{wxfail}
1704 \func{}{wxFAIL}{\param{}{condition}}
1706 Will always generate an assert error if this code is reached (in debug mode).
1708 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
1710 \func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
1712 Will always generate an assert error with specified message if this code is reached (in debug mode).
1714 \membersection{wxCHECK}\label{wxcheck}
1716 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
1718 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
1719 This check is done even in release mode.
1721 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
1723 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
1725 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
1726 This check is done even in release mode.