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{::wxGetOSDirectory
}\label{wxgetosdirectory
}
71 \func{wxString
}{wxGetOSDirectory
}{\void}
73 Returns the Windows directory under Windows; on other platforms returns the empty string.
75 \membersection{::wxIsAbsolutePath
}
77 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
79 Returns TRUE if the argument is an absolute filename, i.e. with a slash
80 or drive name at the beginning.
82 \membersection{::wxPathOnly
}
84 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
86 Returns a temporary pointer to the directory part of the filename. Copy this
87 pointer for long-term use.
89 \membersection{::wxUnix2DosFilename
}
91 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
93 Converts a Unix to a DOS filename by replacing forward
94 slashes with backslashes.
96 \membersection{::wxConcatFiles
}
98 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
99 \param{const wxString\&
}{file3
}}
101 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
104 \membersection{::wxCopyFile
}
106 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
108 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
110 \membersection{::wxGetCwd
}\label{wxgetcwd
}
112 \func{wxString
}{wxGetCwd
}{\void}
114 Returns a string containing the current (or working) directory.
116 \membersection{::wxGetHostName
}\label{wxgethostname
}
118 \func{bool
}{wxGetHostName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
120 Copies the current host machine's name into the supplied buffer.
122 Under Windows or NT, this function first looks in the environment
123 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
124 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
126 Returns TRUE if successful, FALSE otherwise.
128 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
130 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
132 Copies the user's email address into the supplied buffer, by
133 concatenating the values returned by
\helpref{wxGetHostName
}{wxgethostname
}\rtfsp
134 and
\helpref{wxGetUserId
}{wxgetuserid
}.
136 Returns TRUE if successful, FALSE otherwise.
138 \membersection{::wxGetUserId
}\label{wxgetuserid
}
140 \func{bool
}{wxGetUserId
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
142 Copies the current user id into the supplied buffer.
144 Under Windows or NT, this function first looks in the environment
145 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
146 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
148 Returns TRUE if successful, FALSE otherwise.
150 \membersection{::wxGetUserName
}\label{wxgetusername
}
152 \func{bool
}{wxGetUserName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
154 Copies the current user name into the supplied buffer.
156 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
157 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
158 is running, the entry
{\bf Current
} in the section
{\bf User
} of
159 the PENWIN.INI file is used.
161 Returns TRUE if successful, FALSE otherwise.
163 \membersection{::wxGetWorkingDirectory
}
165 \func{wxString
}{wxGetWorkingDirectory
}{\param{const wxString\&
}{buf=NULL
},
\param{int
}{sz=
1000}}
167 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
169 Copies the current working directory into the buffer if supplied, or
170 copies the working directory into new storage (which you must delete yourself)
171 if the buffer is NULL.
173 {\it sz
} is the size of the buffer if supplied.
175 \membersection{::wxGetTempFileName
}
177 \func{wxString
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{const wxString\&
}{buf=NULL
}}
179 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
180 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
181 is allocated for the temporary filename using
{\it new
}.
183 Under Windows, the filename will include the drive and name of the
184 directory allocated for temporary files (usually the contents of the
185 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
187 It is the application's responsibility to create and delete the file.
189 \membersection{::wxIsWild
}\label{wxiswild
}
191 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
193 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
195 \membersection{::wxMatchWild
}\label{wxmatchwild
}
197 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
199 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
200 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
201 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
203 \membersection{::wxMkdir
}
205 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
}}
207 Makes the directory
{\it dir
}, returning TRUE if successful.
209 \membersection{::wxRemoveFile
}
211 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
213 Removes
{\it file
}, returning TRUE if successful.
215 \membersection{::wxRenameFile
}
217 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
219 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
221 \membersection{::wxRmdir
}
223 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
225 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
227 The
{\it flags
} parameter is reserved for future use.
229 \membersection{::wxSetWorkingDirectory
}
231 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
233 Sets the current working directory, returning TRUE if the operation succeeded.
234 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
236 \section{String functions
}
238 \membersection{::copystring
}
240 \func{char*
}{copystring
}{\param{const char*
}{s
}}
242 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
243 deleted with the
{\it delete
} operator.
245 \membersection{::wxStringMatch
}
247 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
248 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
250 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
251 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
252 no substring matching is done.
254 \membersection{::wxStringEq
}\label{wxstringeq
}
256 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
261 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
264 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
266 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
268 Copies the given file to
{\it stream
}. Useful when converting an old application to
269 use streams (within the
document/view framework, for example).
271 Use of this function requires the file wx
\_doc.h to be included.
273 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
275 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
277 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
278 use streams (within the
document/view framework, for example).
280 Use of this function requires the file wx
\_doc.h to be included.
282 \section{Dialog functions
}\label{dialogfunctions
}
284 Below are a number of convenience functions for getting input from the
285 user or displaying messages. Note that in these functions the last three
286 parameters are optional. However, it is recommended to pass a parent frame
287 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
288 the front when the dialog box is popped up.
290 \membersection{::wxFileSelector
}\label{wxfileselector
}
292 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = NULL
},\\
293 \param{const wxString\&
}{default
\_filename = NULL
},
\param{const wxString\&
}{default
\_extension = NULL
},\\
294 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
295 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
297 Pops up a file selector box. In Windows, this is the common file selector
298 dialog. In X, this is a file selector box with somewhat less functionality.
299 The path and filename are distinct elements of a full file pathname.
300 If path is NULL, the current directory will be used. If filename is NULL,
301 no default filename will be supplied. The wildcard determines what files
302 are displayed in the file selector, and file extension supplies a type
303 extension for the required filename. Flags may be a combination of wxOPEN,
304 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
305 at present in Windows.
307 Both the X and Windows versions implement a wildcard filter. Typing a
308 filename containing wildcards
(*, ?) in the filename text item, and
309 clicking on Ok, will result in only those files matching the pattern being
310 displayed. In the X version, supplying no default name will result in the
311 wildcard filter being inserted in the filename text item; the filter is
312 ignored if a default name is supplied.
314 Under Windows (only), the wildcard may be a specification for multiple
315 types of file with a description for each, such as:
318 "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
321 The application must check for a NULL return value (the user pressed
322 Cancel). For example:
325 const wxString\& s = wxFileSelector("Choose a file to open");
332 Remember that the returned pointer is temporary and should be copied
333 if other wxWindows calls will be made before the value is to be used.
335 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
337 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
338 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
339 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
341 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
342 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
343 or press Cancel to return NULL.
345 If {\it centre} is TRUE, the message text (which may include new line characters)
346 is centred; if FALSE, the message is left-justified.
348 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
350 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
351 \param{int }{nsel}, \param{int *}{selection},
352 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
353 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
355 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
356 listbox. The user may choose one or more item(s) and press OK or Cancel.
358 The number of initially selected choices, and array of the selected indices,
359 are passed in; this array will contain the user selections on exit, with
360 the function returning the number of selections. {\it selection} must be
361 as big as the number of choices, in case all are selected.
363 If Cancel is pressed, -1 is returned.
365 {\it choices} is an array of {\it n} strings for the listbox.
367 If {\it centre} is TRUE, the message text (which may include new line characters)
368 is centred; if FALSE, the message is left-justified.
370 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
372 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
373 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
374 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
376 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
377 listbox. The user may choose an item and press OK to return a string or
378 Cancel to return NULL.
380 {\it choices} is an array of {\it n} strings for the listbox.
382 If {\it centre} is TRUE, the message text (which may include new line characters)
383 is centred; if FALSE, the message is left-justified.
385 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
387 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
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 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
392 If the user pressed cancel, -1 is returned.
394 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
396 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
397 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
398 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
400 As {\bf wxGetSingleChoice} but takes an array of client data pointers
401 corresponding to the strings, and returns one of these pointers.
403 \membersection{::wxMessageBox}\label{wxmessagebox}
405 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
406 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
408 General purpose message dialog. {\it style} may be a bit list of the
409 following identifiers:
411 \begin{twocollist}\itemsep=0pt
412 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
414 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
416 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
417 \twocolitem{wxCENTRE}{Centres the text.}
418 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
419 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
420 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
421 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
424 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
430 int answer = wxMessageBox("Quit program?", "Confirm",
431 wxYES_NO | wxCANCEL, main_frame);
437 {\it message} may contain newline characters, in which case the
438 message will be split into separate lines, to cater for large messages.
440 Under Windows, the native MessageBox function is used unless wxCENTRE
441 is specified in the style, in which case a generic function is used.
442 This is because the native MessageBox function cannot centre text.
443 The symbols are not shown when the generic function is used.
445 \section{GDI functions}\label{gdifunctions}
447 The following are relevant to the GDI (Graphics Device Interface).
449 \membersection{::wxColourDisplay}
451 \func{bool}{wxColourDisplay}{\void}
453 Returns TRUE if the display is colour, FALSE otherwise.
455 \membersection{::wxDisplayDepth}
457 \func{int}{wxDisplayDepth}{\void}
459 Returns the depth of the display (a value of 1 denotes a monochrome display).
461 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
463 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
464 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
466 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
467 makes it into a placeable metafile by prepending a header containing the given
468 bounding box. The bounding box may be obtained from a device context after drawing
469 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
471 In addition to adding the placeable metafile header, this function adds
472 the equivalent of the following code to the start of the metafile data:
475 SetMapMode(dc, MM_ANISOTROPIC);
476 SetWindowOrg(dc, minX, minY);
477 SetWindowExt(dc, maxX - minX, maxY - minY);
480 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
482 Placeable metafiles may be imported by many Windows applications, and can be
483 used in RTF (Rich Text Format) files.
485 {\it scale} allows the specification of scale for the metafile.
487 This function is only available under Windows.
489 \membersection{::wxSetCursor}\label{wxsetcursor}
491 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
493 Globally sets the cursor; only has an effect in MS Windows.
494 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
496 \section{Printer settings}\label{printersettings}
498 The following functions are used to control PostScript printing. Under
499 Windows, PostScript output can only be sent to a file.
501 \membersection{::wxGetPrinterCommand}
503 \func{wxString}{wxGetPrinterCommand}{\void}
505 Gets the printer command used to print a file. The default is {\tt lpr}.
507 \membersection{::wxGetPrinterFile}
509 \func{wxString}{wxGetPrinterFile}{\void}
511 Gets the PostScript output filename.
513 \membersection{::wxGetPrinterMode}
515 \func{int}{wxGetPrinterMode}{\void}
517 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
518 The default is PS\_PREVIEW.
520 \membersection{::wxGetPrinterOptions}
522 \func{wxString}{wxGetPrinterOptions}{\void}
524 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
526 \membersection{::wxGetPrinterOrientation}
528 \func{int}{wxGetPrinterOrientation}{\void}
530 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
532 \membersection{::wxGetPrinterPreviewCommand}
534 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
536 Gets the command used to view a PostScript file. The default depends on the platform.
538 \membersection{::wxGetPrinterScaling}
540 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
542 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
544 \membersection{::wxGetPrinterTranslation}
546 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
548 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
550 \membersection{::wxSetPrinterCommand}
552 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
554 Sets the printer command used to print a file. The default is {\tt lpr}.
556 \membersection{::wxSetPrinterFile}
558 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
560 Sets the PostScript output filename.
562 \membersection{::wxSetPrinterMode}
564 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
566 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
567 The default is PS\_PREVIEW.
569 \membersection{::wxSetPrinterOptions}
571 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
573 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
575 \membersection{::wxSetPrinterOrientation}
577 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
579 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
581 \membersection{::wxSetPrinterPreviewCommand}
583 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
585 Sets the command used to view a PostScript file. The default depends on the platform.
587 \membersection{::wxSetPrinterScaling}
589 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
591 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
593 \membersection{::wxSetPrinterTranslation}
595 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
597 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
599 \section{Clipboard functions}\label{clipsboard}
601 These clipboard functions are implemented for Windows only.
603 \membersection{::wxClipboardOpen}
605 \func{bool}{wxClipboardOpen}{\void}
607 Returns TRUE if this application has already opened the clipboard.
609 \membersection{::wxCloseClipboard}
611 \func{bool}{wxCloseClipboard}{\void}
613 Closes the clipboard to allow other applications to use it.
615 \membersection{::wxEmptyClipboard}
617 \func{bool}{wxEmptyClipboard}{\void}
619 Empties the clipboard.
621 \membersection{::wxEnumClipboardFormats}
623 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
625 Enumerates the formats found in a list of available formats that belong
626 to the clipboard. Each call to this function specifies a known
627 available format; the function returns the format that appears next in
630 {\it dataFormat} specifies a known format. If this parameter is zero,
631 the function returns the first format in the list.
633 The return value specifies the next known clipboard data format if the
634 function is successful. It is zero if the {\it dataFormat} parameter specifies
635 the last format in the list of available formats, or if the clipboard
638 Before it enumerates the formats function, an application must open the clipboard by using the
639 wxOpenClipboard function.
641 \membersection{::wxGetClipboardData}
643 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
645 Gets data from the clipboard.
647 {\it dataFormat} may be one of:
649 \begin{itemize}\itemsep=0pt
650 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
651 \item wxCF\_BITMAP: returns a new wxBitmap.
654 The clipboard must have previously been opened for this call to succeed.
656 \membersection{::wxGetClipboardFormatName}
658 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
660 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
661 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
663 \membersection{::wxIsClipboardFormatAvailable}
665 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
667 Returns TRUE if the given data format is available on the clipboard.
669 \membersection{::wxOpenClipboard}
671 \func{bool}{wxOpenClipboard}{\void}
673 Opens the clipboard for passing data to it or getting data from it.
675 \membersection{::wxRegisterClipboardFormat}
677 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
679 Registers the clipboard data format name and returns an identifier.
681 \membersection{::wxSetClipboardData}
683 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
685 Passes data to the clipboard.
687 {\it dataFormat} may be one of:
689 \begin{itemize}\itemsep=0pt
690 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
691 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
692 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
693 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
696 The clipboard must have previously been opened for this call to succeed.
698 \section{Miscellaneous functions}\label{miscellany}
700 \membersection{::NewId}
702 \func{long}{NewId}{\void}
704 Generates an integer identifier unique to this run of the program.
706 \membersection{::RegisterId}
708 \func{void}{RegisterId}{\param{long}{ id}}
710 Ensures that ids subsequently generated by {\bf NewId} do not clash with
713 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
715 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
717 Changes the cursor to the given cursor for all windows in the application.
718 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
719 to its previous state. These two calls can be nested, and a counter
720 ensures that only the outer calls take effect.
722 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
724 \membersection{::wxBell}
726 \func{void}{wxBell}{\void}
728 Ring the system bell.
730 \membersection{::wxCleanUp}\label{wxcleanup}
732 \func{void}{wxCleanUp}{\void}
734 Normally, wxWindows will call this cleanup function for you. However, if
735 you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
736 manually, then you should also call wxCleanUp before terminating wxWindows,
737 if wxWindows does not get a chance to do it.
739 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
741 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
743 Creates and returns an object of the given class, if the class has been
744 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
746 \membersection{::wxDDECleanUp}\label{wxddecleanup}
748 \func{void}{wxDDECleanUp}{\void}
750 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
751 called by the application.
753 See also helpref{wxDDEInitialize}{wxddeinitialize}.
755 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
757 \func{void}{wxDDEInitialize}{\void}
759 Initializes the DDE system. May be called multiple times without harm.
761 This no longer needs to be called by the application: it will be called
762 by wxWindows if necessary.
764 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
765 \helpref{wxDDECleanUp}{wxddecleanup}.
767 \membersection{::wxDebugMsg}\label{wxdebugmsg}
769 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
771 Display a debugging message; under Windows, this will appear on the
772 debugger command window, and under Unix, it will be written to standard
775 The syntax is identical to {\bf printf}: pass a format string and a
776 variable list of arguments.
778 Note that under Windows, you can see the debugging messages without a
779 debugger if you have the DBWIN debug log application that comes with
782 {\bf Tip:} under Windows, if your application crashes before the
783 message appears in the debugging window, put a wxYield call after
784 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
785 (at least for Watcom C++): preformat your messages and use OutputDebugString
788 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
790 \membersection{::wxDisplaySize}
792 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
794 Gets the physical size of the display in pixels.
796 \membersection{::wxEntry}\label{wxentry}
798 This initializes wxWindows in a platform-dependent way. Use this if you
799 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
800 you can initialize wxWindows from an Microsoft Foundation Classes application using
801 this function. See also \helpref{wxCleanUp}{wxcleanup}.
803 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
804 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
806 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
807 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
808 message loop will be entered.
810 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
811 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
813 wxWindows initialization under Windows (for applications constructed as a DLL).
815 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
817 wxWindows initialization under Unix.
819 \membersection{::wxError}\label{wxerror}
821 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
823 Displays {\it msg} and continues. This writes to standard error under
824 Unix, and pops up a message box under Windows. Used for internal
825 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
827 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
829 \func{void}{wxEndBusyCursor}{\void}
831 Changes the cursor back to the original cursor, for all windows in the application.
832 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
834 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
836 \membersection{::wxExecute}\label{wxexecute}
838 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
840 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
842 Executes another program in Unix or Windows.
844 The first form takes a command string, such as {\tt "emacs file.txt"}.
846 The second form takes an array of values: a command, any number of
847 arguments, terminated by NULL.
849 If {\it sync} is FALSE (the default), flow of control immediately returns.
850 If TRUE, the current application waits until the other program has terminated.
852 If execution is asynchronous, the return value is the process id,
853 otherwise it is a status value. A zero value indicates that the command could not
856 If callback isn't NULL and if execution is asynchronous,
857 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
858 the process finishes.
860 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
862 \membersection{::wxExit}\label{wxexit}
864 \func{void}{wxExit}{\void}
866 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
867 Should only be used in an emergency: normally the top-level frame
868 should be deleted (after deleting all other frames) to terminate the
869 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
871 \membersection{::wxFatalError}\label{wxfatalerror}
873 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
875 Displays {\it msg} and exits. This writes to standard error under Unix,
876 and pops up a message box under Windows. Used for fatal internal
877 wxWindows errors. See also \helpref{wxError}{wxerror}.
879 \membersection{::wxFindMenuItemId}
881 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
883 Find a menu item identifier associated with the given frame's menu bar.
885 \membersection{::wxFindWindowByLabel}
887 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
889 Find a window by its label. Depending on the type of window, the label may be a window title
890 or panel item label. If {\it parent} is NULL, the search will start from all top-level
891 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
892 The search is recursive in both cases.
894 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
896 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
898 Find a window by its name (as given in a window constructor or {\bf Create} function call).
899 If {\it parent} is NULL, the search will start from all top-level
900 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
901 The search is recursive in both cases.
903 If no such named window is found, {\bf wxFindWindowByLabel} is called.
905 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
907 \func{wxWindow *}{wxGetActiveWindow}{\void}
909 Gets the currently active window (Windows only).
911 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
913 \func{wxString}{wxGetDisplayName}{\void}
915 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
917 \membersection{::wxGetHomeDir}
919 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
921 Fills the buffer with a string representing the user's home directory (Unix only).
923 \membersection{::wxGetHostName}
925 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
927 Copies the host name of the machine the program is running on into the
928 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
929 successful. Under Unix, this will return a machine name. Under Windows,
930 this returns ``windows''.
932 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
934 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
936 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
938 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
941 See also \helpref{wxTimer}{wxtimer}.
943 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
945 \func{long}{wxGetFreeMemory}{\void}
947 Returns the amount of free memory in Kbytes under environments which
948 support it, and -1 if not supported. Currently, returns a positive value
949 under Windows, and -1 under Unix.
951 \membersection{::wxGetMousePosition}
953 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
955 Returns the mouse position in screen coordinates.
957 \membersection{::wxGetOsVersion}
959 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
961 Gets operating system version information.
963 \begin{twocollist}\itemsep=0pt
964 \twocolitemruled{Platform}{Return tyes}
965 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
966 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
967 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
968 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
969 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
970 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
971 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
972 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
973 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
976 \membersection{::wxGetResource}\label{wxgetresource}
978 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
979 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
981 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
982 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
984 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
985 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
987 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
988 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
990 Gets a resource value from the resource database (for example, WIN.INI, or
991 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
992 otherwise the specified file is used.
994 Under X, if an application class (wxApp::GetClassName) has been defined,
995 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
996 an applications default file when merging all resource databases.
998 The reason for passing the result in an argument is that it
999 can be convenient to define a default value, which gets overridden
1000 if the value exists in the resource file. It saves a separate
1001 test for that resource's existence, and it also allows
1002 the overloading of the function for different types.
1004 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1006 \membersection{::wxGetUserId}
1008 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1010 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1011 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1012 Under Windows, this returns ``user''.
1014 \membersection{::wxGetUserName}
1016 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1018 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1019 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1020 Under Windows, this returns ``unknown''.
1022 \membersection{::wxKill}\label{wxkill}
1024 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1026 Under Unix (the only supported platform), equivalent to the Unix kill function.
1027 Returns 0 on success, -1 on failure.
1029 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1030 It does not raise a signal in the receiving process.
1032 \membersection{::wxInitClipboard}\label{wxinitclipboard}
1034 \func{void}{wxInitClipboard}{\void}
1036 Initializes the generic clipboard system by creating an instance of
1037 the class \helpref{wxClipboard}{wxclipboard}.
1039 \membersection{::wxIsBusy}\label{wxisbusy}
1041 \func{bool}{wxIsBusy}{\void}
1043 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1044 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1046 See also \helpref{wxBusyCursor}{wxbusycursor}.
1048 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1050 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1052 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1053 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1055 The resource must be defined in the {\tt .rc} file using the following syntax:
1058 myResource TEXT file.ext
1061 where {\tt file.ext} is a file that the resource compiler can find.
1063 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1064 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1065 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1067 This function is available under Windows only.
1069 \membersection{::wxNow}\label{wxnow}
1071 \func{wxString}{wxNow}{\void}
1073 Returns a string representing the current date and time.
1075 \membersection{::wxPostDelete}\label{wxpostdelete}
1077 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1079 Under X, tells the system to delete the specified object when
1080 all other events have been processed. In some environments, it is
1081 necessary to use this instead of deleting a frame directly with the
1082 delete operator, because X will still send events to the window.
1084 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1086 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1088 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1090 Under X only, sets the current display name. This is the X host and display name such
1091 as ``colonsay:0.0", and the function indicates which display should be used for creating
1092 windows from this point on. Setting the display within an application allows multiple
1093 displays to be used.
1095 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1097 \membersection{::wxShell}\label{wxshell}
1099 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1101 Executes a command in an interactive shell window. If no command is
1102 specified, then just the shell is spawned.
1104 See also \helpref{wxExecute}{wxexecute}.
1106 \membersection{::wxSleep}\label{wxsleep}
1108 \func{void}{wxSleep}{\param{int}{ secs}}
1110 Sleeps for the specified number of seconds.
1112 \membersection{::wxStripMenuCodes}
1114 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1116 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1118 Strips any menu codes from {\it in} and places the result
1119 in {\it out} (or returns the new string, in the first form).
1121 Menu codes include \& (mark the next character with an underline
1122 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1124 \membersection{::wxStartTimer}\label{wxstarttimer}
1126 \func{void}{wxStartTimer}{\void}
1128 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1130 See also \helpref{wxTimer}{wxtimer}.
1132 \membersection{::wxToLower}\label{wxtolower}
1134 \func{char}{wxToLower}{\param{char }{ch}}
1136 Converts the character to lower case. This is implemented as a macro for efficiency.
1138 \membersection{::wxToUpper}\label{wxtoupper}
1140 \func{char}{wxToUpper}{\param{char }{ch}}
1142 Converts the character to upper case. This is implemented as a macro for efficiency.
1144 \membersection{::wxTrace}\label{wxtrace}
1146 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1148 Takes printf-style variable argument syntax. Output
1149 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1151 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1153 \membersection{::wxTraceLevel}\label{wxtracelevel}
1155 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1157 Takes printf-style variable argument syntax. Output
1158 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1159 The first argument should be the level at which this information is appropriate.
1160 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1163 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1165 \membersection{::wxWriteResource}\label{wxwriteresource}
1167 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1168 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1170 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1171 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1173 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1174 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1176 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1177 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1179 Writes a resource value into the resource database (for example, WIN.INI, or
1180 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1181 otherwise the specified file is used.
1183 Under X, the resource databases are cached until the internal function
1184 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1185 all updated resource databases are written to their files.
1187 Note that it is considered bad manners to write to the .Xdefaults
1188 file under Unix, although the WIN.INI file is fair game under Windows.
1190 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1192 \membersection{::wxYield}
1194 \func{bool}{wxYield}{\void}
1196 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1197 time-consuming process writes to a text window. Without an occasional
1198 yield, the text window will not be updated properly, and (since Windows
1199 multitasking is cooperative) other processes will not respond.
1201 Caution should be exercised, however, since yielding may allow the
1202 user to perform actions which are not compatible with the current task.
1203 Disabling menu items or whole menus during processing can avoid unwanted
1206 \section{Macros}\label{macros}
1208 These macros are defined in wxWindows.
1210 \membersection{CLASSINFO}\label{classinfo}
1212 \func{wxClassInfo *}{CLASSINFO}{className}
1214 Returns a pointer to the wxClassInfo object associated with this class.
1216 \membersection{WXDEBUG\_NEW}\label{debugnew}
1218 \func{}{WXDEBUG\_NEW}{arg}
1220 This is defined in debug mode to be call the redefined new operator
1221 with filename and line number arguments. The definition is:
1224 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1227 In non-debug mode, this is defined as the normal new operator.
1229 \membersection{DECLARE\_ABSTRACT\_CLASS}
1231 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1233 Used inside a class declaration to declare that the class should be
1234 made known to the class hierarchy, but objects of this class cannot be created
1235 dynamically. The same as DECLARE\_CLASS.
1240 class wxCommand: public wxObject
1242 DECLARE_ABSTRACT_CLASS(wxCommand)
1251 \membersection{DECLARE\_APP}\label{declareapp}
1253 \func{}{DECLARE\_APP}{className}
1255 This is used in headers to create a forward declaration of the wxGetApp function implemented
1256 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1264 \membersection{DECLARE\_CLASS}
1266 \func{}{DECLARE\_CLASS}{className}
1268 Used inside a class declaration to declare that the class should be
1269 made known to the class hierarchy, but objects of this class cannot be created
1270 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1272 \membersection{DECLARE\_DYNAMIC\_CLASS}
1274 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1276 Used inside a class declaration to declare that the objects of this class should be dynamically
1277 createable from run-time type information.
1282 class wxFrame: public wxWindow
1284 DECLARE_DYNAMIC_CLASS(wxFrame)
1287 const wxString\& frameTitle;
1293 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1295 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1297 Used in a C++ implementation file to complete the declaration of
1298 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1303 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1305 wxCommand::wxCommand(void)
1311 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1313 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1315 Used in a C++ implementation file to complete the declaration of
1316 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1318 \membersection{IMPLEMENT\_APP}\label{implementapp}
1320 \func{}{IMPLEMENT\_APP}{className}
1322 This is used in the application class implementation file to make the application class known to
1323 wxWindows for dynamic construction. You use this instead of
1334 IMPLEMENT_APP(MyApp)
1337 See also \helpref{DECLARE\_APP}{declareapp}.
1339 \membersection{IMPLEMENT\_CLASS}
1341 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1343 Used in a C++ implementation file to complete the declaration of
1344 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1346 \membersection{IMPLEMENT\_CLASS2}
1348 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1350 Used in a C++ implementation file to complete the declaration of a
1351 class that has run-time type information and two base classes. The
1352 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1354 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1356 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1358 Used in a C++ implementation file to complete the declaration of
1359 a class that has run-time type information, and whose instances
1360 can be created dynamically.
1365 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1367 wxFrame::wxFrame(void)
1373 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1375 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1377 Used in a C++ implementation file to complete the declaration of
1378 a class that has run-time type information, and whose instances
1379 can be created dynamically. Use this for classes derived from two
1382 \membersection{WXTRACE}\label{trace}
1384 \func{}{WXTRACE}{formatString, ...}
1386 Calls wxTrace with printf-style variable argument syntax. Output
1387 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1389 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1391 \membersection{WXTRACELEVEL}\label{tracelevel}
1393 \func{}{WXTRACELEVEL}{level, formatString, ...}
1395 Calls wxTraceLevel with printf-style variable argument syntax. Output
1396 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1397 The first argument should be the level at which this information is appropriate.
1398 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1401 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1403 \section{wxWindows resource functions}\label{resourcefuncs}
1405 \overview{wxWindows resource system}{resourceformats}
1407 This section details functions for manipulating wxWindows (.WXR) resource
1408 files and loading user interface elements from resources.
1410 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1411 about initialisation file resource reading and writing, using such functions
1412 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1414 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1416 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1417 loading from resource data.
1419 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1421 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1423 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1424 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1425 perhaps for implementing resource functionality for interpreted languages.
1427 \membersection{::wxResourceClear}
1429 \func{void}{wxResourceClear}{\void}
1431 Clears the wxWindows resource table.
1433 \membersection{::wxResourceCreateBitmap}
1435 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1437 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1438 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1442 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1443 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1444 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1447 then this function can be called as follows:
1450 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1453 \membersection{::wxResourceCreateIcon}
1455 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1457 Creates a new icon from a file, static data, or Windows resource, given a valid
1458 wxWindows icon resource identifier. For example, if the .WXR file contains
1462 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1463 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1464 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1467 then this function can be called as follows:
1470 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1473 \membersection{::wxResourceCreateMenuBar}
1475 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1477 Creates a new menu bar given a valid wxWindows menubar resource
1478 identifier. For example, if the .WXR file contains the following:
1481 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1485 ['&Open File', 2, 'Open a file'],\
1486 ['&Save File', 3, 'Save a file'],\
1488 ['E&xit', 4, 'Exit program']\
1491 ['&About', 6, 'About this program']\
1496 then this function can be called as follows:
1499 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1503 \membersection{::wxResourceGetIdentifier}
1505 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1507 Used for retrieving the integer value associated with an identifier.
1508 A zero value indicates that the identifier was not found.
1510 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1512 \membersection{::wxResourceParseData}\label{wxresourcedata}
1514 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1516 Parses a string containing one or more wxWindows resource objects. If
1517 the resource objects are global static data that are included into the
1518 C++ program, then this function must be called for each variable
1519 containing the resource data, to make it known to wxWindows.
1521 {\it resource} should contain data in the following form:
1524 dialog(name = 'dialog1',
1525 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1526 title = 'Test dialog box',
1527 x = 312, y = 234, width = 400, height = 300,
1529 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1530 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1531 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1532 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1533 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1534 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1537 This function will typically be used after including a {\tt .wxr} file into
1538 a C++ program as follows:
1541 #include "dialog1.wxr"
1544 Each of the contained resources will declare a new C++ variable, and each
1545 of these variables should be passed to wxResourceParseData.
1547 \membersection{::wxResourceParseFile}
1549 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1551 Parses a file containing one or more wxWindows resource objects
1552 in C++-compatible syntax. Use this function to dynamically load
1553 wxWindows resource data.
1555 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1557 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1559 Parses a string containing one or more wxWindows resource objects. If
1560 the resource objects are global static data that are included into the
1561 C++ program, then this function must be called for each variable
1562 containing the resource data, to make it known to wxWindows.
1564 {\it resource} should contain data with the following form:
1567 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
1568 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
1569 title = 'Test dialog box',\
1570 x = 312, y = 234, width = 400, height = 300,\
1572 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
1573 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
1574 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
1575 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
1576 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
1577 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
1580 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
1581 load an entire {\tt .wxr file} into a string.
1583 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
1585 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
1586 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
1588 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
1590 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
1591 This is required if other resources will use the bitmap data, since otherwise there
1592 is no connection between names used in resources, and the global bitmap data.
1594 \membersection{::wxResourceRegisterIconData}
1596 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
1598 \section{Log functions}\label{logfunctions}
1600 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
1601 further information.
1603 \membersection{::wxLogError}\label{wxlogerror}
1605 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
1607 The function to use for error messages, i.e. the
1608 messages that must be shown to the user. The default processing is to pop up a
1609 message box to inform the user about it.
1611 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
1613 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
1615 Like \helpref{wxLogError}{wxlogerror}, but also
1616 terminates the program with the exit code 3. Using {\it abort()} standard
1617 function also terminates the program with this exit code.
1619 \membersection{::wxLogWarning}\label{wxlogwarning}
1621 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
1623 For warnings - they are also normally shown to the
1624 user, but don't interrupt the program work.
1626 \membersection{::wxLogMessage}\label{wxlogmessage}
1628 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
1630 for all normal, informational messages. They also
1631 appear in a message box by default (but it can be changed). Notice
1632 that the standard behaviour is to not show informational messages if there are
1633 any errors later - the logic being that the later error messages make the
1634 informational messages preceding them meaningless.
1636 \membersection{::wxLogVerbose}\label{wxlogverbose}
1638 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
1640 For verbose output. Normally, it's suppressed, but
1641 might be activated if the user wishes to know more details about the program
1642 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
1644 \membersection{::wxLogStatus}\label{wxlogstatus}
1646 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
1648 For status messages - they will go into the status
1649 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
1651 \membersection{::wxLogSysError}\label{wxlogsyserror}
1653 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
1655 Mostly used by wxWindows itself, but might be
1656 handy for logging errors after system call (API function) failure. It logs the
1657 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
1658 on the platform) and the corresponding error
1659 message. The second form of this function takes the error code explitly as the
1662 \membersection{::wxLogDebug}\label{wxlogdebug}
1664 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
1666 The right function for debug output. It only
1667 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
1668 and expands to nothing in release mode (otherwise).
1670 \membersection{::wxLogTrace}\label{wxlogtrace}
1672 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
1674 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
1676 As {\bf wxLogDebug}, only does something in debug
1677 build. The reason for making it a separate function from it is that usually
1678 there are a lot of trace messages, so it might make sense to separate them
1679 from other debug messages which would be flooded in them. Moreover, the second
1680 version of this function takes a trace mask as the first argument which allows
1681 to further restrict the amount of messages generated. The value of {\it mask} can be:
1683 \begin{itemize}\itemsep=0pt
1684 \item wxTraceMemAlloc: trace memory allocation (new/delete)
1685 \item wxTraceMessages: trace window messages/X callbacks
1686 \item wxTraceResAlloc: trace GDI resource allocation
1687 \item wxTraceRefCount: trace various ref counting operations
1690 \section{Debugging macros and functions}\label{debugmacros}
1692 Useful macros and functins for error checking and defensive programming. ASSERTs are only
1693 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
1696 \membersection{::wxOnAssert}\label{wxonassert}
1698 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
1700 This function may be redefined to do something non trivial and is called
1701 whenever one of debugging macros fails (i.e. condition is false in an
1703 % TODO: this should probably be an overridable in wxApp.
1705 \membersection{wxASSERT}\label{wxassert}
1707 \func{}{wxASSERT}{\param{}{condition}}
1709 Assert macro. An error message will be generated if the condition is FALSE.
1711 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
1713 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
1715 Assert macro with message. An error message will be generated if the condition is FALSE.
1717 \membersection{wxFAIL}\label{wxfail}
1719 \func{}{wxFAIL}{\param{}{condition}}
1721 Will always generate an assert error if this code is reached (in debug mode).
1723 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
1725 \func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
1727 Will always generate an assert error with specified message if this code is reached (in debug mode).
1729 \membersection{wxCHECK}\label{wxcheck}
1731 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
1733 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
1734 This check is done even in release mode.
1736 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
1738 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
1740 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
1741 This check is done even in release mode.