1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: Functions and macros
4 %% Author: wxWidgets Team
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \chapter{Functions
}\label{functions
}
13 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
14 \setfooter{\thepage}{}{}{}{}{\thepage}
16 The functions and macros defined in wxWidgets are described here: you can
17 either look up a function using the alphabetical listing of them or find it in
18 the corresponding topic.
20 \section{Alphabetical functions and macros list
}\label{functionsalphabetically
}
22 \helpref{CLASSINFO
}{classinfo
}\\
23 \helpref{copystring
}{copystring
}\\
24 \helpref{DECLARE
\_ABSTRACT\_CLASS}{declareabstractclass
}\\
25 \helpref{DECLARE
\_APP}{declareapp
}\\
26 \helpref{DECLARE
\_CLASS}{declareclass
}\\
27 \helpref{DECLARE
\_DYNAMIC\_CLASS}{declaredynamicclass
}\\
28 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS2}{implementabstractclass2
}\\
29 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS}{implementabstractclass
}\\
30 \helpref{IMPLEMENT
\_APP}{implementapp
}\\
31 \helpref{IMPLEMENT
\_CLASS2}{implementclass2
}\\
32 \helpref{IMPLEMENT
\_CLASS}{implementclass
}\\
33 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS2}{implementdynamicclass2
}\\
34 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS}{implementdynamicclass
}\\
35 \helpref{wxAboutBox
}{wxaboutbox
}\\
36 \helpref{wxASSERT
}{wxassert
}\\
37 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
38 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
39 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
40 \helpref{wxBell
}{wxbell
}\\
41 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
42 \helpref{wxCHANGE
\_UMASK}{wxchangeumask
}\\
43 \helpref{wxCHECK
}{wxcheck
}\\
44 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
45 \helpref{wxCHECK2
}{wxcheck2
}\\
46 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
47 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
48 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
49 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
50 \helpref{wxCHECK
\_VERSION\_FULL}{wxcheckversionfull
}\\
51 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
52 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
53 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
54 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
55 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
56 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
57 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
58 \helpref{wxCONCAT
}{wxconcat
}\\
59 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
60 \helpref{wxConstCast
}{wxconstcast
}\\
61 \helpref{wxCopyFile
}{wxcopyfile
}\\
62 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
63 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
64 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}\\
65 \helpref{wxCRIT
\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember
}\\
66 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}\\
67 \helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
}\\
% wxcs already taken!
68 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
69 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
70 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
71 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
72 \helpref{WXDEBUG
\_NEW}{debugnew
}\\
73 \helpref{wxDirExists
}{functionwxdirexists
}\\
74 \helpref{wxDirSelector
}{wxdirselector
}\\
75 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
76 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
77 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
78 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
79 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
80 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
81 \helpref{wxDYNLIB
\_FUNCTION}{wxdynlibfunction
}\\
82 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
83 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
84 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
85 \helpref{wxENTER
\_CRIT\_SECT}{wxentercritsect
}\\
86 \helpref{wxEntry
}{wxentry
}\\
87 \helpref{wxEntryStart
}{wxentrystart
}\\
88 \helpref{wxEntryCleanup
}{wxentrycleanup
}\\
89 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
90 \helpref{wxError
}{wxerror
}\\
91 \helpref{wxExecute
}{wxexecute
}\\
92 \helpref{wxExit
}{wxexit
}\\
93 \helpref{wxEXPLICIT
}{wxexplicit
}\\
94 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
95 \helpref{wxFAIL
}{wxfail
}\\
96 \helpref{wxFatalError
}{wxfatalerror
}\\
97 \helpref{wxFileExists
}{functionwxfileexists
}\\
98 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
99 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
100 \helpref{wxFileSelector
}{wxfileselector
}\\
101 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
102 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
103 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
104 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
105 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
106 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
107 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
108 \helpref{wxFinite
}{wxfinite
}\\
109 \helpref{wxGenericAboutBox
}{wxgenericaboutbox
}\\
110 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
111 \helpref{wxGetApp
}{wxgetapp
}\\
112 \helpref{wxGetBatteryState
}{wxgetbatterystate
}\\
113 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
114 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
115 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
116 \helpref{wxGetCwd
}{wxgetcwd
}\\
117 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
118 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
119 \helpref{wxGetDisplaySize
}{wxdisplaysize
}\\
120 \helpref{wxGetDisplaySizeMM
}{wxdisplaysizemm
}\\
121 \helpref{wxGetElapsedTime
}{wxgetelapsedtime
}\\
122 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
123 \helpref{wxGetEnv
}{wxgetenv
}\\
124 \helpref{wxGetFileKind
}{wxgetfilekind
}\\
125 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
126 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
127 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
128 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
129 \helpref{wxGetHostName
}{wxgethostname
}\\
130 \helpref{wxGetKeyState
}{wxgetkeystate
}\\
131 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
132 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
133 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
134 \helpref{wxGetMouseState
}{wxgetmousestate
}\\
135 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
136 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
137 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
138 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
139 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
140 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
141 \helpref{wxGetPowerType
}{wxgetpowertype
}\\
142 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
143 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
144 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
145 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
146 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
147 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
148 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
149 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
150 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
151 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
152 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
153 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
154 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
155 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
156 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
157 \helpref{wxGetTranslation
}{wxgettranslation
}\\
158 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
159 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
160 \helpref{wxGetUserId
}{wxgetuserid
}\\
161 \helpref{wxGetUserName
}{wxgetusername
}\\
162 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
163 \helpref{wxGetenv
}{wxgetenvmacro
}\\
164 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
165 \helpref{wxICON
}{wxiconmacro
}\\
166 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
167 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
168 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
169 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
170 \helpref{wxInitialize
}{wxinitialize
}\\
171 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
172 \helpref{wxIsBusy
}{wxisbusy
}\\
173 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
174 \helpref{wxIsDebuggerRunning
}{wxisdebuggerrunning
}\\
175 \helpref{wxIsEmpty
}{wxisempty
}\\
176 \helpref{wxIsMainThread
}{wxismainthread
}\\
177 \helpref{wxIsNaN
}{wxisnan
}\\
178 \helpref{wxIsPlatformLittleEndian
}{wxisplatformlittleendian
}\\
179 \helpref{wxIsPlatform64Bit
}{wxisplatform64bit
}\\
180 \helpref{wxIsWild
}{wxiswild
}\\
181 \helpref{wxJoin
}{wxjoin
}\\
182 \helpref{wxKill
}{wxkill
}\\
183 \helpref{wxLaunchDefaultBrowser
}{wxlaunchdefaultbrowser
}\\
184 \helpref{wxLEAVE
\_CRIT\_SECT}{wxleavecritsect
}\\
185 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
186 \helpref{wxLogDebug
}{wxlogdebug
}\\
187 \helpref{wxLogError
}{wxlogerror
}\\
188 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
189 \helpref{wxLogMessage
}{wxlogmessage
}\\
190 \helpref{wxLogStatus
}{wxlogstatus
}\\
191 \helpref{wxLogSysError
}{wxlogsyserror
}\\
192 \helpref{wxLogTrace
}{wxlogtrace
}\\
193 \helpref{wxLogVerbose
}{wxlogverbose
}\\
194 \helpref{wxLogWarning
}{wxlogwarning
}\\
195 \helpref{wxLL
}{wxll
}\\
196 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
197 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
198 \helpref{wxMatchWild
}{wxmatchwild
}\\
199 \helpref{wxMessageBox
}{wxmessagebox
}\\
200 \helpref{wxMilliSleep
}{wxmillisleep
}\\
201 \helpref{wxMicroSleep
}{wxmicrosleep
}\\
202 \helpref{wxMkdir
}{wxmkdir
}\\
203 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
204 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
205 \helpref{wxNewId
}{wxnewid
}\\
206 \helpref{wxNow
}{wxnow
}\\
207 \helpref{wxOnAssert
}{wxonassert
}\\
208 \helpref{wxON
\_BLOCK\_EXIT}{wxonblockexit
}\\
209 \helpref{wxON
\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj
}\\
210 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
211 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
212 \helpref{wxPathOnly
}{wxpathonly
}\\
213 \helpref{wxPLURAL
}{wxplural
}\\
214 \helpref{wxPostDelete
}{wxpostdelete
}\\
215 \helpref{wxPostEvent
}{wxpostevent
}\\
216 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
217 \helpref{wxRegisterId
}{wxregisterid
}\\
218 \helpref{wxRemoveFile
}{wxremovefile
}\\
219 \helpref{wxRenameFile
}{wxrenamefile
}\\
220 \helpref{wxRmdir
}{wxrmdir
}\\
221 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
222 \helpref{wxSafeYield
}{wxsafeyield
}\\
223 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
224 \helpref{wxSetCursor
}{wxsetcursor
}\\
225 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
226 \helpref{wxSetEnv
}{wxsetenv
}\\
227 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
228 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
229 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
230 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
231 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
232 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
233 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
234 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
235 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
236 \helpref{wxShell
}{wxshell
}\\
237 \helpref{wxShowTip
}{wxshowtip
}\\
238 \helpref{wxShutdown
}{wxshutdown
}\\
239 \helpref{wxSleep
}{wxsleep
}\\
240 \helpref{wxSnprintf
}{wxsnprintf
}\\
241 \helpref{wxSplit
}{wxsplit
}\\
242 \helpref{wxSplitPath
}{wxsplitfunction
}\\
243 \helpref{wxStartTimer
}{wxstarttimer
}\\
244 \helpref{wxStaticCast
}{wxstaticcast
}\\
245 \helpref{wxStrcmp
}{wxstrcmp
}\\
246 \helpref{wxStricmp
}{wxstricmp
}\\
247 \helpref{wxStringEq
}{wxstringeq
}\\
248 \helpref{wxStringMatch
}{wxstringmatch
}\\
249 \helpref{wxStringTokenize
}{wxstringtokenize
}\\
250 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
251 \helpref{wxStrlen
}{wxstrlen
}\\
252 \helpref{wxSTRINGIZE
}{wxstringize
}\\
253 \helpref{wxSTRINGIZE
\_T}{wxstringizet
}\\
254 \helpref{wxSUPPRESS
\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning
}\\
255 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
256 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
258 \helpref{wxTrace
}{wxtrace
}\\
259 \helpref{WXTRACE
}{trace
}\\
260 \helpref{wxTraceLevel
}{wxtracelevel
}\\
261 \helpref{WXTRACELEVEL
}{tracelevel
}\\
262 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
263 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
264 \helpref{wxTrap
}{wxtrap
}\\
265 \helpref{wxULL
}{wxull
}\\
266 \helpref{wxUninitialize
}{wxuninitialize
}\\
267 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
268 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
269 \helpref{wxUsleep
}{wxusleep
}\\
270 \helpref{wxVaCopy
}{wxvacopy
}\\
271 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
272 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
273 \helpref{wxYield
}{wxyield
}\\
274 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
275 \helpref{wx
\_reinterpret\_cast}{wxreinterpretcastraw
}\\
276 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
277 \helpref{wx
\_truncate\_cast}{wxtruncatecast
}\\
278 \helpref{\_}{underscore
}\\
279 \helpref{\_T}{underscoret
}
280 \helpref{\_\_WXFUNCTION\_\_}{wxfunction
}
284 \section{Version macros
}\label{versionfunctions
}
286 The following constants are defined in wxWidgets:
288 \begin{itemize
}\itemsep=
0pt
289 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
290 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
291 \item {\tt wxRELEASE
\_NUMBER} is the release number
292 \item {\tt wxSUBRELEASE
\_NUMBER} is the subrelease number which is $
0$ for all
296 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
299 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
300 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
301 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
304 The subrelease number is only used for the sources in between official releases
305 and so normally is not useful.
307 \wxheading{Include files
}
309 <wx/version.h> or <wx/defs.h>
312 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
314 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor
}}
316 Returns $
1$ if the compiler being used to compile the code is GNU C++
317 compiler (g++) version major.minor or greater. Otherwise, and also if
318 the compiler is not GNU C++ at all, returns $
0$.
321 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
323 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
325 This is a macro which evaluates to true if the current wxWidgets version is at
326 least major.minor.release.
328 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
329 the following can be done:
333 #if wxCHECK_VERSION(
2,
2,
0)
334 if ( s.StartsWith("foo") )
335 #else // replacement code for old version
336 if ( strncmp(s, "foo",
3) ==
0 )
344 \membersection{wxCHECK
\_VERSION\_FULL}\label{wxcheckversionfull
}
346 \func{bool
}{wxCHECK
\_VERSION\_FULL}{\param{}{major, minor, release, subrel
}}
348 Same as
\helpref{wxCHECK
\_VERSION}{wxcheckversion
} but also checks that
349 \texttt{wxSUBRELEASE
\_NUMBER} is at least
\arg{subrel
}.
352 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
354 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
356 Returns $
1$ if the version of w32api headers used is major.minor.release or
357 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
358 Win32 at all, returns $
0$.
362 \section{Application initialization and termination
}\label{appinifunctions
}
364 The functions in this section are used on application startup/shutdown and also
365 to control the behaviour of the main event loop of the GUI programs.
368 \membersection{::wxEntry
}\label{wxentry
}
370 This initializes wxWidgets in a platform-dependent way. Use this if you are not
371 using the default wxWidgets entry code (e.g. main or WinMain). For example, you
372 can initialize wxWidgets from an Microsoft Foundation Classes application using
375 The following overload of wxEntry is available under all platforms:
377 \func{int
}{wxEntry
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
379 Under MS Windows, an additional overload suitable for calling from
380 \texttt{WinMain
} is available:
382 \func{int
}{wxEntry
}{\param{HINSTANCE
}{hInstance
},
\param{HINSTANCE
}{hPrevInstance =
\NULL},
\param{char *
}{pCmdLine =
\NULL},
\param{int
}{nCmdShow =
\texttt{SW
\_SHOWNORMAL}}}
384 (notice that under Windows CE platform, and only there, the type of
385 \arg{pCmdLine
} is
\texttt{wchar
\_t *
}, otherwise it is
\texttt{char *
}, even in
390 \helpref{wxEntryStart
}{wxentrystart
}
394 To clean up wxWidgets, call wxApp::OnExit followed by the static function
395 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
398 int CTheApp::ExitInstance()
400 // OnExit isn't called by CleanUp so must be called explicitly.
404 return CWinApp::ExitInstance();
408 \wxheading{Include files
}
414 \membersection{::wxEntryCleanup
}\label{wxentrycleanup
}
416 \func{void
}{wxEntryCleanup
}{\void}
418 Free resources allocated by a successful call to
\helpref{wxEntryStart
}{wxentrystart
}.
420 \wxheading{Include files
}
425 \membersection{::wxEntryStart
}\label{wxentrystart
}
427 \func{bool
}{wxEntryStart
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
429 This function can be used to perform the initialization of wxWidgets if you
430 can't use the default initialization code for any reason.
432 If the function returns
\true, the initialization was successful and the global
433 \helpref{wxApp
}{wxapp
} object
\texttt{wxTheApp
} has been created. Moreover,
434 \helpref{wxEntryCleanup
}{wxentrycleanup
} must be called afterwards. If the
435 function returns
\false, a catastrophic initialization error occured and (at
436 least the GUI part of) the library can't be used at all.
438 Notice that parameters
\arg{argc
} and
\arg{argv
} may be modified by this
441 \wxheading{Include files
}
446 \membersection{::wxGetApp
}\label{wxgetapp
}
448 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
450 This function doesn't exist in wxWidgets but it is created by using
451 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
452 anywhere but in the same module where this macro is used, you must make it
453 available using
\helpref{DECLARE
\_APP}{declareapp
}.
455 The advantage of using this function compared to directly using the global
456 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
457 allow you to access the functions specific to your application class but not
458 present in wxApp while wxGetApp() returns the object of the right type.
461 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
463 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
465 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
466 faults under Windows or segmentation violations in the Unix world) will be
467 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
468 By default, i.e. before this function is called, they will be handled in the
469 normal way which usually just means that the application will be terminated.
470 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
471 this default behaviour.
474 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
476 \func{void
}{wxInitAllImageHandlers
}{\void}
478 Initializes all available image handlers. For a list of available handlers,
479 see
\helpref{wxImage
}{wximage
}.
483 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
485 \wxheading{Include files
}
490 \membersection{::wxInitialize
}\label{wxinitialize
}
492 \func{bool
}{wxInitialize
}{\void}
494 This function is used in wxBase only and only if you don't create
495 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
496 {\tt main()
} function before calling any other wxWidgets functions.
498 If the function returns
\false the initialization could not be performed,
499 in this case the library cannot be used and
500 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
502 This function may be called several times but
503 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
504 call to this function.
506 \wxheading{Include files
}
511 \membersection{::wxSafeYield
}\label{wxsafeyield
}
513 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
514 onlyIfNeeded = false
}}
516 This function is similar to wxYield, except that it disables the user input to
517 all program windows before calling wxYield and re-enables it again
518 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
519 allowing the implementation of some limited user interaction.
521 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
523 \wxheading{Include files
}
528 \membersection{::wxUninitialize
}\label{wxuninitialize
}
530 \func{void
}{wxUninitialize
}{\void}
532 This function is for use in console (wxBase) programs only. It must be called
533 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
535 \wxheading{Include files
}
540 \membersection{::wxYield
}\label{wxyield
}
542 \func{bool
}{wxYield
}{\void}
544 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
546 This function is kept only for backwards compatibility. Please use
547 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
549 \wxheading{Include files
}
551 <wx/app.h> or <wx/utils.h>
554 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
556 \func{void
}{wxWakeUpIdle
}{\void}
558 This functions wakes up the (internal and platform dependent) idle system, i.e. it
559 will force the system to send an idle event even if the system currently
{\it is
}
560 idle and thus would not send any idle event until after some other event would get
561 sent. This is also useful for sending events between two threads and is used by
562 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
563 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
565 \wxheading{Include files
}
571 \section{Process control functions
}\label{processfunctions
}
573 The functions in this section are used to launch or terminate the other
577 \membersection{::wxExecute
}\label{wxexecute
}
579 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
581 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
583 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
585 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
587 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{int
}{flags =
0}}
589 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
590 only takes the
{\tt command
} argument,
591 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
594 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
},
\param{int
}{flags =
0}}
596 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
597 and it only takes the
{\tt command
} argument,
598 and returns a
3-element list
{\tt ( status, output, errors )
}, where
599 {\tt output
} and
{\tt errors
} are array references.
}
601 Executes another program in Unix or Windows.
603 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
605 The second form takes an array of values: a command, any number of
606 arguments, terminated by NULL.
608 The semantics of the third and fourth versions is different from the first two
609 and is described in more details below.
611 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
612 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
613 application waits until the other program has terminated.
615 In the case of synchronous execution, the return value is the exit code of
616 the process (which terminates by the moment the function returns) and will be
617 $-
1$ if the process couldn't be started and typically
0 if the process
618 terminated successfully. Also, while waiting for the process to
619 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. Because of this, by
620 default this function disables all application windows to avoid unexpected
621 reentrancies which could result from the users interaction with the program
622 while the child process is running. If you are sure that it is safe to not
623 disable the program windows, you may pass
\texttt{wxEXEC
\_NODISABLE} flag to
624 prevent this automatic disabling from happening.
626 For asynchronous execution, however, the return value is the process id and
627 zero value indicates that the command could not be executed. As an added
628 complication, the return value of $-
1$ in this case indicates that we didn't
629 launch a new process, but connected to the running one (this can only happen in
630 case of using DDE under Windows for command execution). In particular, in this,
631 and only this, case the calling code will not get the notification about
634 If callback isn't NULL and if execution is asynchronous,
635 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
636 the process finishes. Specifying this parameter also allows you to redirect the
637 standard input and/or output of the process being launched by calling
638 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
639 under Windows the process window is not shown by default (this avoids having to
640 flush an unnecessary console for the processes which don't create any windows
641 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
642 happening, i.e. with this flag the child process window will be shown normally.
644 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
645 that the new process is a group leader (this will create a new session if
646 needed). Calling
\helpref{wxKill
}{wxkill
} passing wxKILL
\_CHILDREN will
647 kill this process as well as all of its children (except those which have
648 started their own session).
650 Finally, you may use the third overloaded version of this function to execute
651 a process (always synchronously, the contents of
\arg{flags
} is or'd with
652 \texttt{wxEXEC
\_SYNC}) and capture its output in the array
\arg{output
}. The
653 fourth version adds the possibility to additionally capture the messages from
654 standard error output in the
\arg{errors
} array.
656 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
657 this function from another thread will result in an assert failure in debug
658 build and won't work.
662 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
664 \wxheading{Parameters
}
666 \docparam{command
}{The command to execute and any parameters to pass to it as a
669 \docparam{argv
}{The command to execute should be the first element of this
670 array, any additional ones are the command parameters and the array must be
671 terminated with a NULL pointer.
}
673 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
674 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
676 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
678 \wxheading{Include files
}
683 \membersection{::wxExit
}\label{wxexit
}
685 \func{void
}{wxExit
}{\void}
687 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
688 Should only be used in an emergency: normally the top-level frame
689 should be deleted (after deleting all other frames) to terminate the
690 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
692 \wxheading{Include files
}
697 \membersection{::wxJoin
}\label{wxjoin
}
699 \func{wxString
}{wxJoin
}{\param{const wxArrayString\&
}{ arr
},
\param{const wxChar
}{ sep
},
\param{const wxChar
}{ escape = '$
\backslash$'
}}
701 Concatenate all lines of the given
\helpref{wxArrayString
}{wxarraystring
} object using the separator
\arg{sep
} and returns
702 the result as a
\helpref{wxString
}{wxstring
}.
704 If the
\arg{escape
} character is non-
\NULL, then it's used as prefix for each occurrence of
\arg{sep
}
705 in the strings contained in
\arg{arr
} before joining them which is necessary
706 in order to be able to recover the original array contents from the string
707 later using
\helpref{wxSplit
}{wxsplit
}.
709 \wxheading{Include files
}
714 \membersection{::wxKill
}\label{wxkill
}
716 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
},
\param{int
}{flags =
0}}
718 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
719 process with PID
{\it pid
}. The valid signal values are
724 wxSIGNONE =
0, // verify if the process exists under Unix
733 wxSIGKILL, // forcefully kill, dangerous!
739 wxSIGTERM // terminate the process gently
743 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
744 under both Unix and Windows but all the other signals are equivalent to
745 {\tt wxSIGTERM
} under Windows.
747 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
748 be filled with an element of
{\tt wxKillError
} enum:
753 wxKILL_OK, // no error
754 wxKILL_BAD_SIGNAL, // no such signal
755 wxKILL_ACCESS_DENIED, // permission denied
756 wxKILL_NO_PROCESS, // no such process
757 wxKILL_ERROR // another, unspecified error
761 The
{\it flags
} parameter can be wxKILL
\_NOCHILDREN (the default),
762 or wxKILL
\_CHILDREN, in which case the child processes of this
763 process will be killed too. Note that under Unix, for wxKILL
\_CHILDREN
764 to work you should have created the process by passing wxEXEC
\_MAKE\_GROUP\_LEADER
769 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
770 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
771 \helpref{Exec sample
}{sampleexec
}
773 \wxheading{Include files
}
778 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
780 \func{unsigned long
}{wxGetProcessId
}{\void}
782 Returns the number uniquely identifying the current process in the system.
784 If an error occurs, $
0$ is returned.
786 \wxheading{Include files
}
791 \membersection{::wxShell
}\label{wxshell
}
793 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
795 Executes a command in an interactive shell window. If no command is
796 specified, then just the shell is spawned.
798 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
800 \wxheading{Include files
}
805 \membersection{::wxShutdown
}\label{wxshutdown
}
807 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
809 This function shuts down or reboots the computer depending on the value of the
810 {\it flags
}. Please notice that doing this requires the corresponding access
811 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privilege under Windows NT)
812 and that this function is only implemented under Unix and Win32.
814 \wxheading{Parameters
}
816 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
820 \true on success,
\false if an error occurred.
822 \wxheading{Include files
}
828 \section{Thread functions
}\label{threadfunctions
}
830 The functions and macros here mainly exist to make it writing the code which
831 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
832 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
834 For example, a static variable must be protected against simultaneous access by
835 multiple threads in the former configuration but in the latter the extra
836 overhead of using the critical section is not needed. To solve this problem,
837 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
838 to create and use the critical section only when needed.
840 \wxheading{Include files
}
846 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
850 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
852 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
854 This macro declares a (static) critical section object named
{\it cs
} if
855 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
859 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
861 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
863 This macro declares a critical section object named
{\it cs
} if
864 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
865 include the
{\tt static
} keyword (unlike
866 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
867 a class or struct member which explains its name.
871 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
873 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
875 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
876 object named
{\it name
} and associated with the critical section
{\it cs
} if
877 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
881 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
883 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
885 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
886 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
887 section object and also the lock object associated with it. Because of this, it
888 can be only used inside a function, not at global scope. For example:
893 static int s_counter =
0;
895 wxCRITICAL_SECTION(counter);
901 (note that we suppose that the function is called the first time from the main
902 thread so that the critical section object is initialized correctly by the time
903 other threads start calling it, if this is not the case this approach can
904 {\bf not
} be used and the critical section must be made a global instead).
908 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
910 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
912 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
913 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
917 \membersection{::wxIsMainThread
}\label{wxismainthread
}
919 \func{bool
}{wxIsMainThread
}{\void}
921 Returns
\true if this thread is the main one. Always returns
\true if
922 {\tt wxUSE
\_THREADS} is $
0$.
926 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
928 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
930 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
931 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
935 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
937 \func{void
}{wxMutexGuiEnter
}{\void}
939 This function must be called when any thread other than the main GUI thread
940 wants to get access to the GUI library. This function will block the execution
941 of the calling thread until the main thread (or any other thread holding the
942 main GUI lock) leaves the GUI library and no other thread will enter the GUI
943 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
945 Typically, these functions are used like this:
948 void MyThread::Foo(void)
950 // before doing any GUI calls we must ensure that this thread is the only
956 my_window->DrawSomething();
962 Note that under GTK, no creation of top-level windows is allowed in any
963 thread but the main one.
965 This function is only defined on platforms which support preemptive
969 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
971 \func{void
}{wxMutexGuiLeave
}{\void}
973 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
975 This function is only defined on platforms which support preemptive
980 \section{File functions
}\label{filefunctions
}
982 \wxheading{Include files
}
988 \helpref{wxPathList
}{wxpathlist
}\\
989 \helpref{wxDir
}{wxdir
}\\
990 \helpref{wxFile
}{wxfile
}\\
991 \helpref{wxFileName
}{wxfilename
}
994 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
996 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
998 Converts a DOS to a Unix filename by replacing backslashes with forward
1002 \membersection{::wxFileExists
}\label{functionwxfileexists
}
1004 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
1006 Returns true if the file exists and is a plain file.
1009 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
1011 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
1013 Returns time of last modification of given file.
1015 The function returns
\texttt{(time
\_t)
}$-
1$ if an error occurred (e.g. file not
1019 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
1021 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
1023 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
1025 {\bf NB:
} This function is obsolete, please use
1026 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
1028 Returns the filename for a full path. The second form returns a pointer to
1029 temporary storage that should not be deallocated.
1032 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
1034 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
1036 This function does directory searching; returns the first file
1037 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
1038 get the next matching file. Neither will
report the current directory "." or the
1039 parent directory "..".
1043 As of wx
2.5.2, these functions are not thread-safe! (they use static variables). You probably want to use
\helpref{wxDir::GetFirst
}{wxdirgetfirst
} or
\helpref{wxDirTraverser
}{wxdirtraverser
} instead.
1045 {\it spec
} may contain wildcards.
1047 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
1052 wxString f = wxFindFirstFile("/home/project/*.*");
1053 while ( !f.empty() )
1056 f = wxFindNextFile();
1061 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
1063 \func{wxString
}{wxFindNextFile
}{\void}
1065 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
1067 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
1070 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
1072 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
1074 This function returns the total number of bytes and number of free bytes on
1075 the disk containing the directory
{\it path
} (it should exist). Both
1076 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
1077 information is not needed.
1081 \true on success,
\false if an error occurred (for example, the
1082 directory doesn't exist).
1084 \wxheading{Portability
}
1086 The generic Unix implementation depends on the system having
1087 the
\texttt{statfs()
} or
\texttt{statvfs()
} function.
1089 This function first appeared in wxWidgets
2.3.2.
1092 \membersection{::wxGetFileKind
}\label{wxgetfilekind
}
1094 \func{wxFileKind
}{wxGetFileKind
}{\param{int
}{fd
}}
1096 \func{wxFileKind
}{wxGetFileKind
}{\param{FILE *
}{fp
}}
1098 Returns the type of an open file. Possible return values are:
1103 wxFILE_KIND_UNKNOWN,
1104 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
1105 wxFILE_KIND_TERMINAL, // a tty
1106 wxFILE_KIND_PIPE // a pipe
1111 \wxheading{Include files
}
1116 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
1118 \func{wxString
}{wxGetOSDirectory
}{\void}
1120 Returns the Windows directory under Windows; on other platforms returns the empty string.
1123 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
1125 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
1127 Returns true if the argument is an absolute filename, i.e. with a slash
1128 or drive name at the beginning.
1131 \membersection{::wxDirExists
}\label{functionwxdirexists
}
1133 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
1135 Returns true if
\arg{dirname
} exists and is a directory.
1138 \membersection{::wxPathOnly
}\label{wxpathonly
}
1140 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1142 Returns the directory part of the filename.
1145 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1147 \func{void
}{wxUnix2DosFilename
}{\param{wxChar *
}{s
}}
1149 This function is deprecated, use
\helpref{wxFileName
}{wxfilename
} instead.
1151 Converts a Unix to a DOS filename by replacing forward
1152 slashes with backslashes.
1155 \membersection{wxCHANGE
\_UMASK}\label{wxchangeumask
}
1157 \func{}{wxCHANGE
\_UMASK}{\param{int
}{mask
}}
1159 Under Unix this macro changes the current process umask to the given value,
1160 unless it is equal to $-
1$ in which case nothing is done, and restores it to
1161 the original value on scope exit. It works by declaring a variable which sets
1162 umask to
\arg{mask
} in its constructor and restores it in its destructor.
1164 Under other platforms this macro expands to nothing.
1167 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1169 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1170 \param{const wxString\&
}{file3
}}
1172 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1176 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1178 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1180 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1181 {\it overwrite
} parameter is
\true (default), the destination file is overwritten
1182 if it exists, but if
{\it overwrite
} is
\false, the functions fails in this
1185 This function supports resources forks under Mac OS.
1188 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1190 \func{wxString
}{wxGetCwd
}{\void}
1192 Returns a string containing the current (or working) directory.
1195 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1197 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1199 {\bf NB:
} This function is deprecated: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1201 Copies the current working directory into the buffer if supplied, or
1202 copies the working directory into new storage (which you
{\emph must
} delete
1203 yourself) if the buffer is NULL.
1205 {\it sz
} is the size of the buffer if supplied.
1208 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1210 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1212 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1214 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1215 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1216 %% is allocated for the temporary filename using {\it new}.
1218 %% Under Windows, the filename will include the drive and name of the
1219 %% directory allocated for temporary files (usually the contents of the
1220 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1222 %% It is the application's responsibility to create and delete the file.
1224 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1225 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1229 \membersection{::wxIsWild
}\label{wxiswild
}
1231 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1233 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1236 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1238 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1240 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1241 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1242 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1245 \membersection{::wxMkdir
}\label{wxmkdir
}
1247 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1249 Makes the directory
\arg{dir
}, returning true if successful.
1251 {\it perm
} is the access mask for the directory for the systems on which it is
1252 supported (Unix) and doesn't have any effect on the other ones.
1255 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1257 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1259 Parses the
\arg{wildCard
}, returning the number of filters.
1260 Returns
0 if none or if there's a problem.
1261 The arrays will contain an equal number of items found before the error.
1262 On platforms where native dialogs handle only one filter per entry,
1263 entries in arrays are automatically adjusted.
1264 \arg{wildCard
} is in the form:
1266 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1269 \membersection{::wxRemoveFile}\label{wxremovefile}
1271 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1273 Removes \arg{file}, returning true if successful.
1276 \membersection{::wxRenameFile}\label{wxrenamefile}
1278 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
1280 Renames \arg{file1} to \arg{file2}, returning true if successful.
1282 If \arg{overwrite} parameter is true (default), the destination file is
1283 overwritten if it exists, but if \arg{overwrite} is false, the functions fails
1287 \membersection{::wxRmdir}\label{wxrmdir}
1289 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1291 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1293 The {\it flags} parameter is reserved for future use.
1295 Please notice that there is also a wxRmDir() function which simply wraps the
1296 standard POSIX rmdir() function and so return an integer error code instead of
1297 a boolean value (but otherwise is currently identical to wxRmdir), don't
1298 confuse these two functions.
1301 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1303 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1305 Sets the current working directory, returning true if the operation succeeded.
1306 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1309 \membersection{::wxSplit}\label{wxsplit}
1311 \func{wxArrayString}{wxSplit}{\param{const wxString\&}{ str}, \param{const wxChar}{ sep}, \param{const wxChar}{ escape = '\\'}}
1313 Splits the given \helpref{wxString}{wxstring} object using the separator \arg{sep} and returns the
1314 result as a \helpref{wxArrayString}{wxarraystring}.
1316 If the \arg{escape} character is non-\NULL, then the occurrences of \arg{sep} immediately prefixed
1317 with \arg{escape} are not considered as separators.
1319 Note that empty tokens will be generated if there are two or more adjacent separators.
1321 \wxheading{See also}
1323 \helpref{wxJoin}{wxjoin}
1325 \wxheading{Include files}
1330 \membersection{::wxSplitPath}\label{wxsplitfunction}
1332 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1334 {\bf NB:} This function is obsolete, please use
1335 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1337 This function splits a full file name into components: the path (including possible disk/drive
1338 specification under Windows), the base name and the extension. Any of the output parameters
1339 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1340 a particular component.
1342 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1343 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1344 is a valid character in a filename).
1346 On entry, {\it fullname} should be non-NULL (it may be empty though).
1348 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1349 contains the file name and {\it ext} contains the file extension without leading dot. All
1350 three of them may be empty if the corresponding component is. The old contents of the
1351 strings pointed to by these parameters will be overwritten in any case (if the pointers
1355 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1357 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1359 Copies the given file to {\it stream}. Useful when converting an old application to
1360 use streams (within the document/view framework, for example).
1362 \wxheading{Include files}
1367 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1369 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1371 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1372 use streams (within the document/view framework, for example).
1374 \wxheading{Include files}
1380 \section{Network, user and OS functions}\label{networkfunctions}
1382 The functions in this section are used to retrieve information about the
1383 current computer and/or user characteristics.
1386 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1388 \func{wxString}{wxGetEmailAddress}{\void}
1390 \func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
1392 Copies the user's email address into the supplied buffer, by
1393 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1394 and \helpref{wxGetUserId}{wxgetuserid}.
1396 Returns true if successful, false otherwise.
1398 \wxheading{Include files}
1403 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1405 \func{wxMemorySize}{wxGetFreeMemory}{\void}
1407 Returns the amount of free memory in bytes under environments which
1408 support it, and -1 if not supported or failed to perform measurement.
1410 \wxheading{Include files}
1415 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1417 \func{wxString}{wxGetFullHostName}{\void}
1419 Returns the FQDN (fully qualified domain host name) or an empty string on
1422 \wxheading{See also}
1424 \helpref{wxGetHostName}{wxgethostname}
1426 \wxheading{Include files}
1431 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1433 \func{wxString}{wxGetHomeDir}{\void}
1435 Return the (current) user's home directory.
1437 \wxheading{See also}
1439 \helpref{wxGetUserHome}{wxgetuserhome}\\
1440 \helpref{wxStandardPaths}{wxstandardpaths}
1442 \wxheading{Include files}
1447 \membersection{::wxGetHostName}\label{wxgethostname}
1449 \func{wxString}{wxGetHostName}{\void}
1451 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1453 Copies the current host machine's name into the supplied buffer. Please note
1454 that the returned name is {\it not} fully qualified, i.e. it does not include
1457 Under Windows or NT, this function first looks in the environment
1458 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1459 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1461 The first variant of this function returns the hostname if successful or an
1462 empty string otherwise. The second (deprecated) function returns true
1463 if successful, false otherwise.
1465 \wxheading{See also}
1467 \helpref{wxGetFullHostName}{wxgetfullhostname}
1469 \wxheading{Include files}
1474 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1476 \func{wxString}{wxGetOsDescription}{\void}
1478 Returns the string containing the description of the current platform in a
1479 user-readable form. For example, this function may return strings like
1480 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1482 \wxheading{See also}
1484 \helpref{::wxGetOsVersion}{wxgetosversion}
1486 \wxheading{Include files}
1491 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1493 \func{wxOperatingSystemId}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1495 Gets the version and the operating system ID for currently running OS.
1496 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details about wxOperatingSystemId.
1498 \wxheading{See also}
1500 \helpref{::wxGetOsDescription}{wxgetosdescription},
1501 \helpref{wxPlatformInfo}{wxplatforminfo}
1503 \wxheading{Include files}
1508 \membersection{::wxIsPlatformLittleEndian}\label{wxisplatformlittleendian}
1510 \func{bool}{wxIsPlatformLittleEndian}{\void}
1512 Returns \true if the current platform is little endian (instead of big endian).
1513 The check is performed at run-time.
1515 \wxheading{See also}
1517 \helpref{Byte order macros}{byteordermacros}
1519 \wxheading{Include files}
1524 \membersection{::wxIsPlatform64Bit}\label{wxisplatform64bit}
1526 \func{bool}{wxIsPlatform64Bit}{\void}
1528 Returns \true if the operating system the program is running under is 64 bit.
1529 The check is performed at run-time and may differ from the value available at
1530 compile-time (at compile-time you can just check if {\tt sizeof(void*)==
8})
1531 since the program could be running in emulation mode or in a mixed
32/
64 bit system
1532 (bi-architecture operating system).
1534 Very important: this function is not
100\% reliable on some systems given the fact
1535 that there isn't always a standard way to do a reliable check on the OS architecture.
1537 \wxheading{Include files
}
1542 \membersection{::wxGetUserHome
}\label{wxgetuserhome
}
1544 \func{const wxChar *
}{wxGetUserHome
}{\param{const wxString\&
}{user = ""
}}
1546 Returns the home directory for the given user. If the username is empty
1547 (default value), this function behaves like
1548 \helpref{wxGetHomeDir
}{wxgethomedir
}.
1550 \wxheading{Include files
}
1555 \membersection{::wxGetUserId
}\label{wxgetuserid
}
1557 \func{wxString
}{wxGetUserId
}{\void}
1559 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1561 This function returns the "user id" also known as "login name" under Unix i.e.
1562 something like "jsmith". It uniquely identifies the current user (on this system).
1564 Under Windows or NT, this function first looks in the environment
1565 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
1566 in the
{\bf wxWidgets
} section of the WIN.INI file is tried.
1568 The first variant of this function returns the login name if successful or an
1569 empty string otherwise. The second (deprecated) function returns true
1570 if successful, false otherwise.
1572 \wxheading{See also
}
1574 \helpref{wxGetUserName
}{wxgetusername
}
1576 \wxheading{Include files
}
1581 \membersection{::wxGetUserName
}\label{wxgetusername
}
1583 \func{wxString
}{wxGetUserName
}{\void}
1585 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1587 This function returns the full user name (something like "Mr. John Smith").
1589 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
1590 in the
{\bf wxWidgets
} section of the WIN.INI file. If PenWindows
1591 is running, the entry
{\bf Current
} in the section
{\bf User
} of
1592 the PENWIN.INI file is used.
1594 The first variant of this function returns the user name if successful or an
1595 empty string otherwise. The second (deprecated) function returns
\true
1596 if successful,
\false otherwise.
1598 \wxheading{See also
}
1600 \helpref{wxGetUserId
}{wxgetuserid
}
1602 \wxheading{Include files
}
1608 \section{String functions
}\label{stringfunctions
}
1611 \membersection{::copystring
}\label{copystring
}
1613 \func{char *
}{copystring
}{\param{const char *
}{s
}}
1615 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
1616 deleted with the
{\it delete
} operator.
1618 This function is deprecated, use
\helpref{wxString
}{wxstring
} class instead.
1621 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
1623 \func{const wxString\&
}{wxGetTranslation
}{\param{const wxString\&
}{str
},
1624 \param{const wxString\&
}{domain = wxEmptyString
}}
1626 \func{const wxString\&
}{wxGetTranslation
}{\param{const wxString\&
}{str
},
\param{const wxString\&
}{strPlural
},
\param{size
\_t }{n
},
1627 \param{const wxString\&
}{domain = wxEmptyString
}}
1629 This function returns the translation of string
{\it str
} in the current
1630 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
1631 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
1632 original string is returned. In debug build, an error message is logged -- this
1633 should help to find the strings which were not yet translated. If
1634 {\it domain
} is specified then only that domain/catalog is searched
1635 for a matching string. As this function
1636 is used very often, an alternative (and also common in Unix world) syntax is
1637 provided: the
\helpref{\_()
}{underscore
} macro is defined to do the same thing
1638 as wxGetTranslation.
1640 The second form is used when retrieving translation of string that has
1641 different singular and plural form in English or different plural forms in some
1642 other language. It takes two extra arguments: as above,
\arg{str
}
1643 parameter must contain the singular form of the string to be converted and
1644 is used as the key for the search in the catalog. The
\arg{strPlural
} parameter
1645 is the plural form (in English). The parameter
\arg{n
} is used to determine the
1646 plural form. If no message catalog is found
\arg{str
} is returned if `n ==
1',
1647 otherwise
\arg{strPlural
}.
1649 See
\urlref{GNU gettext manual
}{http://www.gnu.org/manual/gettext/html
\_chapter/gettext
\_10.html\#SEC150
}
1650 for additional information on plural forms handling. For a shorter alternative
1651 see the
\helpref{wxPLURAL()
}{wxplural
} macro.
1653 Both versions call
\helpref{wxLocale::GetString
}{wxlocalegetstring
}.
1655 Note that this function is not suitable for literal strings in Unicode
1656 builds, since the literal strings must be enclosed into
1657 \helpref{\_T()
}{underscoret
} or
\helpref{wxT
}{wxt
} macro which makes them
1658 unrecognised by
\texttt{xgettext
}, and so they are not extracted to the message
1659 catalog. Instead, use the
\helpref{\_()
}{underscore
} and
1660 \helpref{wxPLURAL
}{wxplural
} macro for all literal strings.
1663 \membersection{::wxIsEmpty
}\label{wxisempty
}
1665 \func{bool
}{wxIsEmpty
}{\param{const char *
}{ p
}}
1667 Returns
\true if the pointer is either
{\tt NULL
} or points to an empty
1668 string,
\false otherwise.
1671 \membersection{::wxStrcmp
}\label{wxstrcmp
}
1673 \func{int
}{wxStrcmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1675 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1676 to or greater than
{\it p2
}. The comparison is case-sensitive.
1678 This function complements the standard C function
{\it stricmp()
} which performs
1679 case-insensitive comparison.
1682 \membersection{::wxStricmp
}\label{wxstricmp
}
1684 \func{int
}{wxStricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1686 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1687 to or greater than
{\it p2
}. The comparison is case-insensitive.
1689 This function complements the standard C function
{\it strcmp()
} which performs
1690 case-sensitive comparison.
1693 \membersection{::wxStringEq
}\label{wxstringeq
}
1695 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
1697 {\bf NB:
} This function is obsolete, use
\helpref{wxString
}{wxstring
} instead.
1702 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
1706 \membersection{::wxStringMatch
}\label{wxstringmatch
}
1708 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
1709 \param{bool
}{ subString = true
},
\param{bool
}{ exact = false
}}
1711 {\bf NB:
} This function is obsolete, use
\helpref{wxString::Find
}{wxstringfind
} instead.
1713 Returns
\true if the substring
{\it s1
} is found within
{\it s2
},
1714 ignoring case if
{\it exact
} is false. If
{\it subString
} is
\false,
1715 no substring matching is done.
1718 \membersection{::wxStringTokenize
}\label{wxstringtokenize
}
1720 \func{wxArrayString
}{wxStringTokenize
}{\param{const wxString\&
}{str
},\\
1721 \param{const wxString\&
}{delims = wxDEFAULT
\_DELIMITERS},\\
1722 \param{wxStringTokenizerMode
}{mode = wxTOKEN
\_DEFAULT}}
1724 This is a convenience function wrapping
1725 \helpref{wxStringTokenizer
}{wxstringtokenizer
} which simply returns all tokens
1726 found in the given
\arg{str
} in an array.
1729 \helpref{wxStringTokenizer::wxStringTokenizer
}{wxstringtokenizerwxstringtokenizer
}
1730 for the description of the other parameters.
1733 \membersection{::wxStrlen
}\label{wxstrlen
}
1735 \func{size
\_t}{wxStrlen
}{\param{const char *
}{ p
}}
1737 This is a safe version of standard function
{\it strlen()
}: it does exactly the
1738 same thing (i.e. returns the length of the string) except that it returns
0 if
1739 {\it p
} is the
{\tt NULL
} pointer.
1742 \membersection{::wxSnprintf
}\label{wxsnprintf
}
1744 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
1746 This function replaces the dangerous standard function
{\tt sprintf()
} and is
1747 like
{\tt snprintf()
} available on some platforms. The only difference with
1748 sprintf() is that an additional argument - buffer size - is taken and the
1749 buffer is never overflowed.
1751 Returns the number of characters copied to the buffer or -
1 if there is not
1754 \wxheading{See also
}
1756 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
1759 \membersection{wxT
}\label{wxt
}
1761 \func{wxChar
}{wxT
}{\param{char
}{ch
}}
1763 \func{const wxChar *
}{wxT
}{\param{const char *
}{s
}}
1765 wxT() is a macro which can be used with character and string literals (in other
1766 words,
{\tt 'x'
} or
{\tt "foo"
}) to automatically convert them to Unicode in
1767 Unicode build configuration. Please see the
1768 \helpref{Unicode overview
}{unicode
} for more information.
1770 This macro is simply returns the value passed to it without changes in ASCII
1771 build. In fact, its definition is:
1774 #define wxT(x) L ## x
1781 \membersection{wxTRANSLATE
}\label{wxtranslate
}
1783 \func{const wxChar *
}{wxTRANSLATE
}{\param{const char *
}{s
}}
1785 This macro doesn't do anything in the program code -- it simply expands to the
1786 value of its argument (except in Unicode build where it is equivalent to
1787 \helpref{wxT
}{wxt
} which makes it unnecessary to use both wxTRANSLATE and wxT
1788 with the same string which would be really unreadable).
1790 However it does have a purpose and it is to mark the literal strings for the
1791 extraction into the message catalog created by
{\tt xgettext
} program. Usually
1792 this is achieved using
\helpref{\_()
}{underscore
} but that macro not only marks
1793 the string for extraction but also expands into a
1794 \helpref{wxGetTranslation
}{wxgettranslation
} function call which means that it
1795 cannot be used in some situations, notably for static array
1798 Here is an example which should make it more clear: suppose that you have a
1799 static array of strings containing the weekday names and which have to be
1800 translated (note that it is a bad example, really, as
1801 \helpref{wxDateTime
}{wxdatetime
} already can be used to get the localized week
1802 day names already). If you write
1805 static const wxChar * const weekdays
[] =
{ _("Mon"), ..., _("Sun")
};
1807 // use weekdays
[n
] as usual
1810 the code wouldn't compile because the function calls are forbidden in the array
1811 initializer. So instead you should do
1814 static const wxChar * const weekdays
[] =
{ wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun")
};
1816 // use wxGetTranslation(weekdays
[n
])
1821 Note that although the code
{\bf would
} compile if you simply omit
1822 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1823 no translations for the weekday names in the program message catalog and
1824 wxGetTranslation wouldn't find them.
1826 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
1828 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argPtr
}}
1830 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list }
1831 argument instead of arbitrary number of parameters.
1833 Note that if
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is set to
1, then this function supports
1834 positional arguments (see
\helpref{wxString::Printf
}{wxstringprintf
} for more information).
1835 However other functions of the same family (wxPrintf, wxSprintf, wxFprintf, wxVfprintf,
1836 wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional parameters
1837 even when
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is
1.
1839 \wxheading{See also
}
1841 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
1845 \membersection{\_}\label{underscore
}
1847 \func{const wxString\&
}{\_}{\param{const wxString\&
}{s
}}
1849 This macro expands into a call to
\helpref{wxGetTranslation
}{wxgettranslation
}
1850 function, so it marks the message for the extraction by
{\tt xgettext
} just as
1851 \helpref{wxTRANSLATE
}{wxtranslate
} does, but also returns the translation of
1852 the string for the current locale during execution.
1854 Don't confuse this macro with
\helpref{\_T()
}{underscoret
}!
1857 \membersection{wxPLURAL
}\label{wxplural
}
1859 \func{const wxString\&
}{wxPLURAL
}{\param{const wxString\&
}{sing
},
\param{const wxString\&
}{plur
},
\param{size
\_t}{n
}}
1861 This macro is identical to
\helpref{\_()
}{underscore
} but for the plural variant
1862 of
\helpref{wxGetTranslation
}{wxgettranslation
}.
1865 \membersection{\_T}\label{underscoret
}
1867 \func{wxChar
}{\_T}{\param{char
}{ch
}}
1869 \func{const wxChar *
}{\_T}{\param{const wxChar
}{ch
}}
1871 This macro is exactly the same as
\helpref{wxT
}{wxt
} and is defined in
1872 wxWidgets simply because it may be more intuitive for Windows programmers as
1873 the standard Win32 headers also define it (as well as yet another name for the
1874 same macro which is
{\tt \_TEXT()
}).
1876 Don't confuse this macro with
\helpref{\_()
}{underscore
}!
1880 \section{Dialog functions
}\label{dialogfunctions
}
1882 Below are a number of convenience functions for getting input from the
1883 user or displaying messages. Note that in these functions the last three
1884 parameters are optional. However, it is recommended to pass a parent frame
1885 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1886 the front when the dialog box is popped up.
1889 \membersection{::wxAboutBox
}\label{wxaboutbox
}
1891 \func{void
}{wxAboutBox
}{\param{const wxAboutDialogInfo\&
}{info
}}
1893 This function shows the standard about dialog containing the information
1894 specified in
\arg{info
}. If the current platform has a native about dialog
1895 which is capable of showing all the fields in
\arg{info
}, the native dialog is
1896 used, otherwise the function falls back to the generic wxWidgets version of the
1897 dialog, i.e. does the same thing as
\helpref{wxGenericAboutBox()
}{wxgenericaboutbox
}.
1899 Here is an example of how this function may be used:
1901 void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
1903 wxAboutDialogInfo info;
1904 info.SetName(_("My Program"));
1905 info.SetVersion(_("
1.2.3 Beta"));
1906 info.SetDescription(_("This program does something great."));
1907 info.SetCopyright(_T("(C)
2007 Me <my@email.addre.ss>"));
1913 Please see the
\helpref{dialogs sample
}{sampledialogs
} for more examples of
1914 using this function and
\helpref{wxAboutDialogInfo
}{wxaboutdialoginfo
} for the
1915 description of the information which can be shown in the about dialog.
1917 \wxheading{Include files
}
1922 \membersection{::wxBeginBusyCursor
}\label{wxbeginbusycursor
}
1924 \func{void
}{wxBeginBusyCursor
}{\param{wxCursor *
}{cursor = wxHOURGLASS
\_CURSOR}}
1926 Changes the cursor to the given cursor for all windows in the application.
1927 Use
\helpref{wxEndBusyCursor
}{wxendbusycursor
} to revert the cursor back
1928 to its previous state. These two calls can be nested, and a counter
1929 ensures that only the outer calls take effect.
1931 See also
\helpref{wxIsBusy
}{wxisbusy
},
\helpref{wxBusyCursor
}{wxbusycursor
}.
1933 \wxheading{Include files
}
1938 \membersection{::wxBell
}\label{wxbell
}
1940 \func{void
}{wxBell
}{\void}
1942 Ring the system bell.
1944 \wxheading{Include files
}
1949 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
1951 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
1952 \param{size
\_t }{currentTip
}}
1954 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
1955 used with
\helpref{wxShowTip
}{wxshowtip
}.
1957 \docparam{filename
}{The name of the file containing the tips, one per line
}
1958 \docparam{currentTip
}{The index of the first tip to show - normally this index
1959 is remembered between the
2 program runs.
}
1961 \wxheading{See also
}
1963 \helpref{Tips overview
}{tipsoverview
}
1965 \wxheading{Include files
}
1970 \membersection{::wxDirSelector
}\label{wxdirselector
}
1972 \func{wxString
}{wxDirSelector
}{\param{const wxString\&
}{message = wxDirSelectorPromptStr
},\\
1973 \param{const wxString\&
}{default
\_path = ""
},\\
1974 \param{long
}{style =
0},
\param{const wxPoint\&
}{pos = wxDefaultPosition
},\\
1975 \param{wxWindow *
}{parent = NULL
}}
1977 Pops up a directory selector dialog. The arguments have the same meaning as
1978 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1979 and the default
\_path, if specified, is set as the initial selection.
1981 The application must check for an empty return value (if the user pressed
1982 Cancel). For example:
1985 const wxString& dir = wxDirSelector("Choose a folder");
1992 \wxheading{Include files
}
1997 \membersection{::wxFileSelector
}\label{wxfileselector
}
1999 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
2000 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
2001 \param{const wxString\&
}{wildcard = "*.*"
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
2002 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
2004 Pops up a file selector box. In Windows, this is the common file selector
2005 dialog. In X, this is a file selector box with the same functionality.
2006 The path and filename are distinct elements of a full file pathname.
2007 If path is empty, the current directory will be used. If filename is empty,
2008 no default filename will be supplied. The wildcard determines what files
2009 are displayed in the file selector, and file extension supplies a type
2010 extension for the required filename. Flags may be a combination of wxOPEN,
2011 wxSAVE, wxOVERWRITE
\_PROMPT or wxFILE
\_MUST\_EXIST. Note that wxMULTIPLE
2012 can only be used with
\helpref{wxFileDialog
}{wxfiledialog
} and not here as this
2013 function only returns a single file name.
2015 Both the Unix and Windows versions implement a wildcard filter. Typing a
2016 filename containing wildcards
(*, ?) in the filename text item, and
2017 clicking on Ok, will result in only those files matching the pattern being
2020 The wildcard may be a specification for multiple types of file
2021 with a description for each, such as:
2024 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
2027 The application must check for an empty return value (the user pressed
2028 Cancel). For example:
2031 wxString filename = wxFileSelector("Choose a file to open");
2032 if ( !filename.empty() )
2034 // work with the file
2037 //else: cancelled by user
2040 \wxheading{Include files}
2045 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
2047 \func{void}{wxEndBusyCursor}{\void}
2049 Changes the cursor back to the original cursor, for all windows in the application.
2050 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
2052 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
2054 \wxheading{Include files}
2059 \membersection{::wxGenericAboutBox}\label{wxgenericaboutbox}
2061 \func{void}{wxGenericAboutBox}{\param{const wxAboutDialogInfo\& }{info}}
2063 This function does the same thing as \helpref{wxAboutBox}{wxaboutbox} except
2064 that it always uses the generic wxWidgets version of the dialog instead of the
2065 native one. This is mainly useful if you need to customize the dialog by e.g.
2066 adding custom controls to it (customizing the native dialog is not currently
2069 See the \helpref{dialogs sample}{sampledialogs} for an example of about dialog
2072 \wxheading{See also}
2074 \helpref{wxAboutDialogInfo}{wxaboutdialoginfo}
2076 \wxheading{Include files}
2079 <wx/generic/aboutdlgg.h>
2082 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
2084 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
2086 Shows the colour selection dialog and returns the colour selected by user or
2087 invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour
2088 is valid) if the dialog was cancelled.
2090 \wxheading{Parameters}
2092 \docparam{parent}{The parent window for the colour selection dialog}
2094 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
2096 \docparam{caption}{If given, this will be used for the dialog caption.}
2098 \wxheading{Include files}
2103 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
2105 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
2107 Shows the font selection dialog and returns the font selected by user or
2108 invalid font (use \helpref{wxFont:IsOk}{wxfontisok} to test whether a font
2109 is valid) if the dialog was cancelled.
2111 \wxheading{Parameters}
2113 \docparam{parent}{The parent window for the font selection dialog}
2115 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
2117 \docparam{caption}{If given, this will be used for the dialog caption.}
2119 \wxheading{Include files}
2125 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
2127 \func{size\_t}{wxGetMultipleChoices}{\\
2128 \param{wxArrayInt\& }{selections},\\
2129 \param{const wxString\& }{message},\\
2130 \param{const wxString\& }{caption},\\
2131 \param{const wxArrayString\& }{aChoices},\\
2132 \param{wxWindow *}{parent = NULL},\\
2133 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2134 \param{bool}{ centre = true},\\
2135 \param{int }{width=150}, \param{int }{height=200}}
2137 \func{size\_t}{wxGetMultipleChoices}{\\
2138 \param{wxArrayInt\& }{selections},\\
2139 \param{const wxString\& }{message},\\
2140 \param{const wxString\& }{caption},\\
2141 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2142 \param{wxWindow *}{parent = NULL},\\
2143 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2144 \param{bool}{ centre = true},\\
2145 \param{int }{width=150}, \param{int }{height=200}}
2147 Pops up a dialog box containing a message, OK/Cancel buttons and a
2148 multiple-selection listbox. The user may choose an arbitrary (including 0)
2149 number of items in the listbox whose indices will be returned in
2150 {\it selection} array. The initial contents of this array will be used to
2151 select the items when the dialog is shown.
2153 You may pass the list of strings to choose from either using {\it choices}
2154 which is an array of {\it n} strings for the listbox or by using a single
2155 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2157 If {\it centre} is true, the message text (which may include new line
2158 characters) is centred; if false, the message is left-justified.
2160 \wxheading{Include files}
2164 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2165 and {\tt choices}, and no {\tt selections} parameter; the function
2166 returns an array containing the user selections.}
2169 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
2171 \func{long}{wxGetNumberFromUser}{
2172 \param{const wxString\& }{message},
2173 \param{const wxString\& }{prompt},
2174 \param{const wxString\& }{caption},
2175 \param{long }{value},
2176 \param{long }{min = 0},
2177 \param{long }{max = 100},
2178 \param{wxWindow *}{parent = NULL},
2179 \param{const wxPoint\& }{pos = wxDefaultPosition}}
2181 Shows a dialog asking the user for numeric input. The dialogs title is set to
2182 {\it caption}, it contains a (possibly) multiline {\it message} above the
2183 single line {\it prompt} and the zone for entering the number.
2185 The number entered must be in the range {\it min}..{\it max} (both of which
2186 should be positive) and {\it value} is the initial value of it. If the user
2187 enters an invalid value or cancels the dialog, the function will return -1.
2189 Dialog is centered on its {\it parent} unless an explicit position is given in
2192 \wxheading{Include files}
2197 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
2199 \func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2200 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2201 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2203 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
2204 in the dialog is not shown on screen but replaced with stars. This is intended
2205 to be used for entering passwords as the function name implies.
2207 \wxheading{Include files}
2212 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
2214 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2215 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2216 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2218 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
2219 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
2220 or press Cancel to return the empty string.
2222 If {\it centre} is true, the message text (which may include new line characters)
2223 is centred; if false, the message is left-justified.
2225 \wxheading{Include files}
2230 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
2232 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2233 \param{const wxString\& }{caption},\\
2234 \param{const wxArrayString\& }{aChoices},\\
2235 \param{wxWindow *}{parent = NULL},\\
2236 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2237 \param{bool}{ centre = true},\\
2238 \param{int }{width=150}, \param{int }{height=200}}
2240 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2241 \param{const wxString\& }{caption},\\
2242 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2243 \param{wxWindow *}{parent = NULL},\\
2244 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2245 \param{bool}{ centre = true},\\
2246 \param{int }{width=150}, \param{int }{height=200}}
2248 Pops up a dialog box containing a message, OK/Cancel buttons and a
2249 single-selection listbox. The user may choose an item and press OK to return a
2250 string or Cancel to return the empty string. Use
2251 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
2252 valid choice and if you want to be able to detect pressing Cancel reliably.
2254 You may pass the list of strings to choose from either using {\it choices}
2255 which is an array of {\it n} strings for the listbox or by using a single
2256 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2258 If {\it centre} is true, the message text (which may include new line
2259 characters) is centred; if false, the message is left-justified.
2261 \wxheading{Include files}
2265 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2269 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
2271 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2272 \param{const wxString\& }{caption},\\
2273 \param{const wxArrayString\& }{aChoices},\\
2274 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2275 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2277 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2278 \param{const wxString\& }{caption},\\
2279 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2280 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2281 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2283 As {\bf wxGetSingleChoice} but returns the index representing the selected
2284 string. If the user pressed cancel, -1 is returned.
2286 \wxheading{Include files}
2290 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2294 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2296 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2297 \param{const wxString\& }{caption},\\
2298 \param{const wxArrayString\& }{aChoices},\\
2299 \param{const wxString\& }{client\_data[]},\\
2300 \param{wxWindow *}{parent = NULL},\\
2301 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2302 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2304 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2305 \param{const wxString\& }{caption},\\
2306 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2307 \param{const wxString\& }{client\_data[]},\\
2308 \param{wxWindow *}{parent = NULL},\\
2309 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2310 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2312 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2313 corresponding to the strings, and returns one of these pointers or NULL if
2314 Cancel was pressed. The {\it client\_data} array must have the same number of
2315 elements as {\it choices} or {\it aChoices}!
2317 \wxheading{Include files}
2321 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2322 and {\tt choices}, and the client data array must have the
2323 same length as the choices array.}
2326 \membersection{::wxIsBusy}\label{wxisbusy}
2328 \func{bool}{wxIsBusy}{\void}
2330 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2331 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2333 See also \helpref{wxBusyCursor}{wxbusycursor}.
2335 \wxheading{Include files}
2340 \membersection{::wxMessageBox}\label{wxmessagebox}
2342 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2343 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2345 General purpose message dialog. {\it style} may be a bit list of the
2346 following identifiers:
2348 \begin{twocollist}\itemsep=0pt
2349 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2351 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with
2353 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2354 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2355 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2356 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2357 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2358 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2361 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2367 int answer = wxMessageBox("Quit program?", "Confirm",
2368 wxYES_NO | wxCANCEL, main_frame);
2369 if (answer == wxYES)
2370 main_frame->Close();
2374 {\it message} may contain newline characters, in which case the
2375 message will be split into separate lines, to cater for large messages.
2377 \wxheading{Include files}
2382 \membersection{::wxShowTip}\label{wxshowtip}
2384 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2385 \param{wxTipProvider *}{tipProvider},
2386 \param{bool }{showAtStartup = true}}
2388 This function shows a "startup tip" to the user. The return value is the
2389 state of the `Show tips at startup' checkbox.
2391 \docparam{parent}{The parent window for the modal dialog}
2393 \docparam{tipProvider}{An object which is used to get the text of the tips.
2394 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2396 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2397 otherwise. This is used as the initial value for "Show tips at startup"
2398 checkbox which is shown in the tips dialog.}
2400 \wxheading{See also}
2402 \helpref{Tips overview}{tipsoverview}
2404 \wxheading{Include files}
2411 \section{Math functions}\label{mathfunctions}
2413 \wxheading{Include files}
2418 \membersection{wxFinite}\label{wxfinite}
2420 \func{int}{wxFinite}{\param{double }{x}}
2422 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2423 returns 0 otherwise.
2426 \membersection{wxIsNaN}\label{wxisnan}
2428 \func{bool}{wxIsNaN}{\param{double }{x}}
2430 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2436 \section{GDI functions}\label{gdifunctions}
2438 The following are relevant to the GDI (Graphics Device Interface).
2440 \wxheading{Include files}
2445 \membersection{wxBITMAP}\label{wxbitmapmacro}
2447 \func{}{wxBITMAP}{bitmapName}
2449 This macro loads a bitmap from either application resources (on the platforms
2450 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2451 avoid using {\tt \#ifdef}s when creating bitmaps.
2453 \wxheading{See also}
2455 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2456 \helpref{wxICON}{wxiconmacro}
2458 \wxheading{Include files}
2463 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2465 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2466 \param{int *}{width}, \param{int *}{height}}
2468 \func{wxRect}{wxGetClientDisplayRect}{\void}
2470 Returns the dimensions of the work area on the display. On Windows
2471 this means the area not covered by the taskbar, etc. Other platforms
2472 are currently defaulting to the whole display until a way is found to
2473 provide this info for all window managers, etc.
2476 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2478 \func{bool}{wxColourDisplay}{\void}
2480 Returns true if the display is colour, false otherwise.
2483 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2485 \func{int}{wxDisplayDepth}{\void}
2487 Returns the depth of the display (a value of 1 denotes a monochrome display).
2490 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2492 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2494 \func{wxSize}{wxGetDisplaySize}{\void}
2496 Returns the display size in pixels.
2499 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2501 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2503 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2505 Returns the display size in millimeters.
2508 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2510 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2512 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2513 name. Under MSW, the cursor is loaded from the resource file and the icon is
2514 loaded from XPM file under other platforms.
2516 This macro should be used with
2517 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2519 \wxheading{Include files}
2524 \membersection{wxICON}\label{wxiconmacro}
2526 \func{}{wxICON}{iconName}
2528 This macro loads an icon from either application resources (on the platforms
2529 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2530 avoid using {\tt \#ifdef}s when creating icons.
2532 \wxheading{See also}
2534 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2535 \helpref{wxBITMAP}{wxbitmapmacro}
2537 \wxheading{Include files}
2542 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2544 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2545 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2547 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2548 makes it into a placeable metafile by prepending a header containing the given
2549 bounding box. The bounding box may be obtained from a device context after drawing
2550 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2552 In addition to adding the placeable metafile header, this function adds
2553 the equivalent of the following code to the start of the metafile data:
2556 SetMapMode(dc, MM_ANISOTROPIC);
2557 SetWindowOrg(dc, minX, minY);
2558 SetWindowExt(dc, maxX - minX, maxY - minY);
2561 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2563 Placeable metafiles may be imported by many Windows applications, and can be
2564 used in RTF (Rich Text Format) files.
2566 {\it scale} allows the specification of scale for the metafile.
2568 This function is only available under Windows.
2571 \membersection{::wxSetCursor}\label{wxsetcursor}
2573 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2575 Globally sets the cursor; only has an effect in Windows and GTK.
2576 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2580 \section{Printer settings}\label{printersettings}
2582 {\bf NB:} These routines are obsolete and should no longer be used!
2584 The following functions are used to control PostScript printing. Under
2585 Windows, PostScript output can only be sent to a file.
2587 \wxheading{Include files}
2592 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2594 \func{wxString}{wxGetPrinterCommand}{\void}
2596 Gets the printer command used to print a file. The default is {\tt lpr}.
2599 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2601 \func{wxString}{wxGetPrinterFile}{\void}
2603 Gets the PostScript output filename.
2606 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2608 \func{int}{wxGetPrinterMode}{\void}
2610 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2611 The default is PS\_PREVIEW.
2614 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2616 \func{wxString}{wxGetPrinterOptions}{\void}
2618 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2621 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2623 \func{int}{wxGetPrinterOrientation}{\void}
2625 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2628 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2630 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2632 Gets the command used to view a PostScript file. The default depends on the platform.
2635 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2637 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2639 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2642 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2644 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2646 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2649 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2651 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2653 Sets the printer command used to print a file. The default is {\tt lpr}.
2656 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2658 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2660 Sets the PostScript output filename.
2663 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2665 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2667 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2668 The default is PS\_PREVIEW.
2671 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2673 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2675 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2678 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2680 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2682 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2685 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2687 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2689 Sets the command used to view a PostScript file. The default depends on the platform.
2692 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2694 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2696 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2699 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2701 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2703 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2707 \section{Clipboard functions}\label{clipsboard}
2709 These clipboard functions are implemented for Windows only. The use of these functions
2710 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2713 \wxheading{Include files}
2718 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2720 \func{bool}{wxClipboardOpen}{\void}
2722 Returns true if this application has already opened the clipboard.
2725 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2727 \func{bool}{wxCloseClipboard}{\void}
2729 Closes the clipboard to allow other applications to use it.
2732 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2734 \func{bool}{wxEmptyClipboard}{\void}
2736 Empties the clipboard.
2739 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2741 \func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}}
2743 Enumerates the formats found in a list of available formats that belong
2744 to the clipboard. Each call to this function specifies a known
2745 available format; the function returns the format that appears next in
2748 {\it dataFormat} specifies a known format. If this parameter is zero,
2749 the function returns the first format in the list.
2751 The return value specifies the next known clipboard data format if the
2752 function is successful. It is zero if the {\it dataFormat} parameter specifies
2753 the last format in the list of available formats, or if the clipboard
2756 Before it enumerates the formats function, an application must open the clipboard by using the
2757 wxOpenClipboard function.
2760 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2762 \func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}}
2764 Gets data from the clipboard.
2766 {\it dataFormat} may be one of:
2768 \begin{itemize}\itemsep=0pt
2769 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2770 \item wxCF\_BITMAP: returns a new wxBitmap.
2773 The clipboard must have previously been opened for this call to succeed.
2776 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2778 \func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}}
2780 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2781 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2784 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2786 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}}
2788 Returns true if the given data format is available on the clipboard.
2791 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2793 \func{bool}{wxOpenClipboard}{\void}
2795 Opens the clipboard for passing data to it or getting data from it.
2798 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2800 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2802 Registers the clipboard data format name and returns an identifier.
2805 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2807 \func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}}
2809 Passes data to the clipboard.
2811 {\it dataFormat} may be one of:
2813 \begin{itemize}\itemsep=0pt
2814 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2815 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2816 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2817 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2820 The clipboard must have previously been opened for this call to succeed.
2823 \section{Miscellaneous functions}\label{miscellany}
2826 \membersection{wxCONCAT}\label{wxconcat}
2828 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2830 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2833 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2835 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2837 When loading a function from a DLL you always have to cast the returned
2838 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2839 repeat this type twice if you want to declare and define a function pointer all
2842 This macro makes this slightly less painful by allowing you to specify the
2843 type only once, as the first parameter, and creating a variable of this type
2844 named after the function but with {\tt pfn} prefix and initialized with the
2845 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2848 \wxheading{Parameters}
2850 \docparam{type}{the type of the function}
2852 \docparam{name}{the name of the function to load, not a string (without quotes,
2853 it is quoted automatically by the macro)}
2855 \docparam{dynlib}{the library to load the function from}
2859 \membersection{wxEXPLICIT}\label{wxexplicit}
2861 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2862 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2863 code which might have to be compiled with an old compiler without support for
2864 this language feature but still take advantage of it when it is available.
2868 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2870 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2872 For normal keys, returns \true if the specified key is currently down.
2874 For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns
2875 \true if the key is toggled such that its LED indicator is lit. There is
2876 currently no way to test whether togglable keys are up or down.
2878 Even though there are virtual key codes defined for mouse buttons, they
2879 cannot be used with this function currently.
2881 \wxheading{Include files}
2886 \membersection{wxLL}\label{wxll}
2888 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2890 This macro is defined for the platforms with a native 64 bit integer type and
2891 allows to define 64 bit compile time constants:
2895 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2899 \wxheading{Include files}
2903 \wxheading{See also}
2905 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2908 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2910 This macro is defined to contain the {\tt printf()} format specifier using
2911 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2912 printed. Example of using it:
2916 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2917 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2921 \wxheading{See also}
2923 \helpref{wxLL}{wxll}
2925 \wxheading{Include files}
2930 \membersection{::wxNewId}\label{wxnewid}
2932 \func{long}{wxNewId}{\void}
2934 This function is deprecated as the ids generated by it can conflict with the
2935 ids defined by the user code, use \texttt{wxID\_ANY} to assign ids which are
2936 guaranteed to not conflict with the user-defined ids for the controls and menu
2937 items you create instead of using this function.
2940 Generates an integer identifier unique to this run of the program.
2942 \wxheading{Include files}
2947 \membersection{wxON\_BLOCK\_EXIT}\label{wxonblockexit}
2949 \func{}{wxON\_BLOCK\_EXIT0}{\param{}{func}}
2950 \func{}{wxON\_BLOCK\_EXIT1}{\param{}{func}, \param{}{p1}}
2951 \func{}{wxON\_BLOCK\_EXIT2}{\param{}{func}, \param{}{p1}, \param{}{p2}}
2953 This family of macros allows to ensure that the global function \arg{func}
2954 with 0, 1, 2 or more parameters (up to some implementaton-defined limit) is
2955 executed on scope exit, whether due to a normal function return or because an
2956 exception has been thrown. A typical example of its usage:
2958 void *buf = malloc(size);
2959 wxON_BLOCK_EXIT1(free, buf);
2962 Please see the original article by Andrei Alexandrescu and Petru Marginean
2963 published in December 2000 issue of \emph{C/C++ Users Journal} for more
2966 \wxheading{Include files}
2970 \wxheading{See also}
2972 \helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}
2975 \membersection{wxON\_BLOCK\_EXIT\_OBJ}\label{wxonblockexitobj}
2977 \func{}{wxON\_BLOCK\_EXIT\_OBJ0}{\param{}{obj}, \param{}{method}}
2978 \func{}{wxON\_BLOCK\_EXIT\_OBJ1}{\param{}{obj}, \param{}{method}, \param{}{p1}}
2979 \func{}{wxON\_BLOCK\_EXIT\_OBJ2}{\param{}{obj}, \param{}{method}, \param{}{p1}, \param{}{p2}}
2981 This family of macros is similar to \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}
2982 but calls a method of the given object instead of a free function.
2984 \wxheading{Include files}
2989 \membersection{::wxRegisterId}\label{wxregisterid}
2991 \func{void}{wxRegisterId}{\param{long}{ id}}
2993 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2996 \wxheading{Include files}
3001 \membersection{::wxDDECleanUp}\label{wxddecleanup}
3003 \func{void}{wxDDECleanUp}{\void}
3005 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
3006 called by the application.
3008 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
3010 \wxheading{Include files}
3015 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
3017 \func{void}{wxDDEInitialize}{\void}
3019 Initializes the DDE system. May be called multiple times without harm.
3021 This no longer needs to be called by the application: it will be called
3022 by wxWidgets if necessary.
3024 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
3025 \helpref{wxDDECleanUp}{wxddecleanup}.
3027 \wxheading{Include files}
3032 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
3034 \func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}
3036 This function enables or disables all top level windows. It is used by
3037 \helpref{::wxSafeYield}{wxsafeyield}.
3039 \wxheading{Include files}
3044 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
3046 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
3048 Find a menu item identifier associated with the given frame's menu bar.
3050 \wxheading{Include files}
3055 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
3057 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
3059 {\bf NB:} This function is obsolete, please use
3060 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
3062 Find a window by its label. Depending on the type of window, the label may be a window title
3063 or panel item label. If {\it parent} is NULL, the search will start from all top-level
3064 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3065 The search is recursive in both cases.
3067 \wxheading{Include files}
3072 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
3074 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
3076 {\bf NB:} This function is obsolete, please use
3077 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
3079 Find a window by its name (as given in a window constructor or {\bf Create} function call).
3080 If {\it parent} is NULL, the search will start from all top-level
3081 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3082 The search is recursive in both cases.
3084 If no such named window is found, {\bf wxFindWindowByLabel} is called.
3086 \wxheading{Include files}
3091 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
3093 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
3095 Find the deepest window at the given mouse position in screen coordinates,
3096 returning the window if found, or NULL if not.
3099 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
3101 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
3103 Find the deepest window at the mouse pointer position, returning the window
3104 and current pointer position in screen coordinates.
3107 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
3109 \func{wxWindow *}{wxGetActiveWindow}{\void}
3111 Gets the currently active window (implemented for MSW and GTK only currently,
3112 always returns \NULL in the other ports).
3114 \wxheading{Include files}
3119 \membersection{::wxGetBatteryState}\label{wxgetbatterystate}
3121 \func{wxBatteryState}{wxGetBatteryState}{\void}
3123 Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
3124 \texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
3125 \texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
3126 \texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
3127 this feature is not implemented (currently everywhere but MS Windows).
3129 \wxheading{Include files}
3134 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
3136 \func{wxString}{wxGetDisplayName}{\void}
3138 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
3140 \wxheading{Include files}
3145 \membersection{::wxGetPowerType}\label{wxgetpowertype}
3147 \func{wxPowerType}{wxGetPowerType}{\void}
3149 Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
3150 \texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
3151 \texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
3152 feature is not implemented (currently everywhere but MS Windows).
3154 \wxheading{Include files}
3159 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
3161 \func{wxPoint}{wxGetMousePosition}{\void}
3163 Returns the mouse position in screen coordinates.
3165 \wxheading{Include files}
3170 \membersection{::wxGetMouseState}\label{wxgetmousestate}
3172 \func{wxMouseState}{wxGetMouseState}{\void}
3174 Returns the current state of the mouse. Returns a wxMouseState
3175 instance that contains the current position of the mouse pointer in
3176 screen coordinants, as well as boolean values indicating the up/down
3177 status of the mouse buttons and the modifier keys.
3179 \wxheading{Include files}
3183 wxMouseState has the following interface:
3204 void SetX(wxCoord x);
3205 void SetY(wxCoord y);
3207 void SetLeftDown(bool down);
3208 void SetMiddleDown(bool down);
3209 void SetRightDown(bool down);
3211 void SetControlDown(bool down);
3212 void SetShiftDown(bool down);
3213 void SetAltDown(bool down);
3214 void SetMetaDown(bool down);
3220 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
3222 \func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}}
3224 Returns label that should be used for given {\it id} element.
3226 \wxheading{Parameters}
3228 \docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.}
3230 \docparam{withCodes}{if false then strip accelerator code from the label;
3231 usefull for getting labels without accelerator char code like for toolbar tooltip or
3232 under platforms without traditional keyboard like smartphones}
3234 \docparam{accelerator}{optional accelerator string automatically added to label; useful
3235 for building labels for \helpref{wxMenuItem}{wxmenuitem}}
3237 \wxheading{Include files}
3242 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
3244 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
3246 Returns the first top level parent of the given window, or in other words, the
3247 frame or dialog containing it, or {\tt NULL}.
3249 \wxheading{Include files}
3254 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
3256 \func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}}
3258 Open the \arg{url} in user's default browser. If \arg{flags} parameter contains
3259 \texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL
3260 (currently this is only supported under Windows).
3262 Returns \true if the application was successfully launched.
3264 Note that for some configurations of the running user, the application which
3265 is launched to open the given URL may be URL-dependent (e.g. a browser may be used for
3266 local URLs while another one may be used for remote URLs).
3268 \wxheading{Include files}
3273 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
3275 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
3277 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
3278 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
3280 The resource must be defined in the {\tt .rc} file using the following syntax:
3283 myResource TEXT file.ext
3286 where {\tt file.ext} is a file that the resource compiler can find.
3288 This function is available under Windows only.
3290 \wxheading{Include files}
3295 \membersection{::wxPostDelete}\label{wxpostdelete}
3297 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
3299 Tells the system to delete the specified object when
3300 all other events have been processed. In some environments, it is
3301 necessary to use this instead of deleting a frame directly with the
3302 delete operator, because some GUIs will still send events to a deleted window.
3304 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
3306 \wxheading{Include files}
3311 \membersection{::wxPostEvent}\label{wxpostevent}
3313 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
3315 In a GUI application, this function posts {\it event} to the specified {\it dest}
3316 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
3317 Otherwise, it dispatches {\it event} immediately using
3318 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
3319 See the respective documentation for details (and caveats).
3321 \wxheading{Include files}
3326 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
3328 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
3330 Under X only, sets the current display name. This is the X host and display name such
3331 as ``colonsay:0.0", and the function indicates which display should be used for creating
3332 windows from this point on. Setting the display within an application allows multiple
3333 displays to be used.
3335 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
3337 \wxheading{Include files}
3342 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
3344 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{str}, \param{int }{flags = wxStrip\_All}}
3346 Strips any menu codes from \arg{str} and returns the result.
3348 By default, the functions strips both the mnemonics character (\texttt{'\&'})
3349 which is used to indicate a keyboard shortkey, and the accelerators, which are
3350 used only in the menu items and are separated from the main text by the
3351 \texttt{$\backslash$t} (TAB) character. By using \arg{flags} of
3352 \texttt{wxStrip\_Mnemonics} or \texttt{wxStrip\_Accel} to strip only the former
3353 or the latter part, respectively.
3355 Notice that in most cases
3356 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} or
3357 \helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} can be used instead.
3359 \wxheading{Include files}
3364 \membersection{wxSTRINGIZE}\label{wxstringize}
3366 \func{}{wxSTRINGIZE}{\param{}{x}}
3368 Returns the string representation of the given symbol which can be either a
3369 literal or a macro (hence the advantage of using this macro instead of the
3370 standard preprocessor \texttt{\#} operator which doesn't work with macros).
3372 Notice that this macro always produces a \texttt{char} string, use
3373 \helpref{wxSTRINGIZE\_T}{wxstringizet} to build a wide string Unicode build.
3375 \wxheading{See also}
3377 \helpref{wxCONCAT}{wxconcat}
3380 \membersection{wxSTRINGIZE\_T}\label{wxstringizet}
3382 \func{}{wxSTRINGIZE\_T}{\param{}{x}}
3384 Returns the string representation of the given symbol as either an ASCII or
3385 Unicode string, depending on the current build. This is the Unicode-friendly
3386 equivalent of \helpref{wxSTRINGIZE}{wxstringize}.
3389 \membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning}
3391 \func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}}
3393 GNU C++ compiler gives a warning for any class whose destructor is private
3394 unless it has a friend. This warning may sometimes be useful but it doesn't
3395 make sense for reference counted class which always delete themselves (hence
3396 destructor should be private) but don't necessarily have any friends, so this
3397 macro is provided to disable the warning in such case. The \arg{name} parameter
3398 should be the name of the class but is only used to construct a unique friend
3399 class name internally. Example of using the macro:
3405 RefCounted() { m_nRef = 1; }
3406 void IncRef() { m_nRef++ ; }
3407 void DecRef() { if ( !--m_nRef ) delete this; }
3412 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
3416 Notice that there should be no semicolon after this macro.
3419 \membersection{wxULL}\label{wxull}
3421 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
3423 This macro is defined for the platforms with a native 64 bit integer type and
3424 allows to define unsigned 64 bit compile time constants:
3428 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
3432 \wxheading{Include files}
3436 \wxheading{See also}
3438 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
3441 \membersection{wxVaCopy}\label{wxvacopy}
3443 \func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}}
3445 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
3446 which support it or its replacement for those that don't. It must be used to
3447 preserve the value of a \texttt{va\_list} object if you need to use it after
3448 passing it to another function because it can be modified by the latter.
3450 As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
3455 \membersection{\_\_WXFUNCTION\_\_}\label{wxfunction}
3457 \func{}{\_\_WXFUNCTION\_\_}{\void}
3459 This macro expands to the name of the current function if the compiler supports
3460 any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables
3461 or macros or to \NULL if none of them is available.
3465 \section{Byte order macros}\label{byteordermacros}
3467 The endian-ness issues (that is the difference between big-endian and
3468 little-endian architectures) are important for the portable programs working
3469 with the external binary data (for example, data files or data coming from
3470 network) which is usually in some fixed, platform-independent format. The
3471 macros are helpful for transforming the data to the correct format.
3474 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3476 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3478 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3480 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3482 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3484 These macros will swap the bytes of the {\it value} variable from little
3485 endian to big endian or vice versa unconditionally, i.e. independently of the
3489 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3491 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3493 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3495 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3497 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3499 This macro will swap the bytes of the {\it value} variable from little
3500 endian to big endian or vice versa if the program is compiled on a
3501 big-endian architecture (such as Sun work stations). If the program has
3502 been compiled on a little-endian architecture, the value will be unchanged.
3504 Use these macros to read data from and write data to a file that stores
3505 data in little-endian (for example Intel i386) format.
3508 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3510 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3512 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3514 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3516 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3518 This macro will swap the bytes of the {\it value} variable from little
3519 endian to big endian or vice versa if the program is compiled on a
3520 little-endian architecture (such as Intel PCs). If the program has
3521 been compiled on a big-endian architecture, the value will be unchanged.
3523 Use these macros to read data from and write data to a file that stores
3524 data in big-endian format.
3528 \section{RTTI functions}\label{rttimacros}
3530 wxWidgets uses its own RTTI ("run-time type identification") system which
3531 predates the current standard C++ RTTI and so is kept for backwards
3532 compatibility reasons but also because it allows some things which the
3533 standard RTTI doesn't directly support (such as creating a class from its
3536 The standard C++ RTTI can be used in the user code without any problems and in
3537 general you shouldn't need to use the functions and the macros in this section
3538 unless you are thinking of modifying or adding any wxWidgets classes.
3540 \wxheading{See also}
3542 \helpref{RTTI overview}{runtimeclassoverview}
3545 \membersection{CLASSINFO}\label{classinfo}
3547 \func{wxClassInfo *}{CLASSINFO}{className}
3549 Returns a pointer to the wxClassInfo object associated with this class.
3551 \wxheading{Include files}
3556 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3558 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3560 Used inside a class declaration to declare that the class should be
3561 made known to the class hierarchy, but objects of this class cannot be created
3562 dynamically. The same as DECLARE\_CLASS.
3567 class wxCommand: public wxObject
3569 DECLARE_ABSTRACT_CLASS(wxCommand)
3578 \wxheading{Include files}
3583 \membersection{DECLARE\_APP}\label{declareapp}
3585 \func{}{DECLARE\_APP}{className}
3587 This is used in headers to create a forward declaration of the
3588 \helpref{wxGetApp}{wxgetapp} function implemented by
3589 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3590 {\tt className\& wxGetApp(void)}.
3598 \wxheading{Include files}
3603 \membersection{DECLARE\_CLASS}\label{declareclass}
3605 \func{}{DECLARE\_CLASS}{className}
3607 Used inside a class declaration to declare that the class should be
3608 made known to the class hierarchy, but objects of this class cannot be created
3609 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3611 \wxheading{Include files}
3616 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3618 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3620 Used inside a class declaration to make the class known to wxWidgets RTTI
3621 system and also declare that the objects of this class should be dynamically
3622 creatable from run-time type information. Notice that this implies that the
3623 class should have a default constructor, if this is not the case consider using
3624 \helpref{DECLARE\_CLASS}{declareclass}.
3629 class wxFrame: public wxWindow
3631 DECLARE_DYNAMIC_CLASS(wxFrame)
3634 const wxString& frameTitle;
3640 \wxheading{Include files}
3645 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3647 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3649 Used in a C++ implementation file to complete the declaration of
3650 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3655 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3657 wxCommand::wxCommand(void)
3663 \wxheading{Include files}
3668 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3670 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3672 Used in a C++ implementation file to complete the declaration of
3673 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3675 \wxheading{Include files}
3680 \membersection{IMPLEMENT\_APP}\label{implementapp}
3682 \func{}{IMPLEMENT\_APP}{className}
3684 This is used in the application class implementation file to make the application class known to
3685 wxWidgets for dynamic construction. You use this instead of
3696 IMPLEMENT_APP(MyApp)
3699 See also \helpref{DECLARE\_APP}{declareapp}.
3701 \wxheading{Include files}
3706 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3708 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3710 Used in a C++ implementation file to complete the declaration of
3711 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3713 \wxheading{Include files}
3718 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3720 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3722 Used in a C++ implementation file to complete the declaration of a
3723 class that has run-time type information and two base classes. The
3724 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3726 \wxheading{Include files}
3731 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3733 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3735 Used in a C++ implementation file to complete the declaration of
3736 a class that has run-time type information, and whose instances
3737 can be created dynamically.
3742 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3744 wxFrame::wxFrame(void)
3750 \wxheading{Include files}
3755 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3757 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3759 Used in a C++ implementation file to complete the declaration of
3760 a class that has run-time type information, and whose instances
3761 can be created dynamically. Use this for classes derived from two
3764 \wxheading{Include files}
3769 \membersection{wxConstCast}\label{wxconstcast}
3771 \func{classname *}{wxConstCast}{ptr, classname}
3773 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3774 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3776 \wxheading{See also}
3778 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3779 \helpref{wxDynamicCast}{wxdynamiccast}\\
3780 \helpref{wxStaticCast}{wxstaticcast}
3783 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3785 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3787 Creates and returns an object of the given class, if the class has been
3788 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3791 \membersection{WXDEBUG\_NEW}\label{debugnew}
3793 \func{}{WXDEBUG\_NEW}{arg}
3795 This is defined in debug mode to be call the redefined new operator
3796 with filename and line number arguments. The definition is:
3799 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3802 In non-debug mode, this is defined as the normal new operator.
3804 \wxheading{Include files}
3809 \membersection{wxDynamicCast}\label{wxdynamiccast}
3811 \func{classname *}{wxDynamicCast}{ptr, classname}
3813 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3814 the pointer is of this type (the check is done during the run-time) or
3815 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3816 wxObject::IsKindOf() function.
3818 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3824 wxWindow *win = wxWindow::FindFocus();
3825 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3828 // a text control has the focus...
3832 // no window has the focus or it is not a text control
3836 \wxheading{See also}
3838 \helpref{RTTI overview}{runtimeclassoverview}\\
3839 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3840 \helpref{wxConstCast}{wxconstcast}\\
3841 \helpref{wxStaticCast}{wxstaticcast}
3844 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3846 \func{classname *}{wxDynamicCastThis}{classname}
3848 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3849 latter provokes spurious compilation warnings from some compilers (because it
3850 tests whether {\tt this} pointer is non-{\tt NULL} which is always true), so
3851 this macro should be used to avoid them.
3853 \wxheading{See also}
3855 \helpref{wxDynamicCast}{wxdynamiccast}
3858 \membersection{wxStaticCast}\label{wxstaticcast}
3860 \func{classname *}{wxStaticCast}{ptr, classname}
3862 This macro checks that the cast is valid in debug mode (an assert failure will
3863 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3864 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3866 \wxheading{See also}
3868 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3869 \helpref{wxDynamicCast}{wxdynamiccast}\\
3870 \helpref{wxConstCast}{wxconstcast}
3873 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3875 \func{T}{wx\_const\_cast}{T, x}
3877 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3878 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3879 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3880 arguments is the same as for the standard cast.
3882 \wxheading{See also}
3884 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3885 \helpref{wx\_static\_cast}{wxstaticcastraw}
3888 \membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
3890 \func{T}{wx\_reinterpret\_cast}{T, x}
3892 Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
3893 \texttt{(T)x} for old compilers.
3895 \wxheading{See also}
3897 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3898 \helpref{wx\_static\_cast}{wxstaticcastraw}
3901 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3903 \func{T}{wx\_static\_cast}{T, x}
3905 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3906 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3907 there are no checks being done and the meaning of the macro arguments is exactly
3908 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3909 star is not appended to it.
3911 \wxheading{See also}
3913 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3914 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3915 \helpref{wx\_truncate\_cast}{wxtruncatecast}
3918 \membersection{wx\_truncate\_cast}\label{wxtruncatecast}
3920 \func{T}{wx\_truncate\_cast}{T, x}
3922 This case doesn't correspond to any standard cast but exists solely to make
3923 casts which possibly result in a truncation of an integer value more readable.
3925 \wxheading{See also}
3927 \helpref{wx\_static\_cast}{wxstaticcastraw}
3930 \section{Log functions}\label{logfunctions}
3932 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3933 further information. The functions use (implicitly) the currently active log
3934 target, so their descriptions here may not apply if the log target is not the
3935 standard one (installed by wxWidgets in the beginning of the program).
3937 \wxheading{Include files}
3942 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3944 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3946 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3947 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3949 Display a debugging message; under Windows, this will appear on the
3950 debugger command window, and under Unix, it will be written to standard
3953 The syntax is identical to {\bf printf}: pass a format string and a
3954 variable list of arguments.
3956 {\bf Tip:} under Windows, if your application crashes before the
3957 message appears in the debugging window, put a wxYield call after
3958 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3959 (at least for Watcom C++): preformat your messages and use OutputDebugString
3962 \wxheading{Include files}
3967 \membersection{::wxError}\label{wxerror}
3969 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
3971 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3974 Displays {\it msg} and continues. This writes to standard error under
3975 Unix, and pops up a message box under Windows. Used for internal
3976 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
3978 \wxheading{Include files}
3983 \membersection{::wxFatalError}\label{wxfatalerror}
3985 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
3987 {\bf NB:} This function is now obsolete, please use
3988 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3990 Displays {\it msg} and exits. This writes to standard error under Unix,
3991 and pops up a message box under Windows. Used for fatal internal
3992 wxWidgets errors. See also \helpref{wxError}{wxerror}.
3994 \wxheading{Include files}
3999 \membersection{::wxLogError}\label{wxlogerror}
4001 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
4003 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4005 The functions to use for error messages, i.e. the messages that must be shown
4006 to the user. The default processing is to pop up a message box to inform the
4010 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
4012 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
4014 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4016 Like \helpref{wxLogError}{wxlogerror}, but also
4017 terminates the program with the exit code 3. Using {\it abort()} standard
4018 function also terminates the program with this exit code.
4021 \membersection{::wxLogWarning}\label{wxlogwarning}
4023 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
4025 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4027 For warnings - they are also normally shown to the user, but don't interrupt
4031 \membersection{::wxLogMessage}\label{wxlogmessage}
4033 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
4035 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4037 For all normal, informational messages. They also appear in a message box by
4038 default (but it can be changed).
4040 \membersection{::wxLogVerbose}\label{wxlogverbose}
4042 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
4044 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4046 For verbose output. Normally, it is suppressed, but
4047 might be activated if the user wishes to know more details about the program
4048 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
4051 \membersection{::wxLogStatus}\label{wxlogstatus}
4053 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
4055 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4057 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
4059 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4061 Messages logged by these functions will appear in the statusbar of the {\it
4062 frame} or of the top level application window by default (i.e. when using
4063 the second version of the functions).
4065 If the target frame doesn't have a statusbar, the message will be lost.
4068 \membersection{::wxLogSysError}\label{wxlogsyserror}
4070 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
4072 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4074 Mostly used by wxWidgets itself, but might be handy for logging errors after
4075 system call (API function) failure. It logs the specified message text as well
4076 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
4077 on the platform) and the corresponding error message. The second form
4078 of this function takes the error code explicitly as the first argument.
4080 \wxheading{See also}
4082 \helpref{wxSysErrorCode}{wxsyserrorcode},
4083 \helpref{wxSysErrorMsg}{wxsyserrormsg}
4086 \membersection{::wxLogDebug}\label{wxlogdebug}
4088 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
4090 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4092 The right functions for debug output. They only do something in debug
4093 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
4094 nothing in release mode (otherwise).
4097 \membersection{::wxLogTrace}\label{wxlogtrace}
4099 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
4101 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4103 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
4105 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4107 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
4109 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4111 As {\bf wxLogDebug}, trace functions only do something in debug build and
4112 expand to nothing in the release one. The reason for making
4113 it a separate function from it is that usually there are a lot of trace
4114 messages, so it might make sense to separate them from other debug messages.
4116 The trace messages also usually can be separated into different categories and
4117 the second and third versions of this function only log the message if the
4118 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
4119 allows to selectively trace only some operations and not others by changing
4120 the value of the trace mask (possible during the run-time).
4122 For the second function (taking a string mask), the message is logged only if
4123 the mask has been previously enabled by the call to
4124 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
4125 \helpref{{\tt WXTRACE} environment variable}{envvars}.
4126 The predefined string trace masks
4127 used by wxWidgets are:
4129 \begin{itemize}\itemsep=0pt
4130 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
4131 \item wxTRACE\_Messages: trace window messages/X callbacks
4132 \item wxTRACE\_ResAlloc: trace GDI resource allocation
4133 \item wxTRACE\_RefCount: trace various ref counting operations
4134 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
4137 {\bf Caveats:} since both the mask and the format string are strings,
4138 this might lead to function signature confusion in some cases:
4139 if you intend to call the format string only version of wxLogTrace,
4140 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.
4141 In this case you'll unfortunately have to avoid having two leading
4142 string parameters, e.g. by adding a bogus integer (with its \%d format string).
4144 The third version of the function only logs the message if all the bits
4145 corresponding to the {\it mask} are set in the wxLog trace mask which can be
4146 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
4147 flexible than the previous one because it doesn't allow defining the user
4148 trace masks easily - this is why it is deprecated in favour of using string
4151 \begin{itemize}\itemsep=0pt
4152 \item wxTraceMemAlloc: trace memory allocation (new/delete)
4153 \item wxTraceMessages: trace window messages/X callbacks
4154 \item wxTraceResAlloc: trace GDI resource allocation
4155 \item wxTraceRefCount: trace various ref counting operations
4156 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
4160 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
4162 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
4164 This function shows a message to the user in a safe way and should be safe to
4165 call even before the application has been initialized or if it is currently in
4166 some other strange state (for example, about to crash). Under Windows this
4167 function shows a message box using a native dialog instead of
4168 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
4169 it simply prints the message to the standard output using the title as prefix.
4171 \wxheading{Parameters}
4173 \docparam{title}{The title of the message box shown to the user or the prefix
4174 of the message string}
4176 \docparam{text}{The text to show to the user}
4178 \wxheading{See also}
4180 \helpref{wxLogFatalError}{wxlogfatalerror}
4182 \wxheading{Include files}
4187 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
4189 \func{unsigned long}{wxSysErrorCode}{\void}
4191 Returns the error code from the last system call. This function uses
4192 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
4194 \wxheading{See also}
4196 \helpref{wxSysErrorMsg}{wxsyserrormsg},
4197 \helpref{wxLogSysError}{wxlogsyserror}
4200 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
4202 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
4204 Returns the error message corresponding to the given system error code. If
4205 {\it errCode} is $0$ (default), the last error code (as returned by
4206 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
4208 \wxheading{See also}
4210 \helpref{wxSysErrorCode}{wxsyserrorcode},
4211 \helpref{wxLogSysError}{wxlogsyserror}
4214 \membersection{WXTRACE}\label{trace}
4216 \wxheading{Include files}
4220 \func{}{WXTRACE}{formatString, ...}
4222 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4224 Calls wxTrace with printf-style variable argument syntax. Output
4225 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4227 \wxheading{Include files}
4232 \membersection{WXTRACELEVEL}\label{tracelevel}
4234 \func{}{WXTRACELEVEL}{level, formatString, ...}
4236 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4238 Calls wxTraceLevel with printf-style variable argument syntax. Output
4239 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4240 The first argument should be the level at which this information is appropriate.
4241 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4244 \wxheading{Include files}
4249 \membersection{::wxTrace}\label{wxtrace}
4251 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
4253 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4255 Takes printf-style variable argument syntax. Output
4256 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4258 \wxheading{Include files}
4263 \membersection{::wxTraceLevel}\label{wxtracelevel}
4265 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
4267 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4269 Takes printf-style variable argument syntax. Output
4270 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4271 The first argument should be the level at which this information is appropriate.
4272 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4275 \wxheading{Include files}
4281 \section{Time functions}\label{timefunctions}
4283 The functions in this section deal with getting the current time and
4284 starting/stopping the global timers. Please note that the timer functions are
4285 deprecated because they work with one global timer only and
4286 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
4287 should be used instead. For retrieving the current time, you may also use
4288 \helpref{wxDateTime::Now}{wxdatetimenow} or
4289 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
4292 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
4294 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
4296 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
4298 If {\it resetTimer} is true (the default), the timer is reset to zero
4301 See also \helpref{wxTimer}{wxtimer}.
4303 \wxheading{Include files}
4308 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
4310 \func{long}{wxGetLocalTime}{\void}
4312 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
4314 \wxheading{See also}
4316 \helpref{wxDateTime::Now}{wxdatetimenow}
4318 \wxheading{Include files}
4323 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
4325 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
4327 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
4329 \wxheading{See also}
4331 \helpref{wxDateTime::Now}{wxdatetimenow},\\
4332 \helpref{wxLongLong}{wxlonglong}
4334 \wxheading{Include files}
4339 \membersection{::wxGetUTCTime}\label{wxgetutctime}
4341 \func{long}{wxGetUTCTime}{\void}
4343 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
4345 \wxheading{See also}
4347 \helpref{wxDateTime::Now}{wxdatetimenow}
4349 \wxheading{Include files}
4354 \membersection{::wxMicroSleep}\label{wxmicrosleep}
4356 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
4358 Sleeps for the specified number of microseconds. The microsecond resolution may
4359 not, in fact, be available on all platforms (currently only Unix platforms with
4360 nanosleep(2) may provide it) in which case this is the same as
4361 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
4363 \wxheading{Include files}
4368 \membersection{::wxMilliSleep}\label{wxmillisleep}
4370 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
4372 Sleeps for the specified number of milliseconds. Notice that usage of this
4373 function is encouraged instead of calling usleep(3) directly because the
4374 standard usleep() function is not MT safe.
4376 \wxheading{Include files}
4381 \membersection{::wxNow}\label{wxnow}
4383 \func{wxString}{wxNow}{\void}
4385 Returns a string representing the current date and time.
4387 \wxheading{Include files}
4392 \membersection{::wxSleep}\label{wxsleep}
4394 \func{void}{wxSleep}{\param{int}{ secs}}
4396 Sleeps for the specified number of seconds.
4398 \wxheading{Include files}
4403 \membersection{::wxStartTimer}\label{wxstarttimer}
4405 \func{void}{wxStartTimer}{\void}
4407 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
4409 See also \helpref{wxTimer}{wxtimer}.
4411 \wxheading{Include files}
4416 \membersection{::wxUsleep}\label{wxusleep}
4418 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
4420 This function is deprecated because its name is misleading: notice that the
4421 argument is in milliseconds, not microseconds. Please use either
4422 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
4423 depending on the resolution you need.
4427 \section{Debugging macros and functions}\label{debugmacros}
4429 Useful macros and functions for error checking and defensive programming.
4430 wxWidgets defines three families of the assert-like macros:
4431 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
4432 (in other words, in the debug build) but disappear completely in the release
4433 build. On the other hand, the wxCHECK macros stay event in release builds but a
4434 check failure doesn't generate any user-visible effects then. Finally, the
4435 compile time assertions don't happen during the run-time but result in the
4436 compilation error messages if the condition they check fail.
4438 \wxheading{Include files}
4443 \membersection{::wxOnAssert}\label{wxonassert}
4445 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
4447 This function is called whenever one of debugging macros fails (i.e. condition
4448 is false in an assertion). It is only defined in the debug mode, in release
4449 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
4451 To override the default behaviour in the debug builds which is to show the user
4452 a dialog asking whether he wants to abort the program, continue or continue
4453 ignoring any subsequent assert failures, you may override
4454 \helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if
4455 the global application object exists.
4458 \membersection{wxASSERT}\label{wxassert}
4460 \func{}{wxASSERT}{\param{}{condition}}
4462 Assert macro. An error message will be generated if the condition is false in
4463 debug mode, but nothing will be done in the release build.
4465 Please note that the condition in wxASSERT() should have no side effects
4466 because it will not be executed in release mode at all.
4468 \wxheading{See also}
4470 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4471 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4474 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
4476 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
4478 This macro results in a
4479 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
4480 of the given type {\it type} is less than {\it size} bits.
4482 You may use it like this, for example:
4485 // we rely on the int being able to hold values up to 2^32
4486 wxASSERT_MIN_BITSIZE(int, 32);
4488 // can't work with the platforms using UTF-8 for wchar_t
4489 wxASSERT_MIN_BITSIZE(wchar_t, 16);
4493 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
4495 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
4497 Assert macro with message. An error message will be generated if the condition is false.
4499 \wxheading{See also}
4501 \helpref{wxASSERT}{wxassert},\\
4502 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4505 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4507 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4509 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4510 specified {\it condition} is false. The compiler error message should include
4511 the {\it msg} identifier - please note that it must be a valid C++ identifier
4512 and not a string unlike in the other cases.
4514 This macro is mostly useful for testing the expressions involving the
4515 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4516 sometimes desirable to test them at the compile time.
4518 Note that this macro internally declares a struct whose name it tries to make
4519 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4520 use it on the same line in two different source files. In this case you may
4521 either change the line in which either of them appears on or use the
4522 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4524 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4525 if you use this macro with `Program Database For Edit And Continue'
4526 (\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
4527 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4529 \wxheading{See also}
4531 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4532 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4535 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4537 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4539 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4540 except that it allows you to specify a unique {\it name} for the struct
4541 internally defined by this macro to avoid getting the compilation errors
4542 described \helpref{above}{wxcompiletimeassert}.
4545 \membersection{wxFAIL}\label{wxfail}
4547 \func{}{wxFAIL}{\void}
4549 Will always generate an assert error if this code is reached (in debug mode).
4551 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4554 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4556 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4558 Will always generate an assert error with specified message if this code is reached (in debug mode).
4560 This macro is useful for marking unreachable" code areas, for example
4561 it may be used in the "default:" branch of a switch statement if all possible
4562 cases are processed above.
4564 \wxheading{See also}
4566 \helpref{wxFAIL}{wxfail}
4569 \membersection{wxCHECK}\label{wxcheck}
4571 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4573 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4574 This check is done even in release mode.
4577 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4579 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4581 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4582 This check is done even in release mode.
4584 This macro may be only used in non-void functions, see also
4585 \helpref{wxCHECK\_RET}{wxcheckret}.
4588 \membersection{wxCHECK\_RET}\label{wxcheckret}
4590 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4592 Checks that the condition is true, and returns if not (FAILs with given error
4593 message in debug mode). This check is done even in release mode.
4595 This macro should be used in void functions instead of
4596 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4599 \membersection{wxCHECK2}\label{wxcheck2}
4601 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4603 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4604 {\it operation} if it is not. This is a generalisation of
4605 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4606 returning from the function must be done when the {\it condition} is false.
4608 This check is done even in release mode.
4611 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4613 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4615 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4616 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4617 instead of wxFAIL() if the {\it condition} is false.
4620 \membersection{::wxTrap}\label{wxtrap}
4622 \func{void}{wxTrap}{\void}
4624 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4625 debugger exception meaning that the control is passed to the debugger if one is
4626 attached to the process. Otherwise the program just terminates abnormally.
4628 In release mode this function does nothing.
4630 \wxheading{Include files}
4636 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4638 \func{bool}{wxIsDebuggerRunning}{\void}
4640 Returns \true if the program is running under debugger, \false otherwise.
4642 Please note that this function is currently only implemented for Win32 and Mac
4643 builds using CodeWarrior and always returns \false elsewhere.
4648 \section{Environment access functions}\label{environfunctions}
4650 The functions in this section allow to access (get) or change value of
4651 environment variables in a portable way. They are currently implemented under
4652 Win32 and POSIX-like systems (Unix).
4654 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4656 \wxheading{Include files}
4661 \membersection{wxGetenv}\label{wxgetenvmacro}
4663 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4665 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4668 Note that under Win32 it may not return correct value for the variables set
4669 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4673 \membersection{wxGetEnv}\label{wxgetenv}
4675 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4677 Returns the current value of the environment variable {\it var} in {\it value}.
4678 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4679 and are not interested in its value.
4681 Returns \true if the variable exists, \false otherwise.
4684 \membersection{wxSetEnv}\label{wxsetenv}
4686 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4688 Sets the value of the environment variable {\it var} (adding it if necessary)
4691 Returns \true on success.
4694 \membersection{wxUnsetEnv}\label{wxunsetenv}
4696 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4698 Removes the variable {\it var} from the environment.
4699 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4702 Returns \true on success.