]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/function.tex
Build fix after DrawPushButton introduction.
[wxWidgets.git] / docs / latex / wx / function.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: function.tex
3 %% Purpose: Functions and macros
4 %% Author: wxWidgets Team
5 %% Modified by:
6 %% Created:
7 %% RCS-ID: $Id$
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \chapter{Functions}\label{functions}
13 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
14 \setfooter{\thepage}{}{}{}{}{\thepage}
15
16 The functions and macros defined in wxWidgets are described here: you can
17 either look up a function using the alphabetical listing of them or find it in
18 the corresponding topic.
19
20 \section{Alphabetical functions and macros list}\label{functionsalphabetically}
21
22 \helpref{CLASSINFO}{classinfo}\\
23 \helpref{copystring}{copystring}\\
24 \helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\
25 \helpref{DECLARE\_APP}{declareapp}\\
26 \helpref{DECLARE\_CLASS}{declareclass}\\
27 \helpref{DECLARE\_DYNAMIC\_CLASS}{declaredynamicclass}\\
28 \helpref{IMPLEMENT\_ABSTRACT\_CLASS2}{implementabstractclass2}\\
29 \helpref{IMPLEMENT\_ABSTRACT\_CLASS}{implementabstractclass}\\
30 \helpref{IMPLEMENT\_APP}{implementapp}\\
31 \helpref{IMPLEMENT\_CLASS2}{implementclass2}\\
32 \helpref{IMPLEMENT\_CLASS}{implementclass}\\
33 \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
34 \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
35 \helpref{wxASSERT}{wxassert}\\
36 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\
37 \helpref{wxASSERT\_MSG}{wxassertmsg}\\
38 \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
39 \helpref{wxBell}{wxbell}\\
40 \helpref{wxBITMAP}{wxbitmapmacro}\\
41 \helpref{wxCHANGE\_UMASK}{wxchangeumask}\\
42 \helpref{wxCHECK}{wxcheck}\\
43 \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
44 \helpref{wxCHECK2}{wxcheck2}\\
45 \helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}\\
46 \helpref{wxCHECK\_MSG}{wxcheckmsg}\\
47 \helpref{wxCHECK\_RET}{wxcheckret}\\
48 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\
49 \helpref{wxCHECK\_VERSION\_FULL}{wxcheckversionfull}\\
50 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\
51 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
52 \helpref{wxClipboardOpen}{functionwxclipboardopen}\\
53 \helpref{wxCloseClipboard}{wxcloseclipboard}\\
54 \helpref{wxColourDisplay}{wxcolourdisplay}\\
55 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
56 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}\\
57 \helpref{wxCONCAT}{wxconcat}\\
58 \helpref{wxConcatFiles}{wxconcatfiles}\\
59 \helpref{wxConstCast}{wxconstcast}\\
60 \helpref{wxCopyFile}{wxcopyfile}\\
61 \helpref{wxCreateDynamicObject}{wxcreatedynamicobject}\\
62 \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}\\
63 \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}\\
64 \helpref{wxCRIT\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember}\\
65 \helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}\\
66 \helpref{wxCRITICAL\_SECTION}{wxcriticalsectionmacro}\\ % wxcs already taken!
67 \helpref{wxDDECleanUp}{wxddecleanup}\\
68 \helpref{wxDDEInitialize}{wxddeinitialize}\\
69 \helpref{wxDROP\_ICON}{wxdropicon}\\
70 \helpref{wxDebugMsg}{wxdebugmsg}\\
71 \helpref{WXDEBUG\_NEW}{debugnew}\\
72 \helpref{wxDirExists}{functionwxdirexists}\\
73 \helpref{wxDirSelector}{wxdirselector}\\
74 \helpref{wxDisplayDepth}{wxdisplaydepth}\\
75 \helpref{wxDisplaySize}{wxdisplaysize}\\
76 \helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
77 \helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
78 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
79 \helpref{wxDynamicCast}{wxdynamiccast}\\
80 \helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction}\\
81 \helpref{wxEmptyClipboard}{wxemptyclipboard}\\
82 \helpref{wxEnableTopLevelWindows}{wxenabletoplevelwindows}\\
83 \helpref{wxEndBusyCursor}{wxendbusycursor}\\
84 \helpref{wxENTER\_CRIT\_SECT}{wxentercritsect}\\
85 \helpref{wxEntry}{wxentry}\\
86 \helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\
87 \helpref{wxError}{wxerror}\\
88 \helpref{wxExecute}{wxexecute}\\
89 \helpref{wxExit}{wxexit}\\
90 \helpref{wxEXPLICIT}{wxexplicit}\\
91 \helpref{wxFAIL\_MSG}{wxfailmsg}\\
92 \helpref{wxFAIL}{wxfail}\\
93 \helpref{wxFatalError}{wxfatalerror}\\
94 \helpref{wxFileExists}{functionwxfileexists}\\
95 \helpref{wxFileModificationTime}{wxfilemodificationtime}\\
96 \helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
97 \helpref{wxFileSelector}{wxfileselector}\\
98 \helpref{wxFindFirstFile}{wxfindfirstfile}\\
99 \helpref{wxFindMenuItemId}{wxfindmenuitemid}\\
100 \helpref{wxFindNextFile}{wxfindnextfile}\\
101 \helpref{wxFindWindowAtPointer}{wxfindwindowatpointer}\\
102 \helpref{wxFindWindowAtPoint}{wxfindwindowatpoint}\\
103 \helpref{wxFindWindowByLabel}{wxfindwindowbylabel}\\
104 \helpref{wxFindWindowByName}{wxfindwindowbyname}\\
105 \helpref{wxFinite}{wxfinite}\\
106 \helpref{wxGetActiveWindow}{wxgetactivewindow}\\
107 \helpref{wxGetApp}{wxgetapp}\\
108 \helpref{wxGetBatteryState}{wxgetbatterystate}\\
109 \helpref{wxGetClipboardData}{wxgetclipboarddata}\\
110 \helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
111 \helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
112 \helpref{wxGetCwd}{wxgetcwd}\\
113 \helpref{wxGetDiskSpace}{wxgetdiskspace}\\
114 \helpref{wxGetDisplayName}{wxgetdisplayname}\\
115 \helpref{wxGetDisplaySize}{wxdisplaysize}\\
116 \helpref{wxGetDisplaySizeMM}{wxdisplaysizemm}\\
117 \helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
118 \helpref{wxGetEmailAddress}{wxgetemailaddress}\\
119 \helpref{wxGetEnv}{wxgetenv}\\
120 \helpref{wxGetFileKind}{wxgetfilekind}\\
121 \helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
122 \helpref{wxGetFreeMemory}{wxgetfreememory}\\
123 \helpref{wxGetFullHostName}{wxgetfullhostname}\\
124 \helpref{wxGetHomeDir}{wxgethomedir}\\
125 \helpref{wxGetHostName}{wxgethostname}\\
126 \helpref{wxGetKeyState}{wxgetkeystate}\\
127 \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
128 \helpref{wxGetLocalTime}{wxgetlocaltime}\\
129 \helpref{wxGetMousePosition}{wxgetmouseposition}\\
130 \helpref{wxGetMouseState}{wxgetmousestate}\\
131 \helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\
132 \helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\
133 \helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\
134 \helpref{wxGetOSDirectory}{wxgetosdirectory}\\
135 \helpref{wxGetOsDescription}{wxgetosdescription}\\
136 \helpref{wxGetOsVersion}{wxgetosversion}\\
137 \helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\
138 \helpref{wxGetPowerType}{wxgetpowertype}\\
139 \helpref{wxGetPrinterCommand}{wxgetprintercommand}\\
140 \helpref{wxGetPrinterFile}{wxgetprinterfile}\\
141 \helpref{wxGetPrinterMode}{wxgetprintermode}\\
142 \helpref{wxGetPrinterOptions}{wxgetprinteroptions}\\
143 \helpref{wxGetPrinterOrientation}{wxgetprinterorientation}\\
144 \helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
145 \helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
146 \helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
147 \helpref{wxGetProcessId}{wxgetprocessid}\\
148 \helpref{wxGetResource}{wxgetresource}\\
149 \helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
150 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
151 \helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
152 \helpref{wxGetTempFileName}{wxgettempfilename}\\
153 \helpref{wxGetTextFromUser}{wxgettextfromuser}\\
154 \helpref{wxGetTopLevelParent}{wxgettoplevelparent}\\
155 \helpref{wxGetTranslation}{wxgettranslation}\\
156 \helpref{wxGetUTCTime}{wxgetutctime}\\
157 \helpref{wxGetUserHome}{wxgetuserhome}\\
158 \helpref{wxGetUserId}{wxgetuserid}\\
159 \helpref{wxGetUserName}{wxgetusername}\\
160 \helpref{wxGetWorkingDirectory}{wxgetworkingdirectory}\\
161 \helpref{wxGetenv}{wxgetenvmacro}\\
162 \helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}\\
163 \helpref{wxICON}{wxiconmacro}\\
164 \helpref{wxINTXX\_SWAP\_ALWAYS}{intswapalways}\\
165 \helpref{wxINTXX\_SWAP\_ON\_BE}{intswaponbe}\\
166 \helpref{wxINTXX\_SWAP\_ON\_LE}{intswaponle}\\
167 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}\\
168 \helpref{wxInitialize}{wxinitialize}\\
169 \helpref{wxIsAbsolutePath}{wxisabsolutepath}\\
170 \helpref{wxIsBusy}{wxisbusy}\\
171 \helpref{wxIsClipboardFormatAvailable}{wxisclipboardformatavailable}\\
172 \helpref{wxIsDebuggerRunning}{wxisdebuggerrunning}\\
173 \helpref{wxIsEmpty}{wxisempty}\\
174 \helpref{wxIsMainThread}{wxismainthread}\\
175 \helpref{wxIsNaN}{wxisnan}\\
176 \helpref{wxIsWild}{wxiswild}\\
177 \helpref{wxKill}{wxkill}\\
178 \helpref{wxLaunchDefaultBrowser}{wxlaunchdefaultbrowser}\\
179 \helpref{wxLEAVE\_CRIT\_SECT}{wxleavecritsect}\\
180 \helpref{wxLoadUserResource}{wxloaduserresource}\\
181 \helpref{wxLogDebug}{wxlogdebug}\\
182 \helpref{wxLogError}{wxlogerror}\\
183 \helpref{wxLogFatalError}{wxlogfatalerror}\\
184 \helpref{wxLogMessage}{wxlogmessage}\\
185 \helpref{wxLogStatus}{wxlogstatus}\\
186 \helpref{wxLogSysError}{wxlogsyserror}\\
187 \helpref{wxLogTrace}{wxlogtrace}\\
188 \helpref{wxLogVerbose}{wxlogverbose}\\
189 \helpref{wxLogWarning}{wxlogwarning}\\
190 \helpref{wxLL}{wxll}\\
191 \helpref{wxLongLongFmtSpec}{wxlonglongfmtspec}\\
192 \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
193 \helpref{wxMatchWild}{wxmatchwild}\\
194 \helpref{wxMessageBox}{wxmessagebox}\\
195 \helpref{wxMilliSleep}{wxmillisleep}\\
196 \helpref{wxMicroSleep}{wxmicrosleep}\\
197 \helpref{wxMkdir}{wxmkdir}\\
198 \helpref{wxMutexGuiEnter}{wxmutexguienter}\\
199 \helpref{wxMutexGuiLeave}{wxmutexguileave}\\
200 \helpref{wxNewId}{wxnewid}\\
201 \helpref{wxNow}{wxnow}\\
202 \helpref{wxOnAssert}{wxonassert}\\
203 \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}\\
204 \helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}\\
205 \helpref{wxOpenClipboard}{wxopenclipboard}\\
206 \helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\
207 \helpref{wxPathOnly}{wxpathonly}\\
208 \helpref{wxPLURAL}{wxplural}\\
209 \helpref{wxPostDelete}{wxpostdelete}\\
210 \helpref{wxPostEvent}{wxpostevent}\\
211 \helpref{wxRegisterClipboardFormat}{wxregisterclipboardformat}\\
212 \helpref{wxRegisterId}{wxregisterid}\\
213 \helpref{wxRemoveFile}{wxremovefile}\\
214 \helpref{wxRenameFile}{wxrenamefile}\\
215 \helpref{wxRmdir}{wxrmdir}\\
216 \helpref{wxSafeShowMessage}{wxsafeshowmessage}\\
217 \helpref{wxSafeYield}{wxsafeyield}\\
218 \helpref{wxSetClipboardData}{wxsetclipboarddata}\\
219 \helpref{wxSetCursor}{wxsetcursor}\\
220 \helpref{wxSetDisplayName}{wxsetdisplayname}\\
221 \helpref{wxSetEnv}{wxsetenv}\\
222 \helpref{wxSetPrinterCommand}{wxsetprintercommand}\\
223 \helpref{wxSetPrinterFile}{wxsetprinterfile}\\
224 \helpref{wxSetPrinterMode}{wxsetprintermode}\\
225 \helpref{wxSetPrinterOptions}{wxsetprinteroptions}\\
226 \helpref{wxSetPrinterOrientation}{wxsetprinterorientation}\\
227 \helpref{wxSetPrinterPreviewCommand}{wxsetprinterpreviewcommand}\\
228 \helpref{wxSetPrinterScaling}{wxsetprinterscaling}\\
229 \helpref{wxSetPrinterTranslation}{wxsetprintertranslation}\\
230 \helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
231 \helpref{wxShell}{wxshell}\\
232 \helpref{wxShowTip}{wxshowtip}\\
233 \helpref{wxShutdown}{wxshutdown}\\
234 \helpref{wxSleep}{wxsleep}\\
235 \helpref{wxSnprintf}{wxsnprintf}\\
236 \helpref{wxSplitPath}{wxsplitfunction}\\
237 \helpref{wxStartTimer}{wxstarttimer}\\
238 \helpref{wxStaticCast}{wxstaticcast}\\
239 \helpref{wxStrcmp}{wxstrcmp}\\
240 \helpref{wxStricmp}{wxstricmp}\\
241 \helpref{wxStringEq}{wxstringeq}\\
242 \helpref{wxStringMatch}{wxstringmatch}\\
243 \helpref{wxStringTokenize}{wxstringtokenize}\\
244 \helpref{wxStripMenuCodes}{wxstripmenucodes}\\
245 \helpref{wxStrlen}{wxstrlen}\\
246 \helpref{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning}\\
247 \helpref{wxSysErrorCode}{wxsyserrorcode}\\
248 \helpref{wxSysErrorMsg}{wxsyserrormsg}\\
249 \helpref{wxT}{wxt}\\
250 \helpref{wxTrace}{wxtrace}\\
251 \helpref{WXTRACE}{trace}\\
252 \helpref{wxTraceLevel}{wxtracelevel}\\
253 \helpref{WXTRACELEVEL}{tracelevel}\\
254 \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
255 \helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
256 \helpref{wxTrap}{wxtrap}\\
257 \helpref{wxULL}{wxull}\\
258 \helpref{wxUninitialize}{wxuninitialize}\\
259 \helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
260 \helpref{wxUnsetEnv}{wxunsetenv}\\
261 \helpref{wxUsleep}{wxusleep}\\
262 \helpref{wxVaCopy}{wxvacopy}\\
263 \helpref{wxVsnprintf}{wxvsnprintf}\\
264 \helpref{wxWakeUpIdle}{wxwakeupidle}\\
265 \helpref{wxWriteResource}{wxwriteresource}\\
266 \helpref{wxYield}{wxyield}\\
267 \helpref{wx\_const\_cast}{wxconstcastraw}\\
268 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}\\
269 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
270 \helpref{wx\_truncate\_cast}{wxtruncatecast}\\
271 \helpref{\_}{underscore}\\
272 \helpref{\_T}{underscoret}
273 \helpref{\_\_WXFUNCTION\_\_}{wxfunction}
274
275
276
277 \section{Version macros}\label{versionfunctions}
278
279 The following constants are defined in wxWidgets:
280
281 \begin{itemize}\itemsep=0pt
282 \item {\tt wxMAJOR\_VERSION} is the major version of wxWidgets
283 \item {\tt wxMINOR\_VERSION} is the minor version of wxWidgets
284 \item {\tt wxRELEASE\_NUMBER} is the release number
285 \item {\tt wxSUBRELEASE\_NUMBER} is the subrelease number which is $0$ for all
286 official releases
287 \end{itemize}
288
289 For example, the values or these constants for wxWidgets 2.1.15 are 2, 1 and
290 15.
291
292 Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing
293 the full wxWidgets version and {\tt wxVERSION\_NUMBER} is a combination of the
294 three version numbers above: for 2.1.15, it is 2115 and it is 2200 for
295 wxWidgets 2.2.
296
297 The subrelease number is only used for the sources in between official releases
298 and so normally is not useful.
299
300 \wxheading{Include files}
301
302 <wx/version.h> or <wx/defs.h>
303
304
305 \membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion}
306
307 \func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
308
309 Returns $1$ if the compiler being used to compile the code is GNU C++
310 compiler (g++) version major.minor.release or greater. Otherwise, and also if
311 the compiler is not GNU C++ at all, returns $0$.
312
313
314 \membersection{wxCHECK\_VERSION}\label{wxcheckversion}
315
316 \func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}}
317
318 This is a macro which evaluates to true if the current wxWidgets version is at
319 least major.minor.release.
320
321 For example, to test if the program is compiled with wxWidgets 2.2 or higher,
322 the following can be done:
323
324 \begin{verbatim}
325 wxString s;
326 #if wxCHECK_VERSION(2, 2, 0)
327 if ( s.StartsWith("foo") )
328 #else // replacement code for old version
329 if ( strncmp(s, "foo", 3) == 0 )
330 #endif
331 {
332 ...
333 }
334 \end{verbatim}
335
336
337 \membersection{wxCHECK\_VERSION\_FULL}\label{wxcheckversionfull}
338
339 \func{bool}{wxCHECK\_VERSION\_FULL}{\param{}{major, minor, release, subrel}}
340
341 Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that
342 \texttt{wxSUBRELEASE\_NUMBER} is at least \arg{subrel}.
343
344
345 \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion}
346
347 \func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
348
349 Returns $1$ if the version of w32api headers used is major.minor.release or
350 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
351 Win32 at all, returns $0$.
352
353
354
355 \section{Application initialization and termination}\label{appinifunctions}
356
357 The functions in this section are used on application startup/shutdown and also
358 to control the behaviour of the main event loop of the GUI programs.
359
360
361 \membersection{::wxEntry}\label{wxentry}
362
363 This initializes wxWidgets in a platform-dependent way. Use this if you
364 are not using the default wxWidgets entry code (e.g. main or WinMain). For example,
365 you can initialize wxWidgets from an Microsoft Foundation Classes application using
366 this function.
367
368 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
369 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}}
370
371 wxWidgets initialization under Windows (non-DLL). If {\it enterLoop} is false, the
372 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets
373 message loop will be entered.
374
375 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
376 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
377
378 wxWidgets initialization under Windows (for applications constructed as a DLL).
379
380 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
381
382 wxWidgets initialization under Unix.
383
384 \wxheading{Remarks}
385
386 To clean up wxWidgets, call wxApp::OnExit followed by the static function
387 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
388
389 \begin{verbatim}
390 int CTheApp::ExitInstance()
391 {
392 // OnExit isn't called by CleanUp so must be called explicitly.
393 wxTheApp->OnExit();
394 wxApp::CleanUp();
395
396 return CWinApp::ExitInstance();
397 }
398 \end{verbatim}
399
400 \wxheading{Include files}
401
402 <wx/app.h>
403
404
405
406 \membersection{::wxGetApp}\label{wxgetapp}
407
408 \func{wxAppDerivedClass\&}{wxGetApp}{\void}
409
410 This function doesn't exist in wxWidgets but it is created by using
411 the \helpref{IMPLEMENT\_APP}{implementapp} macro. Thus, before using it
412 anywhere but in the same module where this macro is used, you must make it
413 available using \helpref{DECLARE\_APP}{declareapp}.
414
415 The advantage of using this function compared to directly using the global
416 wxTheApp pointer is that the latter is of type {\tt wxApp *} and so wouldn't
417 allow you to access the functions specific to your application class but not
418 present in wxApp while wxGetApp() returns the object of the right type.
419
420
421 \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
422
423 \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}}
424
425 If {\it doIt} is true, the fatal exceptions (also known as general protection
426 faults under Windows or segmentation violations in the Unix world) will be
427 caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
428 By default, i.e. before this function is called, they will be handled in the
429 normal way which usually just means that the application will be terminated.
430 Calling wxHandleFatalExceptions() with {\it doIt} equal to false will restore
431 this default behaviour.
432
433
434 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
435
436 \func{void}{wxInitAllImageHandlers}{\void}
437
438 Initializes all available image handlers. For a list of available handlers,
439 see \helpref{wxImage}{wximage}.
440
441 \wxheading{See also}
442
443 \helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
444
445 \wxheading{Include files}
446
447 <wx/image.h>
448
449
450 \membersection{::wxInitialize}\label{wxinitialize}
451
452 \func{bool}{wxInitialize}{\void}
453
454 This function is used in wxBase only and only if you don't create
455 \helpref{wxApp}{wxapp} object at all. In this case you must call it from your
456 {\tt main()} function before calling any other wxWidgets functions.
457
458 If the function returns \false the initialization could not be performed,
459 in this case the library cannot be used and
460 \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither.
461
462 This function may be called several times but
463 \helpref{wxUninitialize}{wxuninitialize} must be called for each successful
464 call to this function.
465
466 \wxheading{Include files}
467
468 <wx/app.h>
469
470
471 \membersection{::wxSafeYield}\label{wxsafeyield}
472
473 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
474 onlyIfNeeded = false}}
475
476 This function is similar to wxYield, except that it disables the user input to
477 all program windows before calling wxYield and re-enables it again
478 afterwards. If {\it win} is not NULL, this window will remain enabled,
479 allowing the implementation of some limited user interaction.
480
481 Returns the result of the call to \helpref{::wxYield}{wxyield}.
482
483 \wxheading{Include files}
484
485 <wx/utils.h>
486
487
488 \membersection{::wxUninitialize}\label{wxuninitialize}
489
490 \func{void}{wxUninitialize}{\void}
491
492 This function is for use in console (wxBase) programs only. It must be called
493 once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
494
495 \wxheading{Include files}
496
497 <wx/app.h>
498
499
500 \membersection{::wxYield}\label{wxyield}
501
502 \func{bool}{wxYield}{\void}
503
504 Calls \helpref{wxApp::Yield}{wxappyield}.
505
506 This function is kept only for backwards compatibility. Please use
507 the \helpref{wxApp::Yield}{wxappyield} method instead in any new code.
508
509 \wxheading{Include files}
510
511 <wx/app.h> or <wx/utils.h>
512
513
514 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
515
516 \func{void}{wxWakeUpIdle}{\void}
517
518 This functions wakes up the (internal and platform dependent) idle system, i.e. it
519 will force the system to send an idle event even if the system currently {\it is}
520 idle and thus would not send any idle event until after some other event would get
521 sent. This is also useful for sending events between two threads and is used by
522 the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
523 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
524
525 \wxheading{Include files}
526
527 <wx/event.h>
528
529
530
531 \section{Process control functions}\label{processfunctions}
532
533 The functions in this section are used to launch or terminate the other
534 processes.
535
536
537 \membersection{::wxExecute}\label{wxexecute}
538
539 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{int }{sync = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
540
541 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteCommand}}
542
543 \func{long}{wxExecute}{\param{char **}{argv}, \param{int }{flags = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
544
545 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteArgs}}
546
547 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{int }{flags = 0}}
548
549 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdout} and it
550 only takes the {\tt command} argument,
551 and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
552 an array reference.}
553
554 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}, \param{int }{flags = 0}}
555
556 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr}
557 and it only takes the {\tt command} argument,
558 and returns a 3-element list {\tt ( status, output, errors )}, where
559 {\tt output} and {\tt errors} are array references.}
560
561 Executes another program in Unix or Windows.
562
563 The first form takes a command string, such as {\tt "emacs file.txt"}.
564
565 The second form takes an array of values: a command, any number of
566 arguments, terminated by NULL.
567
568 The semantics of the third and fourth versions is different from the first two
569 and is described in more details below.
570
571 If {\it flags} parameter contains {\tt wxEXEC\_ASYNC} flag (the default), flow
572 of control immediately returns. If it contains {\tt wxEXEC\_SYNC}, the current
573 application waits until the other program has terminated.
574
575 In the case of synchronous execution, the return value is the exit code of
576 the process (which terminates by the moment the function returns) and will be
577 $-1$ if the process couldn't be started and typically 0 if the process
578 terminated successfully. Also, while waiting for the process to
579 terminate, wxExecute will call \helpref{wxYield}{wxyield}. Because of this, by
580 default this function disables all application windows to avoid unexpected
581 reentrancies which could result from the users interaction with the program
582 while the child process is running. If you are sure that it is safe to not
583 disable the program windows, you may pass \texttt{wxEXEC\_NODISABLE} flag to
584 prevent this automatic disabling from happening.
585
586 For asynchronous execution, however, the return value is the process id and
587 zero value indicates that the command could not be executed. As an added
588 complication, the return value of $-1$ in this case indicates that we didn't
589 launch a new process, but connected to the running one (this can only happen in
590 case of using DDE under Windows for command execution). In particular, in this,
591 and only this, case the calling code will not get the notification about
592 process termination.
593
594 If callback isn't NULL and if execution is asynchronous,
595 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
596 the process finishes. Specifying this parameter also allows you to redirect the
597 standard input and/or output of the process being launched by calling
598 \helpref{Redirect}{wxprocessredirect}. If the child process IO is redirected,
599 under Windows the process window is not shown by default (this avoids having to
600 flush an unnecessary console for the processes which don't create any windows
601 anyhow) but a {\tt wxEXEC\_NOHIDE} flag can be used to prevent this from
602 happening, i.e. with this flag the child process window will be shown normally.
603
604 Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
605 that the new process is a group leader (this will create a new session if
606 needed). Calling \helpref{wxKill}{wxkill} passing wxKILL\_CHILDREN will
607 kill this process as well as all of its children (except those which have
608 started their own session).
609
610 Finally, you may use the third overloaded version of this function to execute
611 a process (always synchronously, the contents of \arg{flags} is or'd with
612 \texttt{wxEXEC\_SYNC}) and capture its output in the array \arg{output}. The
613 fourth version adds the possibility to additionally capture the messages from
614 standard error output in the \arg{errors} array.
615
616 {\bf NB:} Currently wxExecute() can only be used from the main thread, calling
617 this function from another thread will result in an assert failure in debug
618 build and won't work.
619
620 \wxheading{See also}
621
622 \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}, \helpref{Exec sample}{sampleexec}.
623
624 \wxheading{Parameters}
625
626 \docparam{command}{The command to execute and any parameters to pass to it as a
627 single string.}
628
629 \docparam{argv}{The command to execute should be the first element of this
630 array, any additional ones are the command parameters and the array must be
631 terminated with a NULL pointer.}
632
633 \docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},\rtfsp
634 {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
635
636 \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
637
638 \wxheading{Include files}
639
640 <wx/utils.h>
641
642
643 \membersection{::wxExit}\label{wxexit}
644
645 \func{void}{wxExit}{\void}
646
647 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
648 Should only be used in an emergency: normally the top-level frame
649 should be deleted (after deleting all other frames) to terminate the
650 application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}.
651
652 \wxheading{Include files}
653
654 <wx/app.h>
655
656
657 \membersection{::wxKill}\label{wxkill}
658
659 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}, \param{int }{flags = 0}}
660
661 Equivalent to the Unix kill function: send the given signal {\it sig} to the
662 process with PID {\it pid}. The valid signal values are
663
664 \begin{verbatim}
665 enum wxSignal
666 {
667 wxSIGNONE = 0, // verify if the process exists under Unix
668 wxSIGHUP,
669 wxSIGINT,
670 wxSIGQUIT,
671 wxSIGILL,
672 wxSIGTRAP,
673 wxSIGABRT,
674 wxSIGEMT,
675 wxSIGFPE,
676 wxSIGKILL, // forcefully kill, dangerous!
677 wxSIGBUS,
678 wxSIGSEGV,
679 wxSIGSYS,
680 wxSIGPIPE,
681 wxSIGALRM,
682 wxSIGTERM // terminate the process gently
683 };
684 \end{verbatim}
685
686 {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning
687 under both Unix and Windows but all the other signals are equivalent to
688 {\tt wxSIGTERM} under Windows.
689
690 Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will
691 be filled with an element of {\tt wxKillError} enum:
692
693 \begin{verbatim}
694 enum wxKillError
695 {
696 wxKILL_OK, // no error
697 wxKILL_BAD_SIGNAL, // no such signal
698 wxKILL_ACCESS_DENIED, // permission denied
699 wxKILL_NO_PROCESS, // no such process
700 wxKILL_ERROR // another, unspecified error
701 };
702 \end{verbatim}
703
704 The {\it flags} parameter can be wxKILL\_NOCHILDREN (the default),
705 or wxKILL\_CHILDREN, in which case the child processes of this
706 process will be killed too. Note that under Unix, for wxKILL\_CHILDREN
707 to work you should have created the process by passing wxEXEC\_MAKE\_GROUP\_LEADER
708 to wxExecute.
709
710 \wxheading{See also}
711
712 \helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
713 \helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
714 \helpref{Exec sample}{sampleexec}
715
716 \wxheading{Include files}
717
718 <wx/utils.h>
719
720
721 \membersection{::wxGetProcessId}\label{wxgetprocessid}
722
723 \func{unsigned long}{wxGetProcessId}{\void}
724
725 Returns the number uniquely identifying the current process in the system.
726
727 If an error occurs, $0$ is returned.
728
729 \wxheading{Include files}
730
731 <wx/utils.h>
732
733
734 \membersection{::wxShell}\label{wxshell}
735
736 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
737
738 Executes a command in an interactive shell window. If no command is
739 specified, then just the shell is spawned.
740
741 See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
742
743 \wxheading{Include files}
744
745 <wx/utils.h>
746
747
748 \membersection{::wxShutdown}\label{wxshutdown}
749
750 \func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
751
752 This function shuts down or reboots the computer depending on the value of the
753 {\it flags}. Please notice that doing this requires the corresponding access
754 rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
755 and that this function is only implemented under Unix and Win32.
756
757 \wxheading{Parameters}
758
759 \docparam{flags}{Either {\tt wxSHUTDOWN\_POWEROFF} or {\tt wxSHUTDOWN\_REBOOT}}
760
761 \wxheading{Returns}
762
763 \true on success, \false if an error occurred.
764
765 \wxheading{Include files}
766
767 <wx/utils.h>
768
769
770
771 \section{Thread functions}\label{threadfunctions}
772
773 The functions and macros here mainly exist to make it writing the code which
774 may be compiled in multi thread build ({\tt wxUSE\_THREADS} $= 1$) as well as
775 in single thread configuration ({\tt wxUSE\_THREADS} $= 0$).
776
777 For example, a static variable must be protected against simultaneous access by
778 multiple threads in the former configuration but in the latter the extra
779 overhead of using the critical section is not needed. To solve this problem,
780 the \helpref{wxCRITICAL\_SECTION}{wxcriticalsectionmacro} macro may be used
781 to create and use the critical section only when needed.
782
783 \wxheading{Include files}
784
785 <wx/thread.h>
786
787 \wxheading{See also}
788
789 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
790
791
792
793 \membersection{wxCRIT\_SECT\_DECLARE}\label{wxcritsectdeclare}
794
795 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
796
797 This macro declares a (static) critical section object named {\it cs} if
798 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
799
800
801
802 \membersection{wxCRIT\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember}
803
804 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
805
806 This macro declares a critical section object named {\it cs} if
807 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. As it doesn't
808 include the {\tt static} keyword (unlike
809 \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}), it can be used to declare
810 a class or struct member which explains its name.
811
812
813
814 \membersection{wxCRIT\_SECT\_LOCKER}\label{wxcritsectlocker}
815
816 \func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}}
817
818 This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker}
819 object named {\it name} and associated with the critical section {\it cs} if
820 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
821
822
823
824 \membersection{wxCRITICAL\_SECTION}\label{wxcriticalsectionmacro}
825
826 \func{}{wxCRITICAL\_SECTION}{\param{}{name}}
827
828 This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and
829 \helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}: it creates a static critical
830 section object and also the lock object associated with it. Because of this, it
831 can be only used inside a function, not at global scope. For example:
832
833 \begin{verbatim}
834 int IncCount()
835 {
836 static int s_counter = 0;
837
838 wxCRITICAL_SECTION(counter);
839
840 return ++s_counter;
841 }
842 \end{verbatim}
843
844 (note that we suppose that the function is called the first time from the main
845 thread so that the critical section object is initialized correctly by the time
846 other threads start calling it, if this is not the case this approach can
847 {\bf not} be used and the critical section must be made a global instead).
848
849
850
851 \membersection{wxENTER\_CRIT\_SECT}\label{wxentercritsect}
852
853 \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
854
855 This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if
856 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
857
858
859
860 \membersection{::wxIsMainThread}\label{wxismainthread}
861
862 \func{bool}{wxIsMainThread}{\void}
863
864 Returns \true if this thread is the main one. Always returns \true if
865 {\tt wxUSE\_THREADS} is $0$.
866
867
868
869 \membersection{wxLEAVE\_CRIT\_SECT}\label{wxleavecritsect}
870
871 \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
872
873 This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if
874 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
875
876
877
878 \membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
879
880 \func{void}{wxMutexGuiEnter}{\void}
881
882 This function must be called when any thread other than the main GUI thread
883 wants to get access to the GUI library. This function will block the execution
884 of the calling thread until the main thread (or any other thread holding the
885 main GUI lock) leaves the GUI library and no other thread will enter the GUI
886 library until the calling thread calls \helpref{::wxMutexGuiLeave()}{wxmutexguileave}.
887
888 Typically, these functions are used like this:
889
890 \begin{verbatim}
891 void MyThread::Foo(void)
892 {
893 // before doing any GUI calls we must ensure that this thread is the only
894 // one doing it!
895
896 wxMutexGuiEnter();
897
898 // Call GUI here:
899 my_window->DrawSomething();
900
901 wxMutexGuiLeave();
902 }
903 \end{verbatim}
904
905 Note that under GTK, no creation of top-level windows is allowed in any
906 thread but the main one.
907
908 This function is only defined on platforms which support preemptive
909 threads.
910
911
912 \membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
913
914 \func{void}{wxMutexGuiLeave}{\void}
915
916 See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
917
918 This function is only defined on platforms which support preemptive
919 threads.
920
921
922
923 \section{File functions}\label{filefunctions}
924
925 \wxheading{Include files}
926
927 <wx/filefn.h>
928
929 \wxheading{See also}
930
931 \helpref{wxPathList}{wxpathlist}\\
932 \helpref{wxDir}{wxdir}\\
933 \helpref{wxFile}{wxfile}\\
934 \helpref{wxFileName}{wxfilename}
935
936
937 \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
938
939 \func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
940
941 Converts a DOS to a Unix filename by replacing backslashes with forward
942 slashes.
943
944
945 \membersection{::wxFileExists}\label{functionwxfileexists}
946
947 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
948
949 Returns true if the file exists and is a plain file.
950
951
952 \membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
953
954 \func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
955
956 Returns time of last modification of given file.
957
958 The return value is $0$ if an error occured (e.g. file not found).
959
960
961 \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
962
963 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
964
965 \func{char *}{wxFileNameFromPath}{\param{char *}{path}}
966
967 {\bf NB:} This function is obsolete, please use
968 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
969
970 Returns the filename for a full path. The second form returns a pointer to
971 temporary storage that should not be deallocated.
972
973
974 \membersection{::wxFindFirstFile}\label{wxfindfirstfile}
975
976 \func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}
977
978 This function does directory searching; returns the first file
979 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
980 get the next matching file. Neither will report the current directory "." or the
981 parent directory "..".
982
983 \wxheading{Warning}
984
985 As of wx 2.5.2, these functions are not thread-safe! (they use static variables). You probably want to use \helpref{wxDir::GetFirst}{wxdirgetfirst} or \helpref{wxDirTraverser}{wxdirtraverser} instead.
986
987 {\it spec} may contain wildcards.
988
989 {\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
990
991 For example:
992
993 \begin{verbatim}
994 wxString f = wxFindFirstFile("/home/project/*.*");
995 while ( !f.empty() )
996 {
997 ...
998 f = wxFindNextFile();
999 }
1000 \end{verbatim}
1001
1002
1003 \membersection{::wxFindNextFile}\label{wxfindnextfile}
1004
1005 \func{wxString}{wxFindNextFile}{\void}
1006
1007 Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
1008
1009 See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
1010
1011
1012 \membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
1013
1014 \func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}
1015
1016 This function returns the total number of bytes and number of free bytes on
1017 the disk containing the directory {\it path} (it should exist). Both
1018 {\it total} and {\it free} parameters may be {\tt NULL} if the corresponding
1019 information is not needed.
1020
1021 \wxheading{Returns}
1022
1023 \true on success, \false if an error occurred (for example, the
1024 directory doesn't exist).
1025
1026 \wxheading{Portability}
1027
1028 This function is implemented for Win32,
1029 Mac OS and generic Unix provided the system has {\tt statfs()} function.
1030
1031 This function first appeared in wxWidgets 2.3.2.
1032
1033
1034 \membersection{::wxGetFileKind}\label{wxgetfilekind}
1035
1036 \func{wxFileKind}{wxGetFileKind}{\param{int }{fd}}
1037
1038 \func{wxFileKind}{wxGetFileKind}{\param{FILE *}{fp}}
1039
1040 Returns the type of an open file. Possible return values are:
1041
1042 \begin{verbatim}
1043 enum wxFileKind
1044 {
1045 wxFILE_KIND_UNKNOWN,
1046 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
1047 wxFILE_KIND_TERMINAL, // a tty
1048 wxFILE_KIND_PIPE // a pipe
1049 };
1050
1051 \end{verbatim}
1052
1053 \wxheading{Include files}
1054
1055 <wx/filefn.h>
1056
1057
1058 \membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
1059
1060 \func{wxString}{wxGetOSDirectory}{\void}
1061
1062 Returns the Windows directory under Windows; on other platforms returns the empty string.
1063
1064
1065 \membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}
1066
1067 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
1068
1069 Returns true if the argument is an absolute filename, i.e. with a slash
1070 or drive name at the beginning.
1071
1072
1073 \membersection{::wxDirExists}\label{functionwxdirexists}
1074
1075 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
1076
1077 Returns true if the path exists.
1078
1079
1080 \membersection{::wxPathOnly}\label{wxpathonly}
1081
1082 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
1083
1084 Returns the directory part of the filename.
1085
1086
1087 \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
1088
1089 \func{void}{wxUnix2DosFilename}{\param{wxChar *}{s}}
1090
1091 This function is deprecated, use \helpref{wxFileName}{wxfilename} instead.
1092
1093 Converts a Unix to a DOS filename by replacing forward
1094 slashes with backslashes.
1095
1096
1097 \membersection{wxCHANGE\_UMASK}\label{wxchangeumask}
1098
1099 \func{}{wxCHANGE\_UMASK}{\param{int }{mask}}
1100
1101 Under Unix this macro changes the current process umask to the given value,
1102 unless it is equal to $-1$ in which case nothing is done, and restores it to
1103 the original value on scope exit. It works by declaring a variable which sets
1104 umask to \arg{mask} in its constructor and restores it in its destructor.
1105
1106 Under other platforms this macro expands to nothing.
1107
1108
1109 \membersection{::wxConcatFiles}\label{wxconcatfiles}
1110
1111 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
1112 \param{const wxString\& }{file3}}
1113
1114 Concatenates {\it file1} and {\it file2} to {\it file3}, returning
1115 true if successful.
1116
1117
1118 \membersection{::wxCopyFile}\label{wxcopyfile}
1119
1120 \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
1121
1122 Copies {\it file1} to {\it file2}, returning true if successful. If
1123 {\it overwrite} parameter is true (default), the destination file is overwritten
1124 if it exists, but if {\it overwrite} is false, the functions fails in this
1125 case.
1126
1127
1128 \membersection{::wxGetCwd}\label{wxgetcwd}
1129
1130 \func{wxString}{wxGetCwd}{\void}
1131
1132 Returns a string containing the current (or working) directory.
1133
1134
1135 \membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
1136
1137 \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
1138
1139 {\bf NB:} This function is deprecated: use \helpref{wxGetCwd}{wxgetcwd} instead.
1140
1141 Copies the current working directory into the buffer if supplied, or
1142 copies the working directory into new storage (which you {\emph must} delete
1143 yourself) if the buffer is NULL.
1144
1145 {\it sz} is the size of the buffer if supplied.
1146
1147
1148 \membersection{::wxGetTempFileName}\label{wxgettempfilename}
1149
1150 \func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}
1151
1152 \func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
1153
1154 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1155 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1156 %% is allocated for the temporary filename using {\it new}.
1157 %%
1158 %% Under Windows, the filename will include the drive and name of the
1159 %% directory allocated for temporary files (usually the contents of the
1160 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1161 %%
1162 %% It is the application's responsibility to create and delete the file.
1163
1164 {\bf NB:} These functions are obsolete, please use\rtfsp
1165 \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
1166 instead.
1167
1168
1169 \membersection{::wxIsWild}\label{wxiswild}
1170
1171 \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
1172
1173 Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
1174
1175
1176 \membersection{::wxMatchWild}\label{wxmatchwild}
1177
1178 \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
1179
1180 Returns true if the \arg{pattern}\/ matches the {\it text}\/; if {\it
1181 dot\_special}\/ is true, filenames beginning with a dot are not matched
1182 with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
1183
1184
1185 \membersection{::wxMkdir}\label{wxmkdir}
1186
1187 \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
1188
1189 Makes the directory \arg{dir}, returning true if successful.
1190
1191 {\it perm} is the access mask for the directory for the systems on which it is
1192 supported (Unix) and doesn't have effect for the other ones.
1193
1194
1195 \membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter}
1196
1197 \func{int}{wxParseCommonDialogsFilter}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}}
1198
1199 Parses the \arg{wildCard}, returning the number of filters.
1200 Returns 0 if none or if there's a problem.
1201 The arrays will contain an equal number of items found before the error.
1202 On platforms where native dialogs handle only one filter per entry,
1203 entries in arrays are automatically adjusted.
1204 \arg{wildCard} is in the form:
1205 \begin{verbatim}
1206 "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1207 \end{verbatim}
1208
1209 \membersection{::wxRemoveFile}\label{wxremovefile}
1210
1211 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1212
1213 Removes \arg{file}, returning true if successful.
1214
1215
1216 \membersection{::wxRenameFile}\label{wxrenamefile}
1217
1218 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
1219
1220 Renames \arg{file1} to \arg{file2}, returning true if successful.
1221
1222 If \arg{overwrite} parameter is true (default), the destination file is
1223 overwritten if it exists, but if \arg{overwrite} is false, the functions fails
1224 in this case.
1225
1226
1227 \membersection{::wxRmdir}\label{wxrmdir}
1228
1229 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1230
1231 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1232
1233 The {\it flags} parameter is reserved for future use.
1234
1235
1236 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1237
1238 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1239
1240 Sets the current working directory, returning true if the operation succeeded.
1241 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1242
1243
1244 \membersection{::wxSplitPath}\label{wxsplitfunction}
1245
1246 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1247
1248 {\bf NB:} This function is obsolete, please use
1249 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1250
1251 This function splits a full file name into components: the path (including possible disk/drive
1252 specification under Windows), the base name and the extension. Any of the output parameters
1253 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1254 a particular component.
1255
1256 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1257 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1258 is a valid character in a filename).
1259
1260 On entry, {\it fullname} should be non-NULL (it may be empty though).
1261
1262 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1263 contains the file name and {\it ext} contains the file extension without leading dot. All
1264 three of them may be empty if the corresponding component is. The old contents of the
1265 strings pointed to by these parameters will be overwritten in any case (if the pointers
1266 are not NULL).
1267
1268
1269 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1270
1271 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1272
1273 Copies the given file to {\it stream}. Useful when converting an old application to
1274 use streams (within the document/view framework, for example).
1275
1276 \wxheading{Include files}
1277
1278 <wx/docview.h>
1279
1280
1281 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1282
1283 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1284
1285 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1286 use streams (within the document/view framework, for example).
1287
1288 \wxheading{Include files}
1289
1290 <wx/docview.h>
1291
1292
1293
1294 \section{Network, user and OS functions}\label{networkfunctions}
1295
1296 The functions in this section are used to retrieve information about the
1297 current computer and/or user characteristics.
1298
1299
1300 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1301
1302 \func{wxString}{wxGetEmailAddress}{\void}
1303
1304 \func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
1305
1306 Copies the user's email address into the supplied buffer, by
1307 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1308 and \helpref{wxGetUserId}{wxgetuserid}.
1309
1310 Returns true if successful, false otherwise.
1311
1312 \wxheading{Include files}
1313
1314 <wx/utils.h>
1315
1316
1317 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1318
1319 \func{wxMemorySize}{wxGetFreeMemory}{\void}
1320
1321 Returns the amount of free memory in bytes under environments which
1322 support it, and -1 if not supported or failed to perform measurement.
1323
1324 \wxheading{Include files}
1325
1326 <wx/utils.h>
1327
1328
1329 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1330
1331 \func{wxString}{wxGetFullHostName}{\void}
1332
1333 Returns the FQDN (fully qualified domain host name) or an empty string on
1334 error.
1335
1336 \wxheading{See also}
1337
1338 \helpref{wxGetHostName}{wxgethostname}
1339
1340 \wxheading{Include files}
1341
1342 <wx/utils.h>
1343
1344
1345 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1346
1347 \func{wxString}{wxGetHomeDir}{\void}
1348
1349 Return the (current) user's home directory.
1350
1351 \wxheading{See also}
1352
1353 \helpref{wxGetUserHome}{wxgetuserhome}\\
1354 \helpref{wxStandardPaths}{wxstandardpaths}
1355
1356 \wxheading{Include files}
1357
1358 <wx/utils.h>
1359
1360
1361 \membersection{::wxGetHostName}\label{wxgethostname}
1362
1363 \func{wxString}{wxGetHostName}{\void}
1364
1365 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1366
1367 Copies the current host machine's name into the supplied buffer. Please note
1368 that the returned name is {\it not} fully qualified, i.e. it does not include
1369 the domain name.
1370
1371 Under Windows or NT, this function first looks in the environment
1372 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1373 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1374
1375 The first variant of this function returns the hostname if successful or an
1376 empty string otherwise. The second (deprecated) function returns true
1377 if successful, false otherwise.
1378
1379 \wxheading{See also}
1380
1381 \helpref{wxGetFullHostName}{wxgetfullhostname}
1382
1383 \wxheading{Include files}
1384
1385 <wx/utils.h>
1386
1387
1388 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1389
1390 \func{wxString}{wxGetOsDescription}{\void}
1391
1392 Returns the string containing the description of the current platform in a
1393 user-readable form. For example, this function may return strings like
1394 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1395
1396 \wxheading{See also}
1397
1398 \helpref{::wxGetOsVersion}{wxgetosversion}
1399
1400 \wxheading{Include files}
1401
1402 <wx/utils.h>
1403
1404
1405 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1406
1407 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1408
1409 Gets operating system version information.
1410
1411 \begin{twocollist}\itemsep=0pt
1412 \twocolitemruled{Platform}{Return types}
1413 \twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X.
1414
1415 Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. }
1416 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1417 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1418 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1419 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1420 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}.}
1421 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1422 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1423 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1424 \twocolitem{Windows PocketPC}{Return value is wxWINDOWS\_POCKETPC, version is returned in {\it major} and {\it minor}.}
1425 \twocolitem{Windows Smartphone}{Return value is wxWINDOWS\_SMARTPHONE, version is returned in {\it major} and {\it minor}.}
1426 \twocolitem{Windows CE (non-specific)}{Return value is wxWINDOWS\_CE, version is returned in {\it major} and {\it minor}.}
1427 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1428 \end{twocollist}
1429
1430 \wxheading{See also}
1431
1432 \helpref{::wxGetOsDescription}{wxgetosdescription}
1433
1434 \wxheading{Include files}
1435
1436 <wx/utils.h>
1437
1438
1439 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1440
1441 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1442
1443 Returns the home directory for the given user. If the username is empty
1444 (default value), this function behaves like
1445 \helpref{wxGetHomeDir}{wxgethomedir}.
1446
1447 \wxheading{Include files}
1448
1449 <wx/utils.h>
1450
1451
1452 \membersection{::wxGetUserId}\label{wxgetuserid}
1453
1454 \func{wxString}{wxGetUserId}{\void}
1455
1456 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
1457
1458 This function returns the "user id" also known as "login name" under Unix i.e.
1459 something like "jsmith". It uniquely identifies the current user (on this system).
1460
1461 Under Windows or NT, this function first looks in the environment
1462 variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
1463 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1464
1465 The first variant of this function returns the login name if successful or an
1466 empty string otherwise. The second (deprecated) function returns true
1467 if successful, false otherwise.
1468
1469 \wxheading{See also}
1470
1471 \helpref{wxGetUserName}{wxgetusername}
1472
1473 \wxheading{Include files}
1474
1475 <wx/utils.h>
1476
1477
1478 \membersection{::wxGetUserName}\label{wxgetusername}
1479
1480 \func{wxString}{wxGetUserName}{\void}
1481
1482 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
1483
1484 This function returns the full user name (something like "Mr. John Smith").
1485
1486 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
1487 in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows
1488 is running, the entry {\bf Current} in the section {\bf User} of
1489 the PENWIN.INI file is used.
1490
1491 The first variant of this function returns the user name if successful or an
1492 empty string otherwise. The second (deprecated) function returns \true
1493 if successful, \false otherwise.
1494
1495 \wxheading{See also}
1496
1497 \helpref{wxGetUserId}{wxgetuserid}
1498
1499 \wxheading{Include files}
1500
1501 <wx/utils.h>
1502
1503
1504
1505 \section{String functions}\label{stringfunctions}
1506
1507
1508 \membersection{::copystring}\label{copystring}
1509
1510 \func{char *}{copystring}{\param{const char *}{s}}
1511
1512 Makes a copy of the string {\it s} using the C++ new operator, so it can be
1513 deleted with the {\it delete} operator.
1514
1515 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
1516
1517
1518 \membersection{::wxGetTranslation}\label{wxgettranslation}
1519
1520 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
1521
1522 \func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}}
1523
1524 This function returns the translation of string {\it str} in the current
1525 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
1526 message catalogs (see \helpref{internationalization overview}{internationalization}), the
1527 original string is returned. In debug build, an error message is logged -- this
1528 should help to find the strings which were not yet translated. As this function
1529 is used very often, an alternative (and also common in Unix world) syntax is
1530 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
1531 as wxGetTranslation.
1532
1533 The second form is used when retrieving translation of string that has
1534 different singular and plural form in English or different plural forms in some
1535 other language. It takes two extra arguments: as above, \arg{str}
1536 parameter must contain the singular form of the string to be converted and
1537 is used as the key for the search in the catalog. The \arg{strPlural} parameter
1538 is the plural form (in English). The parameter \arg{n} is used to determine the
1539 plural form. If no message catalog is found \arg{str} is returned if `n == 1',
1540 otherwise \arg{strPlural}.
1541
1542 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150}
1543 for additional information on plural forms handling. For a shorter alternative
1544 see the \helpref{wxPLURAL()}{wxplural} macro.
1545
1546 Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}.
1547
1548 Note that this function is not suitable for literal strings in Unicode
1549 builds, since the literal strings must be enclosed into
1550 \helpref{\_T()}{underscoret} or \helpref{wxT}{wxt} macro which makes them
1551 unrecognised by \texttt{xgettext}, and so they are not extracted to the message
1552 catalog. Instead, use the \helpref{\_()}{underscore} and
1553 \helpref{wxPLURAL}{wxplural} macro for all literal strings.
1554
1555
1556 \membersection{::wxIsEmpty}\label{wxisempty}
1557
1558 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}
1559
1560 Returns \true if the pointer is either {\tt NULL} or points to an empty
1561 string, \false otherwise.
1562
1563
1564 \membersection{::wxStrcmp}\label{wxstrcmp}
1565
1566 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1567
1568 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1569 to or greater than {\it p2}. The comparison is case-sensitive.
1570
1571 This function complements the standard C function {\it stricmp()} which performs
1572 case-insensitive comparison.
1573
1574
1575 \membersection{::wxStricmp}\label{wxstricmp}
1576
1577 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1578
1579 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1580 to or greater than {\it p2}. The comparison is case-insensitive.
1581
1582 This function complements the standard C function {\it strcmp()} which performs
1583 case-sensitive comparison.
1584
1585
1586 \membersection{::wxStringEq}\label{wxstringeq}
1587
1588 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
1589
1590 {\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
1591
1592 A macro defined as:
1593
1594 \begin{verbatim}
1595 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
1596 \end{verbatim}
1597
1598
1599 \membersection{::wxStringMatch}\label{wxstringmatch}
1600
1601 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
1602 \param{bool}{ subString = true}, \param{bool}{ exact = false}}
1603
1604 {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
1605
1606 Returns \true if the substring {\it s1} is found within {\it s2},
1607 ignoring case if {\it exact} is false. If {\it subString} is \false,
1608 no substring matching is done.
1609
1610
1611 \membersection{::wxStringTokenize}\label{wxstringtokenize}
1612
1613 \func{wxArrayString}{wxStringTokenize}{\param{const wxString\& }{str},\\
1614 \param{const wxString\& }{delims = wxDEFAULT\_DELIMITERS},\\
1615 \param{wxStringTokenizerMode }{mode = wxTOKEN\_DEFAULT}}
1616
1617 This is a convenience function wrapping
1618 \helpref{wxStringTokenizer}{wxstringtokenizer} which simply returns all tokens
1619 found in the given \arg{str} in an array.
1620
1621 Please see
1622 \helpref{wxStringTokenizer::wxStringTokenizer}{wxstringtokenizerwxstringtokenizer}
1623 for the description of the other parameters.
1624
1625
1626 \membersection{::wxStrlen}\label{wxstrlen}
1627
1628 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
1629
1630 This is a safe version of standard function {\it strlen()}: it does exactly the
1631 same thing (i.e. returns the length of the string) except that it returns 0 if
1632 {\it p} is the {\tt NULL} pointer.
1633
1634
1635 \membersection{::wxSnprintf}\label{wxsnprintf}
1636
1637 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
1638
1639 This function replaces the dangerous standard function {\tt sprintf()} and is
1640 like {\tt snprintf()} available on some platforms. The only difference with
1641 sprintf() is that an additional argument - buffer size - is taken and the
1642 buffer is never overflowed.
1643
1644 Returns the number of characters copied to the buffer or -1 if there is not
1645 enough space.
1646
1647 \wxheading{See also}
1648
1649 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
1650
1651
1652 \membersection{wxT}\label{wxt}
1653
1654 \func{wxChar}{wxT}{\param{char }{ch}}
1655
1656 \func{const wxChar *}{wxT}{\param{const char *}{s}}
1657
1658 wxT() is a macro which can be used with character and string literals (in other
1659 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
1660 Unicode build configuration. Please see the
1661 \helpref{Unicode overview}{unicode} for more information.
1662
1663 This macro is simply returns the value passed to it without changes in ASCII
1664 build. In fact, its definition is:
1665 \begin{verbatim}
1666 #ifdef UNICODE
1667 #define wxT(x) L ## x
1668 #else // !Unicode
1669 #define wxT(x) x
1670 #endif
1671 \end{verbatim}
1672
1673
1674 \membersection{wxTRANSLATE}\label{wxtranslate}
1675
1676 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
1677
1678 This macro doesn't do anything in the program code -- it simply expands to the
1679 value of its argument (except in Unicode build where it is equivalent to
1680 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
1681 with the same string which would be really unreadable).
1682
1683 However it does have a purpose and it is to mark the literal strings for the
1684 extraction into the message catalog created by {\tt xgettext} program. Usually
1685 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
1686 the string for extraction but also expands into a
1687 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
1688 cannot be used in some situations, notably for static array
1689 initialization.
1690
1691 Here is an example which should make it more clear: suppose that you have a
1692 static array of strings containing the weekday names and which have to be
1693 translated (note that it is a bad example, really, as
1694 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
1695 day names already). If you write
1696
1697 \begin{verbatim}
1698 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
1699 ...
1700 // use weekdays[n] as usual
1701 \end{verbatim}
1702
1703 the code wouldn't compile because the function calls are forbidden in the array
1704 initializer. So instead you should do
1705
1706 \begin{verbatim}
1707 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
1708 ...
1709 // use wxGetTranslation(weekdays[n])
1710 \end{verbatim}
1711
1712 here.
1713
1714 Note that although the code {\bf would} compile if you simply omit
1715 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1716 no translations for the weekday names in the program message catalog and
1717 wxGetTranslation wouldn't find them.
1718
1719 \membersection{::wxVsnprintf}\label{wxvsnprintf}
1720
1721 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
1722
1723 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
1724 argument instead of arbitrary number of parameters.
1725
1726 \wxheading{See also}
1727
1728 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
1729
1730
1731
1732 \membersection{\_}\label{underscore}
1733
1734 \func{const wxChar *}{\_}{\param{const char *}{s}}
1735
1736 This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}
1737 function, so it marks the message for the extraction by {\tt xgettext} just as
1738 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
1739 the string for the current locale during execution.
1740
1741 Don't confuse this macro with \helpref{\_T()}{underscoret}!
1742
1743
1744 \membersection{wxPLURAL}\label{wxplural}
1745
1746 \func{const wxChar *}{wxPLURAL}{\param{const char *}{sing}, \param{const char *}{plur}, \param{size\_t}{n}}
1747
1748 This macro is identical to \helpref{\_()}{underscore} but for the plural variant
1749 of \helpref{wxGetTranslation}{wxgettranslation}.
1750
1751
1752 \membersection{\_T}\label{underscoret}
1753
1754 \func{wxChar}{\_T}{\param{char }{ch}}
1755
1756 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
1757
1758 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in
1759 wxWidgets simply because it may be more intuitive for Windows programmers as
1760 the standard Win32 headers also define it (as well as yet another name for the
1761 same macro which is {\tt \_TEXT()}).
1762
1763 Don't confuse this macro with \helpref{\_()}{underscore}!
1764
1765
1766
1767 \section{Dialog functions}\label{dialogfunctions}
1768
1769 Below are a number of convenience functions for getting input from the
1770 user or displaying messages. Note that in these functions the last three
1771 parameters are optional. However, it is recommended to pass a parent frame
1772 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1773 the front when the dialog box is popped up.
1774
1775
1776 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1777
1778 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1779
1780 Changes the cursor to the given cursor for all windows in the application.
1781 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1782 to its previous state. These two calls can be nested, and a counter
1783 ensures that only the outer calls take effect.
1784
1785 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1786
1787 \wxheading{Include files}
1788
1789 <wx/utils.h>
1790
1791
1792 \membersection{::wxBell}\label{wxbell}
1793
1794 \func{void}{wxBell}{\void}
1795
1796 Ring the system bell.
1797
1798 \wxheading{Include files}
1799
1800 <wx/utils.h>
1801
1802
1803 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
1804
1805 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
1806 \param{size\_t }{currentTip}}
1807
1808 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
1809 used with \helpref{wxShowTip}{wxshowtip}.
1810
1811 \docparam{filename}{The name of the file containing the tips, one per line}
1812 \docparam{currentTip}{The index of the first tip to show - normally this index
1813 is remembered between the 2 program runs.}
1814
1815 \wxheading{See also}
1816
1817 \helpref{Tips overview}{tipsoverview}
1818
1819 \wxheading{Include files}
1820
1821 <wx/tipdlg.h>
1822
1823
1824 \membersection{::wxDirSelector}\label{wxdirselector}
1825
1826 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
1827 \param{const wxString\& }{default\_path = ""},\\
1828 \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition},\\
1829 \param{wxWindow *}{parent = NULL}}
1830
1831 Pops up a directory selector dialog. The arguments have the same meaning as
1832 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1833 and the default\_path, if specified, is set as the initial selection.
1834
1835 The application must check for an empty return value (if the user pressed
1836 Cancel). For example:
1837
1838 \begin{verbatim}
1839 const wxString& dir = wxDirSelector("Choose a folder");
1840 if ( !dir.empty() )
1841 {
1842 ...
1843 }
1844 \end{verbatim}
1845
1846 \wxheading{Include files}
1847
1848 <wx/dirdlg.h>
1849
1850
1851 \membersection{::wxFileSelector}\label{wxfileselector}
1852
1853 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
1854 \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
1855 \param{const wxString\& }{wildcard = "*.*"}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
1856 \param{int}{ x = -1}, \param{int}{ y = -1}}
1857
1858 Pops up a file selector box. In Windows, this is the common file selector
1859 dialog. In X, this is a file selector box with the same functionality.
1860 The path and filename are distinct elements of a full file pathname.
1861 If path is empty, the current directory will be used. If filename is empty,
1862 no default filename will be supplied. The wildcard determines what files
1863 are displayed in the file selector, and file extension supplies a type
1864 extension for the required filename. Flags may be a combination of wxOPEN,
1865 wxSAVE, wxOVERWRITE\_PROMPT or wxFILE\_MUST\_EXIST. Note that wxMULTIPLE
1866 can only be used with \helpref{wxFileDialog}{wxfiledialog} and not here as this
1867 function only returns a single file name.
1868
1869 Both the Unix and Windows versions implement a wildcard filter. Typing a
1870 filename containing wildcards (*, ?) in the filename text item, and
1871 clicking on Ok, will result in only those files matching the pattern being
1872 displayed.
1873
1874 The wildcard may be a specification for multiple types of file
1875 with a description for each, such as:
1876
1877 \begin{verbatim}
1878 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1879 \end{verbatim}
1880
1881 The application must check for an empty return value (the user pressed
1882 Cancel). For example:
1883
1884 \begin{verbatim}
1885 wxString filename = wxFileSelector("Choose a file to open");
1886 if ( !filename.empty() )
1887 {
1888 // work with the file
1889 ...
1890 }
1891 //else: cancelled by user
1892 \end{verbatim}
1893
1894 \wxheading{Include files}
1895
1896 <wx/filedlg.h>
1897
1898
1899 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1900
1901 \func{void}{wxEndBusyCursor}{\void}
1902
1903 Changes the cursor back to the original cursor, for all windows in the application.
1904 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1905
1906 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1907
1908 \wxheading{Include files}
1909
1910 <wx/utils.h>
1911
1912
1913 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
1914
1915 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
1916
1917 Shows the colour selection dialog and returns the colour selected by user or
1918 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
1919 is valid) if the dialog was cancelled.
1920
1921 \wxheading{Parameters}
1922
1923 \docparam{parent}{The parent window for the colour selection dialog}
1924
1925 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
1926
1927 \docparam{caption}{If given, this will be used for the dialog caption.}
1928
1929 \wxheading{Include files}
1930
1931 <wx/colordlg.h>
1932
1933
1934 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
1935
1936 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
1937
1938 Shows the font selection dialog and returns the font selected by user or
1939 invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
1940 is valid) if the dialog was cancelled.
1941
1942 \wxheading{Parameters}
1943
1944 \docparam{parent}{The parent window for the font selection dialog}
1945
1946 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
1947
1948 \docparam{caption}{If given, this will be used for the dialog caption.}
1949
1950 \wxheading{Include files}
1951
1952 <wx/fontdlg.h>
1953
1954
1955
1956 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
1957
1958 \func{size\_t}{wxGetMultipleChoices}{\\
1959 \param{wxArrayInt\& }{selections},\\
1960 \param{const wxString\& }{message},\\
1961 \param{const wxString\& }{caption},\\
1962 \param{const wxArrayString\& }{aChoices},\\
1963 \param{wxWindow *}{parent = NULL},\\
1964 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1965 \param{bool}{ centre = true},\\
1966 \param{int }{width=150}, \param{int }{height=200}}
1967
1968 \func{size\_t}{wxGetMultipleChoices}{\\
1969 \param{wxArrayInt\& }{selections},\\
1970 \param{const wxString\& }{message},\\
1971 \param{const wxString\& }{caption},\\
1972 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1973 \param{wxWindow *}{parent = NULL},\\
1974 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1975 \param{bool}{ centre = true},\\
1976 \param{int }{width=150}, \param{int }{height=200}}
1977
1978 Pops up a dialog box containing a message, OK/Cancel buttons and a
1979 multiple-selection listbox. The user may choose an arbitrary (including 0)
1980 number of items in the listbox whose indices will be returned in
1981 {\it selection} array. The initial contents of this array will be used to
1982 select the items when the dialog is shown.
1983
1984 You may pass the list of strings to choose from either using {\it choices}
1985 which is an array of {\it n} strings for the listbox or by using a single
1986 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1987
1988 If {\it centre} is true, the message text (which may include new line
1989 characters) is centred; if false, the message is left-justified.
1990
1991 \wxheading{Include files}
1992
1993 <wx/choicdlg.h>
1994
1995 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1996 and {\tt choices}, and no {\tt selections} parameter; the function
1997 returns an array containing the user selections.}
1998
1999
2000 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
2001
2002 \func{long}{wxGetNumberFromUser}{
2003 \param{const wxString\& }{message},
2004 \param{const wxString\& }{prompt},
2005 \param{const wxString\& }{caption},
2006 \param{long }{value},
2007 \param{long }{min = 0},
2008 \param{long }{max = 100},
2009 \param{wxWindow *}{parent = NULL},
2010 \param{const wxPoint\& }{pos = wxDefaultPosition}}
2011
2012 Shows a dialog asking the user for numeric input. The dialogs title is set to
2013 {\it caption}, it contains a (possibly) multiline {\it message} above the
2014 single line {\it prompt} and the zone for entering the number.
2015
2016 The number entered must be in the range {\it min}..{\it max} (both of which
2017 should be positive) and {\it value} is the initial value of it. If the user
2018 enters an invalid value or cancels the dialog, the function will return -1.
2019
2020 Dialog is centered on its {\it parent} unless an explicit position is given in
2021 {\it pos}.
2022
2023 \wxheading{Include files}
2024
2025 <wx/numdlg.h>
2026
2027
2028 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
2029
2030 \func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2031 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2032 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2033
2034 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
2035 in the dialog is not shown on screen but replaced with stars. This is intended
2036 to be used for entering passwords as the function name implies.
2037
2038 \wxheading{Include files}
2039
2040 <wx/textdlg.h>
2041
2042
2043 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
2044
2045 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2046 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2047 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2048
2049 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
2050 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
2051 or press Cancel to return the empty string.
2052
2053 If {\it centre} is true, the message text (which may include new line characters)
2054 is centred; if false, the message is left-justified.
2055
2056 \wxheading{Include files}
2057
2058 <wx/textdlg.h>
2059
2060
2061 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
2062
2063 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2064 \param{int }{nsel}, \param{int *}{selection},
2065 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2066 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2067
2068 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
2069 listbox. The user may choose one or more item(s) and press OK or Cancel.
2070
2071 The number of initially selected choices, and array of the selected indices,
2072 are passed in; this array will contain the user selections on exit, with
2073 the function returning the number of selections. {\it selection} must be
2074 as big as the number of choices, in case all are selected.
2075
2076 If Cancel is pressed, -1 is returned.
2077
2078 {\it choices} is an array of {\it n} strings for the listbox.
2079
2080 If {\it centre} is true, the message text (which may include new line characters)
2081 is centred; if false, the message is left-justified.
2082
2083 \wxheading{Include files}
2084
2085 <wx/choicdlg.h>
2086
2087
2088 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
2089
2090 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2091 \param{const wxString\& }{caption},\\
2092 \param{const wxArrayString\& }{aChoices},\\
2093 \param{wxWindow *}{parent = NULL},\\
2094 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2095 \param{bool}{ centre = true},\\
2096 \param{int }{width=150}, \param{int }{height=200}}
2097
2098 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2099 \param{const wxString\& }{caption},\\
2100 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2101 \param{wxWindow *}{parent = NULL},\\
2102 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2103 \param{bool}{ centre = true},\\
2104 \param{int }{width=150}, \param{int }{height=200}}
2105
2106 Pops up a dialog box containing a message, OK/Cancel buttons and a
2107 single-selection listbox. The user may choose an item and press OK to return a
2108 string or Cancel to return the empty string. Use
2109 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
2110 valid choice and if you want to be able to detect pressing Cancel reliably.
2111
2112 You may pass the list of strings to choose from either using {\it choices}
2113 which is an array of {\it n} strings for the listbox or by using a single
2114 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2115
2116 If {\it centre} is true, the message text (which may include new line
2117 characters) is centred; if false, the message is left-justified.
2118
2119 \wxheading{Include files}
2120
2121 <wx/choicdlg.h>
2122
2123 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2124 and {\tt choices}.}
2125
2126
2127 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
2128
2129 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2130 \param{const wxString\& }{caption},\\
2131 \param{const wxArrayString\& }{aChoices},\\
2132 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2133 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2134
2135 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2136 \param{const wxString\& }{caption},\\
2137 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2138 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2139 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2140
2141 As {\bf wxGetSingleChoice} but returns the index representing the selected
2142 string. If the user pressed cancel, -1 is returned.
2143
2144 \wxheading{Include files}
2145
2146 <wx/choicdlg.h>
2147
2148 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2149 and {\tt choices}.}
2150
2151
2152 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2153
2154 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2155 \param{const wxString\& }{caption},\\
2156 \param{const wxArrayString\& }{aChoices},\\
2157 \param{const wxString\& }{client\_data[]},\\
2158 \param{wxWindow *}{parent = NULL},\\
2159 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2160 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2161
2162 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2163 \param{const wxString\& }{caption},\\
2164 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2165 \param{const wxString\& }{client\_data[]},\\
2166 \param{wxWindow *}{parent = NULL},\\
2167 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2168 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2169
2170 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2171 corresponding to the strings, and returns one of these pointers or NULL if
2172 Cancel was pressed. The {\it client\_data} array must have the same number of
2173 elements as {\it choices} or {\it aChoices}!
2174
2175 \wxheading{Include files}
2176
2177 <wx/choicdlg.h>
2178
2179 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2180 and {\tt choices}, and the client data array must have the
2181 same length as the choices array.}
2182
2183
2184 \membersection{::wxIsBusy}\label{wxisbusy}
2185
2186 \func{bool}{wxIsBusy}{\void}
2187
2188 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2189 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2190
2191 See also \helpref{wxBusyCursor}{wxbusycursor}.
2192
2193 \wxheading{Include files}
2194
2195 <wx/utils.h>
2196
2197
2198 \membersection{::wxMessageBox}\label{wxmessagebox}
2199
2200 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2201 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2202
2203 General purpose message dialog. {\it style} may be a bit list of the
2204 following identifiers:
2205
2206 \begin{twocollist}\itemsep=0pt
2207 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2208 wxCANCEL.}
2209 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with
2210 wxYES\_NO or wxOK.}
2211 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2212 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2213 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2214 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2215 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2216 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2217 \end{twocollist}
2218
2219 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2220
2221 For example:
2222
2223 \begin{verbatim}
2224 ...
2225 int answer = wxMessageBox("Quit program?", "Confirm",
2226 wxYES_NO | wxCANCEL, main_frame);
2227 if (answer == wxYES)
2228 main_frame->Close();
2229 ...
2230 \end{verbatim}
2231
2232 {\it message} may contain newline characters, in which case the
2233 message will be split into separate lines, to cater for large messages.
2234
2235 \wxheading{Include files}
2236
2237 <wx/msgdlg.h>
2238
2239
2240 \membersection{::wxShowTip}\label{wxshowtip}
2241
2242 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2243 \param{wxTipProvider *}{tipProvider},
2244 \param{bool }{showAtStartup = true}}
2245
2246 This function shows a "startup tip" to the user. The return value is the
2247 state of the `Show tips at startup' checkbox.
2248
2249 \docparam{parent}{The parent window for the modal dialog}
2250
2251 \docparam{tipProvider}{An object which is used to get the text of the tips.
2252 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2253
2254 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2255 otherwise. This is used as the initial value for "Show tips at startup"
2256 checkbox which is shown in the tips dialog.}
2257
2258 \wxheading{See also}
2259
2260 \helpref{Tips overview}{tipsoverview}
2261
2262 \wxheading{Include files}
2263
2264 <wx/tipdlg.h>
2265
2266
2267
2268
2269 \section{Math functions}\label{mathfunctions}
2270
2271 \wxheading{Include files}
2272
2273 <wx/math.h>
2274
2275
2276 \membersection{wxFinite}\label{wxfinite}
2277
2278 \func{int}{wxFinite}{\param{double }{x}}
2279
2280 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2281 returns 0 otherwise.
2282
2283
2284 \membersection{wxIsNaN}\label{wxisnan}
2285
2286 \func{bool}{wxIsNaN}{\param{double }{x}}
2287
2288 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2289 otherwise.
2290
2291
2292
2293
2294 \section{GDI functions}\label{gdifunctions}
2295
2296 The following are relevant to the GDI (Graphics Device Interface).
2297
2298 \wxheading{Include files}
2299
2300 <wx/gdicmn.h>
2301
2302
2303 \membersection{wxBITMAP}\label{wxbitmapmacro}
2304
2305 \func{}{wxBITMAP}{bitmapName}
2306
2307 This macro loads a bitmap from either application resources (on the platforms
2308 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2309 avoid using {\tt \#ifdef}s when creating bitmaps.
2310
2311 \wxheading{See also}
2312
2313 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2314 \helpref{wxICON}{wxiconmacro}
2315
2316 \wxheading{Include files}
2317
2318 <wx/gdicmn.h>
2319
2320
2321 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2322
2323 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2324 \param{int *}{width}, \param{int *}{height}}
2325
2326 \func{wxRect}{wxGetClientDisplayRect}{\void}
2327
2328 Returns the dimensions of the work area on the display. On Windows
2329 this means the area not covered by the taskbar, etc. Other platforms
2330 are currently defaulting to the whole display until a way is found to
2331 provide this info for all window managers, etc.
2332
2333
2334 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2335
2336 \func{bool}{wxColourDisplay}{\void}
2337
2338 Returns true if the display is colour, false otherwise.
2339
2340
2341 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2342
2343 \func{int}{wxDisplayDepth}{\void}
2344
2345 Returns the depth of the display (a value of 1 denotes a monochrome display).
2346
2347
2348 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2349
2350 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2351
2352 \func{wxSize}{wxGetDisplaySize}{\void}
2353
2354 Returns the display size in pixels.
2355
2356
2357 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2358
2359 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2360
2361 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2362
2363 Returns the display size in millimeters.
2364
2365
2366 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2367
2368 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2369
2370 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2371 name. Under MSW, the cursor is loaded from the resource file and the icon is
2372 loaded from XPM file under other platforms.
2373
2374 This macro should be used with
2375 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2376
2377 \wxheading{Include files}
2378
2379 <wx/dnd.h>
2380
2381
2382 \membersection{wxICON}\label{wxiconmacro}
2383
2384 \func{}{wxICON}{iconName}
2385
2386 This macro loads an icon from either application resources (on the platforms
2387 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2388 avoid using {\tt \#ifdef}s when creating icons.
2389
2390 \wxheading{See also}
2391
2392 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2393 \helpref{wxBITMAP}{wxbitmapmacro}
2394
2395 \wxheading{Include files}
2396
2397 <wx/gdicmn.h>
2398
2399
2400 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2401
2402 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2403 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2404
2405 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2406 makes it into a placeable metafile by prepending a header containing the given
2407 bounding box. The bounding box may be obtained from a device context after drawing
2408 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2409
2410 In addition to adding the placeable metafile header, this function adds
2411 the equivalent of the following code to the start of the metafile data:
2412
2413 \begin{verbatim}
2414 SetMapMode(dc, MM_ANISOTROPIC);
2415 SetWindowOrg(dc, minX, minY);
2416 SetWindowExt(dc, maxX - minX, maxY - minY);
2417 \end{verbatim}
2418
2419 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2420
2421 Placeable metafiles may be imported by many Windows applications, and can be
2422 used in RTF (Rich Text Format) files.
2423
2424 {\it scale} allows the specification of scale for the metafile.
2425
2426 This function is only available under Windows.
2427
2428
2429 \membersection{::wxSetCursor}\label{wxsetcursor}
2430
2431 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2432
2433 Globally sets the cursor; only has an effect in Windows and GTK.
2434 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2435
2436
2437
2438 \section{Printer settings}\label{printersettings}
2439
2440 {\bf NB:} These routines are obsolete and should no longer be used!
2441
2442 The following functions are used to control PostScript printing. Under
2443 Windows, PostScript output can only be sent to a file.
2444
2445 \wxheading{Include files}
2446
2447 <wx/dcps.h>
2448
2449
2450 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2451
2452 \func{wxString}{wxGetPrinterCommand}{\void}
2453
2454 Gets the printer command used to print a file. The default is {\tt lpr}.
2455
2456
2457 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2458
2459 \func{wxString}{wxGetPrinterFile}{\void}
2460
2461 Gets the PostScript output filename.
2462
2463
2464 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2465
2466 \func{int}{wxGetPrinterMode}{\void}
2467
2468 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2469 The default is PS\_PREVIEW.
2470
2471
2472 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2473
2474 \func{wxString}{wxGetPrinterOptions}{\void}
2475
2476 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2477
2478
2479 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2480
2481 \func{int}{wxGetPrinterOrientation}{\void}
2482
2483 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2484
2485
2486 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2487
2488 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2489
2490 Gets the command used to view a PostScript file. The default depends on the platform.
2491
2492
2493 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2494
2495 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2496
2497 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2498
2499
2500 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2501
2502 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2503
2504 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2505
2506
2507 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2508
2509 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2510
2511 Sets the printer command used to print a file. The default is {\tt lpr}.
2512
2513
2514 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2515
2516 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2517
2518 Sets the PostScript output filename.
2519
2520
2521 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2522
2523 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2524
2525 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2526 The default is PS\_PREVIEW.
2527
2528
2529 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2530
2531 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2532
2533 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2534
2535
2536 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2537
2538 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2539
2540 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2541
2542
2543 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2544
2545 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2546
2547 Sets the command used to view a PostScript file. The default depends on the platform.
2548
2549
2550 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2551
2552 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2553
2554 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2555
2556
2557 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2558
2559 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2560
2561 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2562
2563
2564
2565 \section{Clipboard functions}\label{clipsboard}
2566
2567 These clipboard functions are implemented for Windows only. The use of these functions
2568 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2569 class instead.
2570
2571 \wxheading{Include files}
2572
2573 <wx/clipbrd.h>
2574
2575
2576 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2577
2578 \func{bool}{wxClipboardOpen}{\void}
2579
2580 Returns true if this application has already opened the clipboard.
2581
2582
2583 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2584
2585 \func{bool}{wxCloseClipboard}{\void}
2586
2587 Closes the clipboard to allow other applications to use it.
2588
2589
2590 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2591
2592 \func{bool}{wxEmptyClipboard}{\void}
2593
2594 Empties the clipboard.
2595
2596
2597 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2598
2599 \func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}}
2600
2601 Enumerates the formats found in a list of available formats that belong
2602 to the clipboard. Each call to this function specifies a known
2603 available format; the function returns the format that appears next in
2604 the list.
2605
2606 {\it dataFormat} specifies a known format. If this parameter is zero,
2607 the function returns the first format in the list.
2608
2609 The return value specifies the next known clipboard data format if the
2610 function is successful. It is zero if the {\it dataFormat} parameter specifies
2611 the last format in the list of available formats, or if the clipboard
2612 is not open.
2613
2614 Before it enumerates the formats function, an application must open the clipboard by using the
2615 wxOpenClipboard function.
2616
2617
2618 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2619
2620 \func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}}
2621
2622 Gets data from the clipboard.
2623
2624 {\it dataFormat} may be one of:
2625
2626 \begin{itemize}\itemsep=0pt
2627 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2628 \item wxCF\_BITMAP: returns a new wxBitmap.
2629 \end{itemize}
2630
2631 The clipboard must have previously been opened for this call to succeed.
2632
2633
2634 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2635
2636 \func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}}
2637
2638 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2639 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2640
2641
2642 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2643
2644 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}}
2645
2646 Returns true if the given data format is available on the clipboard.
2647
2648
2649 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2650
2651 \func{bool}{wxOpenClipboard}{\void}
2652
2653 Opens the clipboard for passing data to it or getting data from it.
2654
2655
2656 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2657
2658 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2659
2660 Registers the clipboard data format name and returns an identifier.
2661
2662
2663 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2664
2665 \func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}}
2666
2667 Passes data to the clipboard.
2668
2669 {\it dataFormat} may be one of:
2670
2671 \begin{itemize}\itemsep=0pt
2672 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2673 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2674 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2675 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2676 \end{itemize}
2677
2678 The clipboard must have previously been opened for this call to succeed.
2679
2680
2681 \section{Miscellaneous functions}\label{miscellany}
2682
2683
2684 \membersection{wxCONCAT}\label{wxconcat}
2685
2686 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2687
2688 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2689
2690
2691 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2692
2693 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2694
2695 When loading a function from a DLL you always have to cast the returned
2696 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2697 repeat this type twice if you want to declare and define a function pointer all
2698 in one line
2699
2700 This macro makes this slightly less painful by allowing you to specify the
2701 type only once, as the first parameter, and creating a variable of this type
2702 named after the function but with {\tt pfn} prefix and initialized with the
2703 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2704 \arg{dynlib}.
2705
2706 \wxheading{Parameters}
2707
2708 \docparam{type}{the type of the function}
2709
2710 \docparam{name}{the name of the function to load, not a string (without quotes,
2711 it is quoted automatically by the macro)}
2712
2713 \docparam{dynlib}{the library to load the function from}
2714
2715
2716
2717 \membersection{wxEXPLICIT}\label{wxexplicit}
2718
2719 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2720 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2721 code which might have to be compiled with an old compiler without support for
2722 this language feature but still take advantage of it when it is available.
2723
2724
2725 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2726
2727 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2728
2729 For normal keys, returns \true if the specified key is currently down.
2730
2731 For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns
2732 \true if the key is toggled such that its LED indicator is lit. There is
2733 currently no way to test whether togglable keys are up or down.
2734
2735 Even though there are virtual key codes defined for mouse buttons, they
2736 cannot be used with this function currently.
2737
2738 \wxheading{Include files}
2739
2740 <wx/utils.h>
2741
2742
2743 \membersection{wxLL}\label{wxll}
2744
2745 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2746
2747 This macro is defined for the platforms with a native 64 bit integer type and
2748 allows to define 64 bit compile time constants:
2749
2750 \begin{verbatim}
2751 #ifdef wxLongLong_t
2752 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2753 #endif
2754 \end{verbatim}
2755
2756 \wxheading{Include files}
2757
2758 <wx/longlong.h>
2759
2760 \wxheading{See also}
2761
2762 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2763
2764
2765 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2766
2767 This macro is defined to contain the {\tt printf()} format specifier using
2768 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2769 printed. Example of using it:
2770
2771 \begin{verbatim}
2772 #ifdef wxLongLong_t
2773 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2774 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2775 #endif
2776 \end{verbatim}
2777
2778 \wxheading{See also}
2779
2780 \helpref{wxLL}{wxll}
2781
2782 \wxheading{Include files}
2783
2784 <wx/longlong.h>
2785
2786
2787 \membersection{::wxNewId}\label{wxnewid}
2788
2789 \func{long}{wxNewId}{\void}
2790
2791 Generates an integer identifier unique to this run of the program.
2792
2793 \wxheading{Include files}
2794
2795 <wx/utils.h>
2796
2797
2798 \membersection{wxON\_BLOCK\_EXIT}\label{wxonblockexit}
2799
2800 \func{}{wxON\_BLOCK\_EXIT0}{\param{}{func}}
2801 \func{}{wxON\_BLOCK\_EXIT1}{\param{}{func}, \param{}{p1}}
2802 \func{}{wxON\_BLOCK\_EXIT2}{\param{}{func}, \param{}{p1}, \param{}{p2}}
2803
2804 This family of macros allows to ensure that the global function \arg{func}
2805 with 0, 1, 2 or more parameters (up to some implementaton-defined limit) is
2806 executed on scope exit, whether due to a normal function return or because an
2807 exception has been thrown. A typical example of its usage:
2808 \begin{verbatim}
2809 void *buf = malloc(size);
2810 wxON_BLOCK_EXIT1(free, buf);
2811 \end{verbatim}
2812
2813 Please see the original article by Andrei Alexandrescu and Petru Marginean
2814 published in December 2000 issue of \emph{C/C++ Users Journal} for more
2815 details.
2816
2817 \wxheading{Include files}
2818
2819 <wx/scopeguard.h>
2820
2821 \wxheading{See also}
2822
2823 \helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}
2824
2825
2826 \membersection{wxON\_BLOCK\_EXIT\_OBJ}\label{wxonblockexitobj}
2827
2828 \func{}{wxON\_BLOCK\_EXIT\_OBJ0}{\param{}{obj}, \param{}{method}}
2829 \func{}{wxON\_BLOCK\_EXIT\_OBJ1}{\param{}{obj}, \param{}{method}, \param{}{p1}}
2830 \func{}{wxON\_BLOCK\_EXIT\_OBJ2}{\param{}{obj}, \param{}{method}, \param{}{p1}, \param{}{p2}}
2831
2832 This family of macros is similar to \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}
2833 but calls a method of the given object instead of a free function.
2834
2835 \wxheading{Include files}
2836
2837 <wx/scopeguard.h>
2838
2839
2840 \membersection{::wxRegisterId}\label{wxregisterid}
2841
2842 \func{void}{wxRegisterId}{\param{long}{ id}}
2843
2844 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2845 the given {\bf id}.
2846
2847 \wxheading{Include files}
2848
2849 <wx/utils.h>
2850
2851
2852 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2853
2854 \func{void}{wxDDECleanUp}{\void}
2855
2856 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
2857 called by the application.
2858
2859 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2860
2861 \wxheading{Include files}
2862
2863 <wx/dde.h>
2864
2865
2866 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2867
2868 \func{void}{wxDDEInitialize}{\void}
2869
2870 Initializes the DDE system. May be called multiple times without harm.
2871
2872 This no longer needs to be called by the application: it will be called
2873 by wxWidgets if necessary.
2874
2875 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
2876 \helpref{wxDDECleanUp}{wxddecleanup}.
2877
2878 \wxheading{Include files}
2879
2880 <wx/dde.h>
2881
2882
2883 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
2884
2885 \func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}
2886
2887 This function enables or disables all top level windows. It is used by
2888 \helpref{::wxSafeYield}{wxsafeyield}.
2889
2890 \wxheading{Include files}
2891
2892 <wx/utils.h>
2893
2894
2895 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
2896
2897 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
2898
2899 Find a menu item identifier associated with the given frame's menu bar.
2900
2901 \wxheading{Include files}
2902
2903 <wx/utils.h>
2904
2905
2906 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
2907
2908 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
2909
2910 {\bf NB:} This function is obsolete, please use
2911 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
2912
2913 Find a window by its label. Depending on the type of window, the label may be a window title
2914 or panel item label. If {\it parent} is NULL, the search will start from all top-level
2915 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2916 The search is recursive in both cases.
2917
2918 \wxheading{Include files}
2919
2920 <wx/utils.h>
2921
2922
2923 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
2924
2925 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
2926
2927 {\bf NB:} This function is obsolete, please use
2928 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
2929
2930 Find a window by its name (as given in a window constructor or {\bf Create} function call).
2931 If {\it parent} is NULL, the search will start from all top-level
2932 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2933 The search is recursive in both cases.
2934
2935 If no such named window is found, {\bf wxFindWindowByLabel} is called.
2936
2937 \wxheading{Include files}
2938
2939 <wx/utils.h>
2940
2941
2942 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
2943
2944 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
2945
2946 Find the deepest window at the given mouse position in screen coordinates,
2947 returning the window if found, or NULL if not.
2948
2949
2950 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
2951
2952 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
2953
2954 Find the deepest window at the mouse pointer position, returning the window
2955 and current pointer position in screen coordinates.
2956
2957
2958 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
2959
2960 \func{wxWindow *}{wxGetActiveWindow}{\void}
2961
2962 Gets the currently active window (implemented for MSW and GTK only currently,
2963 always returns \NULL in the other ports).
2964
2965 \wxheading{Include files}
2966
2967 <wx/windows.h>
2968
2969
2970 \membersection{::wxGetBatteryState}\label{wxgetbatterystate}
2971
2972 \func{wxBatteryState}{wxGetBatteryState}{\void}
2973
2974 Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
2975 \texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
2976 \texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
2977 \texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
2978 this feature is not implemented.
2979
2980 \wxheading{Include files}
2981
2982 <wx/utils.h>
2983
2984
2985 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
2986
2987 \func{wxString}{wxGetDisplayName}{\void}
2988
2989 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
2990
2991 \wxheading{Include files}
2992
2993 <wx/utils.h>
2994
2995
2996 \membersection{::wxGetPowerType}\label{wxgetpowertype}
2997
2998 \func{wxPowerType}{wxGetPowerType}{\void}
2999
3000 Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
3001 \texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
3002 \texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
3003 feature is not implemented.
3004
3005 \wxheading{Include files}
3006
3007 <wx/utils.h>
3008
3009
3010 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
3011
3012 \func{wxPoint}{wxGetMousePosition}{\void}
3013
3014 Returns the mouse position in screen coordinates.
3015
3016 \wxheading{Include files}
3017
3018 <wx/utils.h>
3019
3020
3021 \membersection{::wxGetMouseState}\label{wxgetmousestate}
3022
3023 \func{wxMouseState}{wxGetMouseState}{\void}
3024
3025 Returns the current state of the mouse. Returns a wxMouseState
3026 instance that contains the current position of the mouse pointer in
3027 screen coordinants, as well as boolean values indicating the up/down
3028 status of the mouse buttons and the modifier keys.
3029
3030 \wxheading{Include files}
3031
3032 <wx/utils.h>
3033
3034 wxMouseState has the following interface:
3035
3036 \begin{verbatim}
3037 class wxMouseState
3038 {
3039 public:
3040 wxMouseState();
3041
3042 wxCoord GetX();
3043 wxCoord GetY();
3044
3045 bool LeftDown();
3046 bool MiddleDown();
3047 bool RightDown();
3048
3049 bool ControlDown();
3050 bool ShiftDown();
3051 bool AltDown();
3052 bool MetaDown();
3053 bool CmdDown();
3054
3055 void SetX(wxCoord x);
3056 void SetY(wxCoord y);
3057
3058 void SetLeftDown(bool down);
3059 void SetMiddleDown(bool down);
3060 void SetRightDown(bool down);
3061
3062 void SetControlDown(bool down);
3063 void SetShiftDown(bool down);
3064 void SetAltDown(bool down);
3065 void SetMetaDown(bool down);
3066 };
3067 \end{verbatim}
3068
3069
3070 \membersection{::wxGetResource}\label{wxgetresource}
3071
3072 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3073 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
3074
3075 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3076 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
3077
3078 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3079 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
3080
3081 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3082 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
3083
3084 Gets a resource value from the resource database (for example, WIN.INI, or
3085 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
3086 otherwise the specified file is used.
3087
3088 Under X, if an application class (wxApp::GetClassName) has been defined,
3089 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
3090 an applications default file when merging all resource databases.
3091
3092 The reason for passing the result in an argument is that it
3093 can be convenient to define a default value, which gets overridden
3094 if the value exists in the resource file. It saves a separate
3095 test for that resource's existence, and it also allows
3096 the overloading of the function for different types.
3097
3098 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
3099
3100 \wxheading{Include files}
3101
3102 <wx/utils.h>
3103
3104
3105 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
3106
3107 \func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}}
3108
3109 Returns label that should be used for given {\it id} element.
3110
3111 \wxheading{Parameters}
3112
3113 \docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.}
3114
3115 \docparam{withCodes}{if false then strip accelerator code from the label;
3116 usefull for getting labels without accelerator char code like for toolbar tooltip or
3117 under platforms without traditional keyboard like smartphones}
3118
3119 \docparam{accelerator}{optional accelerator string automatically added to label; useful
3120 for building labels for \helpref{wxMenuItem}{wxmenuitem}}
3121
3122 \wxheading{Include files}
3123
3124 <wx/stockitem.h>
3125
3126
3127 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
3128
3129 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
3130
3131 Returns the first top level parent of the given window, or in other words, the
3132 frame or dialog containing it, or {\tt NULL}.
3133
3134 \wxheading{Include files}
3135
3136 <wx/window.h>
3137
3138
3139 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
3140
3141 \func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}}
3142
3143 Open the \arg{url} in user's default browser. If \arg{flags} parameter contains
3144 \texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL
3145 (currently this is only supported under Windows).
3146
3147 Returns \true if the application was successfully launched.
3148
3149 \wxheading{Include files}
3150
3151 <wx/utils.h>
3152
3153
3154 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
3155
3156 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
3157
3158 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
3159 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
3160
3161 The resource must be defined in the {\tt .rc} file using the following syntax:
3162
3163 \begin{verbatim}
3164 myResource TEXT file.ext
3165 \end{verbatim}
3166
3167 where {\tt file.ext} is a file that the resource compiler can find.
3168
3169 This function is available under Windows only.
3170
3171 \wxheading{Include files}
3172
3173 <wx/utils.h>
3174
3175
3176 \membersection{::wxPostDelete}\label{wxpostdelete}
3177
3178 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
3179
3180 Tells the system to delete the specified object when
3181 all other events have been processed. In some environments, it is
3182 necessary to use this instead of deleting a frame directly with the
3183 delete operator, because some GUIs will still send events to a deleted window.
3184
3185 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
3186
3187 \wxheading{Include files}
3188
3189 <wx/utils.h>
3190
3191
3192 \membersection{::wxPostEvent}\label{wxpostevent}
3193
3194 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
3195
3196 In a GUI application, this function posts {\it event} to the specified {\it dest}
3197 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
3198 Otherwise, it dispatches {\it event} immediately using
3199 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
3200 See the respective documentation for details (and caveats).
3201
3202 \wxheading{Include files}
3203
3204 <wx/app.h>
3205
3206
3207 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
3208
3209 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
3210
3211 Under X only, sets the current display name. This is the X host and display name such
3212 as ``colonsay:0.0", and the function indicates which display should be used for creating
3213 windows from this point on. Setting the display within an application allows multiple
3214 displays to be used.
3215
3216 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
3217
3218 \wxheading{Include files}
3219
3220 <wx/utils.h>
3221
3222
3223 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
3224
3225 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
3226
3227 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
3228
3229 {\bf NB:} This function is obsolete, please use
3230 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
3231
3232 Strips any menu codes from {\it in} and places the result
3233 in {\it out} (or returns the new string, in the first form).
3234
3235 Menu codes include \& (mark the next character with an underline
3236 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
3237
3238 \wxheading{Include files}
3239
3240 <wx/utils.h>
3241
3242
3243 \membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning}
3244
3245 \func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}}
3246
3247 GNU C++ compiler gives a warning for any class whose destructor is private
3248 unless it has a friend. This warning may sometimes be useful but it doesn't
3249 make sense for reference counted class which always delete themselves (hence
3250 destructor should be private) but don't necessarily have any friends, so this
3251 macro is provided to disable the warning in such case. The \arg{name} parameter
3252 should be the name of the class but is only used to construct a unique friend
3253 class name internally. Example of using the macro:
3254
3255 \begin{verbatim}
3256 class RefCounted
3257 {
3258 public:
3259 RefCounted() { m_nRef = 1; }
3260 void IncRef() { m_nRef++ ; }
3261 void DecRef() { if ( !--m_nRef ) delete this; }
3262
3263 private:
3264 ~RefCounted() { }
3265
3266 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
3267 };
3268 \end{verbatim}
3269
3270 Notice that there should be no semicolon after this macro.
3271
3272
3273 \membersection{wxULL}\label{wxull}
3274
3275 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
3276
3277 This macro is defined for the platforms with a native 64 bit integer type and
3278 allows to define unsigned 64 bit compile time constants:
3279
3280 \begin{verbatim}
3281 #ifdef wxLongLong_t
3282 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
3283 #endif
3284 \end{verbatim}
3285
3286 \wxheading{Include files}
3287
3288 <wx/longlong.h>
3289
3290 \wxheading{See also}
3291
3292 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
3293
3294
3295 \membersection{wxVaCopy}\label{wxvacopy}
3296
3297 \func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}}
3298
3299 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
3300 which support it or its replacement for those that don't. It must be used to
3301 preserve the value of a \texttt{va\_list} object if you need to use it after
3302 passing it to another function because it can be modified by the latter.
3303
3304 As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
3305 \texttt{va\_end}.
3306
3307
3308 \membersection{::wxWriteResource}\label{wxwriteresource}
3309
3310 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3311 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
3312
3313 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3314 \param{float }{value}, \param{const wxString\& }{file = NULL}}
3315
3316 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3317 \param{long }{value}, \param{const wxString\& }{file = NULL}}
3318
3319 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3320 \param{int }{value}, \param{const wxString\& }{file = NULL}}
3321
3322 Writes a resource value into the resource database (for example, WIN.INI, or
3323 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
3324 otherwise the specified file is used.
3325
3326 Under X, the resource databases are cached until the internal function
3327 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
3328 all updated resource databases are written to their files.
3329
3330 Note that it is considered bad manners to write to the .Xdefaults
3331 file under Unix, although the WIN.INI file is fair game under Windows.
3332
3333 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
3334
3335 \wxheading{Include files}
3336
3337 <wx/utils.h>
3338
3339
3340 \membersection{\_\_WXFUNCTION\_\_}\label{wxfunction}
3341
3342 \func{}{\_\_WXFUNCTION\_\_}{\void}
3343
3344 This macro expands to the name of the current function if the compiler supports
3345 any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables
3346 or macros or to \NULL if none of them is available.
3347
3348
3349
3350 \section{Byte order macros}\label{byteordermacros}
3351
3352 The endian-ness issues (that is the difference between big-endian and
3353 little-endian architectures) are important for the portable programs working
3354 with the external binary data (for example, data files or data coming from
3355 network) which is usually in some fixed, platform-independent format. The
3356 macros are helpful for transforming the data to the correct format.
3357
3358
3359 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3360
3361 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3362
3363 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3364
3365 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3366
3367 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3368
3369 These macros will swap the bytes of the {\it value} variable from little
3370 endian to big endian or vice versa unconditionally, i.e. independently of the
3371 current platform.
3372
3373
3374 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3375
3376 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3377
3378 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3379
3380 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3381
3382 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3383
3384 This macro will swap the bytes of the {\it value} variable from little
3385 endian to big endian or vice versa if the program is compiled on a
3386 big-endian architecture (such as Sun work stations). If the program has
3387 been compiled on a little-endian architecture, the value will be unchanged.
3388
3389 Use these macros to read data from and write data to a file that stores
3390 data in little-endian (for example Intel i386) format.
3391
3392
3393 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3394
3395 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3396
3397 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3398
3399 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3400
3401 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3402
3403 This macro will swap the bytes of the {\it value} variable from little
3404 endian to big endian or vice versa if the program is compiled on a
3405 little-endian architecture (such as Intel PCs). If the program has
3406 been compiled on a big-endian architecture, the value will be unchanged.
3407
3408 Use these macros to read data from and write data to a file that stores
3409 data in big-endian format.
3410
3411
3412
3413 \section{RTTI functions}\label{rttimacros}
3414
3415 wxWidgets uses its own RTTI ("run-time type identification") system which
3416 predates the current standard C++ RTTI and so is kept for backwards
3417 compatibility reasons but also because it allows some things which the
3418 standard RTTI doesn't directly support (such as creating a class from its
3419 name).
3420
3421 The standard C++ RTTI can be used in the user code without any problems and in
3422 general you shouldn't need to use the functions and the macros in this section
3423 unless you are thinking of modifying or adding any wxWidgets classes.
3424
3425 \wxheading{See also}
3426
3427 \helpref{RTTI overview}{runtimeclassoverview}
3428
3429
3430 \membersection{CLASSINFO}\label{classinfo}
3431
3432 \func{wxClassInfo *}{CLASSINFO}{className}
3433
3434 Returns a pointer to the wxClassInfo object associated with this class.
3435
3436 \wxheading{Include files}
3437
3438 <wx/object.h>
3439
3440
3441 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3442
3443 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3444
3445 Used inside a class declaration to declare that the class should be
3446 made known to the class hierarchy, but objects of this class cannot be created
3447 dynamically. The same as DECLARE\_CLASS.
3448
3449 Example:
3450
3451 \begin{verbatim}
3452 class wxCommand: public wxObject
3453 {
3454 DECLARE_ABSTRACT_CLASS(wxCommand)
3455
3456 private:
3457 ...
3458 public:
3459 ...
3460 };
3461 \end{verbatim}
3462
3463 \wxheading{Include files}
3464
3465 <wx/object.h>
3466
3467
3468 \membersection{DECLARE\_APP}\label{declareapp}
3469
3470 \func{}{DECLARE\_APP}{className}
3471
3472 This is used in headers to create a forward declaration of the
3473 \helpref{wxGetApp}{wxgetapp} function implemented by
3474 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3475 {\tt className\& wxGetApp(void)}.
3476
3477 Example:
3478
3479 \begin{verbatim}
3480 DECLARE_APP(MyApp)
3481 \end{verbatim}
3482
3483 \wxheading{Include files}
3484
3485 <wx/app.h>
3486
3487
3488 \membersection{DECLARE\_CLASS}\label{declareclass}
3489
3490 \func{}{DECLARE\_CLASS}{className}
3491
3492 Used inside a class declaration to declare that the class should be
3493 made known to the class hierarchy, but objects of this class cannot be created
3494 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3495
3496 \wxheading{Include files}
3497
3498 <wx/object.h>
3499
3500
3501 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3502
3503 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3504
3505 Used inside a class declaration to make the class known to wxWidgets RTTI
3506 system and also declare that the objects of this class should be dynamically
3507 creatable from run-time type information. Notice that this implies that the
3508 class should have a default constructor, if this is not the case consider using
3509 \helpref{DECLARE\_CLASS}{declareclass}.
3510
3511 Example:
3512
3513 \begin{verbatim}
3514 class wxFrame: public wxWindow
3515 {
3516 DECLARE_DYNAMIC_CLASS(wxFrame)
3517
3518 private:
3519 const wxString& frameTitle;
3520 public:
3521 ...
3522 };
3523 \end{verbatim}
3524
3525 \wxheading{Include files}
3526
3527 <wx/object.h>
3528
3529
3530 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3531
3532 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3533
3534 Used in a C++ implementation file to complete the declaration of
3535 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3536
3537 Example:
3538
3539 \begin{verbatim}
3540 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3541
3542 wxCommand::wxCommand(void)
3543 {
3544 ...
3545 }
3546 \end{verbatim}
3547
3548 \wxheading{Include files}
3549
3550 <wx/object.h>
3551
3552
3553 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3554
3555 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3556
3557 Used in a C++ implementation file to complete the declaration of
3558 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3559
3560 \wxheading{Include files}
3561
3562 <wx/object.h>
3563
3564
3565 \membersection{IMPLEMENT\_APP}\label{implementapp}
3566
3567 \func{}{IMPLEMENT\_APP}{className}
3568
3569 This is used in the application class implementation file to make the application class known to
3570 wxWidgets for dynamic construction. You use this instead of
3571
3572 Old form:
3573
3574 \begin{verbatim}
3575 MyApp myApp;
3576 \end{verbatim}
3577
3578 New form:
3579
3580 \begin{verbatim}
3581 IMPLEMENT_APP(MyApp)
3582 \end{verbatim}
3583
3584 See also \helpref{DECLARE\_APP}{declareapp}.
3585
3586 \wxheading{Include files}
3587
3588 <wx/app.h>
3589
3590
3591 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3592
3593 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3594
3595 Used in a C++ implementation file to complete the declaration of
3596 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3597
3598 \wxheading{Include files}
3599
3600 <wx/object.h>
3601
3602
3603 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3604
3605 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3606
3607 Used in a C++ implementation file to complete the declaration of a
3608 class that has run-time type information and two base classes. The
3609 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3610
3611 \wxheading{Include files}
3612
3613 <wx/object.h>
3614
3615
3616 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3617
3618 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3619
3620 Used in a C++ implementation file to complete the declaration of
3621 a class that has run-time type information, and whose instances
3622 can be created dynamically.
3623
3624 Example:
3625
3626 \begin{verbatim}
3627 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3628
3629 wxFrame::wxFrame(void)
3630 {
3631 ...
3632 }
3633 \end{verbatim}
3634
3635 \wxheading{Include files}
3636
3637 <wx/object.h>
3638
3639
3640 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3641
3642 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3643
3644 Used in a C++ implementation file to complete the declaration of
3645 a class that has run-time type information, and whose instances
3646 can be created dynamically. Use this for classes derived from two
3647 base classes.
3648
3649 \wxheading{Include files}
3650
3651 <wx/object.h>
3652
3653
3654 \membersection{wxConstCast}\label{wxconstcast}
3655
3656 \func{classname *}{wxConstCast}{ptr, classname}
3657
3658 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3659 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3660
3661 \wxheading{See also}
3662
3663 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3664 \helpref{wxDynamicCast}{wxdynamiccast}\\
3665 \helpref{wxStaticCast}{wxstaticcast}
3666
3667
3668 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3669
3670 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3671
3672 Creates and returns an object of the given class, if the class has been
3673 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3674
3675
3676 \membersection{WXDEBUG\_NEW}\label{debugnew}
3677
3678 \func{}{WXDEBUG\_NEW}{arg}
3679
3680 This is defined in debug mode to be call the redefined new operator
3681 with filename and line number arguments. The definition is:
3682
3683 \begin{verbatim}
3684 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3685 \end{verbatim}
3686
3687 In non-debug mode, this is defined as the normal new operator.
3688
3689 \wxheading{Include files}
3690
3691 <wx/object.h>
3692
3693
3694 \membersection{wxDynamicCast}\label{wxdynamiccast}
3695
3696 \func{classname *}{wxDynamicCast}{ptr, classname}
3697
3698 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3699 the pointer is of this type (the check is done during the run-time) or
3700 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3701 wxObject::IsKindOf() function.
3702
3703 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3704 returned.
3705
3706 Example:
3707
3708 \begin{verbatim}
3709 wxWindow *win = wxWindow::FindFocus();
3710 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3711 if ( text )
3712 {
3713 // a text control has the focus...
3714 }
3715 else
3716 {
3717 // no window has the focus or it is not a text control
3718 }
3719 \end{verbatim}
3720
3721 \wxheading{See also}
3722
3723 \helpref{RTTI overview}{runtimeclassoverview}\\
3724 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3725 \helpref{wxConstCast}{wxconstcast}\\
3726 \helpref{wxStaticCast}{wxstaticcast}
3727
3728
3729 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3730
3731 \func{classname *}{wxDynamicCastThis}{classname}
3732
3733 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3734 latter provokes spurious compilation warnings from some compilers (because it
3735 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
3736 this macro should be used to avoid them.
3737
3738 \wxheading{See also}
3739
3740 \helpref{wxDynamicCast}{wxdynamiccast}
3741
3742
3743 \membersection{wxStaticCast}\label{wxstaticcast}
3744
3745 \func{classname *}{wxStaticCast}{ptr, classname}
3746
3747 This macro checks that the cast is valid in debug mode (an assert failure will
3748 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3749 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3750
3751 \wxheading{See also}
3752
3753 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3754 \helpref{wxDynamicCast}{wxdynamiccast}\\
3755 \helpref{wxConstCast}{wxconstcast}
3756
3757
3758 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3759
3760 \func{T}{wx\_const\_cast}{T, x}
3761
3762 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3763 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3764 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3765 arguments is the same as for the standard cast.
3766
3767 \wxheading{See also}
3768
3769 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3770 \helpref{wx\_static\_cast}{wxstaticcastraw}
3771
3772
3773 \membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
3774
3775 \func{T}{wx\_reinterpret\_cast}{T, x}
3776
3777 Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
3778 \texttt{(T)x} for old compilers.
3779
3780 \wxheading{See also}
3781
3782 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3783 \helpref{wx\_static\_cast}{wxstaticcastraw}
3784
3785
3786 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3787
3788 \func{T}{wx\_static\_cast}{T, x}
3789
3790 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3791 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3792 there are no checks being done and the meaning of the macro arguments is exactly
3793 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3794 star is not appended to it.
3795
3796 \wxheading{See also}
3797
3798 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3799 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3800 \helpref{wx\_truncate\_cast}{wxtruncatecast}
3801
3802
3803 \membersection{wx\_truncate\_cast}\label{wxtruncatecast}
3804
3805 \func{T}{wx\_truncate\_cast}{T, x}
3806
3807 This case doesn't correspond to any standard cast but exists solely to make
3808 casts which possibly result in a truncation of an integer value more readable.
3809
3810 \wxheading{See also}
3811
3812 \helpref{wx\_static\_cast}{wxstaticcastraw}
3813
3814
3815 \section{Log functions}\label{logfunctions}
3816
3817 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3818 further information. The functions use (implicitly) the currently active log
3819 target, so their descriptions here may not apply if the log target is not the
3820 standard one (installed by wxWidgets in the beginning of the program).
3821
3822 \wxheading{Include files}
3823
3824 <wx/log.h>
3825
3826
3827 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3828
3829 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3830
3831 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3832 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3833
3834 Display a debugging message; under Windows, this will appear on the
3835 debugger command window, and under Unix, it will be written to standard
3836 error.
3837
3838 The syntax is identical to {\bf printf}: pass a format string and a
3839 variable list of arguments.
3840
3841 {\bf Tip:} under Windows, if your application crashes before the
3842 message appears in the debugging window, put a wxYield call after
3843 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3844 (at least for Watcom C++): preformat your messages and use OutputDebugString
3845 instead.
3846
3847 \wxheading{Include files}
3848
3849 <wx/utils.h>
3850
3851
3852 \membersection{::wxError}\label{wxerror}
3853
3854 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
3855
3856 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3857 instead.
3858
3859 Displays {\it msg} and continues. This writes to standard error under
3860 Unix, and pops up a message box under Windows. Used for internal
3861 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
3862
3863 \wxheading{Include files}
3864
3865 <wx/utils.h>
3866
3867
3868 \membersection{::wxFatalError}\label{wxfatalerror}
3869
3870 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
3871
3872 {\bf NB:} This function is now obsolete, please use
3873 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3874
3875 Displays {\it msg} and exits. This writes to standard error under Unix,
3876 and pops up a message box under Windows. Used for fatal internal
3877 wxWidgets errors. See also \helpref{wxError}{wxerror}.
3878
3879 \wxheading{Include files}
3880
3881 <wx/utils.h>
3882
3883
3884 \membersection{::wxLogError}\label{wxlogerror}
3885
3886 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
3887
3888 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3889
3890 The functions to use for error messages, i.e. the messages that must be shown
3891 to the user. The default processing is to pop up a message box to inform the
3892 user about it.
3893
3894
3895 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
3896
3897 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
3898
3899 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3900
3901 Like \helpref{wxLogError}{wxlogerror}, but also
3902 terminates the program with the exit code 3. Using {\it abort()} standard
3903 function also terminates the program with this exit code.
3904
3905
3906 \membersection{::wxLogWarning}\label{wxlogwarning}
3907
3908 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
3909
3910 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3911
3912 For warnings - they are also normally shown to the user, but don't interrupt
3913 the program work.
3914
3915
3916 \membersection{::wxLogMessage}\label{wxlogmessage}
3917
3918 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
3919
3920 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3921
3922 For all normal, informational messages. They also appear in a message box by
3923 default (but it can be changed).
3924
3925 \membersection{::wxLogVerbose}\label{wxlogverbose}
3926
3927 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
3928
3929 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3930
3931 For verbose output. Normally, it is suppressed, but
3932 might be activated if the user wishes to know more details about the program
3933 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
3934
3935
3936 \membersection{::wxLogStatus}\label{wxlogstatus}
3937
3938 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
3939
3940 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3941
3942 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
3943
3944 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3945
3946 Messages logged by these functions will appear in the statusbar of the {\it
3947 frame} or of the top level application window by default (i.e. when using
3948 the second version of the functions).
3949
3950 If the target frame doesn't have a statusbar, the message will be lost.
3951
3952
3953 \membersection{::wxLogSysError}\label{wxlogsyserror}
3954
3955 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
3956
3957 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3958
3959 Mostly used by wxWidgets itself, but might be handy for logging errors after
3960 system call (API function) failure. It logs the specified message text as well
3961 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
3962 on the platform) and the corresponding error message. The second form
3963 of this function takes the error code explicitly as the first argument.
3964
3965 \wxheading{See also}
3966
3967 \helpref{wxSysErrorCode}{wxsyserrorcode},
3968 \helpref{wxSysErrorMsg}{wxsyserrormsg}
3969
3970
3971 \membersection{::wxLogDebug}\label{wxlogdebug}
3972
3973 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
3974
3975 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3976
3977 The right functions for debug output. They only do something in debug
3978 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
3979 nothing in release mode (otherwise).
3980
3981
3982 \membersection{::wxLogTrace}\label{wxlogtrace}
3983
3984 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
3985
3986 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3987
3988 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
3989
3990 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3991
3992 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
3993
3994 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3995
3996 As {\bf wxLogDebug}, trace functions only do something in debug build and
3997 expand to nothing in the release one. The reason for making
3998 it a separate function from it is that usually there are a lot of trace
3999 messages, so it might make sense to separate them from other debug messages.
4000
4001 The trace messages also usually can be separated into different categories and
4002 the second and third versions of this function only log the message if the
4003 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
4004 allows to selectively trace only some operations and not others by changing
4005 the value of the trace mask (possible during the run-time).
4006
4007 For the second function (taking a string mask), the message is logged only if
4008 the mask has been previously enabled by the call to
4009 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
4010 \helpref{{\tt WXTRACE} environment variable}{envvars}.
4011 The predefined string trace masks
4012 used by wxWidgets are:
4013
4014 \begin{itemize}\itemsep=0pt
4015 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
4016 \item wxTRACE\_Messages: trace window messages/X callbacks
4017 \item wxTRACE\_ResAlloc: trace GDI resource allocation
4018 \item wxTRACE\_RefCount: trace various ref counting operations
4019 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
4020 \end{itemize}
4021
4022 {\bf Caveats:} since both the mask and the format string are strings,
4023 this might lead to function signature confusion in some cases:
4024 if you intend to call the format string only version of wxLogTrace,
4025 then add a \%s format string parameter and then supply a second string parameter for that \%s, the string mask version of wxLogTrace will erroneously get called instead, since you are supplying two string parameters to the function.
4026 In this case you'll unfortunately have to avoid having two leading
4027 string parameters, e.g. by adding a bogus integer (with its \%d format string).
4028
4029 The third version of the function only logs the message if all the bits
4030 corresponding to the {\it mask} are set in the wxLog trace mask which can be
4031 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
4032 flexible than the previous one because it doesn't allow defining the user
4033 trace masks easily - this is why it is deprecated in favour of using string
4034 trace masks.
4035
4036 \begin{itemize}\itemsep=0pt
4037 \item wxTraceMemAlloc: trace memory allocation (new/delete)
4038 \item wxTraceMessages: trace window messages/X callbacks
4039 \item wxTraceResAlloc: trace GDI resource allocation
4040 \item wxTraceRefCount: trace various ref counting operations
4041 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
4042 \end{itemize}
4043
4044
4045 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
4046
4047 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
4048
4049 This function shows a message to the user in a safe way and should be safe to
4050 call even before the application has been initialized or if it is currently in
4051 some other strange state (for example, about to crash). Under Windows this
4052 function shows a message box using a native dialog instead of
4053 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
4054 it simply prints the message to the standard output using the title as prefix.
4055
4056 \wxheading{Parameters}
4057
4058 \docparam{title}{The title of the message box shown to the user or the prefix
4059 of the message string}
4060
4061 \docparam{text}{The text to show to the user}
4062
4063 \wxheading{See also}
4064
4065 \helpref{wxLogFatalError}{wxlogfatalerror}
4066
4067 \wxheading{Include files}
4068
4069 <wx/log.h>
4070
4071
4072 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
4073
4074 \func{unsigned long}{wxSysErrorCode}{\void}
4075
4076 Returns the error code from the last system call. This function uses
4077 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
4078
4079 \wxheading{See also}
4080
4081 \helpref{wxSysErrorMsg}{wxsyserrormsg},
4082 \helpref{wxLogSysError}{wxlogsyserror}
4083
4084
4085 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
4086
4087 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
4088
4089 Returns the error message corresponding to the given system error code. If
4090 {\it errCode} is $0$ (default), the last error code (as returned by
4091 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
4092
4093 \wxheading{See also}
4094
4095 \helpref{wxSysErrorCode}{wxsyserrorcode},
4096 \helpref{wxLogSysError}{wxlogsyserror}
4097
4098
4099 \membersection{WXTRACE}\label{trace}
4100
4101 \wxheading{Include files}
4102
4103 <wx/object.h>
4104
4105 \func{}{WXTRACE}{formatString, ...}
4106
4107 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4108
4109 Calls wxTrace with printf-style variable argument syntax. Output
4110 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4111
4112 \wxheading{Include files}
4113
4114 <wx/memory.h>
4115
4116
4117 \membersection{WXTRACELEVEL}\label{tracelevel}
4118
4119 \func{}{WXTRACELEVEL}{level, formatString, ...}
4120
4121 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4122
4123 Calls wxTraceLevel with printf-style variable argument syntax. Output
4124 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4125 The first argument should be the level at which this information is appropriate.
4126 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4127 this value.
4128
4129 \wxheading{Include files}
4130
4131 <wx/memory.h>
4132
4133
4134 \membersection{::wxTrace}\label{wxtrace}
4135
4136 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
4137
4138 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4139
4140 Takes printf-style variable argument syntax. Output
4141 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4142
4143 \wxheading{Include files}
4144
4145 <wx/memory.h>
4146
4147
4148 \membersection{::wxTraceLevel}\label{wxtracelevel}
4149
4150 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
4151
4152 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4153
4154 Takes printf-style variable argument syntax. Output
4155 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4156 The first argument should be the level at which this information is appropriate.
4157 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4158 this value.
4159
4160 \wxheading{Include files}
4161
4162 <wx/memory.h>
4163
4164
4165
4166 \section{Time functions}\label{timefunctions}
4167
4168 The functions in this section deal with getting the current time and
4169 starting/stopping the global timers. Please note that the timer functions are
4170 deprecated because they work with one global timer only and
4171 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
4172 should be used instead. For retrieving the current time, you may also use
4173 \helpref{wxDateTime::Now}{wxdatetimenow} or
4174 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
4175
4176
4177 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
4178
4179 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
4180
4181 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
4182
4183 If {\it resetTimer} is true (the default), the timer is reset to zero
4184 by this call.
4185
4186 See also \helpref{wxTimer}{wxtimer}.
4187
4188 \wxheading{Include files}
4189
4190 <wx/timer.h>
4191
4192
4193 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
4194
4195 \func{long}{wxGetLocalTime}{\void}
4196
4197 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
4198
4199 \wxheading{See also}
4200
4201 \helpref{wxDateTime::Now}{wxdatetimenow}
4202
4203 \wxheading{Include files}
4204
4205 <wx/timer.h>
4206
4207
4208 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
4209
4210 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
4211
4212 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
4213
4214 \wxheading{See also}
4215
4216 \helpref{wxDateTime::Now}{wxdatetimenow},\\
4217 \helpref{wxLongLong}{wxlonglong}
4218
4219 \wxheading{Include files}
4220
4221 <wx/timer.h>
4222
4223
4224 \membersection{::wxGetUTCTime}\label{wxgetutctime}
4225
4226 \func{long}{wxGetUTCTime}{\void}
4227
4228 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
4229
4230 \wxheading{See also}
4231
4232 \helpref{wxDateTime::Now}{wxdatetimenow}
4233
4234 \wxheading{Include files}
4235
4236 <wx/timer.h>
4237
4238
4239 \membersection{::wxMicroSleep}\label{wxmicrosleep}
4240
4241 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
4242
4243 Sleeps for the specified number of microseconds. The microsecond resolution may
4244 not, in fact, be available on all platforms (currently only Unix platforms with
4245 nanosleep(2) may provide it) in which case this is the same as
4246 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
4247
4248 \wxheading{Include files}
4249
4250 <wx/utils.h>
4251
4252
4253 \membersection{::wxMilliSleep}\label{wxmillisleep}
4254
4255 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
4256
4257 Sleeps for the specified number of milliseconds. Notice that usage of this
4258 function is encouraged instead of calling usleep(3) directly because the
4259 standard usleep() function is not MT safe.
4260
4261 \wxheading{Include files}
4262
4263 <wx/utils.h>
4264
4265
4266 \membersection{::wxNow}\label{wxnow}
4267
4268 \func{wxString}{wxNow}{\void}
4269
4270 Returns a string representing the current date and time.
4271
4272 \wxheading{Include files}
4273
4274 <wx/utils.h>
4275
4276
4277 \membersection{::wxSleep}\label{wxsleep}
4278
4279 \func{void}{wxSleep}{\param{int}{ secs}}
4280
4281 Sleeps for the specified number of seconds.
4282
4283 \wxheading{Include files}
4284
4285 <wx/utils.h>
4286
4287
4288 \membersection{::wxStartTimer}\label{wxstarttimer}
4289
4290 \func{void}{wxStartTimer}{\void}
4291
4292 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
4293
4294 See also \helpref{wxTimer}{wxtimer}.
4295
4296 \wxheading{Include files}
4297
4298 <wx/timer.h>
4299
4300
4301 \membersection{::wxUsleep}\label{wxusleep}
4302
4303 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
4304
4305 This function is deprecated because its name is misleading: notice that the
4306 argument is in milliseconds, not microseconds. Please use either
4307 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
4308 depending on the resolution you need.
4309
4310
4311
4312 \section{Debugging macros and functions}\label{debugmacros}
4313
4314 Useful macros and functions for error checking and defensive programming.
4315 wxWidgets defines three families of the assert-like macros:
4316 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
4317 (in other words, in the debug build) but disappear completely in the release
4318 build. On the other hand, the wxCHECK macros stay event in release builds but a
4319 check failure doesn't generate any user-visible effects then. Finally, the
4320 compile time assertions don't happen during the run-time but result in the
4321 compilation error messages if the condition they check fail.
4322
4323 \wxheading{Include files}
4324
4325 <wx/debug.h>
4326
4327
4328 \membersection{::wxOnAssert}\label{wxonassert}
4329
4330 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
4331
4332 This function is called whenever one of debugging macros fails (i.e. condition
4333 is false in an assertion). It is only defined in the debug mode, in release
4334 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
4335
4336 To override the default behaviour in the debug builds which is to show the user
4337 a dialog asking whether he wants to abort the program, continue or continue
4338 ignoring any subsequent assert failures, you may override
4339 \helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if
4340 the global application object exists.
4341
4342
4343 \membersection{wxASSERT}\label{wxassert}
4344
4345 \func{}{wxASSERT}{\param{}{condition}}
4346
4347 Assert macro. An error message will be generated if the condition is false in
4348 debug mode, but nothing will be done in the release build.
4349
4350 Please note that the condition in wxASSERT() should have no side effects
4351 because it will not be executed in release mode at all.
4352
4353 \wxheading{See also}
4354
4355 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4356 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4357
4358
4359 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
4360
4361 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
4362
4363 This macro results in a
4364 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
4365 of the given type {\it type} is less than {\it size} bits.
4366
4367 You may use it like this, for example:
4368
4369 \begin{verbatim}
4370 // we rely on the int being able to hold values up to 2^32
4371 wxASSERT_MIN_BITSIZE(int, 32);
4372
4373 // can't work with the platforms using UTF-8 for wchar_t
4374 wxASSERT_MIN_BITSIZE(wchar_t, 16);
4375 \end{verbatim}
4376
4377
4378 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
4379
4380 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
4381
4382 Assert macro with message. An error message will be generated if the condition is false.
4383
4384 \wxheading{See also}
4385
4386 \helpref{wxASSERT}{wxassert},\\
4387 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4388
4389
4390 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4391
4392 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4393
4394 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4395 specified {\it condition} is false. The compiler error message should include
4396 the {\it msg} identifier - please note that it must be a valid C++ identifier
4397 and not a string unlike in the other cases.
4398
4399 This macro is mostly useful for testing the expressions involving the
4400 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4401 sometimes desirable to test them at the compile time.
4402
4403 Note that this macro internally declares a struct whose name it tries to make
4404 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4405 use it on the same line in two different source files. In this case you may
4406 either change the line in which either of them appears on or use the
4407 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4408
4409 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4410 if you use this macro with `Program Database For Edit And Continue'
4411 (\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
4412 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4413
4414 \wxheading{See also}
4415
4416 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4417 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4418
4419
4420 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4421
4422 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4423
4424 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4425 except that it allows you to specify a unique {\it name} for the struct
4426 internally defined by this macro to avoid getting the compilation errors
4427 described \helpref{above}{wxcompiletimeassert}.
4428
4429
4430 \membersection{wxFAIL}\label{wxfail}
4431
4432 \func{}{wxFAIL}{\void}
4433
4434 Will always generate an assert error if this code is reached (in debug mode).
4435
4436 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4437
4438
4439 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4440
4441 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4442
4443 Will always generate an assert error with specified message if this code is reached (in debug mode).
4444
4445 This macro is useful for marking unreachable" code areas, for example
4446 it may be used in the "default:" branch of a switch statement if all possible
4447 cases are processed above.
4448
4449 \wxheading{See also}
4450
4451 \helpref{wxFAIL}{wxfail}
4452
4453
4454 \membersection{wxCHECK}\label{wxcheck}
4455
4456 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4457
4458 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4459 This check is done even in release mode.
4460
4461
4462 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4463
4464 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4465
4466 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4467 This check is done even in release mode.
4468
4469 This macro may be only used in non void functions, see also
4470 \helpref{wxCHECK\_RET}{wxcheckret}.
4471
4472
4473 \membersection{wxCHECK\_RET}\label{wxcheckret}
4474
4475 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4476
4477 Checks that the condition is true, and returns if not (FAILs with given error
4478 message in debug mode). This check is done even in release mode.
4479
4480 This macro should be used in void functions instead of
4481 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4482
4483
4484 \membersection{wxCHECK2}\label{wxcheck2}
4485
4486 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4487
4488 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4489 {\it operation} if it is not. This is a generalisation of
4490 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4491 returning from the function must be done when the {\it condition} is false.
4492
4493 This check is done even in release mode.
4494
4495
4496 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4497
4498 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4499
4500 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4501 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4502 instead of wxFAIL() if the {\it condition} is false.
4503
4504
4505 \membersection{::wxTrap}\label{wxtrap}
4506
4507 \func{void}{wxTrap}{\void}
4508
4509 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4510 debugger exception meaning that the control is passed to the debugger if one is
4511 attached to the process. Otherwise the program just terminates abnormally.
4512
4513 In release mode this function does nothing.
4514
4515 \wxheading{Include files}
4516
4517 <wx/debug.h>
4518
4519
4520
4521 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4522
4523 \func{bool}{wxIsDebuggerRunning}{\void}
4524
4525 Returns \true if the program is running under debugger, \false otherwise.
4526
4527 Please note that this function is currently only implemented for Win32 and Mac
4528 builds using CodeWarrior and always returns \false elsewhere.
4529
4530
4531
4532
4533 \section{Environment access functions}\label{environfunctions}
4534
4535 The functions in this section allow to access (get) or change value of
4536 environment variables in a portable way. They are currently implemented under
4537 Win32 and POSIX-like systems (Unix).
4538
4539 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4540
4541 \wxheading{Include files}
4542
4543 <wx/utils.h>
4544
4545
4546 \membersection{wxGetenv}\label{wxgetenvmacro}
4547
4548 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4549
4550 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4551 mode.
4552
4553 Note that under Win32 it may not return correct value for the variables set
4554 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4555 instead.
4556
4557
4558 \membersection{wxGetEnv}\label{wxgetenv}
4559
4560 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4561
4562 Returns the current value of the environment variable {\it var} in {\it value}.
4563 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4564 and are not interested in its value.
4565
4566 Returns \true if the variable exists, \false otherwise.
4567
4568
4569 \membersection{wxSetEnv}\label{wxsetenv}
4570
4571 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4572
4573 Sets the value of the environment variable {\it var} (adding it if necessary)
4574 to {\it value}.
4575
4576 Returns \true on success.
4577
4578
4579 \membersection{wxUnsetEnv}\label{wxunsetenv}
4580
4581 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4582
4583 Removes the variable {\it var} from the environment.
4584 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4585 function.
4586
4587 Returns \true on success.