1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: Functions and macros
4 %% Author: wxWidgets Team
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \chapter{Functions and macros
}\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{DECLARE
\_ABSTRACT\_CLASS}{declareabstractclass
}\\
24 \helpref{DECLARE
\_APP}{declareapp
}\\
25 \helpref{DECLARE
\_CLASS}{declareclass
}\\
26 \helpref{DECLARE
\_DYNAMIC\_CLASS}{declaredynamicclass
}\\
27 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS2}{implementabstractclass2
}\\
28 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS}{implementabstractclass
}\\
29 \helpref{IMPLEMENT
\_APP}{implementapp
}\\
30 \helpref{IMPLEMENT
\_CLASS2}{implementclass2
}\\
31 \helpref{IMPLEMENT
\_CLASS}{implementclass
}\\
32 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS2}{implementdynamicclass2
}\\
33 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS}{implementdynamicclass
}\\
34 \helpref{wxAboutBox
}{wxaboutbox
}\\
35 \helpref{wxASSERT
}{wxassert
}\\
36 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
37 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
38 \helpref{wxAtomicDec
}{wxatomicdec
}\\
39 \helpref{wxAtomicInc
}{wxatomicinc
}\\
40 \helpref{wxBase64Decode
}{wxbase64decode
}\\
41 \helpref{wxBase64Encode
}{wxbase64encode
}\\
42 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
43 \helpref{wxBell
}{wxbell
}\\
44 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
45 \helpref{wxCHANGE
\_UMASK}{wxchangeumask
}\\
46 \helpref{wxCHECK
}{wxcheck
}\\
47 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
48 \helpref{wxCHECK2
}{wxcheck2
}\\
49 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
50 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
51 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
52 \helpref{wxCHECK
\_SUNCC\_VERSION}{wxchecksunccversion
}\\
53 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
54 \helpref{wxCHECK
\_VERSION\_FULL}{wxcheckversionfull
}\\
55 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
56 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
57 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
58 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
59 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
60 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
61 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
62 \helpref{wxCONCAT
}{wxconcat
}\\
63 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
64 \helpref{wxConstCast
}{wxconstcast
}\\
65 \helpref{wxCopyFile
}{wxcopyfile
}\\
66 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
67 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
68 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}\\
69 \helpref{wxCRIT
\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember
}\\
70 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}\\
71 \helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
}\\
% wxcs already taken!
72 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
73 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
74 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
75 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
76 \helpref{WXDEBUG
\_NEW}{debugnew
}\\
77 \helpref{wxDEPRECATED
}{wxdeprecated
}\\
78 \helpref{wxDEPRECATED
\_BUT\_USED\_INTERNALLY}{wxdeprecatedbutusedinternally
}\\
79 \helpref{wxDEPRECATED
\_INLINE}{wxdeprecatedinline
}\\
80 \helpref{wxDirExists
}{functionwxdirexists
}\\
81 \helpref{wxDirSelector
}{wxdirselector
}\\
82 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
83 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
84 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
85 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
86 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
87 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
88 \helpref{wxDYNLIB
\_FUNCTION}{wxdynlibfunction
}\\
89 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
90 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
91 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
92 \helpref{wxENTER
\_CRIT\_SECT}{wxentercritsect
}\\
93 \helpref{wxEntry
}{wxentry
}\\
94 \helpref{wxEntryStart
}{wxentrystart
}\\
95 \helpref{wxEntryCleanup
}{wxentrycleanup
}\\
96 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
97 \helpref{wxError
}{wxerror
}\\
98 \helpref{wxExecute
}{wxexecute
}\\
99 \helpref{wxExit
}{wxexit
}\\
100 \helpref{wxEXPLICIT
}{wxexplicit
}\\
101 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
102 \helpref{wxFAIL
}{wxfail
}\\
103 \helpref{wxFatalError
}{wxfatalerror
}\\
104 \helpref{wxFileExists
}{functionwxfileexists
}\\
105 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
106 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
107 \helpref{wxFileSelector
}{wxfileselector
}\\
108 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
109 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
110 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
111 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
112 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
113 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
114 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
115 \helpref{wxFinite
}{wxfinite
}\\
116 \helpref{wxGenericAboutBox
}{wxgenericaboutbox
}\\
117 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
118 \helpref{wxGetApp
}{wxgetapp
}\\
119 \helpref{wxGetBatteryState
}{wxgetbatterystate
}\\
120 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
121 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
122 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
123 \helpref{wxGetCwd
}{wxgetcwd
}\\
124 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
125 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
126 \helpref{wxGetDisplaySize
}{wxdisplaysize
}\\
127 \helpref{wxGetDisplaySizeMM
}{wxdisplaysizemm
}\\
128 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
129 \helpref{wxGetEnv
}{wxgetenv
}\\
130 \helpref{wxGetFileKind
}{wxgetfilekind
}\\
131 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
132 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
133 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
134 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
135 \helpref{wxGetHostName
}{wxgethostname
}\\
136 \helpref{wxGetKeyState
}{wxgetkeystate
}\\
137 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
138 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
139 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
140 \helpref{wxGetMouseState
}{wxgetmousestate
}\\
141 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
142 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
143 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
144 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
145 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
146 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
147 \helpref{wxGetPowerType
}{wxgetpowertype
}\\
148 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
149 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
150 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
151 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
152 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
153 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
154 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
155 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
156 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
157 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
158 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
159 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
160 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
161 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
162 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
163 \helpref{wxGetTranslation
}{wxgettranslation
}\\
164 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
165 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
166 \helpref{wxGetUserId
}{wxgetuserid
}\\
167 \helpref{wxGetUserName
}{wxgetusername
}\\
168 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
169 \helpref{wxGetenv
}{wxgetenvmacro
}\\
170 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
171 \helpref{wxICON
}{wxiconmacro
}\\
172 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
173 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
174 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
175 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
176 \helpref{wxInitialize
}{wxinitialize
}\\
177 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
178 \helpref{wxIsBusy
}{wxisbusy
}\\
179 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
180 \helpref{wxIsDebuggerRunning
}{wxisdebuggerrunning
}\\
181 \helpref{wxIsEmpty
}{wxisempty
}\\
182 \helpref{wxIsMainThread
}{wxismainthread
}\\
183 \helpref{wxIsNaN
}{wxisnan
}\\
184 \helpref{wxIsPlatformLittleEndian
}{wxisplatformlittleendian
}\\
185 \helpref{wxIsPlatform64Bit
}{wxisplatform64bit
}\\
186 \helpref{wxIsWild
}{wxiswild
}\\
187 \helpref{wxJoin
}{wxjoin
}\\
188 \helpref{wxKill
}{wxkill
}\\
189 \helpref{wxLaunchDefaultBrowser
}{wxlaunchdefaultbrowser
}\\
190 \helpref{wxLEAVE
\_CRIT\_SECT}{wxleavecritsect
}\\
191 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
192 \helpref{wxLogDebug
}{wxlogdebug
}\\
193 \helpref{wxLogError
}{wxlogerror
}\\
194 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
195 \helpref{wxLogMessage
}{wxlogmessage
}\\
196 \helpref{wxLogStatus
}{wxlogstatus
}\\
197 \helpref{wxLogSysError
}{wxlogsyserror
}\\
198 \helpref{wxLogTrace
}{wxlogtrace
}\\
199 \helpref{wxLogVerbose
}{wxlogverbose
}\\
200 \helpref{wxLogWarning
}{wxlogwarning
}\\
201 \helpref{wxLL
}{wxll
}\\
202 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
203 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
204 \helpref{wxMatchWild
}{wxmatchwild
}\\
205 \helpref{wxMessageBox
}{wxmessagebox
}\\
206 \helpref{wxMilliSleep
}{wxmillisleep
}\\
207 \helpref{wxMicroSleep
}{wxmicrosleep
}\\
208 \helpref{wxMkdir
}{wxmkdir
}\\
209 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
210 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
211 \helpref{wxNewId
}{wxnewid
}\\
212 \helpref{wxNow
}{wxnow
}\\
213 \helpref{wxOnAssert
}{wxonassert
}\\
214 \helpref{wxON
\_BLOCK\_EXIT}{wxonblockexit
}\\
215 \helpref{wxON
\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj
}\\
216 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
217 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
218 \helpref{wxPathOnly
}{wxpathonly
}\\
219 \helpref{wxPLURAL
}{wxplural
}\\
220 \helpref{wxPostDelete
}{wxpostdelete
}\\
221 \helpref{wxPostEvent
}{wxpostevent
}\\
222 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
223 \helpref{wxRegisterId
}{wxregisterid
}\\
224 \helpref{wxRemoveFile
}{wxremovefile
}\\
225 \helpref{wxRenameFile
}{wxrenamefile
}\\
226 \helpref{wxRmdir
}{wxrmdir
}\\
227 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
228 \helpref{wxSafeYield
}{wxsafeyield
}\\
229 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
230 \helpref{wxSetCursor
}{wxsetcursor
}\\
231 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
232 \helpref{wxSetEnv
}{wxsetenv
}\\
233 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
234 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
235 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
236 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
237 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
238 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
239 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
240 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
241 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
242 \helpref{wxShell
}{wxshell
}\\
243 \helpref{wxShowTip
}{wxshowtip
}\\
244 \helpref{wxShutdown
}{wxshutdown
}\\
245 \helpref{wxSleep
}{wxsleep
}\\
246 \helpref{wxSnprintf
}{wxsnprintf
}\\
247 \helpref{wxSplit
}{wxsplit
}\\
248 \helpref{wxSplitPath
}{wxsplitfunction
}\\
249 \helpref{wxStaticCast
}{wxstaticcast
}\\
250 \helpref{wxStrcmp
}{wxstrcmp
}\\
251 \helpref{wxStricmp
}{wxstricmp
}\\
252 \helpref{wxStringEq
}{wxstringeq
}\\
253 \helpref{wxStringMatch
}{wxstringmatch
}\\
254 \helpref{wxStringTokenize
}{wxstringtokenize
}\\
255 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
256 \helpref{wxStrlen
}{wxstrlen
}\\
257 \helpref{wxSTRINGIZE
}{wxstringize
}\\
258 \helpref{wxSTRINGIZE
\_T}{wxstringizet
}\\
259 \helpref{wxSUPPRESS
\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning
}\\
260 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
261 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
263 \helpref{wxTrace
}{wxtrace
}\\
264 \helpref{WXTRACE
}{trace
}\\
265 \helpref{wxTraceLevel
}{wxtracelevel
}\\
266 \helpref{WXTRACELEVEL
}{tracelevel
}\\
267 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
268 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
269 \helpref{wxTrap
}{wxtrap
}\\
270 \helpref{wxULL
}{wxull
}\\
271 \helpref{wxUninitialize
}{wxuninitialize
}\\
272 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
273 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
274 \helpref{wxUsleep
}{wxusleep
}\\
275 \helpref{wxVaCopy
}{wxvacopy
}\\
276 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
277 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
278 \helpref{wxYield
}{wxyield
}\\
279 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
280 \helpref{wx
\_reinterpret\_cast}{wxreinterpretcastraw
}\\
281 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
282 \helpref{wx
\_truncate\_cast}{wxtruncatecast
}\\
283 \helpref{\_}{underscore
}\\
284 \helpref{\_T}{underscoret
}
285 \helpref{\_\_WXFUNCTION\_\_}{wxfunction
}
289 \section{Version macros
}\label{versionfunctions
}
291 The following constants are defined in wxWidgets:
293 \begin{itemize
}\itemsep=
0pt
294 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
295 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
296 \item {\tt wxRELEASE
\_NUMBER} is the release number
297 \item {\tt wxSUBRELEASE
\_NUMBER} is the subrelease number which is $
0$ for all
301 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
304 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
305 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
306 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
309 The subrelease number is only used for the sources in between official releases
310 and so normally is not useful.
312 \wxheading{Include files
}
314 <wx/version.h> or <wx/defs.h>
317 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
319 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor
}}
321 Returns $
1$ if the compiler being used to compile the code is GNU C++
322 compiler (g++) version major.minor or greater. Otherwise, and also if
323 the compiler is not GNU C++ at all, returns $
0$.
326 \membersection{wxCHECK
\_SUNCC\_VERSION}\label{wxchecksunccversion
}
328 \func{bool
}{wxCHECK
\_SUNCC\_VERSION}{\param{}{major, minor
}}
330 Returns $
1$ if the compiler being used to compile the code is Sun CC Pro
331 compiler and its version is at least
\texttt{major.minor
}. Otherwise returns
335 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
337 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
339 This is a macro which evaluates to true if the current wxWidgets version is at
340 least major.minor.release.
342 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
343 the following can be done:
347 #if wxCHECK_VERSION(
2,
2,
0)
348 if ( s.StartsWith("foo") )
349 #else // replacement code for old version
350 if ( strncmp(s, "foo",
3) ==
0 )
358 \membersection{wxCHECK
\_VERSION\_FULL}\label{wxcheckversionfull
}
360 \func{bool
}{wxCHECK
\_VERSION\_FULL}{\param{}{major, minor, release, subrel
}}
362 Same as
\helpref{wxCHECK
\_VERSION}{wxcheckversion
} but also checks that
363 \texttt{wxSUBRELEASE
\_NUMBER} is at least
\arg{subrel
}.
366 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
368 \func{bool
}{wxCHECK
\_W32API\_VERSION}{\param{}{major, minor, release
}}
370 Returns $
1$ if the version of w32api headers used is major.minor.release or
371 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
372 Win32 at all, returns $
0$.
376 \section{Application initialization and termination
}\label{appinifunctions
}
378 The functions in this section are used on application startup/shutdown and also
379 to control the behaviour of the main event loop of the GUI programs.
382 \membersection{::wxEntry
}\label{wxentry
}
384 This initializes wxWidgets in a platform-dependent way. Use this if you are not
385 using the default wxWidgets entry code (e.g. main or WinMain). For example, you
386 can initialize wxWidgets from an Microsoft Foundation Classes application using
389 The following overload of wxEntry is available under all platforms:
391 \func{int
}{wxEntry
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
393 Under MS Windows, an additional overload suitable for calling from
394 \texttt{WinMain
} is available:
396 \func{int
}{wxEntry
}{\param{HINSTANCE
}{hInstance
},
\param{HINSTANCE
}{hPrevInstance =
\NULL},
\param{char *
}{pCmdLine =
\NULL},
\param{int
}{nCmdShow =
\texttt{SW
\_SHOWNORMAL}}}
398 (notice that under Windows CE platform, and only there, the type of
399 \arg{pCmdLine
} is
\texttt{wchar
\_t *
}, otherwise it is
\texttt{char *
}, even in
404 \helpref{wxEntryStart
}{wxentrystart
}
408 To clean up wxWidgets, call wxApp::OnExit followed by the static function
409 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
412 int CTheApp::ExitInstance()
414 // OnExit isn't called by CleanUp so must be called explicitly.
418 return CWinApp::ExitInstance();
422 \wxheading{Include files
}
428 \membersection{::wxEntryCleanup
}\label{wxentrycleanup
}
430 \func{void
}{wxEntryCleanup
}{\void}
432 Free resources allocated by a successful call to
\helpref{wxEntryStart
}{wxentrystart
}.
434 \wxheading{Include files
}
439 \membersection{::wxEntryStart
}\label{wxentrystart
}
441 \func{bool
}{wxEntryStart
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
443 This function can be used to perform the initialization of wxWidgets if you
444 can't use the default initialization code for any reason.
446 If the function returns
\true, the initialization was successful and the global
447 \helpref{wxApp
}{wxapp
} object
\texttt{wxTheApp
} has been created. Moreover,
448 \helpref{wxEntryCleanup
}{wxentrycleanup
} must be called afterwards. If the
449 function returns
\false, a catastrophic initialization error occured and (at
450 least the GUI part of) the library can't be used at all.
452 Notice that parameters
\arg{argc
} and
\arg{argv
} may be modified by this
455 An additional overload of wxEntryStart() is provided under MSW only: it is
456 meant to be called with the parameters passed to
\texttt{WinMain()
}.
458 \func{bool
}{wxEntryStart
}{\param{HINSTANCE
}{hInstance
},
\param{HINSTANCE
}{hPrevInstance =
\NULL},
\param{char *
}{pCmdLine =
\NULL},
\param{int
}{nCmdShow =
\texttt{SW
\_SHOWNORMAL}}}
460 (notice that under Windows CE platform, and only there, the type of
461 \arg{pCmdLine
} is
\texttt{wchar
\_t *
}, otherwise it is
\texttt{char *
}, even in
464 \wxheading{Include files
}
469 \membersection{::wxGetApp
}\label{wxgetapp
}
471 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
473 This function doesn't exist in wxWidgets but it is created by using
474 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
475 anywhere but in the same module where this macro is used, you must make it
476 available using
\helpref{DECLARE
\_APP}{declareapp
}.
478 The advantage of using this function compared to directly using the global
479 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
480 allow you to access the functions specific to your application class but not
481 present in wxApp while wxGetApp() returns the object of the right type.
484 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
486 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
488 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
489 faults under Windows or segmentation violations in the Unix world) will be
490 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
491 By default, i.e. before this function is called, they will be handled in the
492 normal way which usually just means that the application will be terminated.
493 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
494 this default behaviour.
496 Notice that this function is only available if
497 \texttt{wxUSE
\_ON\_FATAL\_EXCEPTION} is $
1$ and under Windows platform this
498 requires a compiler with support for SEH (structured exception handling) which
499 currently means only Microsoft Visual C++ or a recent Borland C++ version.
502 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
504 \func{void
}{wxInitAllImageHandlers
}{\void}
506 Initializes all available image handlers. For a list of available handlers,
507 see
\helpref{wxImage
}{wximage
}.
511 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
513 \wxheading{Include files
}
518 \membersection{::wxInitialize
}\label{wxinitialize
}
520 \func{bool
}{wxInitialize
}{\void}
522 This function is used in wxBase only and only if you don't create
523 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
524 {\tt main()
} function before calling any other wxWidgets functions.
526 If the function returns
\false the initialization could not be performed,
527 in this case the library cannot be used and
528 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
530 This function may be called several times but
531 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
532 call to this function.
534 \wxheading{Include files
}
539 \membersection{::wxSafeYield
}\label{wxsafeyield
}
541 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
542 onlyIfNeeded = false
}}
544 This function is similar to wxYield, except that it disables the user input to
545 all program windows before calling wxYield and re-enables it again
546 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
547 allowing the implementation of some limited user interaction.
549 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
551 \wxheading{Include files
}
556 \membersection{::wxUninitialize
}\label{wxuninitialize
}
558 \func{void
}{wxUninitialize
}{\void}
560 This function is for use in console (wxBase) programs only. It must be called
561 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
563 \wxheading{Include files
}
568 \membersection{::wxYield
}\label{wxyield
}
570 \func{bool
}{wxYield
}{\void}
572 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
574 This function is kept only for backwards compatibility. Please use
575 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
577 \wxheading{Include files
}
579 <wx/app.h> or <wx/utils.h>
582 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
584 \func{void
}{wxWakeUpIdle
}{\void}
586 This functions wakes up the (internal and platform dependent) idle system, i.e. it
587 will force the system to send an idle event even if the system currently
{\it is
}
588 idle and thus would not send any idle event until after some other event would get
589 sent. This is also useful for sending events between two threads and is used by
590 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
591 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
593 \wxheading{Include files
}
599 \section{Process control functions
}\label{processfunctions
}
601 The functions in this section are used to launch or terminate the other
605 \membersection{::wxExecute
}\label{wxexecute
}
607 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
609 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
611 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
613 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
615 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{int
}{flags =
0}}
617 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
618 only takes the
{\tt command
} argument,
619 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
622 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
},
\param{int
}{flags =
0}}
624 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
625 and it only takes the
{\tt command
} argument,
626 and returns a
3-element list
{\tt ( status, output, errors )
}, where
627 {\tt output
} and
{\tt errors
} are array references.
}
629 Executes another program in Unix or Windows.
631 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
633 The second form takes an array of values: a command, any number of
634 arguments, terminated by NULL.
636 The semantics of the third and fourth versions is different from the first two
637 and is described in more details below.
639 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
640 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
641 application waits until the other program has terminated.
643 In the case of synchronous execution, the return value is the exit code of
644 the process (which terminates by the moment the function returns) and will be
645 $-
1$ if the process couldn't be started and typically
0 if the process
646 terminated successfully. Also, while waiting for the process to
647 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. Because of this, by
648 default this function disables all application windows to avoid unexpected
649 reentrancies which could result from the users interaction with the program
650 while the child process is running. If you are sure that it is safe to not
651 disable the program windows, you may pass
\texttt{wxEXEC
\_NODISABLE} flag to
652 prevent this automatic disabling from happening.
654 For asynchronous execution, however, the return value is the process id and
655 zero value indicates that the command could not be executed. As an added
656 complication, the return value of $-
1$ in this case indicates that we didn't
657 launch a new process, but connected to the running one (this can only happen in
658 case of using DDE under Windows for command execution). In particular, in this,
659 and only this, case the calling code will not get the notification about
662 If callback isn't NULL and if execution is asynchronous,
663 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
664 the process finishes. Specifying this parameter also allows you to redirect the
665 standard input and/or output of the process being launched by calling
666 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
667 under Windows the process window is not shown by default (this avoids having to
668 flush an unnecessary console for the processes which don't create any windows
669 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
670 happening, i.e. with this flag the child process window will be shown normally.
672 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
673 that the new process is a group leader (this will create a new session if
674 needed). Calling
\helpref{wxKill
}{wxkill
} passing wxKILL
\_CHILDREN will
675 kill this process as well as all of its children (except those which have
676 started their own session).
678 The
{\tt wxEXEC
\_NOEVENTS} flag prevents processing of any events from taking
679 place while the child process is running. It should be only used for very
680 short-lived processes as otherwise the application windows risk becoming
681 unresponsive from the users point of view. As this flag only makes sense with
682 {\tt wxEXEC
\_SYNC},
{\tt wxEXEC
\_BLOCK} equal to the sum of both of these flags
683 is provided as a convenience.
685 Finally, you may use the third overloaded version of this function to execute
686 a process (always synchronously, the contents of
\arg{flags
} is or'd with
687 \texttt{wxEXEC
\_SYNC}) and capture its output in the array
\arg{output
}. The
688 fourth version adds the possibility to additionally capture the messages from
689 standard error output in the
\arg{errors
} array.
691 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
692 this function from another thread will result in an assert failure in debug
693 build and won't work.
697 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
699 \wxheading{Parameters
}
701 \docparam{command
}{The command to execute and any parameters to pass to it as a
704 \docparam{argv
}{The command to execute should be the first element of this
705 array, any additional ones are the command parameters and the array must be
706 terminated with a NULL pointer.
}
708 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
709 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
711 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
713 \wxheading{Include files
}
718 \membersection{::wxExit
}\label{wxexit
}
720 \func{void
}{wxExit
}{\void}
722 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
723 Should only be used in an emergency: normally the top-level frame
724 should be deleted (after deleting all other frames) to terminate the
725 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
727 \wxheading{Include files
}
732 \membersection{::wxJoin
}\label{wxjoin
}
734 \func{wxString
}{wxJoin
}{\param{const wxArrayString\&
}{ arr
},
\param{const wxChar
}{ sep
},
\param{const wxChar
}{ escape = '$
\backslash$'
}}
736 Concatenate all lines of the given
\helpref{wxArrayString
}{wxarraystring
} object using the separator
\arg{sep
} and returns
737 the result as a
\helpref{wxString
}{wxstring
}.
739 If the
\arg{escape
} character is non-
\NULL, then it's used as prefix for each occurrence of
\arg{sep
}
740 in the strings contained in
\arg{arr
} before joining them which is necessary
741 in order to be able to recover the original array contents from the string
742 later using
\helpref{wxSplit
}{wxsplit
}.
744 \wxheading{Include files
}
749 \membersection{::wxKill
}\label{wxkill
}
751 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
},
\param{int
}{flags =
0}}
753 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
754 process with PID
{\it pid
}. The valid signal values are
759 wxSIGNONE =
0, // verify if the process exists under Unix
768 wxSIGKILL, // forcefully kill, dangerous!
774 wxSIGTERM // terminate the process gently
778 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
779 under both Unix and Windows but all the other signals are equivalent to
780 {\tt wxSIGTERM
} under Windows.
782 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
783 be filled with an element of
{\tt wxKillError
} enum:
788 wxKILL_OK, // no error
789 wxKILL_BAD_SIGNAL, // no such signal
790 wxKILL_ACCESS_DENIED, // permission denied
791 wxKILL_NO_PROCESS, // no such process
792 wxKILL_ERROR // another, unspecified error
796 The
{\it flags
} parameter can be wxKILL
\_NOCHILDREN (the default),
797 or wxKILL
\_CHILDREN, in which case the child processes of this
798 process will be killed too. Note that under Unix, for wxKILL
\_CHILDREN
799 to work you should have created the process by passing wxEXEC
\_MAKE\_GROUP\_LEADER
804 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
805 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
806 \helpref{Exec sample
}{sampleexec
}
808 \wxheading{Include files
}
813 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
815 \func{unsigned long
}{wxGetProcessId
}{\void}
817 Returns the number uniquely identifying the current process in the system.
819 If an error occurs, $
0$ is returned.
821 \wxheading{Include files
}
826 \membersection{::wxShell
}\label{wxshell
}
828 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
830 Executes a command in an interactive shell window. If no command is
831 specified, then just the shell is spawned.
833 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
835 \wxheading{Include files
}
840 \membersection{::wxShutdown
}\label{wxshutdown
}
842 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
844 This function shuts down or reboots the computer depending on the value of the
845 {\it flags
}. Please notice that doing this requires the corresponding access
846 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privilege under Windows NT)
847 and that this function is only implemented under Unix and Win32.
849 \wxheading{Parameters
}
851 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
855 \true on success,
\false if an error occurred.
857 \wxheading{Include files
}
863 \section{Thread functions
}\label{threadfunctions
}
865 The functions and macros here mainly exist to make it writing the code which
866 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
867 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
869 For example, a static variable must be protected against simultaneous access by
870 multiple threads in the former configuration but in the latter the extra
871 overhead of using the critical section is not needed. To solve this problem,
872 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
873 to create and use the critical section only when needed.
875 \wxheading{Include files
}
881 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
885 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
887 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
889 This macro declares a (static) critical section object named
{\it cs
} if
890 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
894 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
896 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
898 This macro declares a critical section object named
{\it cs
} if
899 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
900 include the
{\tt static
} keyword (unlike
901 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
902 a class or struct member which explains its name.
906 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
908 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
910 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
911 object named
{\it name
} and associated with the critical section
{\it cs
} if
912 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
916 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
918 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
920 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
921 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
922 section object and also the lock object associated with it. Because of this, it
923 can be only used inside a function, not at global scope. For example:
928 static int s_counter =
0;
930 wxCRITICAL_SECTION(counter);
936 (note that we suppose that the function is called the first time from the main
937 thread so that the critical section object is initialized correctly by the time
938 other threads start calling it, if this is not the case this approach can
939 {\bf not
} be used and the critical section must be made a global instead).
943 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
945 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
947 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
948 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
952 \membersection{::wxIsMainThread
}\label{wxismainthread
}
954 \func{bool
}{wxIsMainThread
}{\void}
956 Returns
\true if this thread is the main one. Always returns
\true if
957 {\tt wxUSE
\_THREADS} is $
0$.
961 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
963 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
965 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
966 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
970 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
972 \func{void
}{wxMutexGuiEnter
}{\void}
974 This function must be called when any thread other than the main GUI thread
975 wants to get access to the GUI library. This function will block the execution
976 of the calling thread until the main thread (or any other thread holding the
977 main GUI lock) leaves the GUI library and no other thread will enter the GUI
978 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
980 Typically, these functions are used like this:
983 void MyThread::Foo(void)
985 // before doing any GUI calls we must ensure that this thread is the only
991 my_window->DrawSomething();
997 Note that under GTK, no creation of top-level windows is allowed in any
998 thread but the main one.
1000 This function is only defined on platforms which support preemptive
1004 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
1006 \func{void
}{wxMutexGuiLeave
}{\void}
1008 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
1010 This function is only defined on platforms which support preemptive
1015 \section{File functions
}\label{filefunctions
}
1017 \wxheading{Include files
}
1021 \wxheading{See also
}
1023 \helpref{wxPathList
}{wxpathlist
}\\
1024 \helpref{wxDir
}{wxdir
}\\
1025 \helpref{wxFile
}{wxfile
}\\
1026 \helpref{wxFileName
}{wxfilename
}
1029 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
1031 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
1033 Converts a DOS to a Unix filename by replacing backslashes with forward
1037 \membersection{::wxFileExists
}\label{functionwxfileexists
}
1039 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
1041 Returns true if the file exists and is a plain file.
1044 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
1046 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
1048 Returns time of last modification of given file.
1050 The function returns
\texttt{(time
\_t)
}$-
1$ if an error occurred (e.g. file not
1054 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
1056 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
1058 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
1060 {\bf NB:
} This function is obsolete, please use
1061 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
1063 Returns the filename for a full path. The second form returns a pointer to
1064 temporary storage that should not be deallocated.
1067 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
1069 \func{wxString
}{wxFindFirstFile
}{\param{const wxString\&
}{spec
},
\param{int
}{ flags =
0}}
1071 This function does directory searching; returns the first file
1072 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
1073 get the next matching file. Neither will
report the current directory "." or the
1074 parent directory "..".
1078 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.
1080 {\it spec
} may contain wildcards.
1082 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
1087 wxString f = wxFindFirstFile("/home/project/*.*");
1088 while ( !f.empty() )
1091 f = wxFindNextFile();
1096 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
1098 \func{wxString
}{wxFindNextFile
}{\void}
1100 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
1102 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
1105 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
1107 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
1109 This function returns the total number of bytes and number of free bytes on
1110 the disk containing the directory
{\it path
} (it should exist). Both
1111 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
1112 information is not needed.
1116 \true on success,
\false if an error occurred (for example, the
1117 directory doesn't exist).
1119 \wxheading{Portability
}
1121 The generic Unix implementation depends on the system having
1122 the
\texttt{statfs()
} or
\texttt{statvfs()
} function.
1124 This function first appeared in wxWidgets
2.3.2.
1127 \membersection{::wxGetFileKind
}\label{wxgetfilekind
}
1129 \func{wxFileKind
}{wxGetFileKind
}{\param{int
}{fd
}}
1131 \func{wxFileKind
}{wxGetFileKind
}{\param{FILE *
}{fp
}}
1133 Returns the type of an open file. Possible return values are:
1138 wxFILE_KIND_UNKNOWN,
1139 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
1140 wxFILE_KIND_TERMINAL, // a tty
1141 wxFILE_KIND_PIPE // a pipe
1146 \wxheading{Include files
}
1151 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
1153 \func{wxString
}{wxGetOSDirectory
}{\void}
1155 Returns the Windows directory under Windows; on other platforms returns the empty string.
1158 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
1160 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
1162 Returns true if the argument is an absolute filename, i.e. with a slash
1163 or drive name at the beginning.
1166 \membersection{::wxDirExists
}\label{functionwxdirexists
}
1168 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
1170 Returns true if
\arg{dirname
} exists and is a directory.
1173 \membersection{::wxPathOnly
}\label{wxpathonly
}
1175 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1177 Returns the directory part of the filename.
1180 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1182 \func{void
}{wxUnix2DosFilename
}{\param{wxChar *
}{s
}}
1184 This function is deprecated, use
\helpref{wxFileName
}{wxfilename
} instead.
1186 Converts a Unix to a DOS filename by replacing forward
1187 slashes with backslashes.
1190 \membersection{wxCHANGE
\_UMASK}\label{wxchangeumask
}
1192 \func{}{wxCHANGE
\_UMASK}{\param{int
}{mask
}}
1194 Under Unix this macro changes the current process umask to the given value,
1195 unless it is equal to $-
1$ in which case nothing is done, and restores it to
1196 the original value on scope exit. It works by declaring a variable which sets
1197 umask to
\arg{mask
} in its constructor and restores it in its destructor.
1199 Under other platforms this macro expands to nothing.
1202 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1204 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1205 \param{const wxString\&
}{file3
}}
1207 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1211 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1213 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1215 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1216 {\it overwrite
} parameter is
\true (default), the destination file is overwritten
1217 if it exists, but if
{\it overwrite
} is
\false, the functions fails in this
1220 This function supports resources forks under Mac OS.
1223 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1225 \func{wxString
}{wxGetCwd
}{\void}
1227 Returns a string containing the current (or working) directory.
1230 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1232 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1234 {\bf NB:
} This function is deprecated: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1236 Copies the current working directory into the buffer if supplied, or
1237 copies the working directory into new storage (which you
{\emph must
} delete
1238 yourself) if the buffer is NULL.
1240 {\it sz
} is the size of the buffer if supplied.
1243 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1245 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1247 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1249 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1250 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1251 %% is allocated for the temporary filename using {\it new}.
1253 %% Under Windows, the filename will include the drive and name of the
1254 %% directory allocated for temporary files (usually the contents of the
1255 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1257 %% It is the application's responsibility to create and delete the file.
1259 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1260 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1264 \membersection{::wxIsWild
}\label{wxiswild
}
1266 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1268 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1271 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1273 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1275 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1276 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1277 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1280 \membersection{::wxMkdir
}\label{wxmkdir
}
1282 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1284 Makes the directory
\arg{dir
}, returning true if successful.
1286 {\it perm
} is the access mask for the directory for the systems on which it is
1287 supported (Unix) and doesn't have any effect on the other ones.
1290 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1292 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1294 Parses the
\arg{wildCard
}, returning the number of filters.
1295 Returns
0 if none or if there's a problem.
1296 The arrays will contain an equal number of items found before the error.
1297 On platforms where native dialogs handle only one filter per entry,
1298 entries in arrays are automatically adjusted.
1299 \arg{wildCard
} is in the form:
1301 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1304 \membersection{::wxRemoveFile}\label{wxremovefile}
1306 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1308 Removes \arg{file}, returning true if successful.
1311 \membersection{::wxRenameFile}\label{wxrenamefile}
1313 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
1315 Renames \arg{file1} to \arg{file2}, returning true if successful.
1317 If \arg{overwrite} parameter is true (default), the destination file is
1318 overwritten if it exists, but if \arg{overwrite} is false, the functions fails
1322 \membersection{::wxRmdir}\label{wxrmdir}
1324 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1326 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1328 The {\it flags} parameter is reserved for future use.
1330 Please notice that there is also a wxRmDir() function which simply wraps the
1331 standard POSIX rmdir() function and so return an integer error code instead of
1332 a boolean value (but otherwise is currently identical to wxRmdir), don't
1333 confuse these two functions.
1336 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1338 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1340 Sets the current working directory, returning true if the operation succeeded.
1341 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1344 \membersection{::wxSplit}\label{wxsplit}
1346 \func{wxArrayString}{wxSplit}{\param{const wxString\&}{ str}, \param{const wxChar}{ sep}, \param{const wxChar}{ escape = '\\'}}
1348 Splits the given \helpref{wxString}{wxstring} object using the separator \arg{sep} and returns the
1349 result as a \helpref{wxArrayString}{wxarraystring}.
1351 If the \arg{escape} character is non-\NULL, then the occurrences of \arg{sep} immediately prefixed
1352 with \arg{escape} are not considered as separators.
1354 Note that empty tokens will be generated if there are two or more adjacent separators.
1356 \wxheading{See also}
1358 \helpref{wxJoin}{wxjoin}
1360 \wxheading{Include files}
1365 \membersection{::wxSplitPath}\label{wxsplitfunction}
1367 \func{void}{wxSplitPath}{\param{const wxString\&}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1369 {\bf NB:} This function is obsolete, please use
1370 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1372 This function splits a full file name into components: the path (including possible disk/drive
1373 specification under Windows), the base name and the extension. Any of the output parameters
1374 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1375 a particular component.
1377 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1378 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1379 is a valid character in a filename).
1381 On entry, {\it fullname} should be non-NULL (it may be empty though).
1383 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1384 contains the file name and {\it ext} contains the file extension without leading dot. All
1385 three of them may be empty if the corresponding component is. The old contents of the
1386 strings pointed to by these parameters will be overwritten in any case (if the pointers
1390 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1392 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1394 Copies the given file to {\it stream}. Useful when converting an old application to
1395 use streams (within the document/view framework, for example).
1397 \wxheading{Include files}
1402 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1404 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1406 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1407 use streams (within the document/view framework, for example).
1409 \wxheading{Include files}
1415 \section{Network, user and OS functions}\label{networkfunctions}
1417 The functions in this section are used to retrieve information about the
1418 current computer and/or user characteristics.
1421 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1423 \func{wxString}{wxGetEmailAddress}{\void}
1425 \func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
1427 Copies the user's email address into the supplied buffer, by
1428 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1429 and \helpref{wxGetUserId}{wxgetuserid}.
1431 Returns true if successful, false otherwise.
1433 \wxheading{Include files}
1438 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1440 \func{wxMemorySize}{wxGetFreeMemory}{\void}
1442 Returns the amount of free memory in bytes under environments which
1443 support it, and -1 if not supported or failed to perform measurement.
1445 \wxheading{Include files}
1450 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1452 \func{wxString}{wxGetFullHostName}{\void}
1454 Returns the FQDN (fully qualified domain host name) or an empty string on
1457 \wxheading{See also}
1459 \helpref{wxGetHostName}{wxgethostname}
1461 \wxheading{Include files}
1466 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1468 \func{wxString}{wxGetHomeDir}{\void}
1470 Return the (current) user's home directory.
1472 \wxheading{See also}
1474 \helpref{wxGetUserHome}{wxgetuserhome}\\
1475 \helpref{wxStandardPaths}{wxstandardpaths}
1477 \wxheading{Include files}
1482 \membersection{::wxGetHostName}\label{wxgethostname}
1484 \func{wxString}{wxGetHostName}{\void}
1486 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1488 Copies the current host machine's name into the supplied buffer. Please note
1489 that the returned name is {\it not} fully qualified, i.e. it does not include
1492 Under Windows or NT, this function first looks in the environment
1493 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1494 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1496 The first variant of this function returns the hostname if successful or an
1497 empty string otherwise. The second (deprecated) function returns true
1498 if successful, false otherwise.
1500 \wxheading{See also}
1502 \helpref{wxGetFullHostName}{wxgetfullhostname}
1504 \wxheading{Include files}
1509 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1511 \func{wxString}{wxGetOsDescription}{\void}
1513 Returns the string containing the description of the current platform in a
1514 user-readable form. For example, this function may return strings like
1515 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1517 \wxheading{See also}
1519 \helpref{::wxGetOsVersion}{wxgetosversion}
1521 \wxheading{Include files}
1526 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1528 \func{wxOperatingSystemId}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1530 Gets the version and the operating system ID for currently running OS.
1531 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details about wxOperatingSystemId.
1533 \wxheading{See also}
1535 \helpref{::wxGetOsDescription}{wxgetosdescription},
1536 \helpref{wxPlatformInfo}{wxplatforminfo}
1538 \wxheading{Include files}
1543 \membersection{::wxIsPlatformLittleEndian}\label{wxisplatformlittleendian}
1545 \func{bool}{wxIsPlatformLittleEndian}{\void}
1547 Returns \true if the current platform is little endian (instead of big endian).
1548 The check is performed at run-time.
1550 \wxheading{See also}
1552 \helpref{Byte order macros}{byteordermacros}
1554 \wxheading{Include files}
1559 \membersection{::wxIsPlatform64Bit}\label{wxisplatform64bit}
1561 \func{bool}{wxIsPlatform64Bit}{\void}
1563 Returns \true if the operating system the program is running under is 64 bit.
1564 The check is performed at run-time and may differ from the value available at
1565 compile-time (at compile-time you can just check if {\tt sizeof(void*)==
8})
1566 since the program could be running in emulation mode or in a mixed
32/
64 bit system
1567 (bi-architecture operating system).
1569 Very important: this function is not
100\% reliable on some systems given the fact
1570 that there isn't always a standard way to do a reliable check on the OS architecture.
1572 \wxheading{Include files
}
1577 \membersection{::wxGetUserHome
}\label{wxgetuserhome
}
1579 \func{wxString
}{wxGetUserHome
}{\param{const wxString\&
}{user = ""
}}
1581 Returns the home directory for the given user. If the
\arg{user
} is empty
1582 (default value), this function behaves like
1583 \helpref{wxGetHomeDir
}{wxgethomedir
} i.e. returns the current user home
1586 If the home directory couldn't be determined, an empty string is returned.
1588 \wxheading{Include files
}
1593 \membersection{::wxGetUserId
}\label{wxgetuserid
}
1595 \func{wxString
}{wxGetUserId
}{\void}
1597 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1599 This function returns the "user id" also known as "login name" under Unix i.e.
1600 something like "jsmith". It uniquely identifies the current user (on this system).
1602 Under Windows or NT, this function first looks in the environment
1603 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
1604 in the
{\bf wxWidgets
} section of the WIN.INI file is tried.
1606 The first variant of this function returns the login name if successful or an
1607 empty string otherwise. The second (deprecated) function returns true
1608 if successful, false otherwise.
1610 \wxheading{See also
}
1612 \helpref{wxGetUserName
}{wxgetusername
}
1614 \wxheading{Include files
}
1619 \membersection{::wxGetUserName
}\label{wxgetusername
}
1621 \func{wxString
}{wxGetUserName
}{\void}
1623 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1625 This function returns the full user name (something like "Mr. John Smith").
1627 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
1628 in the
{\bf wxWidgets
} section of the WIN.INI file. If PenWindows
1629 is running, the entry
{\bf Current
} in the section
{\bf User
} of
1630 the PENWIN.INI file is used.
1632 The first variant of this function returns the user name if successful or an
1633 empty string otherwise. The second (deprecated) function returns
\true
1634 if successful,
\false otherwise.
1636 \wxheading{See also
}
1638 \helpref{wxGetUserId
}{wxgetuserid
}
1640 \wxheading{Include files
}
1646 \section{String functions
}\label{stringfunctions
}
1648 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
1650 \func{const wxString\&
}{wxGetTranslation
}{\param{const wxString\&
}{str
},
1651 \param{const wxString\&
}{domain = wxEmptyString
}}
1653 \func{const wxString\&
}{wxGetTranslation
}{\param{const wxString\&
}{str
},
\param{const wxString\&
}{strPlural
},
\param{size
\_t }{n
},
1654 \param{const wxString\&
}{domain = wxEmptyString
}}
1656 This function returns the translation of string
{\it str
} in the current
1657 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
1658 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
1659 original string is returned. In debug build, an error message is logged -- this
1660 should help to find the strings which were not yet translated. If
1661 {\it domain
} is specified then only that domain/catalog is searched
1662 for a matching string. As this function
1663 is used very often, an alternative (and also common in Unix world) syntax is
1664 provided: the
\helpref{\_()
}{underscore
} macro is defined to do the same thing
1665 as wxGetTranslation.
1667 The second form is used when retrieving translation of string that has
1668 different singular and plural form in English or different plural forms in some
1669 other language. It takes two extra arguments: as above,
\arg{str
}
1670 parameter must contain the singular form of the string to be converted and
1671 is used as the key for the search in the catalog. The
\arg{strPlural
} parameter
1672 is the plural form (in English). The parameter
\arg{n
} is used to determine the
1673 plural form. If no message catalog is found
\arg{str
} is returned if `n ==
1',
1674 otherwise
\arg{strPlural
}.
1676 See
\urlref{GNU gettext manual
}{http://www.gnu.org/manual/gettext/html
\_chapter/gettext
\_10.html\#SEC150
}
1677 for additional information on plural forms handling. For a shorter alternative
1678 see the
\helpref{wxPLURAL()
}{wxplural
} macro.
1680 Both versions call
\helpref{wxLocale::GetString
}{wxlocalegetstring
}.
1682 Note that this function is not suitable for literal strings in Unicode
1683 builds, since the literal strings must be enclosed into
1684 \helpref{\_T()
}{underscoret
} or
\helpref{wxT
}{wxt
} macro which makes them
1685 unrecognised by
\texttt{xgettext
}, and so they are not extracted to the message
1686 catalog. Instead, use the
\helpref{\_()
}{underscore
} and
1687 \helpref{wxPLURAL
}{wxplural
} macro for all literal strings.
1690 \membersection{::wxIsEmpty
}\label{wxisempty
}
1692 \func{bool
}{wxIsEmpty
}{\param{const char *
}{ p
}}
1694 Returns
\true if the pointer is either
{\tt NULL
} or points to an empty
1695 string,
\false otherwise.
1698 \membersection{::wxStrcmp
}\label{wxstrcmp
}
1700 \func{int
}{wxStrcmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1702 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1703 to or greater than
{\it p2
}. The comparison is case-sensitive.
1705 This function complements the standard C function
{\it stricmp()
} which performs
1706 case-insensitive comparison.
1709 \membersection{::wxStricmp
}\label{wxstricmp
}
1711 \func{int
}{wxStricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1713 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1714 to or greater than
{\it p2
}. The comparison is case-insensitive.
1716 This function complements the standard C function
{\it strcmp()
} which performs
1717 case-sensitive comparison.
1720 \membersection{::wxStringEq
}\label{wxstringeq
}
1722 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
1724 {\bf NB:
} This function is obsolete, use
\helpref{wxString
}{wxstring
} instead.
1729 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
1733 \membersection{::wxStringMatch
}\label{wxstringmatch
}
1735 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
1736 \param{bool
}{ subString = true
},
\param{bool
}{ exact = false
}}
1738 {\bf NB:
} This function is obsolete, use
\helpref{wxString::Find
}{wxstringfind
} instead.
1740 Returns
\true if the substring
{\it s1
} is found within
{\it s2
},
1741 ignoring case if
{\it exact
} is false. If
{\it subString
} is
\false,
1742 no substring matching is done.
1745 \membersection{::wxStringTokenize
}\label{wxstringtokenize
}
1747 \func{wxArrayString
}{wxStringTokenize
}{\param{const wxString\&
}{str
},\\
1748 \param{const wxString\&
}{delims = wxDEFAULT
\_DELIMITERS},\\
1749 \param{wxStringTokenizerMode
}{mode = wxTOKEN
\_DEFAULT}}
1751 This is a convenience function wrapping
1752 \helpref{wxStringTokenizer
}{wxstringtokenizer
} which simply returns all tokens
1753 found in the given
\arg{str
} in an array.
1756 \helpref{wxStringTokenizer::wxStringTokenizer
}{wxstringtokenizerwxstringtokenizer
}
1757 for the description of the other parameters.
1760 \membersection{::wxStrlen
}\label{wxstrlen
}
1762 \func{size
\_t}{wxStrlen
}{\param{const char *
}{ p
}}
1764 This is a safe version of standard function
{\it strlen()
}: it does exactly the
1765 same thing (i.e. returns the length of the string) except that it returns
0 if
1766 {\it p
} is the
{\tt NULL
} pointer.
1769 \membersection{::wxSnprintf
}\label{wxsnprintf
}
1771 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
1773 This function replaces the dangerous standard function
{\tt sprintf()
} and is
1774 like
{\tt snprintf()
} available on some platforms. The only difference with
1775 sprintf() is that an additional argument - buffer size - is taken and the
1776 buffer is never overflowed.
1778 Returns the number of characters copied to the buffer or -
1 if there is not
1781 \wxheading{See also
}
1783 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
1786 \membersection{wxT
}\label{wxt
}
1788 \func{wxChar
}{wxT
}{\param{char
}{ch
}}
1790 \func{const wxChar *
}{wxT
}{\param{const char *
}{s
}}
1792 wxT() is a macro which can be used with character and string literals (in other
1793 words,
{\tt 'x'
} or
{\tt "foo"
}) to automatically convert them to Unicode in
1794 Unicode build configuration. Please see the
1795 \helpref{Unicode overview
}{unicode
} for more information.
1797 This macro is simply returns the value passed to it without changes in ASCII
1798 build. In fact, its definition is:
1801 #define wxT(x) L ## x
1808 \membersection{wxTRANSLATE
}\label{wxtranslate
}
1810 \func{const wxChar *
}{wxTRANSLATE
}{\param{const char *
}{s
}}
1812 This macro doesn't do anything in the program code -- it simply expands to the
1813 value of its argument.
1815 However it does have a purpose which is to mark the literal strings for the
1816 extraction into the message catalog created by
{\tt xgettext
} program. Usually
1817 this is achieved using
\helpref{\_()
}{underscore
} but that macro not only marks
1818 the string for extraction but also expands into a
1819 \helpref{wxGetTranslation
}{wxgettranslation
} function call which means that it
1820 cannot be used in some situations, notably for static array
1823 Here is an example which should make it more clear: suppose that you have a
1824 static array of strings containing the weekday names and which have to be
1825 translated (note that it is a bad example, really, as
1826 \helpref{wxDateTime
}{wxdatetime
} already can be used to get the localized week
1827 day names already). If you write
1830 static const char * const weekdays
[] =
{ _("Mon"), ..., _("Sun")
};
1832 // use weekdays
[n
] as usual
1835 the code wouldn't compile because the function calls are forbidden in the array
1836 initializer. So instead you should do
1839 static const char * const weekdays
[] =
{ wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun")
};
1841 // use wxGetTranslation(weekdays
[n
])
1846 Note that although the code
{\bf would
} compile if you simply omit
1847 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1848 no translations for the weekday names in the program message catalog and
1849 wxGetTranslation wouldn't find them.
1852 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
1854 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argPtr
}}
1856 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list }
1857 argument instead of arbitrary number of parameters.
1859 Note that if
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is set to
1, then this function supports
1860 positional arguments (see
\helpref{wxString::Printf
}{wxstringprintf
} for more information).
1861 However other functions of the same family (wxPrintf, wxSprintf, wxFprintf, wxVfprintf,
1862 wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional parameters
1863 even when
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is
1.
1865 \wxheading{See also
}
1867 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
1871 \membersection{\_}\label{underscore
}
1873 \func{const wxString\&
}{\_}{\param{const wxString\&
}{s
}}
1875 This macro expands into a call to
\helpref{wxGetTranslation
}{wxgettranslation
}
1876 function, so it marks the message for the extraction by
{\tt xgettext
} just as
1877 \helpref{wxTRANSLATE
}{wxtranslate
} does, but also returns the translation of
1878 the string for the current locale during execution.
1880 Don't confuse this macro with
\helpref{\_T()
}{underscoret
}!
1883 \membersection{wxPLURAL
}\label{wxplural
}
1885 \func{const wxString\&
}{wxPLURAL
}{\param{const wxString\&
}{sing
},
\param{const wxString\&
}{plur
},
\param{size
\_t}{n
}}
1887 This macro is identical to
\helpref{\_()
}{underscore
} but for the plural variant
1888 of
\helpref{wxGetTranslation
}{wxgettranslation
}.
1891 \membersection{\_T}\label{underscoret
}
1893 \func{wxChar
}{\_T}{\param{char
}{ch
}}
1895 \func{const wxChar *
}{\_T}{\param{const wxChar
}{ch
}}
1897 This macro is exactly the same as
\helpref{wxT
}{wxt
} and is defined in
1898 wxWidgets simply because it may be more intuitive for Windows programmers as
1899 the standard Win32 headers also define it (as well as yet another name for the
1900 same macro which is
{\tt \_TEXT()
}).
1902 Don't confuse this macro with
\helpref{\_()
}{underscore
}!
1906 \section{Dialog functions
}\label{dialogfunctions
}
1908 Below are a number of convenience functions for getting input from the
1909 user or displaying messages. Note that in these functions the last three
1910 parameters are optional. However, it is recommended to pass a parent frame
1911 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1912 the front when the dialog box is popped up.
1915 \membersection{::wxAboutBox
}\label{wxaboutbox
}
1917 \func{void
}{wxAboutBox
}{\param{const wxAboutDialogInfo\&
}{info
}}
1919 This function shows the standard about dialog containing the information
1920 specified in
\arg{info
}. If the current platform has a native about dialog
1921 which is capable of showing all the fields in
\arg{info
}, the native dialog is
1922 used, otherwise the function falls back to the generic wxWidgets version of the
1923 dialog, i.e. does the same thing as
\helpref{wxGenericAboutBox()
}{wxgenericaboutbox
}.
1925 Here is an example of how this function may be used:
1927 void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
1929 wxAboutDialogInfo info;
1930 info.SetName(_("My Program"));
1931 info.SetVersion(_("
1.2.3 Beta"));
1932 info.SetDescription(_("This program does something great."));
1933 info.SetCopyright(_T("(C)
2007 Me <my@email.addre.ss>"));
1939 Please see the
\helpref{dialogs sample
}{sampledialogs
} for more examples of
1940 using this function and
\helpref{wxAboutDialogInfo
}{wxaboutdialoginfo
} for the
1941 description of the information which can be shown in the about dialog.
1943 \wxheading{Include files
}
1948 \membersection{::wxBeginBusyCursor
}\label{wxbeginbusycursor
}
1950 \func{void
}{wxBeginBusyCursor
}{\param{wxCursor *
}{cursor = wxHOURGLASS
\_CURSOR}}
1952 Changes the cursor to the given cursor for all windows in the application.
1953 Use
\helpref{wxEndBusyCursor
}{wxendbusycursor
} to revert the cursor back
1954 to its previous state. These two calls can be nested, and a counter
1955 ensures that only the outer calls take effect.
1957 See also
\helpref{wxIsBusy
}{wxisbusy
},
\helpref{wxBusyCursor
}{wxbusycursor
}.
1959 \wxheading{Include files
}
1964 \membersection{::wxBell
}\label{wxbell
}
1966 \func{void
}{wxBell
}{\void}
1968 Ring the system bell.
1970 Note that this function is categorized as a GUI one and so is not thread-safe.
1972 \wxheading{Include files
}
1977 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
1979 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
1980 \param{size
\_t }{currentTip
}}
1982 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
1983 used with
\helpref{wxShowTip
}{wxshowtip
}.
1985 \docparam{filename
}{The name of the file containing the tips, one per line
}
1986 \docparam{currentTip
}{The index of the first tip to show - normally this index
1987 is remembered between the
2 program runs.
}
1989 \wxheading{See also
}
1991 \helpref{Tips overview
}{tipsoverview
}
1993 \wxheading{Include files
}
1998 \membersection{::wxDirSelector
}\label{wxdirselector
}
2000 \func{wxString
}{wxDirSelector
}{\param{const wxString\&
}{message = wxDirSelectorPromptStr
},\\
2001 \param{const wxString\&
}{default
\_path = ""
},\\
2002 \param{long
}{style =
0},
\param{const wxPoint\&
}{pos = wxDefaultPosition
},\\
2003 \param{wxWindow *
}{parent = NULL
}}
2005 Pops up a directory selector dialog. The arguments have the same meaning as
2006 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
2007 and the default
\_path, if specified, is set as the initial selection.
2009 The application must check for an empty return value (if the user pressed
2010 Cancel). For example:
2013 const wxString& dir = wxDirSelector("Choose a folder");
2020 \wxheading{Include files
}
2025 \membersection{::wxFileSelector
}\label{wxfileselector
}
2027 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
2028 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
2029 \param{const wxString\&
}{wildcard = "*.*"
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
2030 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
2032 Pops up a file selector box. In Windows, this is the common file selector
2033 dialog. In X, this is a file selector box with the same functionality.
2034 The path and filename are distinct elements of a full file pathname.
2035 If path is empty, the current directory will be used. If filename is empty,
2036 no default filename will be supplied. The wildcard determines what files
2037 are displayed in the file selector, and file extension supplies a type
2038 extension for the required filename. Flags may be a combination of wxFD
\_OPEN,
2039 wxFD
\_SAVE, wxFD
\_OVERWRITE\_PROMPT or wxFD
\_FILE\_MUST\_EXIST. Note that wxFD
\_MULTIPLE
2040 can only be used with
\helpref{wxFileDialog
}{wxfiledialog
} and not here as this
2041 function only returns a single file name.
2043 Both the Unix and Windows versions implement a wildcard filter. Typing a
2044 filename containing wildcards
(*, ?) in the filename text item, and
2045 clicking on Ok, will result in only those files matching the pattern being
2048 The wildcard may be a specification for multiple types of file
2049 with a description for each, such as:
2052 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
2055 The application must check for an empty return value (the user pressed
2056 Cancel). For example:
2059 wxString filename = wxFileSelector("Choose a file to open");
2060 if ( !filename.empty() )
2062 // work with the file
2065 //else: cancelled by user
2068 \wxheading{Include files}
2073 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
2075 \func{void}{wxEndBusyCursor}{\void}
2077 Changes the cursor back to the original cursor, for all windows in the application.
2078 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
2080 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
2082 \wxheading{Include files}
2087 \membersection{::wxGenericAboutBox}\label{wxgenericaboutbox}
2089 \func{void}{wxGenericAboutBox}{\param{const wxAboutDialogInfo\& }{info}}
2091 This function does the same thing as \helpref{wxAboutBox}{wxaboutbox} except
2092 that it always uses the generic wxWidgets version of the dialog instead of the
2093 native one. This is mainly useful if you need to customize the dialog by e.g.
2094 adding custom controls to it (customizing the native dialog is not currently
2097 See the \helpref{dialogs sample}{sampledialogs} for an example of about dialog
2100 \wxheading{See also}
2102 \helpref{wxAboutDialogInfo}{wxaboutdialoginfo}
2104 \wxheading{Include files}
2107 <wx/generic/aboutdlgg.h>
2110 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
2112 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
2114 Shows the colour selection dialog and returns the colour selected by user or
2115 invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour
2116 is valid) if the dialog was cancelled.
2118 \wxheading{Parameters}
2120 \docparam{parent}{The parent window for the colour selection dialog}
2122 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
2124 \docparam{caption}{If given, this will be used for the dialog caption.}
2126 \wxheading{Include files}
2131 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
2133 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
2135 Shows the font selection dialog and returns the font selected by user or
2136 invalid font (use \helpref{wxFont:IsOk}{wxfontisok} to test whether a font
2137 is valid) if the dialog was cancelled.
2139 \wxheading{Parameters}
2141 \docparam{parent}{The parent window for the font selection dialog}
2143 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
2145 \docparam{caption}{If given, this will be used for the dialog caption.}
2147 \wxheading{Include files}
2153 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
2155 \func{size\_t}{wxGetMultipleChoices}{\\
2156 \param{wxArrayInt\& }{selections},\\
2157 \param{const wxString\& }{message},\\
2158 \param{const wxString\& }{caption},\\
2159 \param{const wxArrayString\& }{aChoices},\\
2160 \param{wxWindow *}{parent = NULL},\\
2161 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2162 \param{bool}{ centre = true},\\
2163 \param{int }{width=150}, \param{int }{height=200}}
2165 \func{size\_t}{wxGetMultipleChoices}{\\
2166 \param{wxArrayInt\& }{selections},\\
2167 \param{const wxString\& }{message},\\
2168 \param{const wxString\& }{caption},\\
2169 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2170 \param{wxWindow *}{parent = NULL},\\
2171 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2172 \param{bool}{ centre = true},\\
2173 \param{int }{width=150}, \param{int }{height=200}}
2175 Pops up a dialog box containing a message, OK/Cancel buttons and a
2176 multiple-selection listbox. The user may choose an arbitrary (including 0)
2177 number of items in the listbox whose indices will be returned in
2178 {\it selection} array. The initial contents of this array will be used to
2179 select the items when the dialog is shown.
2181 You may pass the list of strings to choose from either using {\it choices}
2182 which is an array of {\it n} strings for the listbox or by using a single
2183 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2185 If {\it centre} is true, the message text (which may include new line
2186 characters) is centred; if false, the message is left-justified.
2188 \wxheading{Include files}
2192 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2193 and {\tt choices}, and no {\tt selections} parameter; the function
2194 returns an array containing the user selections.}
2197 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
2199 \func{long}{wxGetNumberFromUser}{
2200 \param{const wxString\& }{message},
2201 \param{const wxString\& }{prompt},
2202 \param{const wxString\& }{caption},
2203 \param{long }{value},
2204 \param{long }{min = 0},
2205 \param{long }{max = 100},
2206 \param{wxWindow *}{parent = NULL},
2207 \param{const wxPoint\& }{pos = wxDefaultPosition}}
2209 Shows a dialog asking the user for numeric input. The dialogs title is set to
2210 {\it caption}, it contains a (possibly) multiline {\it message} above the
2211 single line {\it prompt} and the zone for entering the number.
2213 The number entered must be in the range {\it min}..{\it max} (both of which
2214 should be positive) and {\it value} is the initial value of it. If the user
2215 enters an invalid value or cancels the dialog, the function will return -1.
2217 Dialog is centered on its {\it parent} unless an explicit position is given in
2220 \wxheading{Include files}
2225 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
2227 \func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2228 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2229 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2231 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
2232 in the dialog is not shown on screen but replaced with stars. This is intended
2233 to be used for entering passwords as the function name implies.
2235 \wxheading{Include files}
2240 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
2242 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2243 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2244 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2246 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
2247 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
2248 or press Cancel to return the empty string.
2250 If {\it centre} is true, the message text (which may include new line characters)
2251 is centred; if false, the message is left-justified.
2253 \wxheading{Include files}
2258 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
2260 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2261 \param{const wxString\& }{caption},\\
2262 \param{const wxArrayString\& }{aChoices},\\
2263 \param{wxWindow *}{parent = NULL},\\
2264 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2265 \param{bool}{ centre = true},\\
2266 \param{int }{width=150}, \param{int }{height=200}}
2268 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2269 \param{const wxString\& }{caption},\\
2270 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2271 \param{wxWindow *}{parent = NULL},\\
2272 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2273 \param{bool}{ centre = true},\\
2274 \param{int }{width=150}, \param{int }{height=200}}
2276 Pops up a dialog box containing a message, OK/Cancel buttons and a
2277 single-selection listbox. The user may choose an item and press OK to return a
2278 string or Cancel to return the empty string. Use
2279 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
2280 valid choice and if you want to be able to detect pressing Cancel reliably.
2282 You may pass the list of strings to choose from either using {\it choices}
2283 which is an array of {\it n} strings for the listbox or by using a single
2284 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2286 If {\it centre} is true, the message text (which may include new line
2287 characters) is centred; if false, the message is left-justified.
2289 \wxheading{Include files}
2293 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2297 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
2299 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2300 \param{const wxString\& }{caption},\\
2301 \param{const wxArrayString\& }{aChoices},\\
2302 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2303 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2305 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2306 \param{const wxString\& }{caption},\\
2307 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2308 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2309 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2311 As {\bf wxGetSingleChoice} but returns the index representing the selected
2312 string. If the user pressed cancel, -1 is returned.
2314 \wxheading{Include files}
2318 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2322 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2324 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2325 \param{const wxString\& }{caption},\\
2326 \param{const wxArrayString\& }{aChoices},\\
2327 \param{const wxString\& }{client\_data[]},\\
2328 \param{wxWindow *}{parent = NULL},\\
2329 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2330 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2332 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2333 \param{const wxString\& }{caption},\\
2334 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2335 \param{const wxString\& }{client\_data[]},\\
2336 \param{wxWindow *}{parent = NULL},\\
2337 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2338 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2340 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2341 corresponding to the strings, and returns one of these pointers or NULL if
2342 Cancel was pressed. The {\it client\_data} array must have the same number of
2343 elements as {\it choices} or {\it aChoices}!
2345 \wxheading{Include files}
2349 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2350 and {\tt choices}, and the client data array must have the
2351 same length as the choices array.}
2354 \membersection{::wxIsBusy}\label{wxisbusy}
2356 \func{bool}{wxIsBusy}{\void}
2358 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2359 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2361 See also \helpref{wxBusyCursor}{wxbusycursor}.
2363 \wxheading{Include files}
2368 \membersection{::wxMessageBox}\label{wxmessagebox}
2370 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2371 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2373 General purpose message dialog. {\it style} may be a bit list of the
2374 following identifiers:
2376 \begin{twocollist}\itemsep=0pt
2377 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2379 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with
2381 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2382 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2383 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2384 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2385 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2386 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2389 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2395 int answer = wxMessageBox("Quit program?", "Confirm",
2396 wxYES_NO | wxCANCEL, main_frame);
2397 if (answer == wxYES)
2398 main_frame->Close();
2402 {\it message} may contain newline characters, in which case the
2403 message will be split into separate lines, to cater for large messages.
2405 \wxheading{Include files}
2410 \membersection{::wxShowTip}\label{wxshowtip}
2412 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2413 \param{wxTipProvider *}{tipProvider},
2414 \param{bool }{showAtStartup = true}}
2416 This function shows a "startup tip" to the user. The return value is the
2417 state of the `Show tips at startup' checkbox.
2419 \docparam{parent}{The parent window for the modal dialog}
2421 \docparam{tipProvider}{An object which is used to get the text of the tips.
2422 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2424 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2425 otherwise. This is used as the initial value for "Show tips at startup"
2426 checkbox which is shown in the tips dialog.}
2428 \wxheading{See also}
2430 \helpref{Tips overview}{tipsoverview}
2432 \wxheading{Include files}
2439 \section{Math functions}\label{mathfunctions}
2441 \wxheading{Include files}
2446 \membersection{wxFinite}\label{wxfinite}
2448 \func{int}{wxFinite}{\param{double }{x}}
2450 Returns a non-zero value if {\it x} is neither infinite nor NaN (not a number),
2451 returns 0 otherwise.
2454 \membersection{wxIsNaN}\label{wxisnan}
2456 \func{bool}{wxIsNaN}{\param{double }{x}}
2458 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2464 \section{GDI functions}\label{gdifunctions}
2466 The following are relevant to the GDI (Graphics Device Interface).
2468 \wxheading{Include files}
2473 \membersection{wxBITMAP}\label{wxbitmapmacro}
2475 \func{}{wxBITMAP}{bitmapName}
2477 This macro loads a bitmap from either application resources (on the platforms
2478 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2479 avoid using {\tt \#ifdef}s when creating bitmaps.
2481 \wxheading{See also}
2483 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2484 \helpref{wxICON}{wxiconmacro}
2486 \wxheading{Include files}
2491 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2493 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2494 \param{int *}{width}, \param{int *}{height}}
2496 \func{wxRect}{wxGetClientDisplayRect}{\void}
2498 Returns the dimensions of the work area on the display. On Windows
2499 this means the area not covered by the taskbar, etc. Other platforms
2500 are currently defaulting to the whole display until a way is found to
2501 provide this info for all window managers, etc.
2504 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2506 \func{bool}{wxColourDisplay}{\void}
2508 Returns true if the display is colour, false otherwise.
2511 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2513 \func{int}{wxDisplayDepth}{\void}
2515 Returns the depth of the display (a value of 1 denotes a monochrome display).
2518 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2520 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2522 \func{wxSize}{wxGetDisplaySize}{\void}
2524 Returns the display size in pixels.
2527 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2529 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2531 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2533 Returns the display size in millimeters.
2536 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2538 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2540 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2541 name. Under MSW, the cursor is loaded from the resource file and the icon is
2542 loaded from XPM file under other platforms.
2544 This macro should be used with
2545 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2547 \wxheading{Include files}
2552 \membersection{wxICON}\label{wxiconmacro}
2554 \func{}{wxICON}{iconName}
2556 This macro loads an icon from either application resources (on the platforms
2557 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2558 avoid using {\tt \#ifdef}s when creating icons.
2560 \wxheading{See also}
2562 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2563 \helpref{wxBITMAP}{wxbitmapmacro}
2565 \wxheading{Include files}
2570 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2572 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2573 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2575 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2576 makes it into a placeable metafile by prepending a header containing the given
2577 bounding box. The bounding box may be obtained from a device context after drawing
2578 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2580 In addition to adding the placeable metafile header, this function adds
2581 the equivalent of the following code to the start of the metafile data:
2584 SetMapMode(dc, MM_ANISOTROPIC);
2585 SetWindowOrg(dc, minX, minY);
2586 SetWindowExt(dc, maxX - minX, maxY - minY);
2589 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2591 Placeable metafiles may be imported by many Windows applications, and can be
2592 used in RTF (Rich Text Format) files.
2594 {\it scale} allows the specification of scale for the metafile.
2596 This function is only available under Windows.
2599 \membersection{::wxSetCursor}\label{wxsetcursor}
2601 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2603 Globally sets the cursor; only has an effect in Windows and GTK.
2604 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2608 \section{Printer settings}\label{printersettings}
2610 {\bf NB:} These routines are obsolete and should no longer be used!
2612 The following functions are used to control PostScript printing. Under
2613 Windows, PostScript output can only be sent to a file.
2615 \wxheading{Include files}
2620 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2622 \func{wxString}{wxGetPrinterCommand}{\void}
2624 Gets the printer command used to print a file. The default is {\tt lpr}.
2627 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2629 \func{wxString}{wxGetPrinterFile}{\void}
2631 Gets the PostScript output filename.
2634 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2636 \func{int}{wxGetPrinterMode}{\void}
2638 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2639 The default is PS\_PREVIEW.
2642 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2644 \func{wxString}{wxGetPrinterOptions}{\void}
2646 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2649 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2651 \func{int}{wxGetPrinterOrientation}{\void}
2653 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2656 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2658 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2660 Gets the command used to view a PostScript file. The default depends on the platform.
2663 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2665 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2667 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2670 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2672 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2674 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2677 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2679 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2681 Sets the printer command used to print a file. The default is {\tt lpr}.
2684 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2686 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2688 Sets the PostScript output filename.
2691 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2693 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2695 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2696 The default is PS\_PREVIEW.
2699 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2701 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2703 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2706 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2708 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2710 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2713 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2715 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2717 Sets the command used to view a PostScript file. The default depends on the platform.
2720 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2722 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2724 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2727 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2729 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2731 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2735 \section{Clipboard functions}\label{clipsboard}
2737 These clipboard functions are implemented for Windows only. The use of these functions
2738 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2741 \wxheading{Include files}
2746 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2748 \func{bool}{wxClipboardOpen}{\void}
2750 Returns true if this application has already opened the clipboard.
2753 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2755 \func{bool}{wxCloseClipboard}{\void}
2757 Closes the clipboard to allow other applications to use it.
2760 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2762 \func{bool}{wxEmptyClipboard}{\void}
2764 Empties the clipboard.
2767 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2769 \func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}}
2771 Enumerates the formats found in a list of available formats that belong
2772 to the clipboard. Each call to this function specifies a known
2773 available format; the function returns the format that appears next in
2776 {\it dataFormat} specifies a known format. If this parameter is zero,
2777 the function returns the first format in the list.
2779 The return value specifies the next known clipboard data format if the
2780 function is successful. It is zero if the {\it dataFormat} parameter specifies
2781 the last format in the list of available formats, or if the clipboard
2784 Before it enumerates the formats function, an application must open the clipboard by using the
2785 wxOpenClipboard function.
2788 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2790 \func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}}
2792 Gets data from the clipboard.
2794 {\it dataFormat} may be one of:
2796 \begin{itemize}\itemsep=0pt
2797 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2798 \item wxCF\_BITMAP: returns a new wxBitmap.
2801 The clipboard must have previously been opened for this call to succeed.
2804 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2806 \func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}}
2808 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2809 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2812 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2814 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}}
2816 Returns true if the given data format is available on the clipboard.
2819 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2821 \func{bool}{wxOpenClipboard}{\void}
2823 Opens the clipboard for passing data to it or getting data from it.
2826 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2828 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2830 Registers the clipboard data format name and returns an identifier.
2833 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2835 \func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}}
2837 Passes data to the clipboard.
2839 {\it dataFormat} may be one of:
2841 \begin{itemize}\itemsep=0pt
2842 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2843 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2844 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2845 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2848 The clipboard must have previously been opened for this call to succeed.
2851 \section{Miscellaneous functions and macros}\label{miscellany}
2854 \membersection{wxBase64Decode}\label{wxbase64decode}
2856 \func{size\_t}{wxBase64Decode}{\param{void *}{dst}, \param{size\_t }{dstLen},
2857 \param{const char * }{src}, \param{size\_t }{srcLen = wxNO\_LEN},
2858 \param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},
2859 \param{size\_t }{*posErr = \NULL}}
2861 \func{wxMemoryBuffer}{wxBase64Decode}{\\
2862 \param{const char * }{src}, \param{size\_t }{srcLen = wxNO\_LEN},\\
2863 \param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},\\
2864 \param{size\_t }{*posErr = \NULL}}
2866 \func{wxMemoryBuffer}{wxBase64Decode}{\\
2867 \param{const wxString\& }{src},\\
2868 \param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},\\
2869 \param{size\_t }{*posErr = \NULL}}
2871 These function decode a Base64-encoded string. The first version is a raw
2872 decoding function and decodes the data into the provided buffer \arg{dst} of
2873 the given size \arg{dstLen}. An error is returned if the buffer is not large
2874 enough -- that is not at least \helpref{wxBase64DecodedSize(srcLen)}{wxbase64decodedsize}
2875 bytes. The second version allocates memory internally and returns it as
2876 \helpref{wxMemoryBuffer}{wxmemorybuffer} and is recommended for normal use.
2878 The first version returns the number of bytes written to the buffer or the
2879 necessary buffer size if \arg{dst} was \NULL or \texttt{wxCONV\_FAILED} on
2880 error, e.g. if the output buffer is too small or invalid characters were
2881 encountered in the input string. The second version returns a buffer with the
2882 base64 decoded binary equivalent of the input string. In neither case is the
2883 buffer NUL-terminated.
2885 \wxheading{Parameters}
2887 \docparam{dst}{Pointer to output buffer, may be \NULL to just compute the
2888 necessary buffer size.}
2890 \docparam{dstLen}{The size of the output buffer, ignored if \arg{dst} is
2893 \docparam{src}{The input string, must not be \NULL. For the version using
2894 wxString, the input string should contain only ASCII characters.}
2896 \docparam{srcLen}{The length of the input string or special value
2897 \texttt{wxNO\_LEN} if the string is \NUL-terminated and the length should be
2898 computed by this function itself.}
2900 \docparam{mode}{This parameter specifies the function behaviour when invalid
2901 characters are encountered in input. By default, any such character stops the
2902 decoding with error. If the mode is wxBase64DecodeMode\_SkipWS, then the white
2903 space characters are silently skipped instead. And if it is
2904 wxBase64DecodeMode\_Relaxed, then all invalid characters are skipped.}
2906 \docparam{posErr}{If this pointer is non-\NULL and an error occurs during
2907 decoding, it is filled with the index of the invalid character.}
2909 \wxheading{Include files}
2914 \membersection{wxBase64DecodedSize}\label{wxbase64decodedsize}
2916 \func{size\_t}{wxBase64DecodedSize}{\param{size\_t }{srcLen}}
2918 Returns the size of the buffer necessary to contain the data encoded in a
2919 base64 string of length \arg{srcLen}. This can be useful for allocating a
2920 buffer to be passed to \helpref{wxBase64Decode}{wxbase64decode}.
2923 \membersection{wxBase64Encode}\label{wxbase64encode}
2925 \func{size\_t}{wxBase64Encode}{\param{char *}{dst}, \param{size\_t }{dstLen},
2926 \param{const void *}{src}, \param{size\_t }{srcLen}}
2928 \func{wxString}{wxBase64Encode}{\param{const void *}{src}, \param{size\_t }{srcLen}}
2930 \func{wxString}{wxBase64Encode}{\param{const wxMemoryBuffer\& }{buf}}
2932 These functions encode the given data using base64. The first of them is the
2933 raw encoding function writing the output string into provided buffer while the
2934 other ones return the output as wxString. There is no error return for these
2935 functions except for the first one which returns \texttt{wxCONV\_FAILED} if the
2936 output buffer is too small. To allocate the buffer of the correct size, use
2937 \helpref{wxBase64EncodedSize}{wxbase64encodedsize} or call this function with
2938 \arg{dst} set to \NULL -- it will then return the necessary buffer size.
2940 \wxheading{Parameters}
2942 \docparam{dst}{The output buffer, may be \NULL to retrieve the needed buffer
2945 \docparam{dstLen}{The output buffer size, ignored if \arg{dst} is \NULL.}
2947 \docparam{src}{The input buffer, must not be \NULL.}
2949 \docparam{srcLen}{The length of the input data.}
2951 \wxheading{Include files}
2956 \membersection{wxBase64EncodedSize}\label{wxbase64encodedsize}
2958 \func{size\_t}{wxBase64EncodedSize}{\param{size\_t }{len}}
2960 Returns the length of the string with base64 representation of a buffer of
2961 specified size \arg{len}. This can be useful for allocating the buffer passed
2962 to \helpref{wxBase64Encode}{wxbase64encode}.
2965 \membersection{wxCONCAT}\label{wxconcat}
2967 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2969 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2972 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2974 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2976 When loading a function from a DLL you always have to cast the returned
2977 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2978 repeat this type twice if you want to declare and define a function pointer all
2981 This macro makes this slightly less painful by allowing you to specify the
2982 type only once, as the first parameter, and creating a variable of this type
2983 named after the function but with {\tt pfn} prefix and initialized with the
2984 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2987 \wxheading{Parameters}
2989 \docparam{type}{the type of the function}
2991 \docparam{name}{the name of the function to load, not a string (without quotes,
2992 it is quoted automatically by the macro)}
2994 \docparam{dynlib}{the library to load the function from}
2998 \membersection{wxDEPRECATED}\label{wxdeprecated}
3000 This macro can be used around a function declaration to generate warnings
3001 indicating that this function is deprecated (i.e. obsolete and planned to be
3002 removed in the future) when it is used. Only Visual C++ 7 and higher and g++
3003 compilers currently support this functionality.
3007 // old function, use wxString version instead
3008 wxDEPRECATED( void wxGetSomething(char *buf, size_t len) );
3011 wxString wxGetSomething();
3015 \membersection{wxDEPRECATED\_BUT\_USED\_INTERNALLY}\label{wxdeprecatedbutusedinternally}
3017 This is a special version of \helpref{wxDEPRECATED}{wxdeprecated} macro which
3018 only does something when the deprecated function is used from the code outside
3019 wxWidgets itself but doesn't generate warnings when it is used from wxWidgets.
3020 It is used with the virtual functions which are called by the library itself --
3021 even if such function is deprecated the library still has to call it to ensure
3022 that the existing code overriding it continues to work, but the use of this
3023 macro ensures that a deprecation warning will be generated if this function is
3024 used from the user code or, in case of Visual C++, even when it is simply
3028 \membersection{wxDEPRECATED\_INLINE}\label{wxdeprecatedinline}
3030 \func{}{wxDEPRECATED\_INLINE}{\param{}{func}, \param{}{body}}
3032 This macro is similar to \helpref{wxDEPRECATED}{wxdeprecated} but can be used
3033 to not only declare the function \arg{func} as deprecated but to also provide
3034 its (inline) implementation \arg{body}.
3036 It can be used as following:
3041 // OldMethod() is deprecated, use NewMethod() instead
3043 wxDEPRECATED_INLINE( void OldMethod(), NewMethod() );
3047 \membersection{wxEXPLICIT}\label{wxexplicit}
3049 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
3050 the compiler supports it or nothing otherwise. Thus, it can be used even in the
3051 code which might have to be compiled with an old compiler without support for
3052 this language feature but still take advantage of it when it is available.
3056 \membersection{::wxGetKeyState}\label{wxgetkeystate}
3058 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
3060 For normal keys, returns \true if the specified key is currently down.
3062 For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns
3063 \true if the key is toggled such that its LED indicator is lit. There is
3064 currently no way to test whether togglable keys are up or down.
3066 Even though there are virtual key codes defined for mouse buttons, they
3067 cannot be used with this function currently.
3069 \wxheading{Include files}
3074 \membersection{wxLL}\label{wxll}
3076 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
3078 This macro is defined for the platforms with a native 64 bit integer type and
3079 allows to define 64 bit compile time constants:
3083 wxLongLong_t ll = wxLL(0x1234567890abcdef);
3087 \wxheading{Include files}
3091 \wxheading{See also}
3093 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
3096 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
3098 This macro is defined to contain the {\tt printf()} format specifier using
3099 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
3100 printed. Example of using it:
3104 wxLongLong_t ll = wxLL(0x1234567890abcdef);
3105 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
3109 \wxheading{See also}
3111 \helpref{wxLL}{wxll}
3113 \wxheading{Include files}
3118 \membersection{::wxNewId}\label{wxnewid}
3120 \func{long}{wxNewId}{\void}
3122 This function is deprecated as the ids generated by it can conflict with the
3123 ids defined by the user code, use \texttt{wxID\_ANY} to assign ids which are
3124 guaranteed to not conflict with the user-defined ids for the controls and menu
3125 items you create instead of using this function.
3128 Generates an integer identifier unique to this run of the program.
3130 \wxheading{Include files}
3135 \membersection{wxON\_BLOCK\_EXIT}\label{wxonblockexit}
3137 \func{}{wxON\_BLOCK\_EXIT0}{\param{}{func}}
3139 \func{}{wxON\_BLOCK\_EXIT1}{\param{}{func}, \param{}{p1}}
3141 \func{}{wxON\_BLOCK\_EXIT2}{\param{}{func}, \param{}{p1}, \param{}{p2}}
3143 This family of macros allows to ensure that the global function \arg{func}
3144 with 0, 1, 2 or more parameters (up to some implementaton-defined limit) is
3145 executed on scope exit, whether due to a normal function return or because an
3146 exception has been thrown. A typical example of its usage:
3148 void *buf = malloc(size);
3149 wxON_BLOCK_EXIT1(free, buf);
3152 Please see the original article by Andrei Alexandrescu and Petru Marginean
3153 published in December 2000 issue of \emph{C/C++ Users Journal} for more
3156 \wxheading{Include files}
3160 \wxheading{See also}
3162 \helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}
3165 \membersection{wxON\_BLOCK\_EXIT\_OBJ}\label{wxonblockexitobj}
3167 \func{}{wxON\_BLOCK\_EXIT\_OBJ0}{\param{}{obj}, \param{}{method}}
3169 \func{}{wxON\_BLOCK\_EXIT\_OBJ1}{\param{}{obj}, \param{}{method}, \param{}{p1}}
3171 \func{}{wxON\_BLOCK\_EXIT\_OBJ2}{\param{}{obj}, \param{}{method}, \param{}{p1}, \param{}{p2}}
3173 This family of macros is similar to \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}
3174 but calls a method of the given object instead of a free function.
3176 \wxheading{Include files}
3181 \membersection{::wxRegisterId}\label{wxregisterid}
3183 \func{void}{wxRegisterId}{\param{long}{ id}}
3185 Ensures that ids subsequently generated by {\bf NewId} do not clash with
3188 \wxheading{Include files}
3193 \membersection{::wxDDECleanUp}\label{wxddecleanup}
3195 \func{void}{wxDDECleanUp}{\void}
3197 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
3198 called by the application.
3200 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
3202 \wxheading{Include files}
3207 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
3209 \func{void}{wxDDEInitialize}{\void}
3211 Initializes the DDE system. May be called multiple times without harm.
3213 This no longer needs to be called by the application: it will be called
3214 by wxWidgets if necessary.
3216 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
3217 \helpref{wxDDECleanUp}{wxddecleanup}.
3219 \wxheading{Include files}
3224 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
3226 \func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}
3228 This function enables or disables all top level windows. It is used by
3229 \helpref{::wxSafeYield}{wxsafeyield}.
3231 \wxheading{Include files}
3236 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
3238 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
3240 Find a menu item identifier associated with the given frame's menu bar.
3242 \wxheading{Include files}
3247 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
3249 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
3251 {\bf NB:} This function is obsolete, please use
3252 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
3254 Find a window by its label. Depending on the type of window, the label may be a window title
3255 or panel item label. If {\it parent} is NULL, the search will start from all top-level
3256 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3257 The search is recursive in both cases.
3259 \wxheading{Include files}
3264 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
3266 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
3268 {\bf NB:} This function is obsolete, please use
3269 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
3271 Find a window by its name (as given in a window constructor or {\bf Create} function call).
3272 If {\it parent} is NULL, the search will start from all top-level
3273 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3274 The search is recursive in both cases.
3276 If no such named window is found, {\bf wxFindWindowByLabel} is called.
3278 \wxheading{Include files}
3283 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
3285 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
3287 Find the deepest window at the given mouse position in screen coordinates,
3288 returning the window if found, or NULL if not.
3291 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
3293 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
3295 Find the deepest window at the mouse pointer position, returning the window
3296 and current pointer position in screen coordinates.
3299 \membersection{wxFromString}\label{wxfromstring}
3301 \func{bool}{wxFromString}{\param{const wxString\& }{str},
3302 \param{wxColour* }{col}}
3304 \func{bool}{wxFromString}{\param{const wxString\& }{str},
3305 \param{wxFont* }{col}}
3307 Converts string to the type of the second argument. Returns \true on success.
3308 See also: \helpref{wxToString}{wxtostring}.
3311 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
3313 \func{wxWindow *}{wxGetActiveWindow}{\void}
3315 Gets the currently active window (implemented for MSW and GTK only currently,
3316 always returns \NULL in the other ports).
3318 \wxheading{Include files}
3323 \membersection{::wxGetBatteryState}\label{wxgetbatterystate}
3325 \func{wxBatteryState}{wxGetBatteryState}{\void}
3327 Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
3328 \texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
3329 \texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
3330 \texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
3331 this feature is not implemented (currently everywhere but MS Windows).
3333 \wxheading{Include files}
3338 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
3340 \func{wxString}{wxGetDisplayName}{\void}
3342 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
3344 \wxheading{Include files}
3349 \membersection{::wxGetPowerType}\label{wxgetpowertype}
3351 \func{wxPowerType}{wxGetPowerType}{\void}
3353 Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
3354 \texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
3355 \texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
3356 feature is not implemented (currently everywhere but MS Windows).
3358 \wxheading{Include files}
3363 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
3365 \func{wxPoint}{wxGetMousePosition}{\void}
3367 Returns the mouse position in screen coordinates.
3369 \wxheading{Include files}
3374 \membersection{::wxGetMouseState}\label{wxgetmousestate}
3376 \func{wxMouseState}{wxGetMouseState}{\void}
3378 Returns the current state of the mouse. Returns a wxMouseState
3379 instance that contains the current position of the mouse pointer in
3380 screen coordinates, as well as boolean values indicating the up/down
3381 status of the mouse buttons and the modifier keys.
3383 \wxheading{Include files}
3387 wxMouseState has the following interface:
3408 void SetX(wxCoord x);
3409 void SetY(wxCoord y);
3411 void SetLeftDown(bool down);
3412 void SetMiddleDown(bool down);
3413 void SetRightDown(bool down);
3415 void SetControlDown(bool down);
3416 void SetShiftDown(bool down);
3417 void SetAltDown(bool down);
3418 void SetMetaDown(bool down);
3424 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
3426 \func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}}
3428 Returns label that should be used for given {\it id} element.
3430 \wxheading{Parameters}
3432 \docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.}
3434 \docparam{withCodes}{if false then strip accelerator code from the label;
3435 useful for getting labels without accelerator char code like for toolbar tooltip or
3436 on platforms without traditional keyboard like smartphones}
3438 \docparam{accelerator}{optional accelerator string automatically added to label; useful
3439 for building labels for \helpref{wxMenuItem}{wxmenuitem}}
3441 \wxheading{Include files}
3446 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
3448 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
3450 Returns the first top level parent of the given window, or in other words, the
3451 frame or dialog containing it, or {\tt NULL}.
3453 \wxheading{Include files}
3458 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
3460 \func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}}
3462 Open the \arg{url} in user's default browser. If \arg{flags} parameter contains
3463 \texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL
3464 (currently this is only supported under Windows). The \arg{url} may also be a
3465 local file path (with or without \texttt{file://} prefix), if it doesn't
3466 correspond to an existing file and the URL has no scheme \texttt{http://} is
3467 prepended to it by default.
3469 Returns \true if the application was successfully launched.
3471 Note that for some configurations of the running user, the application which
3472 is launched to open the given URL may be URL-dependent (e.g. a browser may be used for
3473 local URLs while another one may be used for remote URLs).
3475 \wxheading{Include files}
3480 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
3482 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
3484 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
3485 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
3487 The resource must be defined in the {\tt .rc} file using the following syntax:
3490 myResource TEXT file.ext
3493 where {\tt file.ext} is a file that the resource compiler can find.
3495 This function is available under Windows only.
3497 \wxheading{Include files}
3502 \membersection{::wxPostDelete}\label{wxpostdelete}
3504 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
3506 Tells the system to delete the specified object when
3507 all other events have been processed. In some environments, it is
3508 necessary to use this instead of deleting a frame directly with the
3509 delete operator, because some GUIs will still send events to a deleted window.
3511 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
3513 \wxheading{Include files}
3518 \membersection{::wxPostEvent}\label{wxpostevent}
3520 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
3522 In a GUI application, this function posts {\it event} to the specified {\it dest}
3523 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
3524 Otherwise, it dispatches {\it event} immediately using
3525 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
3526 See the respective documentation for details (and caveats).
3528 \wxheading{Include files}
3533 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
3535 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
3537 Under X only, sets the current display name. This is the X host and display name such
3538 as ``colonsay:0.0", and the function indicates which display should be used for creating
3539 windows from this point on. Setting the display within an application allows multiple
3540 displays to be used.
3542 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
3544 \wxheading{Include files}
3549 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
3551 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{str}, \param{int }{flags = wxStrip\_All}}
3553 Strips any menu codes from \arg{str} and returns the result.
3555 By default, the functions strips both the mnemonics character (\texttt{'\&'})
3556 which is used to indicate a keyboard shortkey, and the accelerators, which are
3557 used only in the menu items and are separated from the main text by the
3558 \texttt{$\backslash$t} (TAB) character. By using \arg{flags} of
3559 \texttt{wxStrip\_Mnemonics} or \texttt{wxStrip\_Accel} to strip only the former
3560 or the latter part, respectively.
3562 Notice that in most cases
3563 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} or
3564 \helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} can be used instead.
3566 \wxheading{Include files}
3571 \membersection{wxSTRINGIZE}\label{wxstringize}
3573 \func{}{wxSTRINGIZE}{\param{}{x}}
3575 Returns the string representation of the given symbol which can be either a
3576 literal or a macro (hence the advantage of using this macro instead of the
3577 standard preprocessor \texttt{\#} operator which doesn't work with macros).
3579 Notice that this macro always produces a \texttt{char} string, use
3580 \helpref{wxSTRINGIZE\_T}{wxstringizet} to build a wide string Unicode build.
3582 \wxheading{See also}
3584 \helpref{wxCONCAT}{wxconcat}
3587 \membersection{wxSTRINGIZE\_T}\label{wxstringizet}
3589 \func{}{wxSTRINGIZE\_T}{\param{}{x}}
3591 Returns the string representation of the given symbol as either an ASCII or
3592 Unicode string, depending on the current build. This is the Unicode-friendly
3593 equivalent of \helpref{wxSTRINGIZE}{wxstringize}.
3596 \membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning}
3598 \func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}}
3600 GNU C++ compiler gives a warning for any class whose destructor is private
3601 unless it has a friend. This warning may sometimes be useful but it doesn't
3602 make sense for reference counted class which always delete themselves (hence
3603 destructor should be private) but don't necessarily have any friends, so this
3604 macro is provided to disable the warning in such case. The \arg{name} parameter
3605 should be the name of the class but is only used to construct a unique friend
3606 class name internally. Example of using the macro:
3612 RefCounted() { m_nRef = 1; }
3613 void IncRef() { m_nRef++ ; }
3614 void DecRef() { if ( !--m_nRef ) delete this; }
3619 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
3623 Notice that there should be no semicolon after this macro.
3626 \membersection{wxToString}\label{wxtostring}
3628 \func{wxString}{wxToString}{\param{const wxColour\& }{col}}
3630 \func{wxString}{wxToString}{\param{const wxFont\& }{col}}
3632 Converts its argument to string.
3633 See also: \helpref{wxFromString}{wxfromstring}.
3636 \membersection{wxULL}\label{wxull}
3638 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
3640 This macro is defined for the platforms with a native 64 bit integer type and
3641 allows to define unsigned 64 bit compile time constants:
3645 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
3649 \wxheading{Include files}
3653 \wxheading{See also}
3655 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
3658 \membersection{wxVaCopy}\label{wxvacopy}
3660 \func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}}
3662 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
3663 which support it or its replacement for those that don't. It must be used to
3664 preserve the value of a \texttt{va\_list} object if you need to use it after
3665 passing it to another function because it can be modified by the latter.
3667 As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
3672 \membersection{\_\_WXFUNCTION\_\_}\label{wxfunction}
3674 \func{}{\_\_WXFUNCTION\_\_}{\void}
3676 This macro expands to the name of the current function if the compiler supports
3677 any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables
3678 or macros or to \NULL if none of them is available.
3682 \section{Byte order macros}\label{byteordermacros}
3684 The endian-ness issues (that is the difference between big-endian and
3685 little-endian architectures) are important for the portable programs working
3686 with the external binary data (for example, data files or data coming from
3687 network) which is usually in some fixed, platform-independent format. The
3688 macros are helpful for transforming the data to the correct format.
3691 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3693 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3695 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3697 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3699 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3701 These macros will swap the bytes of the {\it value} variable from little
3702 endian to big endian or vice versa unconditionally, i.e. independently of the
3706 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3708 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3710 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3712 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3714 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3716 This macro will swap the bytes of the {\it value} variable from little
3717 endian to big endian or vice versa if the program is compiled on a
3718 big-endian architecture (such as Sun work stations). If the program has
3719 been compiled on a little-endian architecture, the value will be unchanged.
3721 Use these macros to read data from and write data to a file that stores
3722 data in little-endian (for example Intel i386) format.
3725 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3727 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3729 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3731 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3733 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3735 This macro will swap the bytes of the {\it value} variable from little
3736 endian to big endian or vice versa if the program is compiled on a
3737 little-endian architecture (such as Intel PCs). If the program has
3738 been compiled on a big-endian architecture, the value will be unchanged.
3740 Use these macros to read data from and write data to a file that stores
3741 data in big-endian format.
3744 \membersection{wxFORCE\_LINK\_THIS\_MODULE}\label{wxforcelinkthismodule}
3746 \func{}{wxFORCE\_LINK\_THIS\_MODULE}{moduleName}
3748 This macro can be used in conjunction with the
3749 \helpref{wxFORCE\_LINK\_MODULE}{wxforcelinkmodule} macro to force
3750 the linker to include in its output a specific object file.
3752 In particular, you should use this macro in the source file which you want
3753 to force for inclusion. The \tt{moduleName} needs to be a name not already
3754 in use in other \tt{wxFORCE\_LINK\_THIS\_MODULE} macros, but is not required
3755 to be e.g. the same name of the source file (even if it's a good choice).
3757 \wxheading{Include files}
3762 \membersection{wxFORCE\_LINK\_MODULE}\label{wxforcelinkmodule}
3764 \func{}{wxFORCE\_LINK\_MODULE}{moduleName}
3766 This macro can be used in conjunction with the
3767 \helpref{wxFORCE\_LINK\_THIS\_MODULE}{wxforcelinkthismodule} macro to force
3768 the linker to include in its output a specific object file.
3770 In particular, you should use this macro in a source file which you know
3771 for sure is linked in the output (e.g. the source file containing the "main()"
3772 of your app). The \tt{moduleName} is the name of the module you want to forcefully link
3773 (i.e. the name you used in the relative \helpref{wxFORCE\_LINK\_THIS\_MODULE}{wxforcelinkthismodule} macro.
3775 \wxheading{Include files}
3780 \membersection{wxIMPLEMENT\_APP}\label{wximplementapp}
3782 \func{}{wxIMPLEMENT\_APP}{className}
3784 This is used in the application class implementation file to make the application class
3785 known to wxWidgets for dynamic construction. You use this as:
3788 wxIMPLEMENT_APP(MyApp)
3791 See also \helpref{wxDECLARE\_APP}{wxdeclareapp}.
3793 \wxheading{Include files}
3798 \section{RTTI functions}\label{rttimacros}
3800 wxWidgets uses its own RTTI ("run-time type identification") system which
3801 predates the current standard C++ RTTI and so is kept for backwards
3802 compatibility reasons but also because it allows some things which the
3803 standard RTTI doesn't directly support (such as creating a class from its
3806 The standard C++ RTTI can be used in the user code without any problems and in
3807 general you shouldn't need to use the functions and the macros in this section
3808 unless you are thinking of modifying or adding any wxWidgets classes.
3810 \wxheading{See also}
3812 \helpref{RTTI overview}{runtimeclassoverview}
3815 \membersection{CLASSINFO}\label{classinfo}
3817 \func{wxClassInfo *}{CLASSINFO}{className}
3819 Returns a pointer to the wxClassInfo object associated with this class.
3821 \wxheading{Include files}
3826 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3828 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3830 Used inside a class declaration to declare that the class should be
3831 made known to the class hierarchy, but objects of this class cannot be created
3832 dynamically. The same as DECLARE\_CLASS.
3837 class wxCommand: public wxObject
3839 DECLARE_ABSTRACT_CLASS(wxCommand)
3848 \wxheading{Include files}
3853 \membersection{DECLARE\_APP}\label{declareapp}
3855 \func{}{DECLARE\_APP}{className}
3857 This is used in headers to create a forward declaration of the
3858 \helpref{wxGetApp}{wxgetapp} function implemented by
3859 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3860 {\tt className\& wxGetApp(void)}.
3868 \wxheading{Include files}
3873 \membersection{DECLARE\_CLASS}\label{declareclass}
3875 \func{}{DECLARE\_CLASS}{className}
3877 Used inside a class declaration to declare that the class should be
3878 made known to the class hierarchy, but objects of this class cannot be created
3879 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3881 \wxheading{Include files}
3886 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3888 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3890 Used inside a class declaration to make the class known to wxWidgets RTTI
3891 system and also declare that the objects of this class should be dynamically
3892 creatable from run-time type information. Notice that this implies that the
3893 class should have a default constructor, if this is not the case consider using
3894 \helpref{DECLARE\_CLASS}{declareclass}.
3899 class wxFrame: public wxWindow
3901 DECLARE_DYNAMIC_CLASS(wxFrame)
3904 const wxString& frameTitle;
3910 \wxheading{Include files}
3915 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3917 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3919 Used in a C++ implementation file to complete the declaration of
3920 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3925 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3927 wxCommand::wxCommand(void)
3933 \wxheading{Include files}
3938 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3940 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3942 Used in a C++ implementation file to complete the declaration of
3943 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3945 \wxheading{Include files}
3950 \membersection{IMPLEMENT\_APP}\label{implementapp}
3952 \func{}{IMPLEMENT\_APP}{className}
3954 This is used in the application class implementation file to make the application class known to
3955 wxWidgets for dynamic construction. You use this instead of
3966 IMPLEMENT_APP(MyApp)
3969 See also \helpref{DECLARE\_APP}{declareapp}.
3971 \wxheading{Include files}
3976 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3978 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3980 Used in a C++ implementation file to complete the declaration of
3981 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3983 \wxheading{Include files}
3988 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3990 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3992 Used in a C++ implementation file to complete the declaration of a
3993 class that has run-time type information and two base classes. The
3994 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3996 \wxheading{Include files}
4001 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
4003 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
4005 Used in a C++ implementation file to complete the declaration of
4006 a class that has run-time type information, and whose instances
4007 can be created dynamically.
4012 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
4014 wxFrame::wxFrame(void)
4020 \wxheading{Include files}
4025 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
4027 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
4029 Used in a C++ implementation file to complete the declaration of
4030 a class that has run-time type information, and whose instances
4031 can be created dynamically. Use this for classes derived from two
4034 \wxheading{Include files}
4039 \membersection{wxConstCast}\label{wxconstcast}
4041 \func{classname *}{wxConstCast}{ptr, classname}
4043 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
4044 supports {\it const\_cast} or into an old, C-style cast, otherwise.
4046 \wxheading{See also}
4048 \helpref{wx\_const\_cast}{wxconstcastraw}\\
4049 \helpref{wxDynamicCast}{wxdynamiccast}\\
4050 \helpref{wxStaticCast}{wxstaticcast}
4053 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
4055 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
4057 Creates and returns an object of the given class, if the class has been
4058 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
4061 \membersection{WXDEBUG\_NEW}\label{debugnew}
4063 \func{}{WXDEBUG\_NEW}{arg}
4065 This is defined in debug mode to be call the redefined new operator
4066 with filename and line number arguments. The definition is:
4069 #define WXDEBUG_NEW new(__FILE__,__LINE__)
4072 In non-debug mode, this is defined as the normal new operator.
4074 \wxheading{Include files}
4079 \membersection{wxDynamicCast}\label{wxdynamiccast}
4081 \func{classname *}{wxDynamicCast}{ptr, classname}
4083 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
4084 the pointer is of this type (the check is done during the run-time) or
4085 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
4086 wxObject::IsKindOf() function.
4088 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
4094 wxWindow *win = wxWindow::FindFocus();
4095 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
4098 // a text control has the focus...
4102 // no window has the focus or it is not a text control
4106 \wxheading{See also}
4108 \helpref{RTTI overview}{runtimeclassoverview}\\
4109 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
4110 \helpref{wxConstCast}{wxconstcast}\\
4111 \helpref{wxStaticCast}{wxstaticcast}
4114 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
4116 \func{classname *}{wxDynamicCastThis}{classname}
4118 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
4119 latter provokes spurious compilation warnings from some compilers (because it
4120 tests whether {\tt this} pointer is non-{\tt NULL} which is always true), so
4121 this macro should be used to avoid them.
4123 \wxheading{See also}
4125 \helpref{wxDynamicCast}{wxdynamiccast}
4128 \membersection{wxStaticCast}\label{wxstaticcast}
4130 \func{classname *}{wxStaticCast}{ptr, classname}
4132 This macro checks that the cast is valid in debug mode (an assert failure will
4133 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
4134 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
4136 \wxheading{See also}
4138 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
4139 \helpref{wxDynamicCast}{wxdynamiccast}\\
4140 \helpref{wxConstCast}{wxconstcast}
4143 \membersection{wx\_const\_cast}\label{wxconstcastraw}
4145 \func{T}{wx\_const\_cast}{T, x}
4147 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
4148 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
4149 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
4150 arguments is the same as for the standard cast.
4152 \wxheading{See also}
4154 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
4155 \helpref{wx\_static\_cast}{wxstaticcastraw}
4158 \membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
4160 \func{T}{wx\_reinterpret\_cast}{T, x}
4162 Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
4163 \texttt{(T)x} for old compilers.
4165 \wxheading{See also}
4167 \helpref{wx\_const\_cast}{wxconstcastraw},\\
4168 \helpref{wx\_static\_cast}{wxstaticcastraw}
4171 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
4173 \func{T}{wx\_static\_cast}{T, x}
4175 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
4176 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
4177 there are no checks being done and the meaning of the macro arguments is exactly
4178 the same as for the standard static cast, i.e. \arg{T} is the full type name and
4179 star is not appended to it.
4181 \wxheading{See also}
4183 \helpref{wx\_const\_cast}{wxconstcastraw},\\
4184 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
4185 \helpref{wx\_truncate\_cast}{wxtruncatecast}
4188 \membersection{wx\_truncate\_cast}\label{wxtruncatecast}
4190 \func{T}{wx\_truncate\_cast}{T, x}
4192 This case doesn't correspond to any standard cast but exists solely to make
4193 casts which possibly result in a truncation of an integer value more readable.
4195 \wxheading{See also}
4197 \helpref{wx\_static\_cast}{wxstaticcastraw}
4200 \section{Log functions}\label{logfunctions}
4202 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
4203 further information. The functions use (implicitly) the currently active log
4204 target, so their descriptions here may not apply if the log target is not the
4205 standard one (installed by wxWidgets in the beginning of the program).
4207 \wxheading{Include files}
4212 \membersection{::wxDebugMsg}\label{wxdebugmsg}
4214 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
4216 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
4217 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
4219 Display a debugging message; under Windows, this will appear on the
4220 debugger command window, and under Unix, it will be written to standard
4223 The syntax is identical to {\bf printf}: pass a format string and a
4224 variable list of arguments.
4226 {\bf Tip:} under Windows, if your application crashes before the
4227 message appears in the debugging window, put a wxYield call after
4228 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
4229 (at least for Watcom C++): preformat your messages and use OutputDebugString
4232 \wxheading{Include files}
4237 \membersection{::wxError}\label{wxerror}
4239 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
4241 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
4244 Displays {\it msg} and continues. This writes to standard error under
4245 Unix, and pops up a message box under Windows. Used for internal
4246 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
4248 \wxheading{Include files}
4253 \membersection{::wxFatalError}\label{wxfatalerror}
4255 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
4257 {\bf NB:} This function is now obsolete, please use
4258 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
4260 Displays {\it msg} and exits. This writes to standard error under Unix,
4261 and pops up a message box under Windows. Used for fatal internal
4262 wxWidgets errors. See also \helpref{wxError}{wxerror}.
4264 \wxheading{Include files}
4269 \membersection{::wxLogError}\label{wxlogerror}
4271 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
4273 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4275 The functions to use for error messages, i.e. the messages that must be shown
4276 to the user. The default processing is to pop up a message box to inform the
4280 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
4282 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
4284 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4286 Like \helpref{wxLogError}{wxlogerror}, but also
4287 terminates the program with the exit code 3. Using {\it abort()} standard
4288 function also terminates the program with this exit code.
4291 \membersection{::wxLogWarning}\label{wxlogwarning}
4293 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
4295 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4297 For warnings - they are also normally shown to the user, but don't interrupt
4301 \membersection{::wxLogMessage}\label{wxlogmessage}
4303 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
4305 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4307 For all normal, informational messages. They also appear in a message box by
4308 default (but it can be changed).
4310 \membersection{::wxLogVerbose}\label{wxlogverbose}
4312 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
4314 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4316 For verbose output. Normally, it is suppressed, but
4317 might be activated if the user wishes to know more details about the program
4318 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
4321 \membersection{::wxLogStatus}\label{wxlogstatus}
4323 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
4325 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4327 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
4329 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4331 Messages logged by these functions will appear in the statusbar of the {\it
4332 frame} or of the top level application window by default (i.e. when using
4333 the second version of the functions).
4335 If the target frame doesn't have a statusbar, the message will be lost.
4338 \membersection{::wxLogSysError}\label{wxlogsyserror}
4340 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
4342 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4344 Mostly used by wxWidgets itself, but might be handy for logging errors after
4345 system call (API function) failure. It logs the specified message text as well
4346 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
4347 on the platform) and the corresponding error message. The second form
4348 of this function takes the error code explicitly as the first argument.
4350 \wxheading{See also}
4352 \helpref{wxSysErrorCode}{wxsyserrorcode},
4353 \helpref{wxSysErrorMsg}{wxsyserrormsg}
4356 \membersection{::wxLogDebug}\label{wxlogdebug}
4358 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
4360 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4362 The right functions for debug output. They only do something in debug
4363 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
4364 nothing in release mode (otherwise).
4367 \membersection{::wxLogTrace}\label{wxlogtrace}
4369 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
4371 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4373 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
4375 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4377 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
4379 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4381 As {\bf wxLogDebug}, trace functions only do something in debug build and
4382 expand to nothing in the release one. The reason for making
4383 it a separate function from it is that usually there are a lot of trace
4384 messages, so it might make sense to separate them from other debug messages.
4386 The trace messages also usually can be separated into different categories and
4387 the second and third versions of this function only log the message if the
4388 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
4389 allows to selectively trace only some operations and not others by changing
4390 the value of the trace mask (possible during the run-time).
4392 For the second function (taking a string mask), the message is logged only if
4393 the mask has been previously enabled by the call to
4394 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
4395 \helpref{{\tt WXTRACE} environment variable}{envvars}.
4396 The predefined string trace masks
4397 used by wxWidgets are:
4399 \begin{itemize}\itemsep=0pt
4400 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
4401 \item wxTRACE\_Messages: trace window messages/X callbacks
4402 \item wxTRACE\_ResAlloc: trace GDI resource allocation
4403 \item wxTRACE\_RefCount: trace various ref counting operations
4404 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
4407 {\bf Caveats:} since both the mask and the format string are strings,
4408 this might lead to function signature confusion in some cases:
4409 if you intend to call the format string only version of wxLogTrace,
4410 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.
4411 In this case you'll unfortunately have to avoid having two leading
4412 string parameters, e.g. by adding a bogus integer (with its \%d format string).
4414 The third version of the function only logs the message if all the bits
4415 corresponding to the {\it mask} are set in the wxLog trace mask which can be
4416 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
4417 flexible than the previous one because it doesn't allow defining the user
4418 trace masks easily - this is why it is deprecated in favour of using string
4421 \begin{itemize}\itemsep=0pt
4422 \item wxTraceMemAlloc: trace memory allocation (new/delete)
4423 \item wxTraceMessages: trace window messages/X callbacks
4424 \item wxTraceResAlloc: trace GDI resource allocation
4425 \item wxTraceRefCount: trace various ref counting operations
4426 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
4430 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
4432 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
4434 This function shows a message to the user in a safe way and should be safe to
4435 call even before the application has been initialized or if it is currently in
4436 some other strange state (for example, about to crash). Under Windows this
4437 function shows a message box using a native dialog instead of
4438 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
4439 it simply prints the message to the standard output using the title as prefix.
4441 \wxheading{Parameters}
4443 \docparam{title}{The title of the message box shown to the user or the prefix
4444 of the message string}
4446 \docparam{text}{The text to show to the user}
4448 \wxheading{See also}
4450 \helpref{wxLogFatalError}{wxlogfatalerror}
4452 \wxheading{Include files}
4457 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
4459 \func{unsigned long}{wxSysErrorCode}{\void}
4461 Returns the error code from the last system call. This function uses
4462 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
4464 \wxheading{See also}
4466 \helpref{wxSysErrorMsg}{wxsyserrormsg},
4467 \helpref{wxLogSysError}{wxlogsyserror}
4470 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
4472 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
4474 Returns the error message corresponding to the given system error code. If
4475 {\it errCode} is $0$ (default), the last error code (as returned by
4476 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
4478 \wxheading{See also}
4480 \helpref{wxSysErrorCode}{wxsyserrorcode},
4481 \helpref{wxLogSysError}{wxlogsyserror}
4484 \membersection{WXTRACE}\label{trace}
4486 \wxheading{Include files}
4490 \func{}{WXTRACE}{formatString, ...}
4492 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4494 Calls wxTrace with printf-style variable argument syntax. Output
4495 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4497 \wxheading{Include files}
4502 \membersection{WXTRACELEVEL}\label{tracelevel}
4504 \func{}{WXTRACELEVEL}{level, formatString, ...}
4506 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4508 Calls wxTraceLevel with printf-style variable argument syntax. Output
4509 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4510 The first argument should be the level at which this information is appropriate.
4511 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4514 \wxheading{Include files}
4519 \membersection{::wxTrace}\label{wxtrace}
4521 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
4523 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4525 Takes printf-style variable argument syntax. Output
4526 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4528 \wxheading{Include files}
4533 \membersection{::wxTraceLevel}\label{wxtracelevel}
4535 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
4537 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4539 Takes printf-style variable argument syntax. Output
4540 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4541 The first argument should be the level at which this information is appropriate.
4542 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4545 \wxheading{Include files}
4551 \section{Time functions}\label{timefunctions}
4553 The functions in this section deal with getting the current time and sleeping
4554 for the specified time interval.
4557 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
4559 \func{long}{wxGetLocalTime}{\void}
4561 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
4563 \wxheading{See also}
4565 \helpref{wxDateTime::Now}{wxdatetimenow}
4567 \wxheading{Include files}
4572 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
4574 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
4576 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
4578 \wxheading{See also}
4580 \helpref{wxDateTime::Now}{wxdatetimenow},\\
4581 \helpref{wxLongLong}{wxlonglong}
4583 \wxheading{Include files}
4588 \membersection{::wxGetUTCTime}\label{wxgetutctime}
4590 \func{long}{wxGetUTCTime}{\void}
4592 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
4594 \wxheading{See also}
4596 \helpref{wxDateTime::Now}{wxdatetimenow}
4598 \wxheading{Include files}
4603 \membersection{::wxMicroSleep}\label{wxmicrosleep}
4605 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
4607 Sleeps for the specified number of microseconds. The microsecond resolution may
4608 not, in fact, be available on all platforms (currently only Unix platforms with
4609 nanosleep(2) may provide it) in which case this is the same as
4610 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
4612 \wxheading{Include files}
4617 \membersection{::wxMilliSleep}\label{wxmillisleep}
4619 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
4621 Sleeps for the specified number of milliseconds. Notice that usage of this
4622 function is encouraged instead of calling usleep(3) directly because the
4623 standard usleep() function is not MT safe.
4625 \wxheading{Include files}
4630 \membersection{::wxNow}\label{wxnow}
4632 \func{wxString}{wxNow}{\void}
4634 Returns a string representing the current date and time.
4636 \wxheading{Include files}
4641 \membersection{::wxSleep}\label{wxsleep}
4643 \func{void}{wxSleep}{\param{int}{ secs}}
4645 Sleeps for the specified number of seconds.
4647 \wxheading{Include files}
4652 \membersection{::wxUsleep}\label{wxusleep}
4654 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
4656 This function is deprecated because its name is misleading: notice that the
4657 argument is in milliseconds, not microseconds. Please use either
4658 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
4659 depending on the resolution you need.
4663 \section{Debugging macros and functions}\label{debugmacros}
4665 Useful macros and functions for error checking and defensive programming.
4666 wxWidgets defines three families of the assert-like macros:
4667 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
4668 (in other words, in the debug build) but disappear completely in the release
4669 build. On the other hand, the wxCHECK macros stay event in release builds but a
4670 check failure doesn't generate any user-visible effects then. Finally, the
4671 compile time assertions don't happen during the run-time but result in the
4672 compilation error messages if the condition they check fail.
4674 \wxheading{Include files}
4679 \membersection{::wxOnAssert}\label{wxonassert}
4681 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
4683 This function is called whenever one of debugging macros fails (i.e. condition
4684 is false in an assertion). It is only defined in the debug mode, in release
4685 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
4687 To override the default behaviour in the debug builds which is to show the user
4688 a dialog asking whether he wants to abort the program, continue or continue
4689 ignoring any subsequent assert failures, you may override
4690 \helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if
4691 the global application object exists.
4694 \membersection{wxASSERT}\label{wxassert}
4696 \func{}{wxASSERT}{\param{}{condition}}
4698 Assert macro. An error message will be generated if the condition is false in
4699 debug mode, but nothing will be done in the release build.
4701 Please note that the condition in wxASSERT() should have no side effects
4702 because it will not be executed in release mode at all.
4704 \wxheading{See also}
4706 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4707 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4710 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
4712 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
4714 This macro results in a
4715 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
4716 of the given type {\it type} is less than {\it size} bits.
4718 You may use it like this, for example:
4721 // we rely on the int being able to hold values up to 2^32
4722 wxASSERT_MIN_BITSIZE(int, 32);
4724 // can't work with the platforms using UTF-8 for wchar_t
4725 wxASSERT_MIN_BITSIZE(wchar_t, 16);
4729 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
4731 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
4733 Assert macro with message. An error message will be generated if the condition is false.
4735 \wxheading{See also}
4737 \helpref{wxASSERT}{wxassert},\\
4738 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4741 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4743 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4745 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4746 specified {\it condition} is false. The compiler error message should include
4747 the {\it msg} identifier - please note that it must be a valid C++ identifier
4748 and not a string unlike in the other cases.
4750 This macro is mostly useful for testing the expressions involving the
4751 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4752 sometimes desirable to test them at the compile time.
4754 Note that this macro internally declares a struct whose name it tries to make
4755 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4756 use it on the same line in two different source files. In this case you may
4757 either change the line in which either of them appears on or use the
4758 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4760 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4761 if you use this macro with `Program Database For Edit And Continue'
4762 (\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
4763 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4765 \wxheading{See also}
4767 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4768 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4771 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4773 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4775 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4776 except that it allows you to specify a unique {\it name} for the struct
4777 internally defined by this macro to avoid getting the compilation errors
4778 described \helpref{above}{wxcompiletimeassert}.
4781 \membersection{wxFAIL}\label{wxfail}
4783 \func{}{wxFAIL}{\void}
4785 Will always generate an assert error if this code is reached (in debug mode).
4787 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4790 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4792 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4794 Will always generate an assert error with specified message if this code is reached (in debug mode).
4796 This macro is useful for marking unreachable" code areas, for example
4797 it may be used in the "default:" branch of a switch statement if all possible
4798 cases are processed above.
4800 \wxheading{See also}
4802 \helpref{wxFAIL}{wxfail}
4805 \membersection{wxCHECK}\label{wxcheck}
4807 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4809 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4810 This check is done even in release mode.
4813 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4815 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4817 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4818 This check is done even in release mode.
4820 This macro may be only used in non-void functions, see also
4821 \helpref{wxCHECK\_RET}{wxcheckret}.
4824 \membersection{wxCHECK\_RET}\label{wxcheckret}
4826 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4828 Checks that the condition is true, and returns if not (FAILs with given error
4829 message in debug mode). This check is done even in release mode.
4831 This macro should be used in void functions instead of
4832 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4835 \membersection{wxCHECK2}\label{wxcheck2}
4837 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4839 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4840 {\it operation} if it is not. This is a generalisation of
4841 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4842 returning from the function must be done when the {\it condition} is false.
4844 This check is done even in release mode.
4847 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4849 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4851 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4852 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4853 instead of wxFAIL() if the {\it condition} is false.
4856 \membersection{::wxTrap}\label{wxtrap}
4858 \func{void}{wxTrap}{\void}
4860 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4861 debugger exception meaning that the control is passed to the debugger if one is
4862 attached to the process. Otherwise the program just terminates abnormally.
4864 In release mode this function does nothing.
4866 \wxheading{Include files}
4872 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4874 \func{bool}{wxIsDebuggerRunning}{\void}
4876 Returns \true if the program is running under debugger, \false otherwise.
4878 Please note that this function is currently only implemented for Win32 and Mac
4879 builds using CodeWarrior and always returns \false elsewhere.
4884 \section{Environment access functions}\label{environfunctions}
4886 The functions in this section allow to access (get) or change value of
4887 environment variables in a portable way. They are currently implemented under
4888 Win32 and POSIX-like systems (Unix).
4890 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4892 \wxheading{Include files}
4897 \membersection{wxGetenv}\label{wxgetenvmacro}
4899 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4901 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4904 Note that under Win32 it may not return correct value for the variables set
4905 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4909 \membersection{wxGetEnv}\label{wxgetenv}
4911 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4913 Returns the current value of the environment variable {\it var} in {\it value}.
4914 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4915 and are not interested in its value.
4917 Returns \true if the variable exists, \false otherwise.
4920 \membersection{wxSetEnv}\label{wxsetenv}
4922 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxString\& }{value}}
4924 Sets the value of the environment variable {\it var} (adding it if necessary)
4927 Returns \true on success.
4929 \wxheading{See also}
4931 \helpref{wxUnsetEnv}{wxunsetenv}
4934 \membersection{wxUnsetEnv}\label{wxunsetenv}
4936 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4938 Removes the variable {\it var} from the environment.
4939 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4942 Returns \true on success.
4944 \wxheading{See also}
4946 \helpref{wxSetEnv}{wxsetenv}
4949 \section{Atomic operations}\label{atomicoperations}
4951 When using multi-threaded applications, it is often required to access or
4952 modify memory which is shared between threads. Atomic integer and pointer
4953 operations are an efficient way to handle this issue (another, less efficient,
4954 way is to use a \helpref{mutex}{wxmutex} or \helpref{critical
4955 section}{wxcriticalsection}). A native implementation exists for Windows,
4956 Linux, Solaris and Mac OS X, for other OS, a
4957 \helpref{wxCriticalSection}{wxcriticalsection} is used to protect the data.
4959 One particular application is reference counting (used by so-called smart
4962 You should define your variable with the type wxAtomicInt in order to apply
4963 atomic operations to it.
4965 \wxheading{Include files}
4969 \membersection{::wxAtomicInc}\label{wxatomicinc}
4971 \func{void}{wxAtomicInc}{\param{wxAtomicInt\& }{value}}
4973 This function increments \arg{value} in an atomic manner.
4976 \membersection{::wxAtomicDec}\label{wxatomicdec}
4978 \func{wxInt32}{wxAtomicDec}{\param{wxAtomicInt\& }{value}}
4980 This function decrements \arg{value} in an atomic manner.
4982 Returns 0 if \arg{value} is 0 after decrementation or any non-zero value (not
4983 necessarily equal to the value of the variable) otherwise.