1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions and macros defined in wxWidgets are described here: you can
6 either look up a function using the alphabetical listing of them or find it in
7 the corresponding topic.
9 \section{Alphabetical functions and macros list
}\label{functionsalphabetically
}
11 \helpref{CLASSINFO
}{classinfo
}\\
12 \helpref{copystring
}{copystring
}\\
13 \helpref{DECLARE
\_ABSTRACT\_CLASS}{declareabstractclass
}\\
14 \helpref{DECLARE
\_APP}{declareapp
}\\
15 \helpref{DECLARE
\_CLASS}{declareclass
}\\
16 \helpref{DECLARE
\_DYNAMIC\_CLASS}{declaredynamicclass
}\\
17 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS2}{implementabstractclass2
}\\
18 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS}{implementabstractclass
}\\
19 \helpref{IMPLEMENT
\_APP}{implementapp
}\\
20 \helpref{IMPLEMENT
\_CLASS2}{implementclass2
}\\
21 \helpref{IMPLEMENT
\_CLASS}{implementclass
}\\
22 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS2}{implementdynamicclass2
}\\
23 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS}{implementdynamicclass
}\\
24 \helpref{wxCONCAT
}{wxconcat
}\\
25 \helpref{WXDEBUG
\_NEW}{debugnew
}\\
26 \helpref{WXTRACELEVEL
}{tracelevel
}\\
27 \helpref{WXTRACE
}{trace
}\\
28 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
29 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
30 \helpref{wxASSERT
}{wxassert
}\\
31 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
32 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
33 \helpref{wxBell
}{wxbell
}\\
34 \helpref{wxCHANGE
\_UMASK}{wxchangeumask
}\\
35 \helpref{wxCHECK
}{wxcheck
}\\
36 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
37 \helpref{wxCHECK2
}{wxcheck2
}\\
38 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
39 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
40 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
41 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
42 \helpref{wxCHECK
\_VERSION\_FULL}{wxcheckversionfull
}\\
43 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
44 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
45 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
46 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
47 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
48 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
49 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
50 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
51 \helpref{wxConstCast
}{wxconstcast
}\\
52 \helpref{wxCopyFile
}{wxcopyfile
}\\
53 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
54 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
55 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}\\
56 \helpref{wxCRIT
\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember
}\\
57 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}\\
58 \helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
}\\
% wxcs already taken!
59 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
60 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
61 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
62 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
63 \helpref{wxDirExists
}{functionwxdirexists
}\\
64 \helpref{wxDirSelector
}{wxdirselector
}\\
65 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
66 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
67 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
68 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
69 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
70 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
71 \helpref{wxDYNLIB
\_FUNCTION}{wxdynlibfunction
}\\
72 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
73 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
74 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
75 \helpref{wxENTER
\_CRIT\_SECT}{wxentercritsect
}\\
76 \helpref{wxEntry
}{wxentry
}\\
77 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
78 \helpref{wxError
}{wxerror
}\\
79 \helpref{wxExecute
}{wxexecute
}\\
80 \helpref{wxExit
}{wxexit
}\\
81 \helpref{wxEXPLICIT
}{wxexplicit
}\\
82 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
83 \helpref{wxFAIL
}{wxfail
}\\
84 \helpref{wxFatalError
}{wxfatalerror
}\\
85 \helpref{wxFileExists
}{functionwxfileexists
}\\
86 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
87 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
88 \helpref{wxFileSelector
}{wxfileselector
}\\
89 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
90 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
91 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
92 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
93 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
94 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
95 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
96 \helpref{wxFinite
}{wxfinite
}\\
97 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
98 \helpref{wxGetApp
}{wxgetapp
}\\
99 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
100 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
101 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
102 \helpref{wxGetCwd
}{wxgetcwd
}\\
103 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
104 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
105 \helpref{wxGetDisplaySize
}{wxdisplaysize
}\\
106 \helpref{wxGetDisplaySizeMM
}{wxdisplaysizemm
}\\
107 \helpref{wxGetElapsedTime
}{wxgetelapsedtime
}\\
108 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
109 \helpref{wxGetEnv
}{wxgetenv
}\\
110 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
111 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
112 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
113 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
114 \helpref{wxGetHostName
}{wxgethostname
}\\
115 \helpref{wxGetKeyState
}{wxgetkeystate
}\\
116 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
117 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
118 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
119 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
120 \helpref{wxGetMultipleChoice
}{wxgetmultiplechoice
}\\
121 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
122 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
123 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
124 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
125 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
126 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
127 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
128 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
129 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
130 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
131 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
132 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
133 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
134 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
135 \helpref{wxGetResource
}{wxgetresource
}\\
136 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
137 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
138 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
139 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
140 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
141 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
142 \helpref{wxGetTranslation
}{wxgettranslation
}\\
143 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
144 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
145 \helpref{wxGetUserId
}{wxgetuserid
}\\
146 \helpref{wxGetUserName
}{wxgetusername
}\\
147 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
148 \helpref{wxGetenv
}{wxgetenvmacro
}\\
149 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
150 \helpref{wxICON
}{wxiconmacro
}\\
151 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
152 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
153 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
154 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
155 \helpref{wxInitialize
}{wxinitialize
}\\
156 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
157 \helpref{wxIsBusy
}{wxisbusy
}\\
158 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
159 \helpref{wxIsDebuggerRunning
}{wxisdebuggerrunning
}\\
160 \helpref{wxIsEmpty
}{wxisempty
}\\
161 \helpref{wxIsMainThread
}{wxismainthread
}\\
162 \helpref{wxIsNaN
}{wxisnan
}\\
163 \helpref{wxIsWild
}{wxiswild
}\\
164 \helpref{wxKill
}{wxkill
}\\
165 \helpref{wxLEAVE
\_CRIT\_SECT}{wxleavecritsect
}\\
166 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
167 \helpref{wxLogDebug
}{wxlogdebug
}\\
168 \helpref{wxLogError
}{wxlogerror
}\\
169 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
170 \helpref{wxLogMessage
}{wxlogmessage
}\\
171 \helpref{wxLogStatus
}{wxlogstatus
}\\
172 \helpref{wxLogSysError
}{wxlogsyserror
}\\
173 \helpref{wxLogTrace
}{wxlogtrace
}\\
174 \helpref{wxLogVerbose
}{wxlogverbose
}\\
175 \helpref{wxLogWarning
}{wxlogwarning
}\\
176 \helpref{wxLL
}{wxll
}\\
177 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
178 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
179 \helpref{wxMatchWild
}{wxmatchwild
}\\
180 \helpref{wxMessageBox
}{wxmessagebox
}\\
181 \helpref{wxMilliSleep
}{wxmillisleep
}\\
182 \helpref{wxMicroSleep
}{wxmicrosleep
}\\
183 \helpref{wxMkdir
}{wxmkdir
}\\
184 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
185 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
186 \helpref{wxNewId
}{wxnewid
}\\
187 \helpref{wxNow
}{wxnow
}\\
188 \helpref{wxOnAssert
}{wxonassert
}\\
189 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
190 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
191 \helpref{wxPathOnly
}{wxpathonly
}\\
192 \helpref{wxPostDelete
}{wxpostdelete
}\\
193 \helpref{wxPostEvent
}{wxpostevent
}\\
194 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
195 \helpref{wxRegisterId
}{wxregisterid
}\\
196 \helpref{wxRemoveFile
}{wxremovefile
}\\
197 \helpref{wxRenameFile
}{wxrenamefile
}\\
198 \helpref{wxRmdir
}{wxrmdir
}\\
199 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
200 \helpref{wxSafeYield
}{wxsafeyield
}\\
201 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
202 \helpref{wxSetCursor
}{wxsetcursor
}\\
203 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
204 \helpref{wxSetEnv
}{wxsetenv
}\\
205 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
206 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
207 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
208 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
209 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
210 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
211 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
212 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
213 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
214 \helpref{wxShell
}{wxshell
}\\
215 \helpref{wxShowTip
}{wxshowtip
}\\
216 \helpref{wxShutdown
}{wxshutdown
}\\
217 \helpref{wxSleep
}{wxsleep
}\\
218 \helpref{wxSnprintf
}{wxsnprintf
}\\
219 \helpref{wxSplitPath
}{wxsplitfunction
}\\
220 \helpref{wxStartTimer
}{wxstarttimer
}\\
221 \helpref{wxStaticCast
}{wxstaticcast
}\\
222 \helpref{wxStrcmp
}{wxstrcmp
}\\
223 \helpref{wxStricmp
}{wxstricmp
}\\
224 \helpref{wxStringEq
}{wxstringeq
}\\
225 \helpref{wxStringMatch
}{wxstringmatch
}\\
226 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
227 \helpref{wxStrlen
}{wxstrlen
}\\
228 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
229 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
231 \helpref{wxTraceLevel
}{wxtracelevel
}\\
232 \helpref{wxTrace
}{wxtrace
}\\
233 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
234 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
235 \helpref{wxTrap
}{wxtrap
}\\
236 \helpref{wxULL
}{wxull
}\\
237 \helpref{wxUninitialize
}{wxuninitialize
}\\
238 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
239 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
240 \helpref{wxUsleep
}{wxusleep
}\\
241 \helpref{wxVaCopy
}{wxvacopy
}\\
242 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
243 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
244 \helpref{wxWriteResource
}{wxwriteresource
}\\
245 \helpref{wxYield
}{wxyield
}\\
246 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
247 \helpref{wx
\_reinterpret\_cast}{wxreinterpretcastraw
}\\
248 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
249 \helpref{\_}{underscore
}\\
250 \helpref{\_T}{underscoret
}
254 \section{Version macros
}\label{versionfunctions
}
256 The following constants are defined in wxWidgets:
258 \begin{itemize
}\itemsep=
0pt
259 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
260 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
261 \item {\tt wxRELEASE
\_NUMBER} is the release number
262 \item {\tt wxSUBRELEASE
\_NUMBER} is the subrelease number which is $
0$ for all
266 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
269 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
270 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
271 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
274 The subrelease number is only used for the sources in between official releases
275 and so normally is not useful.
277 \wxheading{Include files
}
279 <wx/version.h> or <wx/defs.h>
282 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
284 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
286 Returns $
1$ if the compiler being used to compile the code is GNU C++
287 compiler (g++) version major.minor.release or greater. Otherwise, and also if
288 the compiler is not GNU C++ at all, returns $
0$.
291 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
293 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
295 This is a macro which evaluates to true if the current wxWidgets version is at
296 least major.minor.release.
298 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
299 the following can be done:
303 #if wxCHECK_VERSION(
2,
2,
0)
304 if ( s.StartsWith("foo") )
305 #else // replacement code for old version
306 if ( strncmp(s, "foo",
3) ==
0 )
314 \membersection{wxCHECK
\_VERSION\_FULL}\label{wxcheckversionfull
}
316 \func{bool
}{wxCHECK
\_VERSION\_FULL}{\param{}{major, minor, release, subrel
}}
318 Same as
\helpref{wxCHECK
\_VERSION}{wxcheckversion
} but also checks that
319 \texttt{wxSUBRELEASE
\_NUMBER} is at least
\arg{subrel
}.
322 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
324 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
326 Returns $
1$ if the version of w32api headers used is major.minor.release or
327 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
328 Win32 at all, returns $
0$.
332 \section{Application initialization and termination
}\label{appinifunctions
}
334 The functions in this section are used on application startup/shutdown and also
335 to control the behaviour of the main event loop of the GUI programs.
338 \membersection{::wxEntry
}\label{wxentry
}
340 This initializes wxWidgets in a platform-dependent way. Use this if you
341 are not using the default wxWidgets entry code (e.g. main or WinMain). For example,
342 you can initialize wxWidgets from an Microsoft Foundation Classes application using
345 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
346 \param{const wxString\&
}{commandLine
},
\param{int
}{ cmdShow
},
\param{bool
}{ enterLoop = true
}}
348 wxWidgets initialization under Windows (non-DLL). If
{\it enterLoop
} is false, the
349 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets
350 message loop will be entered.
352 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
353 \param{WORD
}{ wDataSegment
},
\param{WORD
}{ wHeapSize
},
\param{const wxString\&
}{ commandLine
}}
355 wxWidgets initialization under Windows (for applications constructed as a DLL).
357 \func{int
}{wxEntry
}{\param{int
}{ argc
},
\param{const wxString\& *
}{argv
}}
359 wxWidgets initialization under Unix.
363 To clean up wxWidgets, call wxApp::OnExit followed by the static function
364 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
367 int CTheApp::ExitInstance()
369 // OnExit isn't called by CleanUp so must be called explicitly.
373 return CWinApp::ExitInstance();
377 \wxheading{Include files
}
383 \membersection{::wxGetApp
}\label{wxgetapp
}
385 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
387 This function doesn't exist in wxWidgets but it is created by using
388 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
389 anywhere but in the same module where this macro is used, you must make it
390 available using
\helpref{DECLARE
\_APP}{declareapp
}.
392 The advantage of using this function compared to directly using the global
393 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
394 allow you to access the functions specific to your application class but not
395 present in wxApp while wxGetApp() returns the object of the right type.
398 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
400 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
402 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
403 faults under Windows or segmentation violations in the Unix world) will be
404 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
405 By default, i.e. before this function is called, they will be handled in the
406 normal way which usually just means that the application will be terminated.
407 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
408 this default behaviour.
411 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
413 \func{void
}{wxInitAllImageHandlers
}{\void}
415 Initializes all available image handlers. For a list of available handlers,
416 see
\helpref{wxImage
}{wximage
}.
420 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
422 \wxheading{Include files
}
427 \membersection{::wxInitialize
}\label{wxinitialize
}
429 \func{bool
}{wxInitialize
}{\void}
431 This function is used in wxBase only and only if you don't create
432 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
433 {\tt main()
} function before calling any other wxWidgets functions.
435 If the function returns
{\tt false
} the initialization could not be performed,
436 in this case the library cannot be used and
437 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
439 This function may be called several times but
440 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
441 call to this function.
443 \wxheading{Include files
}
448 \membersection{::wxSafeYield
}\label{wxsafeyield
}
450 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
451 onlyIfNeeded = false
}}
453 This function is similar to wxYield, except that it disables the user input to
454 all program windows before calling wxYield and re-enables it again
455 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
456 allowing the implementation of some limited user interaction.
458 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
460 \wxheading{Include files
}
465 \membersection{::wxUninitialize
}\label{wxuninitialize
}
467 \func{void
}{wxUninitialize
}{\void}
469 This function is for use in console (wxBase) programs only. It must be called
470 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
472 \wxheading{Include files
}
477 \membersection{::wxYield
}\label{wxyield
}
479 \func{bool
}{wxYield
}{\void}
481 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
483 This function is kept only for backwards compatibility. Please use
484 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
486 \wxheading{Include files
}
488 <wx/app.h> or <wx/utils.h>
491 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
493 \func{void
}{wxWakeUpIdle
}{\void}
495 This functions wakes up the (internal and platform dependent) idle system, i.e. it
496 will force the system to send an idle event even if the system currently
{\it is
}
497 idle and thus would not send any idle event until after some other event would get
498 sent. This is also useful for sending events between two threads and is used by
499 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
500 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
502 \wxheading{Include files
}
508 \section{Process control functions
}\label{processfunctions
}
510 The functions in this section are used to launch or terminate the other
514 \membersection{::wxExecute
}\label{wxexecute
}
516 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
518 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
520 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
522 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
524 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
}}
526 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
527 only takes the
{\tt command
} argument,
528 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
531 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
}}
533 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
534 and it only takes the
{\tt command
} argument,
535 and returns a
3-element list
{\tt ( status, output, errors )
}, where
536 {\tt output
} and
{\tt errors
} are array references.
}
538 Executes another program in Unix or Windows.
540 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
542 The second form takes an array of values: a command, any number of
543 arguments, terminated by NULL.
545 The semantics of the third and fourth versions is different from the first two
546 and is described in more details below.
548 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
549 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
550 application waits until the other program has terminated.
552 In the case of synchronous execution, the return value is the exit code of
553 the process (which terminates by the moment the function returns) and will be
554 $-
1$ if the process couldn't be started and typically
0 if the process
555 terminated successfully. Also, while waiting for the process to
556 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. Because of this, by
557 default this function disables all application windows to avoid unexpected
558 reentrancies which could result from the users interaction with the program
559 while the child process is running. If you are sure that it is safe to not
560 disable the program windows, you may pass
\texttt{wxEXEC
\_NODISABLE} flag to
561 prevent this automatic disabling from happening.
563 For asynchronous execution, however, the return value is the process id and
564 zero value indicates that the command could not be executed. As an added
565 complication, the return value of $-
1$ in this case indicates that we didn't
566 launch a new process, but connected to the running one (this can only happen in
567 case of using DDE under Windows for command execution). In particular, in this,
568 and only this, case the calling code will not get the notification about
571 If callback isn't NULL and if execution is asynchronous,
572 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
573 the process finishes. Specifying this parameter also allows you to redirect the
574 standard input and/or output of the process being launched by calling
575 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
576 under Windows the process window is not shown by default (this avoids having to
577 flush an unnecessary console for the processes which don't create any windows
578 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
579 happening, i.e. with this flag the child process window will be shown normally.
581 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
582 that the new process is a group leader (this will create a new session if
583 needed). Calling
\helpref{wxKill
}{wxkill
} passing wxKILL
\_CHILDREN will
584 will kill this process as well as all of its children (except those which have
585 started their own session).
587 Finally, you may use the third overloaded version of this function to execute
588 a process (always synchronously) and capture its output in the array
589 {\it output
}. The fourth version adds the possibility to additionally capture
590 the messages from standard error output in the
{\it errors
} array.
592 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
593 this function from another thread will result in an assert failure in debug
594 build and won't work.
598 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
600 \wxheading{Parameters
}
602 \docparam{command
}{The command to execute and any parameters to pass to it as a
605 \docparam{argv
}{The command to execute should be the first element of this
606 array, any additional ones are the command parameters and the array must be
607 terminated with a NULL pointer.
}
609 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
610 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
612 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
614 \wxheading{Include files
}
619 \membersection{::wxExit
}\label{wxexit
}
621 \func{void
}{wxExit
}{\void}
623 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
624 Should only be used in an emergency: normally the top-level frame
625 should be deleted (after deleting all other frames) to terminate the
626 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
628 \wxheading{Include files
}
633 \membersection{::wxKill
}\label{wxkill
}
635 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
},
\param{int
}{flags =
0}}
637 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
638 process with PID
{\it pid
}. The valid signal values are
643 wxSIGNONE =
0, // verify if the process exists under Unix
652 wxSIGKILL, // forcefully kill, dangerous!
658 wxSIGTERM // terminate the process gently
662 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
663 under both Unix and Windows but all the other signals are equivalent to
664 {\tt wxSIGTERM
} under Windows.
666 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
667 be filled with an element of
{\tt wxKillError
} enum:
672 wxKILL_OK, // no error
673 wxKILL_BAD_SIGNAL, // no such signal
674 wxKILL_ACCESS_DENIED, // permission denied
675 wxKILL_NO_PROCESS, // no such process
676 wxKILL_ERROR // another, unspecified error
680 The
{\it flags
} parameter can be wxKILL
\_NOCHILDREN (the default),
681 or wxKILL
\_CHILDREN, in which case the child processes of this
682 process will be killed too. Note that under Unix, for wxKILL
\_CHILDREN
683 to work you should have created the process by passing wxEXEC
\_MAKE_GROUP\_LEADER
688 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
689 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
690 \helpref{Exec sample
}{sampleexec
}
692 \wxheading{Include files
}
697 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
699 \func{unsigned long
}{wxGetProcessId
}{\void}
701 Returns the number uniquely identifying the current process in the system.
703 If an error occurs, $
0$ is returned.
705 \wxheading{Include files
}
710 \membersection{::wxShell
}\label{wxshell
}
712 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
714 Executes a command in an interactive shell window. If no command is
715 specified, then just the shell is spawned.
717 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
719 \wxheading{Include files
}
724 \membersection{::wxShutdown
}\label{wxshutdown
}
726 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
728 This function shuts down or reboots the computer depending on the value of the
729 {\it flags
}. Please notice that doing this requires the corresponding access
730 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privelege under Windows NT)
731 and that this function is only implemented under Unix and Win32.
733 \wxheading{Parameters
}
735 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
739 {\tt true
} on success,
{\tt false
} if an error occured.
741 \wxheading{Include files
}
747 \section{Thread functions
}\label{threadfunctions
}
749 The functions and macros here mainly exist to make it writing the code which
750 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
751 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
753 For example, a static variable must be protected against simultaneous access by
754 multiple threads in the former configuration but in the latter the extra
755 overhead of using the critical section is not needed. To solve this problem,
756 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
757 to create and use the critical section only when needed.
759 \wxheading{Include files
}
765 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
769 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
771 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
773 This macro declares a (static) critical section object named
{\it cs
} if
774 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
778 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
780 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
782 This macro declares a critical section object named
{\it cs
} if
783 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
784 include the
{\tt static
} keyword (unlike
785 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
786 a class or struct member which explains its name.
790 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
792 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
794 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
795 object named
{\it name
} and associated with the critical section
{\it cs
} if
796 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
800 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
802 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
804 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
805 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
806 section object and also the lock object associated with it. Because of this, it
807 can be only used inside a function, not at global scope. For example:
812 static int s_counter =
0;
814 wxCRITICAL_SECTION(counter);
820 (note that we suppose that the function is called the first time from the main
821 thread so that the critical section object is initialized correctly by the time
822 other threads start calling it, if this is not the case this approach can
823 {\bf not
} be used and the critical section must be made a global instead).
827 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
829 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
831 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
832 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
836 \membersection{::wxIsMainThread
}\label{wxismainthread
}
838 \func{bool
}{wxIsMainThread
}{\void}
840 Returns
{\tt true
} if this thread is the main one. Always returns
{\tt true
} if
841 {\tt wxUSE
\_THREADS} is $
0$.
845 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
847 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
849 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
850 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
854 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
856 \func{void
}{wxMutexGuiEnter
}{\void}
858 This function must be called when any thread other than the main GUI thread
859 wants to get access to the GUI library. This function will block the execution
860 of the calling thread until the main thread (or any other thread holding the
861 main GUI lock) leaves the GUI library and no other thread will enter the GUI
862 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
864 Typically, these functions are used like this:
867 void MyThread::Foo(void)
869 // before doing any GUI calls we must ensure that this thread is the only
875 my_window->DrawSomething();
881 Note that under GTK, no creation of top-level windows is allowed in any
882 thread but the main one.
884 This function is only defined on platforms which support preemptive
888 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
890 \func{void
}{wxMutexGuiLeave
}{\void}
892 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
894 This function is only defined on platforms which support preemptive
899 \section{File functions
}\label{filefunctions
}
901 \wxheading{Include files
}
907 \helpref{wxPathList
}{wxpathlist
}\\
908 \helpref{wxDir
}{wxdir
}\\
909 \helpref{wxFile
}{wxfile
}\\
910 \helpref{wxFileName
}{wxfilename
}
913 \membersection{::wxDirExists
}\label{functionwxdirexists
}
915 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
917 Returns true if the directory exists.
920 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
922 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
924 Converts a DOS to a Unix filename by replacing backslashes with forward
928 \membersection{::wxFileExists
}\label{functionwxfileexists
}
930 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
932 Returns true if the file exists and is a plain file.
935 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
937 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
939 Returns time of last modification of given file.
942 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
944 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
946 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
948 {\bf NB:
} This function is obsolete, please use
949 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
951 Returns the filename for a full path. The second form returns a pointer to
952 temporary storage that should not be deallocated.
955 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
957 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
959 This function does directory searching; returns the first file
960 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
961 get the next matching file. Neither will
report the current directory "." or the
962 parent directory "..".
966 As of wx
2.5.2, these functions are not thread-safe! (use static variables)
968 {\it spec
} may contain wildcards.
970 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
975 wxString f = wxFindFirstFile("/home/project/*.*");
976 while ( !f.IsEmpty() )
979 f = wxFindNextFile();
984 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
986 \func{wxString
}{wxFindNextFile
}{\void}
988 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
990 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
993 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
995 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
997 This function returns the total number of bytes and number of free bytes on
998 the disk containing the directory
{\it path
} (it should exist). Both
999 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
1000 information is not needed.
1004 {\tt true
} on success,
{\tt false
} if an error occured (for example, the
1005 directory doesn't exist).
1007 \wxheading{Portability
}
1009 This function is implemented for Win32,
1010 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
1012 This function first appeared in wxWidgets
2.3.2.
1015 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
1017 \func{wxString
}{wxGetOSDirectory
}{\void}
1019 Returns the Windows directory under Windows; on other platforms returns the empty string.
1022 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
1024 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
1026 Returns true if the argument is an absolute filename, i.e. with a slash
1027 or drive name at the beginning.
1030 \membersection{::wxPathOnly
}\label{wxpathonly
}
1032 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1034 Returns the directory part of the filename.
1037 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1039 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
1041 Converts a Unix to a DOS filename by replacing forward
1042 slashes with backslashes.
1045 \membersection{wxCHANGE
\_UMASK}\label{wxchangeumask
}
1047 \func{}{wxCHANGE
\_UMASK}{\param{int
}{mask
}}
1049 Under Unix this macro changes the current process umask to the given value,
1050 unless it is equal to $-
1$ in which case nothing is done, and restores it to
1051 the original value on scope exit. It works by declaring a variable which sets
1052 umask to
\arg{mask
} in its constructor and restores it in its destructor.
1054 Under other platforms this macro expands to nothing.
1057 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1059 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1060 \param{const wxString\&
}{file3
}}
1062 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1066 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1068 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1070 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1071 {\it overwrite
} parameter is true (default), the destination file is overwritten
1072 if it exists, but if
{\it overwrite
} is false, the functions fails in this
1076 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1078 \func{wxString
}{wxGetCwd
}{\void}
1080 Returns a string containing the current (or working) directory.
1083 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1085 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1087 {\bf NB:
} This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1089 Copies the current working directory into the buffer if supplied, or
1090 copies the working directory into new storage (which you
{\emph must
} delete
1091 yourself) if the buffer is NULL.
1093 {\it sz
} is the size of the buffer if supplied.
1096 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1098 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1100 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1102 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1103 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1104 %% is allocated for the temporary filename using {\it new}.
1106 %% Under Windows, the filename will include the drive and name of the
1107 %% directory allocated for temporary files (usually the contents of the
1108 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1110 %% It is the application's responsibility to create and delete the file.
1112 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1113 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1117 \membersection{::wxIsWild
}\label{wxiswild
}
1119 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1121 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1124 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1126 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1128 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1129 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1130 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1133 \membersection{::wxMkdir
}\label{wxmkdir
}
1135 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1137 Makes the directory
\arg{dir
}, returning true if successful.
1139 {\it perm
} is the access mask for the directory for the systems on which it is
1140 supported (Unix) and doesn't have effect for the other ones.
1143 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1145 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1147 Parses the
\arg{wildCard
}, returning the number of filters.
1148 Returns
0 if none or if there's a problem.
1149 The arrays will contain an equal number of items found before the error.
1150 On platforms where native dialogs handle only one filter per entry,
1151 entries in arrays are automatically adjusted.
1152 \arg{wildCard
} is in the form:
1154 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1157 \membersection{::wxRemoveFile}\label{wxremovefile}
1159 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1161 Removes \arg{file}, returning true if successful.
1164 \membersection{::wxRenameFile}\label{wxrenamefile}
1166 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
1168 Renames \arg{file1} to \arg{file2}, returning true if successful.
1171 \membersection{::wxRmdir}\label{wxrmdir}
1173 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1175 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1177 The {\it flags} parameter is reserved for future use.
1180 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1182 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1184 Sets the current working directory, returning true if the operation succeeded.
1185 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1188 \membersection{::wxSplitPath}\label{wxsplitfunction}
1190 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1192 {\bf NB:} This function is obsolete, please use
1193 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1195 This function splits a full file name into components: the path (including possible disk/drive
1196 specification under Windows), the base name and the extension. Any of the output parameters
1197 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1198 a particular component.
1200 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1201 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1202 is a valid character in a filename).
1204 On entry, {\it fullname} should be non-NULL (it may be empty though).
1206 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1207 contains the file name and {\it ext} contains the file extension without leading dot. All
1208 three of them may be empty if the corresponding component is. The old contents of the
1209 strings pointed to by these parameters will be overwritten in any case (if the pointers
1213 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1215 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1217 Copies the given file to {\it stream}. Useful when converting an old application to
1218 use streams (within the document/view framework, for example).
1220 \wxheading{Include files}
1225 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1227 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1229 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1230 use streams (within the document/view framework, for example).
1232 \wxheading{Include files}
1238 \section{Network, user and OS functions}\label{networkfunctions}
1240 The functions in this section are used to retrieve information about the
1241 current computer and/or user characteristics.
1244 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1246 \func{long}{wxGetFreeMemory}{\void}
1248 Returns the amount of free memory in bytes under environments which
1249 support it, and -1 if not supported. Currently, it is supported only
1250 under Windows, Linux and Solaris.
1252 \wxheading{Include files}
1257 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1259 \func{wxString}{wxGetFullHostName}{\void}
1261 Returns the FQDN (fully qualified domain host name) or an empty string on
1264 \wxheading{See also}
1266 \helpref{wxGetHostName}{wxgethostname}
1268 \wxheading{Include files}
1273 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1275 \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
1277 Copies the user's email address into the supplied buffer, by
1278 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1279 and \helpref{wxGetUserId}{wxgetuserid}.
1281 Returns true if successful, false otherwise.
1283 \wxheading{Include files}
1288 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1290 \func{wxString}{wxGetHomeDir}{\void}
1292 Return the (current) user's home directory.
1294 \wxheading{See also}
1296 \helpref{wxGetUserHome}{wxgetuserhome}
1298 \wxheading{Include files}
1303 \membersection{::wxGetHostName}\label{wxgethostname}
1305 \func{wxString}{wxGetHostName}{\void}
1307 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1309 Copies the current host machine's name into the supplied buffer. Please note
1310 that the returned name is {\it not} fully qualified, i.e. it does not include
1313 Under Windows or NT, this function first looks in the environment
1314 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1315 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1317 The first variant of this function returns the hostname if successful or an
1318 empty string otherwise. The second (deprecated) function returns true
1319 if successful, false otherwise.
1321 \wxheading{See also}
1323 \helpref{wxGetFullHostName}{wxgetfullhostname}
1325 \wxheading{Include files}
1330 \membersection{::wxGetUserId}\label{wxgetuserid}
1332 \func{wxString}{wxGetUserId}{\void}
1334 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
1336 This function returns the "user id" also known as "login name" under Unix i.e.
1337 something like "jsmith". It uniquely identifies the current user (on this system).
1339 Under Windows or NT, this function first looks in the environment
1340 variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
1341 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1343 The first variant of this function returns the login name if successful or an
1344 empty string otherwise. The second (deprecated) function returns true
1345 if successful, false otherwise.
1347 \wxheading{See also}
1349 \helpref{wxGetUserName}{wxgetusername}
1351 \wxheading{Include files}
1356 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1358 \func{wxString}{wxGetOsDescription}{\void}
1360 Returns the string containing the description of the current platform in a
1361 user-readable form. For example, this function may return strings like
1362 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1364 \wxheading{See also}
1366 \helpref{::wxGetOsVersion}{wxgetosversion}
1368 \wxheading{Include files}
1373 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1375 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1377 Gets operating system version information.
1379 \begin{twocollist}\itemsep=0pt
1380 \twocolitemruled{Platform}{Return types}
1381 \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.
1383 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}. }
1384 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1385 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1386 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1387 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1388 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1389 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1390 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1391 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1392 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1395 \wxheading{See also}
1397 \helpref{::wxGetOsDescription}{wxgetosdescription}
1399 \wxheading{Include files}
1404 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1406 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1408 Returns the home directory for the given user. If the username is empty
1409 (default value), this function behaves like
1410 \helpref{wxGetHomeDir}{wxgethomedir}.
1412 \wxheading{Include files}
1417 \membersection{::wxGetUserName}\label{wxgetusername}
1419 \func{wxString}{wxGetUserName}{\void}
1421 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
1423 This function returns the full user name (something like "Mr. John Smith").
1425 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
1426 in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows
1427 is running, the entry {\bf Current} in the section {\bf User} of
1428 the PENWIN.INI file is used.
1430 The first variant of this function returns the user name if successful or an
1431 empty string otherwise. The second (deprecated) function returns {\tt true}
1432 if successful, {\tt false} otherwise.
1434 \wxheading{See also}
1436 \helpref{wxGetUserId}{wxgetuserid}
1438 \wxheading{Include files}
1444 \section{String functions}\label{stringfunctions}
1447 \membersection{::copystring}\label{copystring}
1449 \func{char *}{copystring}{\param{const char *}{s}}
1451 Makes a copy of the string {\it s} using the C++ new operator, so it can be
1452 deleted with the {\it delete} operator.
1454 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
1457 \membersection{::wxGetTranslation}\label{wxgettranslation}
1459 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
1461 \func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}}
1463 This function returns the translation of string {\it str} in the current
1464 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
1465 message catalogs (see \helpref{internationalization overview}{internationalization}), the
1466 original string is returned. In debug build, an error message is logged -- this
1467 should help to find the strings which were not yet translated. As this function
1468 is used very often, an alternative (and also common in Unix world) syntax is
1469 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
1470 as wxGetTranslation.
1472 The second form is used when retrieving translation of string that has
1473 different singular and plural form in English or different plural forms in some
1474 other language. It takes two extra arguments: \arg{str}
1475 parameter must contain the singular form of the string to be converted.
1476 It is also used as the key for the search in the catalog.
1477 The \arg{strPlural} parameter is the plural form (in English).
1478 The parameter \arg{n} is used to determine the plural form. If no
1479 message catalog is found \arg{str} is returned if `n == 1',
1480 otherwise \arg{strPlural}.
1481 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
1483 Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}.
1485 \membersection{::wxIsEmpty}\label{wxisempty}
1487 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}
1489 Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
1490 string, {\tt false} otherwise.
1493 \membersection{::wxStrcmp}\label{wxstrcmp}
1495 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1497 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1498 to or greater than {\it p2}. The comparison is case-sensitive.
1500 This function complements the standard C function {\it stricmp()} which performs
1501 case-insensitive comparison.
1504 \membersection{::wxStricmp}\label{wxstricmp}
1506 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1508 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1509 to or greater than {\it p2}. The comparison is case-insensitive.
1511 This function complements the standard C function {\it strcmp()} which performs
1512 case-sensitive comparison.
1515 \membersection{::wxStringMatch}\label{wxstringmatch}
1517 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
1518 \param{bool}{ subString = true}, \param{bool}{ exact = false}}
1520 {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
1522 Returns {\tt true} if the substring {\it s1} is found within {\it s2},
1523 ignoring case if {\it exact} is false. If {\it subString} is {\tt false},
1524 no substring matching is done.
1527 \membersection{::wxStringEq}\label{wxstringeq}
1529 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
1531 {\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
1536 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
1540 \membersection{::wxStrlen}\label{wxstrlen}
1542 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
1544 This is a safe version of standard function {\it strlen()}: it does exactly the
1545 same thing (i.e. returns the length of the string) except that it returns 0 if
1546 {\it p} is the {\tt NULL} pointer.
1549 \membersection{::wxSnprintf}\label{wxsnprintf}
1551 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
1553 This function replaces the dangerous standard function {\tt sprintf()} and is
1554 like {\tt snprintf()} available on some platforms. The only difference with
1555 sprintf() is that an additional argument - buffer size - is taken and the
1556 buffer is never overflowed.
1558 Returns the number of characters copied to the buffer or -1 if there is not
1561 \wxheading{See also}
1563 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
1566 \membersection{wxT}\label{wxt}
1568 \func{wxChar}{wxT}{\param{char }{ch}}
1570 \func{const wxChar *}{wxT}{\param{const char *}{s}}
1572 wxT() is a macro which can be used with character and string literals (in other
1573 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
1574 Unicode build configuration. Please see the
1575 \helpref{Unicode overview}{unicode} for more information.
1577 This macro is simply returns the value passed to it without changes in ASCII
1578 build. In fact, its definition is:
1581 #define wxT(x) L ## x
1588 \membersection{wxTRANSLATE}\label{wxtranslate}
1590 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
1592 This macro doesn't do anything in the program code -- it simply expands to the
1593 value of its argument (except in Unicode build where it is equivalent to
1594 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
1595 with the same string which would be really unreadable).
1597 However it does have a purpose and it is to mark the literal strings for the
1598 extraction into the message catalog created by {\tt xgettext} program. Usually
1599 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
1600 the string for extraction but also expands into a
1601 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
1602 cannot be used in some situations, notably for static array
1605 Here is an example which should make it more clear: suppose that you have a
1606 static array of strings containing the weekday names and which have to be
1607 translated (note that it is a bad example, really, as
1608 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
1609 day names already). If you write
1612 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
1614 // use weekdays[n] as usual
1617 the code wouldn't compile because the function calls are forbidden in the array
1618 initializer. So instead you should do
1621 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
1623 // use wxGetTranslation(weekdays[n])
1628 Note that although the code {\bf would} compile if you simply omit
1629 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1630 no translations for the weekday names in the program message catalog and
1631 wxGetTranslation wouldn't find them.
1633 \membersection{::wxVsnprintf}\label{wxvsnprintf}
1635 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
1637 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
1638 argument instead of arbitrary number of parameters.
1640 \wxheading{See also}
1642 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
1646 \membersection{\_}\label{underscore}
1648 \func{const wxChar *}{\_}{\param{const char *}{s}}
1650 This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}
1651 function, so it marks the message for the extraction by {\tt xgettext} just as
1652 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
1653 the string for the current locale during execution.
1655 Don't confuse this macro with \helpref{\_T()}{underscoret}!
1658 \membersection{\_T}\label{underscoret}
1660 \func{wxChar}{\_T}{\param{char }{ch}}
1662 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
1664 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in
1665 wxWidgets simply because it may be more intuitive for Windows programmers as
1666 the standard Win32 headers also define it (as well as yet another name for the
1667 same macro which is {\tt \_TEXT()}).
1669 Don't confuse this macro with \helpref{\_()}{underscore}!
1673 \section{Dialog functions}\label{dialogfunctions}
1675 Below are a number of convenience functions for getting input from the
1676 user or displaying messages. Note that in these functions the last three
1677 parameters are optional. However, it is recommended to pass a parent frame
1678 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1679 the front when the dialog box is popped up.
1682 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1684 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1686 Changes the cursor to the given cursor for all windows in the application.
1687 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1688 to its previous state. These two calls can be nested, and a counter
1689 ensures that only the outer calls take effect.
1691 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1693 \wxheading{Include files}
1698 \membersection{::wxBell}\label{wxbell}
1700 \func{void}{wxBell}{\void}
1702 Ring the system bell.
1704 \wxheading{Include files}
1709 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
1711 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
1712 \param{size\_t }{currentTip}}
1714 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
1715 used with \helpref{wxShowTip}{wxshowtip}.
1717 \docparam{filename}{The name of the file containing the tips, one per line}
1718 \docparam{currentTip}{The index of the first tip to show - normally this index
1719 is remembered between the 2 program runs.}
1721 \wxheading{See also}
1723 \helpref{Tips overview}{tipsoverview}
1725 \wxheading{Include files}
1730 \membersection{::wxDirSelector}\label{wxdirselector}
1732 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
1733 \param{const wxString\& }{default\_path = ""},\\
1734 \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition},\\
1735 \param{wxWindow *}{parent = NULL}}
1737 Pops up a directory selector dialog. The arguments have the same meaning as
1738 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1739 and the default\_path, if specified, is set as the initial selection.
1741 The application must check for an empty return value (if the user pressed
1742 Cancel). For example:
1745 const wxString& dir = wxDirSelector("Choose a folder");
1752 \wxheading{Include files}
1757 \membersection{::wxFileSelector}\label{wxfileselector}
1759 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
1760 \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
1761 \param{const wxString\& }{wildcard = "*.*"}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
1762 \param{int}{ x = -1}, \param{int}{ y = -1}}
1764 Pops up a file selector box. In Windows, this is the common file selector
1765 dialog. In X, this is a file selector box with the same functionality.
1766 The path and filename are distinct elements of a full file pathname.
1767 If path is empty, the current directory will be used. If filename is empty,
1768 no default filename will be supplied. The wildcard determines what files
1769 are displayed in the file selector, and file extension supplies a type
1770 extension for the required filename. Flags may be a combination of wxOPEN,
1771 wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
1773 Both the Unix and Windows versions implement a wildcard filter. Typing a
1774 filename containing wildcards (*, ?) in the filename text item, and
1775 clicking on Ok, will result in only those files matching the pattern being
1778 The wildcard may be a specification for multiple types of file
1779 with a description for each, such as:
1782 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1785 The application must check for an empty return value (the user pressed
1786 Cancel). For example:
1789 wxString filename = wxFileSelector("Choose a file to open");
1790 if ( !filename.empty() )
1792 // work with the file
1795 //else: cancelled by user
1798 \wxheading{Include files}
1803 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1805 \func{void}{wxEndBusyCursor}{\void}
1807 Changes the cursor back to the original cursor, for all windows in the application.
1808 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1810 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1812 \wxheading{Include files}
1817 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
1819 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
1821 Shows the colour selection dialog and returns the colour selected by user or
1822 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
1823 is valid) if the dialog was cancelled.
1825 \wxheading{Parameters}
1827 \docparam{parent}{The parent window for the colour selection dialog}
1829 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
1831 \wxheading{Include files}
1836 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
1838 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
1840 Shows the font selection dialog and returns the font selected by user or
1841 invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
1842 is valid) if the dialog was cancelled.
1844 \wxheading{Parameters}
1846 \docparam{parent}{The parent window for the font selection dialog}
1848 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
1850 \wxheading{Include files}
1856 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
1858 \func{size\_t}{wxGetMultipleChoices}{\\
1859 \param{wxArrayInt\& }{selections},\\
1860 \param{const wxString\& }{message},\\
1861 \param{const wxString\& }{caption},\\
1862 \param{const wxArrayString\& }{aChoices},\\
1863 \param{wxWindow *}{parent = NULL},\\
1864 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1865 \param{bool}{ centre = true},\\
1866 \param{int }{width=150}, \param{int }{height=200}}
1868 \func{size\_t}{wxGetMultipleChoices}{\\
1869 \param{wxArrayInt\& }{selections},\\
1870 \param{const wxString\& }{message},\\
1871 \param{const wxString\& }{caption},\\
1872 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1873 \param{wxWindow *}{parent = NULL},\\
1874 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1875 \param{bool}{ centre = true},\\
1876 \param{int }{width=150}, \param{int }{height=200}}
1878 Pops up a dialog box containing a message, OK/Cancel buttons and a
1879 multiple-selection listbox. The user may choose an arbitrary (including 0)
1880 number of items in the listbox whose indices will be returned in
1881 {\it selection} array. The initial contents of this array will be used to
1882 select the items when the dialog is shown.
1884 You may pass the list of strings to choose from either using {\it choices}
1885 which is an array of {\it n} strings for the listbox or by using a single
1886 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1888 If {\it centre} is true, the message text (which may include new line
1889 characters) is centred; if false, the message is left-justified.
1891 \wxheading{Include files}
1895 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1896 and {\tt choices}, and no {\tt selections} parameter; the function
1897 returns an array containing the user selections.}
1900 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
1902 \func{long}{wxGetNumberFromUser}{
1903 \param{const wxString\& }{message},
1904 \param{const wxString\& }{prompt},
1905 \param{const wxString\& }{caption},
1906 \param{long }{value},
1907 \param{long }{min = 0},
1908 \param{long }{max = 100},
1909 \param{wxWindow *}{parent = NULL},
1910 \param{const wxPoint\& }{pos = wxDefaultPosition}}
1912 Shows a dialog asking the user for numeric input. The dialogs title is set to
1913 {\it caption}, it contains a (possibly) multiline {\it message} above the
1914 single line {\it prompt} and the zone for entering the number.
1916 The number entered must be in the range {\it min}..{\it max} (both of which
1917 should be positive) and {\it value} is the initial value of it. If the user
1918 enters an invalid value or cancels the dialog, the function will return -1.
1920 Dialog is centered on its {\it parent} unless an explicit position is given in
1923 \wxheading{Include files}
1928 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
1930 \func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1931 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
1932 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
1934 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
1935 in the dialog is not shown on screen but replaced with stars. This is intended
1936 to be used for entering passwords as the function name implies.
1938 \wxheading{Include files}
1943 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
1945 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1946 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
1947 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
1949 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
1950 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
1951 or press Cancel to return the empty string.
1953 If {\it centre} is true, the message text (which may include new line characters)
1954 is centred; if false, the message is left-justified.
1956 \wxheading{Include files}
1961 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
1963 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1964 \param{int }{nsel}, \param{int *}{selection},
1965 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1966 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1968 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
1969 listbox. The user may choose one or more item(s) and press OK or Cancel.
1971 The number of initially selected choices, and array of the selected indices,
1972 are passed in; this array will contain the user selections on exit, with
1973 the function returning the number of selections. {\it selection} must be
1974 as big as the number of choices, in case all are selected.
1976 If Cancel is pressed, -1 is returned.
1978 {\it choices} is an array of {\it n} strings for the listbox.
1980 If {\it centre} is true, the message text (which may include new line characters)
1981 is centred; if false, the message is left-justified.
1983 \wxheading{Include files}
1988 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
1990 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1991 \param{const wxString\& }{caption},\\
1992 \param{const wxArrayString\& }{aChoices},\\
1993 \param{wxWindow *}{parent = NULL},\\
1994 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1995 \param{bool}{ centre = true},\\
1996 \param{int }{width=150}, \param{int }{height=200}}
1998 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1999 \param{const wxString\& }{caption},\\
2000 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2001 \param{wxWindow *}{parent = NULL},\\
2002 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2003 \param{bool}{ centre = true},\\
2004 \param{int }{width=150}, \param{int }{height=200}}
2006 Pops up a dialog box containing a message, OK/Cancel buttons and a
2007 single-selection listbox. The user may choose an item and press OK to return a
2008 string or Cancel to return the empty string. Use
2009 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
2010 valid choice and if you want to be able to detect pressing Cancel reliably.
2012 You may pass the list of strings to choose from either using {\it choices}
2013 which is an array of {\it n} strings for the listbox or by using a single
2014 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2016 If {\it centre} is true, the message text (which may include new line
2017 characters) is centred; if false, the message is left-justified.
2019 \wxheading{Include files}
2023 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2027 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
2029 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2030 \param{const wxString\& }{caption},\\
2031 \param{const wxArrayString\& }{aChoices},\\
2032 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2033 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2035 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2036 \param{const wxString\& }{caption},\\
2037 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2038 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2039 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2041 As {\bf wxGetSingleChoice} but returns the index representing the selected
2042 string. If the user pressed cancel, -1 is returned.
2044 \wxheading{Include files}
2048 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2052 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2054 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2055 \param{const wxString\& }{caption},\\
2056 \param{const wxArrayString\& }{aChoices},\\
2057 \param{const wxString\& }{client\_data[]},\\
2058 \param{wxWindow *}{parent = NULL},\\
2059 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2060 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2062 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2063 \param{const wxString\& }{caption},\\
2064 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2065 \param{const wxString\& }{client\_data[]},\\
2066 \param{wxWindow *}{parent = NULL},\\
2067 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2068 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2070 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2071 corresponding to the strings, and returns one of these pointers or NULL if
2072 Cancel was pressed. The {\it client\_data} array must have the same number of
2073 elements as {\it choices} or {\it aChoices}!
2075 \wxheading{Include files}
2079 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2080 and {\tt choices}, and the client data array must have the
2081 same length as the choices array.}
2084 \membersection{::wxIsBusy}\label{wxisbusy}
2086 \func{bool}{wxIsBusy}{\void}
2088 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2089 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2091 See also \helpref{wxBusyCursor}{wxbusycursor}.
2093 \wxheading{Include files}
2098 \membersection{::wxMessageBox}\label{wxmessagebox}
2100 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2101 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2103 General purpose message dialog. {\it style} may be a bit list of the
2104 following identifiers:
2106 \begin{twocollist}\itemsep=0pt
2107 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2109 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
2111 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2112 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2113 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2114 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2115 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2116 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2119 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2125 int answer = wxMessageBox("Quit program?", "Confirm",
2126 wxYES_NO | wxCANCEL, main_frame);
2127 if (answer == wxYES)
2128 main_frame->Close();
2132 {\it message} may contain newline characters, in which case the
2133 message will be split into separate lines, to cater for large messages.
2135 \wxheading{Include files}
2140 \membersection{::wxShowTip}\label{wxshowtip}
2142 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2143 \param{wxTipProvider *}{tipProvider},
2144 \param{bool }{showAtStartup = true}}
2146 This function shows a "startup tip" to the user. The return value is the
2147 state of the `Show tips at startup' checkbox.
2149 \docparam{parent}{The parent window for the modal dialog}
2151 \docparam{tipProvider}{An object which is used to get the text of the tips.
2152 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2154 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2155 otherwise. This is used as the initial value for "Show tips at startup"
2156 checkbox which is shown in the tips dialog.}
2158 \wxheading{See also}
2160 \helpref{Tips overview}{tipsoverview}
2162 \wxheading{Include files}
2169 \section{Math functions}\label{mathfunctions}
2171 \wxheading{Include files}
2176 \membersection{wxFinite}\label{wxfinite}
2178 \func{int}{wxFinite}{\param{double }{x}}
2180 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2181 returns 0 otherwise.
2184 \membersection{wxIsNaN}\label{wxisnan}
2186 \func{bool}{wxIsNaN}{\param{double }{x}}
2188 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2194 \section{GDI functions}\label{gdifunctions}
2196 The following are relevant to the GDI (Graphics Device Interface).
2198 \wxheading{Include files}
2203 \membersection{wxBITMAP}\label{wxbitmapmacro}
2205 \func{}{wxBITMAP}{bitmapName}
2207 This macro loads a bitmap from either application resources (on the platforms
2208 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2209 avoid using {\tt \#ifdef}s when creating bitmaps.
2211 \wxheading{See also}
2213 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2214 \helpref{wxICON}{wxiconmacro}
2216 \wxheading{Include files}
2221 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2223 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2224 \param{int *}{width}, \param{int *}{height}}
2226 \func{wxRect}{wxGetClientDisplayRect}{\void}
2228 Returns the dimensions of the work area on the display. On Windows
2229 this means the area not covered by the taskbar, etc. Other platforms
2230 are currently defaulting to the whole display until a way is found to
2231 provide this info for all window managers, etc.
2234 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2236 \func{bool}{wxColourDisplay}{\void}
2238 Returns true if the display is colour, false otherwise.
2241 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2243 \func{int}{wxDisplayDepth}{\void}
2245 Returns the depth of the display (a value of 1 denotes a monochrome display).
2248 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2250 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2252 \func{wxSize}{wxGetDisplaySize}{\void}
2254 Returns the display size in pixels.
2257 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2259 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2261 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2263 Returns the display size in millimeters.
2266 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2268 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2270 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2271 name. Under MSW, the cursor is loaded from the resource file and the icon is
2272 loaded from XPM file under other platforms.
2274 This macro should be used with
2275 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2277 \wxheading{Include files}
2282 \membersection{wxICON}\label{wxiconmacro}
2284 \func{}{wxICON}{iconName}
2286 This macro loads an icon from either application resources (on the platforms
2287 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2288 avoid using {\tt \#ifdef}s when creating icons.
2290 \wxheading{See also}
2292 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2293 \helpref{wxBITMAP}{wxbitmapmacro}
2295 \wxheading{Include files}
2300 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2302 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2303 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2305 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2306 makes it into a placeable metafile by prepending a header containing the given
2307 bounding box. The bounding box may be obtained from a device context after drawing
2308 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2310 In addition to adding the placeable metafile header, this function adds
2311 the equivalent of the following code to the start of the metafile data:
2314 SetMapMode(dc, MM_ANISOTROPIC);
2315 SetWindowOrg(dc, minX, minY);
2316 SetWindowExt(dc, maxX - minX, maxY - minY);
2319 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2321 Placeable metafiles may be imported by many Windows applications, and can be
2322 used in RTF (Rich Text Format) files.
2324 {\it scale} allows the specification of scale for the metafile.
2326 This function is only available under Windows.
2329 \membersection{::wxSetCursor}\label{wxsetcursor}
2331 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2333 Globally sets the cursor; only has an effect in Windows and GTK.
2334 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2338 \section{Printer settings}\label{printersettings}
2340 {\bf NB:} These routines are obsolete and should no longer be used!
2342 The following functions are used to control PostScript printing. Under
2343 Windows, PostScript output can only be sent to a file.
2345 \wxheading{Include files}
2350 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2352 \func{wxString}{wxGetPrinterCommand}{\void}
2354 Gets the printer command used to print a file. The default is {\tt lpr}.
2357 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2359 \func{wxString}{wxGetPrinterFile}{\void}
2361 Gets the PostScript output filename.
2364 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2366 \func{int}{wxGetPrinterMode}{\void}
2368 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2369 The default is PS\_PREVIEW.
2372 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2374 \func{wxString}{wxGetPrinterOptions}{\void}
2376 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2379 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2381 \func{int}{wxGetPrinterOrientation}{\void}
2383 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2386 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2388 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2390 Gets the command used to view a PostScript file. The default depends on the platform.
2393 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2395 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2397 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2400 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2402 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2404 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2407 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2409 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2411 Sets the printer command used to print a file. The default is {\tt lpr}.
2414 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2416 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2418 Sets the PostScript output filename.
2421 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2423 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2425 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2426 The default is PS\_PREVIEW.
2429 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2431 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2433 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2436 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2438 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2440 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2443 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2445 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2447 Sets the command used to view a PostScript file. The default depends on the platform.
2450 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2452 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2454 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2457 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2459 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2461 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2465 \section{Clipboard functions}\label{clipsboard}
2467 These clipboard functions are implemented for Windows only. The use of these functions
2468 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2471 \wxheading{Include files}
2476 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2478 \func{bool}{wxClipboardOpen}{\void}
2480 Returns true if this application has already opened the clipboard.
2483 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2485 \func{bool}{wxCloseClipboard}{\void}
2487 Closes the clipboard to allow other applications to use it.
2490 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2492 \func{bool}{wxEmptyClipboard}{\void}
2494 Empties the clipboard.
2497 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2499 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
2501 Enumerates the formats found in a list of available formats that belong
2502 to the clipboard. Each call to this function specifies a known
2503 available format; the function returns the format that appears next in
2506 {\it dataFormat} specifies a known format. If this parameter is zero,
2507 the function returns the first format in the list.
2509 The return value specifies the next known clipboard data format if the
2510 function is successful. It is zero if the {\it dataFormat} parameter specifies
2511 the last format in the list of available formats, or if the clipboard
2514 Before it enumerates the formats function, an application must open the clipboard by using the
2515 wxOpenClipboard function.
2518 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2520 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
2522 Gets data from the clipboard.
2524 {\it dataFormat} may be one of:
2526 \begin{itemize}\itemsep=0pt
2527 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2528 \item wxCF\_BITMAP: returns a new wxBitmap.
2531 The clipboard must have previously been opened for this call to succeed.
2534 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2536 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
2538 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2539 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2542 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2544 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
2546 Returns true if the given data format is available on the clipboard.
2549 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2551 \func{bool}{wxOpenClipboard}{\void}
2553 Opens the clipboard for passing data to it or getting data from it.
2556 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2558 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2560 Registers the clipboard data format name and returns an identifier.
2563 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2565 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
2567 Passes data to the clipboard.
2569 {\it dataFormat} may be one of:
2571 \begin{itemize}\itemsep=0pt
2572 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2573 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2574 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2575 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2578 The clipboard must have previously been opened for this call to succeed.
2583 \section{Miscellaneous functions}\label{miscellany}
2586 \membersection{wxCONCAT}\label{wxconcat}
2588 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2590 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2593 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2595 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2597 When loading a function from a DLL you always have to cast the returned
2598 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2599 repeat this type twice if you want to declare and define a function pointer all
2602 This macro makes this slightly less painful by allowing you to specify the
2603 type only once, as the first parameter, and creating a variable of this type
2604 named after the function but with {\tt pfn} prefix and initialized with the
2605 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2608 \wxheading{Parameters}
2610 \docparam{type}{the type of the function}
2612 \docparam{name}{the name of the function to load, not a string (without quotes,
2613 it is quoted automatically by the macro)}
2615 \docparam{dynlib}{the library to load the function from}
2619 \membersection{wxEXPLICIT}\label{wxexplicit}
2621 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2622 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2623 code which might have to be compiled with an old compiler without support for
2624 this language feature but still take advantage of it when it is available.
2627 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2629 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2631 Returns \true if the key parameter is currently pressed on the keyboard, or
2632 with modifier keys, (caps lock, etc) if the key is active (the led light is
2635 \wxheading{Include files}
2640 \membersection{wxLL}\label{wxll}
2642 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2644 This macro is defined for the platforms with a native 64 bit integer type and
2645 allows to define 64 bit compile time constants:
2649 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2653 \wxheading{Include files}
2657 \wxheading{See also}
2659 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2662 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2664 This macro is defined to contain the {\tt printf()} format specifier using
2665 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2666 printed. Example of using it:
2670 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2671 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2675 \wxheading{See also}
2677 \helpref{wxLL}{wxll}
2679 \wxheading{Include files}
2684 \membersection{::wxNewId}\label{wxnewid}
2686 \func{long}{wxNewId}{\void}
2688 Generates an integer identifier unique to this run of the program.
2690 \wxheading{Include files}
2695 \membersection{::wxRegisterId}\label{wxregisterid}
2697 \func{void}{wxRegisterId}{\param{long}{ id}}
2699 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2702 \wxheading{Include files}
2707 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2709 \func{void}{wxDDECleanUp}{\void}
2711 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
2712 called by the application.
2714 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2716 \wxheading{Include files}
2721 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2723 \func{void}{wxDDEInitialize}{\void}
2725 Initializes the DDE system. May be called multiple times without harm.
2727 This no longer needs to be called by the application: it will be called
2728 by wxWidgets if necessary.
2730 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
2731 \helpref{wxDDECleanUp}{wxddecleanup}.
2733 \wxheading{Include files}
2738 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
2740 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
2742 This function enables or disables all top level windows. It is used by
2743 \helpref{::wxSafeYield}{wxsafeyield}.
2745 \wxheading{Include files}
2750 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
2752 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
2754 Find a menu item identifier associated with the given frame's menu bar.
2756 \wxheading{Include files}
2761 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
2763 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
2765 {\bf NB:} This function is obsolete, please use
2766 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
2768 Find a window by its label. Depending on the type of window, the label may be a window title
2769 or panel item label. If {\it parent} is NULL, the search will start from all top-level
2770 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2771 The search is recursive in both cases.
2773 \wxheading{Include files}
2778 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
2780 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
2782 {\bf NB:} This function is obsolete, please use
2783 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
2785 Find a window by its name (as given in a window constructor or {\bf Create} function call).
2786 If {\it parent} is NULL, the search will start from all top-level
2787 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2788 The search is recursive in both cases.
2790 If no such named window is found, {\bf wxFindWindowByLabel} is called.
2792 \wxheading{Include files}
2797 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
2799 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
2801 Find the deepest window at the given mouse position in screen coordinates,
2802 returning the window if found, or NULL if not.
2805 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
2807 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
2809 Find the deepest window at the mouse pointer position, returning the window
2810 and current pointer position in screen coordinates.
2813 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
2815 \func{wxWindow *}{wxGetActiveWindow}{\void}
2817 Gets the currently active window (Windows only).
2819 \wxheading{Include files}
2824 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
2826 \func{wxString}{wxGetDisplayName}{\void}
2828 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
2830 \wxheading{Include files}
2835 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
2837 \func{wxPoint}{wxGetMousePosition}{\void}
2839 Returns the mouse position in screen coordinates.
2841 \wxheading{Include files}
2846 \membersection{::wxGetResource}\label{wxgetresource}
2848 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2849 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
2851 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2852 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
2854 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2855 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
2857 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2858 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
2860 Gets a resource value from the resource database (for example, WIN.INI, or
2861 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2862 otherwise the specified file is used.
2864 Under X, if an application class (wxApp::GetClassName) has been defined,
2865 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
2866 an applications default file when merging all resource databases.
2868 The reason for passing the result in an argument is that it
2869 can be convenient to define a default value, which gets overridden
2870 if the value exists in the resource file. It saves a separate
2871 test for that resource's existence, and it also allows
2872 the overloading of the function for different types.
2874 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
2876 \wxheading{Include files}
2881 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
2883 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
2885 Returns the first top level parent of the given window, or in other words, the
2886 frame or dialog containing it, or {\tt NULL}.
2888 \wxheading{Include files}
2893 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
2895 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
2897 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
2898 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
2900 The resource must be defined in the {\tt .rc} file using the following syntax:
2903 myResource TEXT file.ext
2906 where {\tt file.ext} is a file that the resource compiler can find.
2908 This function is available under Windows only.
2910 \wxheading{Include files}
2915 \membersection{::wxPostDelete}\label{wxpostdelete}
2917 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
2919 Tells the system to delete the specified object when
2920 all other events have been processed. In some environments, it is
2921 necessary to use this instead of deleting a frame directly with the
2922 delete operator, because some GUIs will still send events to a deleted window.
2924 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
2926 \wxheading{Include files}
2931 \membersection{::wxPostEvent}\label{wxpostevent}
2933 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
2935 In a GUI application, this function posts {\it event} to the specified {\it dest}
2936 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2937 Otherwise, it dispatches {\it event} immediately using
2938 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
2939 See the respective documentation for details (and caveats).
2941 \wxheading{Include files}
2946 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
2948 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
2950 Under X only, sets the current display name. This is the X host and display name such
2951 as ``colonsay:0.0", and the function indicates which display should be used for creating
2952 windows from this point on. Setting the display within an application allows multiple
2953 displays to be used.
2955 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
2957 \wxheading{Include files}
2962 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
2964 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
2966 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
2968 {\bf NB:} This function is obsolete, please use
2969 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
2971 Strips any menu codes from {\it in} and places the result
2972 in {\it out} (or returns the new string, in the first form).
2974 Menu codes include \& (mark the next character with an underline
2975 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
2977 \wxheading{Include files}
2982 \membersection{wxULL}\label{wxull}
2984 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
2986 This macro is defined for the platforms with a native 64 bit integer type and
2987 allows to define unsigned 64 bit compile time constants:
2991 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
2995 \wxheading{Include files}
2999 \wxheading{See also}
3001 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
3004 \membersection{wxVaCopy}\label{wxvacopy}
3006 \func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{argptrSrc}}
3008 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
3009 which support it or its replacement for those that don't. It must be used to
3010 preserve the value of a \texttt{va\_list} object if you need to use it after
3011 passing it to another function because it can be modified by the latter.
3013 As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
3017 \membersection{::wxWriteResource}\label{wxwriteresource}
3019 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3020 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
3022 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3023 \param{float }{value}, \param{const wxString\& }{file = NULL}}
3025 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3026 \param{long }{value}, \param{const wxString\& }{file = NULL}}
3028 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3029 \param{int }{value}, \param{const wxString\& }{file = NULL}}
3031 Writes a resource value into the resource database (for example, WIN.INI, or
3032 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
3033 otherwise the specified file is used.
3035 Under X, the resource databases are cached until the internal function
3036 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
3037 all updated resource databases are written to their files.
3039 Note that it is considered bad manners to write to the .Xdefaults
3040 file under Unix, although the WIN.INI file is fair game under Windows.
3042 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
3044 \wxheading{Include files}
3050 \section{Byte order macros}\label{byteordermacros}
3052 The endian-ness issues (that is the difference between big-endian and
3053 little-endian architectures) are important for the portable programs working
3054 with the external binary data (for example, data files or data coming from
3055 network) which is usually in some fixed, platform-independent format. The
3056 macros are helpful for transforming the data to the correct format.
3059 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3061 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3063 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3065 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3067 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3069 These macros will swap the bytes of the {\it value} variable from little
3070 endian to big endian or vice versa unconditionally, i.e. independently of the
3074 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3076 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3078 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3080 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3082 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3084 This macro will swap the bytes of the {\it value} variable from little
3085 endian to big endian or vice versa if the program is compiled on a
3086 big-endian architecture (such as Sun work stations). If the program has
3087 been compiled on a little-endian architecture, the value will be unchanged.
3089 Use these macros to read data from and write data to a file that stores
3090 data in little-endian (for example Intel i386) format.
3093 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3095 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3097 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3099 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3101 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3103 This macro will swap the bytes of the {\it value} variable from little
3104 endian to big endian or vice versa if the program is compiled on a
3105 little-endian architecture (such as Intel PCs). If the program has
3106 been compiled on a big-endian architecture, the value will be unchanged.
3108 Use these macros to read data from and write data to a file that stores
3109 data in big-endian format.
3113 \section{RTTI functions}\label{rttimacros}
3115 wxWidgets uses its own RTTI ("run-time type identification") system which
3116 predates the current standard C++ RTTI and so is kept for backwards
3117 compatibility reasons but also because it allows some things which the
3118 standard RTTI doesn't directly support (such as creating a class from its
3121 The standard C++ RTTI can be used in the user code without any problems and in
3122 general you shouldn't need to use the functions and the macros in this section
3123 unless you are thinking of modifying or adding any wxWidgets classes.
3125 \wxheading{See also}
3127 \helpref{RTTI overview}{runtimeclassoverview}
3130 \membersection{CLASSINFO}\label{classinfo}
3132 \func{wxClassInfo *}{CLASSINFO}{className}
3134 Returns a pointer to the wxClassInfo object associated with this class.
3136 \wxheading{Include files}
3141 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3143 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3145 Used inside a class declaration to declare that the class should be
3146 made known to the class hierarchy, but objects of this class cannot be created
3147 dynamically. The same as DECLARE\_CLASS.
3152 class wxCommand: public wxObject
3154 DECLARE_ABSTRACT_CLASS(wxCommand)
3163 \wxheading{Include files}
3168 \membersection{DECLARE\_APP}\label{declareapp}
3170 \func{}{DECLARE\_APP}{className}
3172 This is used in headers to create a forward declaration of the
3173 \helpref{wxGetApp}{wxgetapp} function implemented by
3174 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3175 {\tt className\& wxGetApp(void)}.
3183 \wxheading{Include files}
3188 \membersection{DECLARE\_CLASS}\label{declareclass}
3190 \func{}{DECLARE\_CLASS}{className}
3192 Used inside a class declaration to declare that the class should be
3193 made known to the class hierarchy, but objects of this class cannot be created
3194 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3196 \wxheading{Include files}
3201 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3203 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3205 Used inside a class declaration to declare that the objects of this class should be dynamically
3206 creatable from run-time type information.
3211 class wxFrame: public wxWindow
3213 DECLARE_DYNAMIC_CLASS(wxFrame)
3216 const wxString& frameTitle;
3222 \wxheading{Include files}
3227 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3229 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3231 Used in a C++ implementation file to complete the declaration of
3232 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3237 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3239 wxCommand::wxCommand(void)
3245 \wxheading{Include files}
3250 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3252 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3254 Used in a C++ implementation file to complete the declaration of
3255 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3257 \wxheading{Include files}
3262 \membersection{IMPLEMENT\_APP}\label{implementapp}
3264 \func{}{IMPLEMENT\_APP}{className}
3266 This is used in the application class implementation file to make the application class known to
3267 wxWidgets for dynamic construction. You use this instead of
3278 IMPLEMENT_APP(MyApp)
3281 See also \helpref{DECLARE\_APP}{declareapp}.
3283 \wxheading{Include files}
3288 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3290 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3292 Used in a C++ implementation file to complete the declaration of
3293 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3295 \wxheading{Include files}
3300 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3302 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3304 Used in a C++ implementation file to complete the declaration of a
3305 class that has run-time type information and two base classes. The
3306 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3308 \wxheading{Include files}
3313 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3315 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3317 Used in a C++ implementation file to complete the declaration of
3318 a class that has run-time type information, and whose instances
3319 can be created dynamically.
3324 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3326 wxFrame::wxFrame(void)
3332 \wxheading{Include files}
3337 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3339 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3341 Used in a C++ implementation file to complete the declaration of
3342 a class that has run-time type information, and whose instances
3343 can be created dynamically. Use this for classes derived from two
3346 \wxheading{Include files}
3351 \membersection{wxConstCast}\label{wxconstcast}
3353 \func{classname *}{wxConstCast}{ptr, classname}
3355 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3356 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3358 \wxheading{See also}
3360 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3361 \helpref{wxDynamicCast}{wxdynamiccast}\\
3362 \helpref{wxStaticCast}{wxstaticcast}
3365 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3367 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3369 Creates and returns an object of the given class, if the class has been
3370 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3373 \membersection{WXDEBUG\_NEW}\label{debugnew}
3375 \func{}{WXDEBUG\_NEW}{arg}
3377 This is defined in debug mode to be call the redefined new operator
3378 with filename and line number arguments. The definition is:
3381 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3384 In non-debug mode, this is defined as the normal new operator.
3386 \wxheading{Include files}
3391 \membersection{wxDynamicCast}\label{wxdynamiccast}
3393 \func{classname *}{wxDynamicCast}{ptr, classname}
3395 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3396 the pointer is of this type (the check is done during the run-time) or
3397 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3398 wxObject::IsKindOf() function.
3400 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3406 wxWindow *win = wxWindow::FindFocus();
3407 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3410 // a text control has the focus...
3414 // no window has the focus or it is not a text control
3418 \wxheading{See also}
3420 \helpref{RTTI overview}{runtimeclassoverview}\\
3421 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3422 \helpref{wxConstCast}{wxconstcast}\\
3423 \helpref{wxStatiicCast}{wxstaticcast}
3426 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3428 \func{classname *}{wxDynamicCastThis}{classname}
3430 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3431 latter provokes spurious compilation warnings from some compilers (because it
3432 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
3433 this macro should be used to avoid them.
3435 \wxheading{See also}
3437 \helpref{wxDynamicCast}{wxdynamiccast}
3440 \membersection{wxStaticCast}\label{wxstaticcast}
3442 \func{classname *}{wxStaticCast}{ptr, classname}
3444 This macro checks that the cast is valid in debug mode (an assert failure will
3445 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3446 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3448 \wxheading{See also}
3450 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3451 \helpref{wxDynamicCast}{wxdynamiccast}\\
3452 \helpref{wxConstCast}{wxconstcast}
3455 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3457 \func{T}{wx\_const\_cast}{T, x}
3459 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3460 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3461 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3462 arguments is the same as for the standard cast.
3464 \wxheading{See also}
3466 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3467 \helpref{wx\_static\_cast}{wxstaticcastraw}
3470 \membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
3472 \func{T}{wx\_reinterpret\_cast}{T, x}
3474 Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
3475 \texttt{(T)x} for old compilers.
3477 \wxheading{See also}
3479 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3480 \helpref{wx\_static\_cast}{wxstaticcastraw}
3483 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3485 \func{T}{wx\_static\_cast}{T, x}
3487 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3488 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3489 there are no checks being done and the meaning of the macro arguments is exactly
3490 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3491 star is not appended to it.
3493 \wxheading{See also}
3495 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3496 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}
3500 \section{Log functions}\label{logfunctions}
3502 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3503 further information. The functions use (implicitly) the currently active log
3504 target, so their descriptions here may not apply if the log target is not the
3505 standard one (installed by wxWidgets in the beginning of the program).
3507 \wxheading{Include files}
3512 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3514 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3516 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3517 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3519 Display a debugging message; under Windows, this will appear on the
3520 debugger command window, and under Unix, it will be written to standard
3523 The syntax is identical to {\bf printf}: pass a format string and a
3524 variable list of arguments.
3526 {\bf Tip:} under Windows, if your application crashes before the
3527 message appears in the debugging window, put a wxYield call after
3528 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3529 (at least for Watcom C++): preformat your messages and use OutputDebugString
3532 \wxheading{Include files}
3537 \membersection{::wxError}\label{wxerror}
3539 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
3541 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3544 Displays {\it msg} and continues. This writes to standard error under
3545 Unix, and pops up a message box under Windows. Used for internal
3546 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
3548 \wxheading{Include files}
3553 \membersection{::wxFatalError}\label{wxfatalerror}
3555 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
3557 {\bf NB:} This function is now obsolete, please use
3558 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3560 Displays {\it msg} and exits. This writes to standard error under Unix,
3561 and pops up a message box under Windows. Used for fatal internal
3562 wxWidgets errors. See also \helpref{wxError}{wxerror}.
3564 \wxheading{Include files}
3569 \membersection{::wxLogError}\label{wxlogerror}
3571 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
3573 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3575 The functions to use for error messages, i.e. the messages that must be shown
3576 to the user. The default processing is to pop up a message box to inform the
3580 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
3582 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
3584 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3586 Like \helpref{wxLogError}{wxlogerror}, but also
3587 terminates the program with the exit code 3. Using {\it abort()} standard
3588 function also terminates the program with this exit code.
3591 \membersection{::wxLogWarning}\label{wxlogwarning}
3593 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
3595 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3597 For warnings - they are also normally shown to the user, but don't interrupt
3601 \membersection{::wxLogMessage}\label{wxlogmessage}
3603 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
3605 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3607 For all normal, informational messages. They also appear in a message box by
3608 default (but it can be changed). Notice that the standard behaviour is to not
3609 show informational messages if there are any errors later - the logic being
3610 that the later error messages make the informational messages preceding them
3614 \membersection{::wxLogVerbose}\label{wxlogverbose}
3616 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
3618 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3620 For verbose output. Normally, it is suppressed, but
3621 might be activated if the user wishes to know more details about the program
3622 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
3625 \membersection{::wxLogStatus}\label{wxlogstatus}
3627 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
3629 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3631 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
3633 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3635 Messages logged by these functions will appear in the statusbar of the {\it
3636 frame} or of the top level application window by default (i.e. when using
3637 the second version of the functions).
3639 If the target frame doesn't have a statusbar, the message will be lost.
3642 \membersection{::wxLogSysError}\label{wxlogsyserror}
3644 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
3646 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3648 Mostly used by wxWidgets itself, but might be handy for logging errors after
3649 system call (API function) failure. It logs the specified message text as well
3650 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
3651 on the platform) and the corresponding error message. The second form
3652 of this function takes the error code explicitly as the first argument.
3654 \wxheading{See also}
3656 \helpref{wxSysErrorCode}{wxsyserrorcode},
3657 \helpref{wxSysErrorMsg}{wxsyserrormsg}
3660 \membersection{::wxLogDebug}\label{wxlogdebug}
3662 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
3664 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3666 The right functions for debug output. They only do something in debug
3667 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
3668 nothing in release mode (otherwise).
3671 \membersection{::wxLogTrace}\label{wxlogtrace}
3673 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
3675 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3677 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
3679 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3681 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
3683 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3685 As {\bf wxLogDebug}, trace functions only do something in debug build and
3686 expand to nothing in the release one. The reason for making
3687 it a separate function from it is that usually there are a lot of trace
3688 messages, so it might make sense to separate them from other debug messages.
3690 The trace messages also usually can be separated into different categories and
3691 the second and third versions of this function only log the message if the
3692 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
3693 allows to selectively trace only some operations and not others by changing
3694 the value of the trace mask (possible during the run-time).
3696 For the second function (taking a string mask), the message is logged only if
3697 the mask has been previously enabled by the call to
3698 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
3699 \helpref{{\tt WXTRACE} environment variable}{envvars}.
3700 The predefined string trace masks
3701 used by wxWidgets are:
3703 \begin{itemize}\itemsep=0pt
3704 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
3705 \item wxTRACE\_Messages: trace window messages/X callbacks
3706 \item wxTRACE\_ResAlloc: trace GDI resource allocation
3707 \item wxTRACE\_RefCount: trace various ref counting operations
3708 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
3711 {\bf Caveats:} since both the mask and the format string are strings,
3712 this might lead to function signature confusion in some cases:
3713 if you intend to call the format string only version of wxLogTrace,
3714 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.
3715 In this case you'll unfortunately have to avoid having two leading
3716 string parameters, e.g. by adding a bogus integer (with its \%d format string).
3718 The third version of the function only logs the message if all the bits
3719 corresponding to the {\it mask} are set in the wxLog trace mask which can be
3720 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
3721 flexible than the previous one because it doesn't allow defining the user
3722 trace masks easily - this is why it is deprecated in favour of using string
3725 \begin{itemize}\itemsep=0pt
3726 \item wxTraceMemAlloc: trace memory allocation (new/delete)
3727 \item wxTraceMessages: trace window messages/X callbacks
3728 \item wxTraceResAlloc: trace GDI resource allocation
3729 \item wxTraceRefCount: trace various ref counting operations
3730 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
3734 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
3736 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
3738 This function shows a message to the user in a safe way and should be safe to
3739 call even before the application has been initialized or if it is currently in
3740 some other strange state (for example, about to crash). Under Windows this
3741 function shows a message box using a native dialog instead of
3742 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
3743 it simply prints the message to the standard output using the title as prefix.
3745 \wxheading{Parameters}
3747 \docparam{title}{The title of the message box shown to the user or the prefix
3748 of the message string}
3750 \docparam{text}{The text to show to the user}
3752 \wxheading{See also}
3754 \helpref{wxLogFatalError}{wxlogfatalerror}
3756 \wxheading{Include files}
3761 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
3763 \func{unsigned long}{wxSysErrorCode}{\void}
3765 Returns the error code from the last system call. This function uses
3766 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
3768 \wxheading{See also}
3770 \helpref{wxSysErrorMsg}{wxsyserrormsg},
3771 \helpref{wxLogSysError}{wxlogsyserror}
3774 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
3776 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
3778 Returns the error message corresponding to the given system error code. If
3779 {\it errCode} is $0$ (default), the last error code (as returned by
3780 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
3782 \wxheading{See also}
3784 \helpref{wxSysErrorCode}{wxsyserrorcode},
3785 \helpref{wxLogSysError}{wxlogsyserror}
3788 \membersection{WXTRACE}\label{trace}
3790 \wxheading{Include files}
3794 \func{}{WXTRACE}{formatString, ...}
3796 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3798 Calls wxTrace with printf-style variable argument syntax. Output
3799 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3801 \wxheading{Include files}
3806 \membersection{WXTRACELEVEL}\label{tracelevel}
3808 \func{}{WXTRACELEVEL}{level, formatString, ...}
3810 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3812 Calls wxTraceLevel with printf-style variable argument syntax. Output
3813 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3814 The first argument should be the level at which this information is appropriate.
3815 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3818 \wxheading{Include files}
3823 \membersection{::wxTrace}\label{wxtrace}
3825 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
3827 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3829 Takes printf-style variable argument syntax. Output
3830 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3832 \wxheading{Include files}
3837 \membersection{::wxTraceLevel}\label{wxtracelevel}
3839 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
3841 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3843 Takes printf-style variable argument syntax. Output
3844 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3845 The first argument should be the level at which this information is appropriate.
3846 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3849 \wxheading{Include files}
3855 \section{Time functions}\label{timefunctions}
3857 The functions in this section deal with getting the current time and
3858 starting/stopping the global timers. Please note that the timer functions are
3859 deprecated because they work with one global timer only and
3860 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
3861 should be used instead. For retrieving the current time, you may also use
3862 \helpref{wxDateTime::Now}{wxdatetimenow} or
3863 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
3866 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
3868 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
3870 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
3872 If {\it resetTimer} is true (the default), the timer is reset to zero
3875 See also \helpref{wxTimer}{wxtimer}.
3877 \wxheading{Include files}
3882 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
3884 \func{long}{wxGetLocalTime}{\void}
3886 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
3888 \wxheading{See also}
3890 \helpref{wxDateTime::Now}{wxdatetimenow}
3892 \wxheading{Include files}
3897 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
3899 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
3901 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
3903 \wxheading{See also}
3905 \helpref{wxDateTime::Now}{wxdatetimenow},\\
3906 \helpref{wxLongLong}{wxlonglong}
3908 \wxheading{Include files}
3913 \membersection{::wxGetUTCTime}\label{wxgetutctime}
3915 \func{long}{wxGetUTCTime}{\void}
3917 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
3919 \wxheading{See also}
3921 \helpref{wxDateTime::Now}{wxdatetimenow}
3923 \wxheading{Include files}
3928 \membersection{::wxMicroSleep}\label{wxmicrosleep}
3930 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
3932 Sleeps for the specified number of microseconds. The microsecond resolution may
3933 not, in fact, be available on all platforms (currently only Unix platforms with
3934 nanosleep(2) may provide it) in which case this is the same as
3935 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
3937 \wxheading{Include files}
3942 \membersection{::wxMilliSleep}\label{wxmillisleep}
3944 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
3946 Sleeps for the specified number of milliseconds. Notice that usage of this
3947 function is encouraged instead of calling usleep(3) directly because the
3948 standard usleep() function is not MT safe.
3950 \wxheading{Include files}
3955 \membersection{::wxNow}\label{wxnow}
3957 \func{wxString}{wxNow}{\void}
3959 Returns a string representing the current date and time.
3961 \wxheading{Include files}
3966 \membersection{::wxSleep}\label{wxsleep}
3968 \func{void}{wxSleep}{\param{int}{ secs}}
3970 Sleeps for the specified number of seconds.
3972 \wxheading{Include files}
3977 \membersection{::wxStartTimer}\label{wxstarttimer}
3979 \func{void}{wxStartTimer}{\void}
3981 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
3983 See also \helpref{wxTimer}{wxtimer}.
3985 \wxheading{Include files}
3990 \membersection{::wxUsleep}\label{wxusleep}
3992 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
3994 This function is deprecated because its name is misleading: notice that the
3995 argument is in milliseconds, not microseconds. Please use either
3996 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
3997 depending on the resolution you need.
4001 \section{Debugging macros and functions}\label{debugmacros}
4003 Useful macros and functions for error checking and defensive programming.
4004 wxWidgets defines three families of the assert-like macros:
4005 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
4006 (in other words, in the debug build) but disappear completely in the release
4007 build. On the other hand, the wxCHECK macros stay event in release builds but a
4008 check failure doesn't generate any user-visible effects then. Finally, the
4009 compile time assertions don't happen during the run-time but result in the
4010 compilation error messages if the condition they check fail.
4012 \wxheading{Include files}
4017 \membersection{::wxOnAssert}\label{wxonassert}
4019 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
4021 This function is called whenever one of debugging macros fails (i.e. condition
4022 is false in an assertion). It is only defined in the debug mode, in release
4023 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
4025 To override the default behaviour in the debug builds which is to show the user
4026 a dialog asking whether he wants to abort the program, continue or continue
4027 ignoring any subsequent assert failures, you may override
4028 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
4029 the global application object exists.
4032 \membersection{wxASSERT}\label{wxassert}
4034 \func{}{wxASSERT}{\param{}{condition}}
4036 Assert macro. An error message will be generated if the condition is false in
4037 debug mode, but nothing will be done in the release build.
4039 Please note that the condition in wxASSERT() should have no side effects
4040 because it will not be executed in release mode at all.
4042 \wxheading{See also}
4044 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4045 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4048 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
4050 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
4052 This macro results in a
4053 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
4054 of the given type {\it type} is less than {\it size} bits.
4056 You may use it like this, for example:
4059 // we rely on the int being able to hold values up to 2^32
4060 wxASSERT_MIN_BITSIZE(int, 32);
4062 // can't work with the platforms using UTF-8 for wchar_t
4063 wxASSERT_MIN_BITSIZE(wchar_t, 16);
4067 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
4069 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
4071 Assert macro with message. An error message will be generated if the condition is false.
4073 \wxheading{See also}
4075 \helpref{wxASSERT}{wxassert},\\
4076 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4079 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4081 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4083 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4084 specified {\it condition} is false. The compiler error message should include
4085 the {\it msg} identifier - please note that it must be a valid C++ identifier
4086 and not a string unlike in the other cases.
4088 This macro is mostly useful for testing the expressions involving the
4089 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4090 sometimes desirable to test them at the compile time.
4092 Note that this macro internally declares a struct whose name it tries to make
4093 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4094 use it on the same line in two different source files. In this case you may
4095 either change the line in which either of them appears on or use the
4096 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4098 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4099 if you use this macro with `Program Database For Edit And Continue'
4100 (\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
4101 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4103 \wxheading{See also}
4105 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4106 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4109 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4111 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4113 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4114 except that it allows you to specify a unique {\it name} for the struct
4115 internally defined by this macro to avoid getting the compilation errors
4116 described \helpref{above}{wxcompiletimeassert}.
4119 \membersection{wxFAIL}\label{wxfail}
4121 \func{}{wxFAIL}{\void}
4123 Will always generate an assert error if this code is reached (in debug mode).
4125 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4128 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4130 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4132 Will always generate an assert error with specified message if this code is reached (in debug mode).
4134 This macro is useful for marking unreachable" code areas, for example
4135 it may be used in the "default:" branch of a switch statement if all possible
4136 cases are processed above.
4138 \wxheading{See also}
4140 \helpref{wxFAIL}{wxfail}
4143 \membersection{wxCHECK}\label{wxcheck}
4145 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4147 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4148 This check is done even in release mode.
4151 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4153 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4155 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4156 This check is done even in release mode.
4158 This macro may be only used in non void functions, see also
4159 \helpref{wxCHECK\_RET}{wxcheckret}.
4162 \membersection{wxCHECK\_RET}\label{wxcheckret}
4164 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4166 Checks that the condition is true, and returns if not (FAILs with given error
4167 message in debug mode). This check is done even in release mode.
4169 This macro should be used in void functions instead of
4170 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4173 \membersection{wxCHECK2}\label{wxcheck2}
4175 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4177 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4178 {\it operation} if it is not. This is a generalisation of
4179 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4180 returning from the function must be done when the {\it condition} is false.
4182 This check is done even in release mode.
4185 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4187 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4189 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4190 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4191 instead of wxFAIL() if the {\it condition} is false.
4194 \membersection{::wxTrap}\label{wxtrap}
4196 \func{void}{wxTrap}{\void}
4198 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4199 debugger exception meaning that the control is passed to the debugger if one is
4200 attached to the process. Otherwise the program just terminates abnormally.
4202 In release mode this function does nothing.
4204 \wxheading{Include files}
4210 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4212 \func{bool}{wxIsDebuggerRunning}{\void}
4214 Returns {\tt true} if the program is running under debugger, {\tt false}
4217 Please note that this function is currently only implemented for Mac builds
4218 using CodeWarrior and always returns {\tt false} elsewhere.
4223 \section{Environment access functions}\label{environfunctions}
4225 The functions in this section allow to access (get) or change value of
4226 environment variables in a portable way. They are currently implemented under
4227 Win32 and POSIX-like systems (Unix).
4229 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4231 \wxheading{Include files}
4236 \membersection{wxGetenv}\label{wxgetenvmacro}
4238 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4240 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4243 Note that under Win32 it may not return correct value for the variables set
4244 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4248 \membersection{wxGetEnv}\label{wxgetenv}
4250 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4252 Returns the current value of the environment variable {\it var} in {\it value}.
4253 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4254 and are not interested in its value.
4256 Returns {\tt true} if the variable exists, {\tt false} otherwise.
4259 \membersection{wxSetEnv}\label{wxsetenv}
4261 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4263 Sets the value of the environment variable {\it var} (adding it if necessary)
4266 Returns {\tt true} on success.
4269 \membersection{wxUnsetEnv}\label{wxunsetenv}
4271 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4273 Removes the variable {\it var} from the environment.
4274 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4277 Returns {\tt true} on success.