1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: Functions and macros
4 %% Author: wxWidgets Team
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \chapter{Functions
}\label{functions
}
13 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
14 \setfooter{\thepage}{}{}{}{}{\thepage}
16 The functions and macros defined in wxWidgets are described here: you can
17 either look up a function using the alphabetical listing of them or find it in
18 the corresponding topic.
20 \section{Alphabetical functions and macros list
}\label{functionsalphabetically
}
22 \helpref{CLASSINFO
}{classinfo
}\\
23 \helpref{copystring
}{copystring
}\\
24 \helpref{DECLARE
\_ABSTRACT\_CLASS}{declareabstractclass
}\\
25 \helpref{DECLARE
\_APP}{declareapp
}\\
26 \helpref{DECLARE
\_CLASS}{declareclass
}\\
27 \helpref{DECLARE
\_DYNAMIC\_CLASS}{declaredynamicclass
}\\
28 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS2}{implementabstractclass2
}\\
29 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS}{implementabstractclass
}\\
30 \helpref{IMPLEMENT
\_APP}{implementapp
}\\
31 \helpref{IMPLEMENT
\_CLASS2}{implementclass2
}\\
32 \helpref{IMPLEMENT
\_CLASS}{implementclass
}\\
33 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS2}{implementdynamicclass2
}\\
34 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS}{implementdynamicclass
}\\
35 \helpref{wxAboutBox
}{wxaboutbox
}\\
36 \helpref{wxASSERT
}{wxassert
}\\
37 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
38 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
39 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
40 \helpref{wxBell
}{wxbell
}\\
41 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
42 \helpref{wxCHANGE
\_UMASK}{wxchangeumask
}\\
43 \helpref{wxCHECK
}{wxcheck
}\\
44 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
45 \helpref{wxCHECK2
}{wxcheck2
}\\
46 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
47 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
48 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
49 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
50 \helpref{wxCHECK
\_VERSION\_FULL}{wxcheckversionfull
}\\
51 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
52 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
53 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
54 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
55 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
56 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
57 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
58 \helpref{wxCONCAT
}{wxconcat
}\\
59 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
60 \helpref{wxConstCast
}{wxconstcast
}\\
61 \helpref{wxCopyFile
}{wxcopyfile
}\\
62 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
63 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
64 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}\\
65 \helpref{wxCRIT
\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember
}\\
66 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}\\
67 \helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
}\\
% wxcs already taken!
68 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
69 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
70 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
71 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
72 \helpref{WXDEBUG
\_NEW}{debugnew
}\\
73 \helpref{wxDirExists
}{functionwxdirexists
}\\
74 \helpref{wxDirSelector
}{wxdirselector
}\\
75 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
76 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
77 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
78 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
79 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
80 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
81 \helpref{wxDYNLIB
\_FUNCTION}{wxdynlibfunction
}\\
82 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
83 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
84 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
85 \helpref{wxENTER
\_CRIT\_SECT}{wxentercritsect
}\\
86 \helpref{wxEntry
}{wxentry
}\\
87 \helpref{wxEntryStart
}{wxentrystart
}\\
88 \helpref{wxEntryCleanup
}{wxentrycleanup
}\\
89 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
90 \helpref{wxError
}{wxerror
}\\
91 \helpref{wxExecute
}{wxexecute
}\\
92 \helpref{wxExit
}{wxexit
}\\
93 \helpref{wxEXPLICIT
}{wxexplicit
}\\
94 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
95 \helpref{wxFAIL
}{wxfail
}\\
96 \helpref{wxFatalError
}{wxfatalerror
}\\
97 \helpref{wxFileExists
}{functionwxfileexists
}\\
98 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
99 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
100 \helpref{wxFileSelector
}{wxfileselector
}\\
101 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
102 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
103 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
104 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
105 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
106 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
107 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
108 \helpref{wxFinite
}{wxfinite
}\\
109 \helpref{wxGenericAboutBox
}{wxgenericaboutbox
}\\
110 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
111 \helpref{wxGetApp
}{wxgetapp
}\\
112 \helpref{wxGetBatteryState
}{wxgetbatterystate
}\\
113 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
114 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
115 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
116 \helpref{wxGetCwd
}{wxgetcwd
}\\
117 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
118 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
119 \helpref{wxGetDisplaySize
}{wxdisplaysize
}\\
120 \helpref{wxGetDisplaySizeMM
}{wxdisplaysizemm
}\\
121 \helpref{wxGetElapsedTime
}{wxgetelapsedtime
}\\
122 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
123 \helpref{wxGetEnv
}{wxgetenv
}\\
124 \helpref{wxGetFileKind
}{wxgetfilekind
}\\
125 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
126 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
127 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
128 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
129 \helpref{wxGetHostName
}{wxgethostname
}\\
130 \helpref{wxGetKeyState
}{wxgetkeystate
}\\
131 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
132 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
133 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
134 \helpref{wxGetMouseState
}{wxgetmousestate
}\\
135 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
136 \helpref{wxGetMultipleChoice
}{wxgetmultiplechoice
}\\
137 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
138 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
139 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
140 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
141 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
142 \helpref{wxGetPowerType
}{wxgetpowertype
}\\
143 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
144 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
145 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
146 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
147 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
148 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
149 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
150 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
151 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
152 \helpref{wxGetResource
}{wxgetresource
}\\
153 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
154 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
155 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
156 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
157 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
158 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
159 \helpref{wxGetTranslation
}{wxgettranslation
}\\
160 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
161 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
162 \helpref{wxGetUserId
}{wxgetuserid
}\\
163 \helpref{wxGetUserName
}{wxgetusername
}\\
164 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
165 \helpref{wxGetenv
}{wxgetenvmacro
}\\
166 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
167 \helpref{wxICON
}{wxiconmacro
}\\
168 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
169 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
170 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
171 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
172 \helpref{wxInitialize
}{wxinitialize
}\\
173 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
174 \helpref{wxIsBusy
}{wxisbusy
}\\
175 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
176 \helpref{wxIsDebuggerRunning
}{wxisdebuggerrunning
}\\
177 \helpref{wxIsEmpty
}{wxisempty
}\\
178 \helpref{wxIsMainThread
}{wxismainthread
}\\
179 \helpref{wxIsNaN
}{wxisnan
}\\
180 \helpref{wxIsPlatformLittleEndian
}{wxisplatformlittleendian
}\\
181 \helpref{wxIsPlatform64Bit
}{wxisplatform64bit
}\\
182 \helpref{wxIsWild
}{wxiswild
}\\
183 \helpref{wxKill
}{wxkill
}\\
184 \helpref{wxLaunchDefaultBrowser
}{wxlaunchdefaultbrowser
}\\
185 \helpref{wxLEAVE
\_CRIT\_SECT}{wxleavecritsect
}\\
186 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
187 \helpref{wxLogDebug
}{wxlogdebug
}\\
188 \helpref{wxLogError
}{wxlogerror
}\\
189 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
190 \helpref{wxLogMessage
}{wxlogmessage
}\\
191 \helpref{wxLogStatus
}{wxlogstatus
}\\
192 \helpref{wxLogSysError
}{wxlogsyserror
}\\
193 \helpref{wxLogTrace
}{wxlogtrace
}\\
194 \helpref{wxLogVerbose
}{wxlogverbose
}\\
195 \helpref{wxLogWarning
}{wxlogwarning
}\\
196 \helpref{wxLL
}{wxll
}\\
197 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
198 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
199 \helpref{wxMatchWild
}{wxmatchwild
}\\
200 \helpref{wxMessageBox
}{wxmessagebox
}\\
201 \helpref{wxMilliSleep
}{wxmillisleep
}\\
202 \helpref{wxMicroSleep
}{wxmicrosleep
}\\
203 \helpref{wxMkdir
}{wxmkdir
}\\
204 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
205 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
206 \helpref{wxNewId
}{wxnewid
}\\
207 \helpref{wxNow
}{wxnow
}\\
208 \helpref{wxOnAssert
}{wxonassert
}\\
209 \helpref{wxON
\_BLOCK\_EXIT}{wxonblockexit
}\\
210 \helpref{wxON
\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj
}\\
211 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
212 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
213 \helpref{wxPathOnly
}{wxpathonly
}\\
214 \helpref{wxPLURAL
}{wxplural
}\\
215 \helpref{wxPostDelete
}{wxpostdelete
}\\
216 \helpref{wxPostEvent
}{wxpostevent
}\\
217 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
218 \helpref{wxRegisterId
}{wxregisterid
}\\
219 \helpref{wxRemoveFile
}{wxremovefile
}\\
220 \helpref{wxRenameFile
}{wxrenamefile
}\\
221 \helpref{wxRmdir
}{wxrmdir
}\\
222 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
223 \helpref{wxSafeYield
}{wxsafeyield
}\\
224 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
225 \helpref{wxSetCursor
}{wxsetcursor
}\\
226 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
227 \helpref{wxSetEnv
}{wxsetenv
}\\
228 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
229 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
230 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
231 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
232 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
233 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
234 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
235 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
236 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
237 \helpref{wxShell
}{wxshell
}\\
238 \helpref{wxShowTip
}{wxshowtip
}\\
239 \helpref{wxShutdown
}{wxshutdown
}\\
240 \helpref{wxSleep
}{wxsleep
}\\
241 \helpref{wxSnprintf
}{wxsnprintf
}\\
242 \helpref{wxSplitPath
}{wxsplitfunction
}\\
243 \helpref{wxStartTimer
}{wxstarttimer
}\\
244 \helpref{wxStaticCast
}{wxstaticcast
}\\
245 \helpref{wxStrcmp
}{wxstrcmp
}\\
246 \helpref{wxStricmp
}{wxstricmp
}\\
247 \helpref{wxStringEq
}{wxstringeq
}\\
248 \helpref{wxStringMatch
}{wxstringmatch
}\\
249 \helpref{wxStringTokenize
}{wxstringtokenize
}\\
250 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
251 \helpref{wxStrlen
}{wxstrlen
}\\
252 \helpref{wxSTRINGIZE
}{wxstringize
}\\
253 \helpref{wxSTRINGIZE
\_T}{wxstringizet
}\\
254 \helpref{wxSUPPRESS
\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning
}\\
255 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
256 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
258 \helpref{wxTrace
}{wxtrace
}\\
259 \helpref{WXTRACE
}{trace
}\\
260 \helpref{wxTraceLevel
}{wxtracelevel
}\\
261 \helpref{WXTRACELEVEL
}{tracelevel
}\\
262 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
263 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
264 \helpref{wxTrap
}{wxtrap
}\\
265 \helpref{wxULL
}{wxull
}\\
266 \helpref{wxUninitialize
}{wxuninitialize
}\\
267 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
268 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
269 \helpref{wxUsleep
}{wxusleep
}\\
270 \helpref{wxVaCopy
}{wxvacopy
}\\
271 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
272 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
273 \helpref{wxWriteResource
}{wxwriteresource
}\\
274 \helpref{wxYield
}{wxyield
}\\
275 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
276 \helpref{wx
\_reinterpret\_cast}{wxreinterpretcastraw
}\\
277 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
278 \helpref{wx
\_truncate\_cast}{wxtruncatecast
}\\
279 \helpref{\_}{underscore
}\\
280 \helpref{\_T}{underscoret
}
281 \helpref{\_\_WXFUNCTION\_\_}{wxfunction
}
285 \section{Version macros
}\label{versionfunctions
}
287 The following constants are defined in wxWidgets:
289 \begin{itemize
}\itemsep=
0pt
290 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
291 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
292 \item {\tt wxRELEASE
\_NUMBER} is the release number
293 \item {\tt wxSUBRELEASE
\_NUMBER} is the subrelease number which is $
0$ for all
297 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
300 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
301 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
302 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
305 The subrelease number is only used for the sources in between official releases
306 and so normally is not useful.
308 \wxheading{Include files
}
310 <wx/version.h> or <wx/defs.h>
313 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
315 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor
}}
317 Returns $
1$ if the compiler being used to compile the code is GNU C++
318 compiler (g++) version major.minor or greater. Otherwise, and also if
319 the compiler is not GNU C++ at all, returns $
0$.
322 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
324 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
326 This is a macro which evaluates to true if the current wxWidgets version is at
327 least major.minor.release.
329 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
330 the following can be done:
334 #if wxCHECK_VERSION(
2,
2,
0)
335 if ( s.StartsWith("foo") )
336 #else // replacement code for old version
337 if ( strncmp(s, "foo",
3) ==
0 )
345 \membersection{wxCHECK
\_VERSION\_FULL}\label{wxcheckversionfull
}
347 \func{bool
}{wxCHECK
\_VERSION\_FULL}{\param{}{major, minor, release, subrel
}}
349 Same as
\helpref{wxCHECK
\_VERSION}{wxcheckversion
} but also checks that
350 \texttt{wxSUBRELEASE
\_NUMBER} is at least
\arg{subrel
}.
353 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
355 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
357 Returns $
1$ if the version of w32api headers used is major.minor.release or
358 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
359 Win32 at all, returns $
0$.
363 \section{Application initialization and termination
}\label{appinifunctions
}
365 The functions in this section are used on application startup/shutdown and also
366 to control the behaviour of the main event loop of the GUI programs.
369 \membersection{::wxEntry
}\label{wxentry
}
371 This initializes wxWidgets in a platform-dependent way. Use this if you are not
372 using the default wxWidgets entry code (e.g. main or WinMain). For example, you
373 can initialize wxWidgets from an Microsoft Foundation Classes application using
376 The following overload of wxEntry is available under all platforms:
378 \func{int
}{wxEntry
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
380 Under MS Windows, an additional overload suitable for calling from
381 \texttt{WinMain
} is available:
383 \func{int
}{wxEntry
}{\param{HINSTANCE
}{hInstance
},
\param{HINSTANCE
}{hPrevInstance =
\NULL},
\param{char *
}{pCmdLine =
\NULL},
\param{int
}{nCmdShow =
\texttt{SW
\_SHOWNORMAL}}}
385 (notice that under Windows CE platform, and only there, the type of
386 \arg{pCmdLine
} is
\texttt{wchar
\_t *
}, otherwise it is
\texttt{char *
}, even in
391 \helpref{wxEntryStart
}{wxentrystart
}
395 To clean up wxWidgets, call wxApp::OnExit followed by the static function
396 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
399 int CTheApp::ExitInstance()
401 // OnExit isn't called by CleanUp so must be called explicitly.
405 return CWinApp::ExitInstance();
409 \wxheading{Include files
}
415 \membersection{::wxEntryCleanup
}\label{wxentrycleanup
}
417 \func{void
}{wxEntryCleanup
}{\void}
419 Free resources allocated by a successful call to
\helpref{wxEntryStart
}{wxentrystart
}.
421 \wxheading{Include files
}
426 \membersection{::wxEntryStart
}\label{wxentrystart
}
428 \func{bool
}{wxEntryStart
}{\param{int\&
}{ argc
},
\param{wxChar **
}{argv
}}
430 This function can be used to perform the initialization of wxWidgets if you
431 can't use the default initialization code for any reason.
433 If the function returns
\true, the initialization was successful and the global
434 \helpref{wxApp
}{wxapp
} object
\texttt{wxTheApp
} has been created. Moreover,
435 \helpref{wxEntryCleanup
}{wxentrycleanup
} must be called afterwards. If the
436 function returns
\false, a catastrophic initialization error occured and (at
437 least the GUI part of) the library can't be used at all.
439 Notice that parameters
\arg{argc
} and
\arg{argv
} may be modified by this
442 \wxheading{Include files
}
447 \membersection{::wxGetApp
}\label{wxgetapp
}
449 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
451 This function doesn't exist in wxWidgets but it is created by using
452 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
453 anywhere but in the same module where this macro is used, you must make it
454 available using
\helpref{DECLARE
\_APP}{declareapp
}.
456 The advantage of using this function compared to directly using the global
457 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
458 allow you to access the functions specific to your application class but not
459 present in wxApp while wxGetApp() returns the object of the right type.
462 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
464 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
466 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
467 faults under Windows or segmentation violations in the Unix world) will be
468 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
469 By default, i.e. before this function is called, they will be handled in the
470 normal way which usually just means that the application will be terminated.
471 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
472 this default behaviour.
475 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
477 \func{void
}{wxInitAllImageHandlers
}{\void}
479 Initializes all available image handlers. For a list of available handlers,
480 see
\helpref{wxImage
}{wximage
}.
484 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
486 \wxheading{Include files
}
491 \membersection{::wxInitialize
}\label{wxinitialize
}
493 \func{bool
}{wxInitialize
}{\void}
495 This function is used in wxBase only and only if you don't create
496 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
497 {\tt main()
} function before calling any other wxWidgets functions.
499 If the function returns
\false the initialization could not be performed,
500 in this case the library cannot be used and
501 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
503 This function may be called several times but
504 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
505 call to this function.
507 \wxheading{Include files
}
512 \membersection{::wxSafeYield
}\label{wxsafeyield
}
514 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
515 onlyIfNeeded = false
}}
517 This function is similar to wxYield, except that it disables the user input to
518 all program windows before calling wxYield and re-enables it again
519 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
520 allowing the implementation of some limited user interaction.
522 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
524 \wxheading{Include files
}
529 \membersection{::wxUninitialize
}\label{wxuninitialize
}
531 \func{void
}{wxUninitialize
}{\void}
533 This function is for use in console (wxBase) programs only. It must be called
534 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
536 \wxheading{Include files
}
541 \membersection{::wxYield
}\label{wxyield
}
543 \func{bool
}{wxYield
}{\void}
545 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
547 This function is kept only for backwards compatibility. Please use
548 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
550 \wxheading{Include files
}
552 <wx/app.h> or <wx/utils.h>
555 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
557 \func{void
}{wxWakeUpIdle
}{\void}
559 This functions wakes up the (internal and platform dependent) idle system, i.e. it
560 will force the system to send an idle event even if the system currently
{\it is
}
561 idle and thus would not send any idle event until after some other event would get
562 sent. This is also useful for sending events between two threads and is used by
563 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
564 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
566 \wxheading{Include files
}
572 \section{Process control functions
}\label{processfunctions
}
574 The functions in this section are used to launch or terminate the other
578 \membersection{::wxExecute
}\label{wxexecute
}
580 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
582 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
584 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
586 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
588 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{int
}{flags =
0}}
590 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
591 only takes the
{\tt command
} argument,
592 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
595 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
},
\param{int
}{flags =
0}}
597 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
598 and it only takes the
{\tt command
} argument,
599 and returns a
3-element list
{\tt ( status, output, errors )
}, where
600 {\tt output
} and
{\tt errors
} are array references.
}
602 Executes another program in Unix or Windows.
604 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
606 The second form takes an array of values: a command, any number of
607 arguments, terminated by NULL.
609 The semantics of the third and fourth versions is different from the first two
610 and is described in more details below.
612 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
613 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
614 application waits until the other program has terminated.
616 In the case of synchronous execution, the return value is the exit code of
617 the process (which terminates by the moment the function returns) and will be
618 $-
1$ if the process couldn't be started and typically
0 if the process
619 terminated successfully. Also, while waiting for the process to
620 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. Because of this, by
621 default this function disables all application windows to avoid unexpected
622 reentrancies which could result from the users interaction with the program
623 while the child process is running. If you are sure that it is safe to not
624 disable the program windows, you may pass
\texttt{wxEXEC
\_NODISABLE} flag to
625 prevent this automatic disabling from happening.
627 For asynchronous execution, however, the return value is the process id and
628 zero value indicates that the command could not be executed. As an added
629 complication, the return value of $-
1$ in this case indicates that we didn't
630 launch a new process, but connected to the running one (this can only happen in
631 case of using DDE under Windows for command execution). In particular, in this,
632 and only this, case the calling code will not get the notification about
635 If callback isn't NULL and if execution is asynchronous,
636 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
637 the process finishes. Specifying this parameter also allows you to redirect the
638 standard input and/or output of the process being launched by calling
639 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
640 under Windows the process window is not shown by default (this avoids having to
641 flush an unnecessary console for the processes which don't create any windows
642 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
643 happening, i.e. with this flag the child process window will be shown normally.
645 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
646 that the new process is a group leader (this will create a new session if
647 needed). Calling
\helpref{wxKill
}{wxkill
} passing wxKILL
\_CHILDREN will
648 kill this process as well as all of its children (except those which have
649 started their own session).
651 Finally, you may use the third overloaded version of this function to execute
652 a process (always synchronously, the contents of
\arg{flags
} is or'd with
653 \texttt{wxEXEC
\_SYNC}) and capture its output in the array
\arg{output
}. The
654 fourth version adds the possibility to additionally capture the messages from
655 standard error output in the
\arg{errors
} array.
657 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
658 this function from another thread will result in an assert failure in debug
659 build and won't work.
663 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
665 \wxheading{Parameters
}
667 \docparam{command
}{The command to execute and any parameters to pass to it as a
670 \docparam{argv
}{The command to execute should be the first element of this
671 array, any additional ones are the command parameters and the array must be
672 terminated with a NULL pointer.
}
674 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
675 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
677 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
679 \wxheading{Include files
}
684 \membersection{::wxExit
}\label{wxexit
}
686 \func{void
}{wxExit
}{\void}
688 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
689 Should only be used in an emergency: normally the top-level frame
690 should be deleted (after deleting all other frames) to terminate the
691 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
693 \wxheading{Include files
}
698 \membersection{::wxKill
}\label{wxkill
}
700 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
},
\param{int
}{flags =
0}}
702 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
703 process with PID
{\it pid
}. The valid signal values are
708 wxSIGNONE =
0, // verify if the process exists under Unix
717 wxSIGKILL, // forcefully kill, dangerous!
723 wxSIGTERM // terminate the process gently
727 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
728 under both Unix and Windows but all the other signals are equivalent to
729 {\tt wxSIGTERM
} under Windows.
731 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
732 be filled with an element of
{\tt wxKillError
} enum:
737 wxKILL_OK, // no error
738 wxKILL_BAD_SIGNAL, // no such signal
739 wxKILL_ACCESS_DENIED, // permission denied
740 wxKILL_NO_PROCESS, // no such process
741 wxKILL_ERROR // another, unspecified error
745 The
{\it flags
} parameter can be wxKILL
\_NOCHILDREN (the default),
746 or wxKILL
\_CHILDREN, in which case the child processes of this
747 process will be killed too. Note that under Unix, for wxKILL
\_CHILDREN
748 to work you should have created the process by passing wxEXEC
\_MAKE\_GROUP\_LEADER
753 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
754 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
755 \helpref{Exec sample
}{sampleexec
}
757 \wxheading{Include files
}
762 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
764 \func{unsigned long
}{wxGetProcessId
}{\void}
766 Returns the number uniquely identifying the current process in the system.
768 If an error occurs, $
0$ is returned.
770 \wxheading{Include files
}
775 \membersection{::wxShell
}\label{wxshell
}
777 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
779 Executes a command in an interactive shell window. If no command is
780 specified, then just the shell is spawned.
782 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
784 \wxheading{Include files
}
789 \membersection{::wxShutdown
}\label{wxshutdown
}
791 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
793 This function shuts down or reboots the computer depending on the value of the
794 {\it flags
}. Please notice that doing this requires the corresponding access
795 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privilege under Windows NT)
796 and that this function is only implemented under Unix and Win32.
798 \wxheading{Parameters
}
800 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
804 \true on success,
\false if an error occurred.
806 \wxheading{Include files
}
812 \section{Thread functions
}\label{threadfunctions
}
814 The functions and macros here mainly exist to make it writing the code which
815 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
816 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
818 For example, a static variable must be protected against simultaneous access by
819 multiple threads in the former configuration but in the latter the extra
820 overhead of using the critical section is not needed. To solve this problem,
821 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
822 to create and use the critical section only when needed.
824 \wxheading{Include files
}
830 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
834 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
836 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
838 This macro declares a (static) critical section object named
{\it cs
} if
839 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
843 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
845 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
847 This macro declares a critical section object named
{\it cs
} if
848 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
849 include the
{\tt static
} keyword (unlike
850 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
851 a class or struct member which explains its name.
855 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
857 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
859 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
860 object named
{\it name
} and associated with the critical section
{\it cs
} if
861 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
865 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
867 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
869 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
870 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
871 section object and also the lock object associated with it. Because of this, it
872 can be only used inside a function, not at global scope. For example:
877 static int s_counter =
0;
879 wxCRITICAL_SECTION(counter);
885 (note that we suppose that the function is called the first time from the main
886 thread so that the critical section object is initialized correctly by the time
887 other threads start calling it, if this is not the case this approach can
888 {\bf not
} be used and the critical section must be made a global instead).
892 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
894 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
896 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
897 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
901 \membersection{::wxIsMainThread
}\label{wxismainthread
}
903 \func{bool
}{wxIsMainThread
}{\void}
905 Returns
\true if this thread is the main one. Always returns
\true if
906 {\tt wxUSE
\_THREADS} is $
0$.
910 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
912 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
914 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
915 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
919 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
921 \func{void
}{wxMutexGuiEnter
}{\void}
923 This function must be called when any thread other than the main GUI thread
924 wants to get access to the GUI library. This function will block the execution
925 of the calling thread until the main thread (or any other thread holding the
926 main GUI lock) leaves the GUI library and no other thread will enter the GUI
927 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
929 Typically, these functions are used like this:
932 void MyThread::Foo(void)
934 // before doing any GUI calls we must ensure that this thread is the only
940 my_window->DrawSomething();
946 Note that under GTK, no creation of top-level windows is allowed in any
947 thread but the main one.
949 This function is only defined on platforms which support preemptive
953 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
955 \func{void
}{wxMutexGuiLeave
}{\void}
957 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
959 This function is only defined on platforms which support preemptive
964 \section{File functions
}\label{filefunctions
}
966 \wxheading{Include files
}
972 \helpref{wxPathList
}{wxpathlist
}\\
973 \helpref{wxDir
}{wxdir
}\\
974 \helpref{wxFile
}{wxfile
}\\
975 \helpref{wxFileName
}{wxfilename
}
978 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
980 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
982 Converts a DOS to a Unix filename by replacing backslashes with forward
986 \membersection{::wxFileExists
}\label{functionwxfileexists
}
988 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
990 Returns true if the file exists and is a plain file.
993 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
995 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
997 Returns time of last modification of given file.
999 The return value is $
0$ if an error occured (e.g. file not found).
1002 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
1004 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
1006 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
1008 {\bf NB:
} This function is obsolete, please use
1009 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
1011 Returns the filename for a full path. The second form returns a pointer to
1012 temporary storage that should not be deallocated.
1015 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
1017 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
1019 This function does directory searching; returns the first file
1020 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
1021 get the next matching file. Neither will
report the current directory "." or the
1022 parent directory "..".
1026 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.
1028 {\it spec
} may contain wildcards.
1030 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
1035 wxString f = wxFindFirstFile("/home/project/*.*");
1036 while ( !f.empty() )
1039 f = wxFindNextFile();
1044 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
1046 \func{wxString
}{wxFindNextFile
}{\void}
1048 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
1050 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
1053 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
1055 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
1057 This function returns the total number of bytes and number of free bytes on
1058 the disk containing the directory
{\it path
} (it should exist). Both
1059 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
1060 information is not needed.
1064 \true on success,
\false if an error occurred (for example, the
1065 directory doesn't exist).
1067 \wxheading{Portability
}
1069 This function is implemented for Win32,
1070 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
1072 This function first appeared in wxWidgets
2.3.2.
1075 \membersection{::wxGetFileKind
}\label{wxgetfilekind
}
1077 \func{wxFileKind
}{wxGetFileKind
}{\param{int
}{fd
}}
1079 \func{wxFileKind
}{wxGetFileKind
}{\param{FILE *
}{fp
}}
1081 Returns the type of an open file. Possible return values are:
1086 wxFILE_KIND_UNKNOWN,
1087 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
1088 wxFILE_KIND_TERMINAL, // a tty
1089 wxFILE_KIND_PIPE // a pipe
1094 \wxheading{Include files
}
1099 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
1101 \func{wxString
}{wxGetOSDirectory
}{\void}
1103 Returns the Windows directory under Windows; on other platforms returns the empty string.
1106 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
1108 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
1110 Returns true if the argument is an absolute filename, i.e. with a slash
1111 or drive name at the beginning.
1114 \membersection{::wxDirExists
}\label{functionwxdirexists
}
1116 \func{bool
}{wxDirExists
}{\param{const wxChar *
}{dirname
}}
1118 Returns true if
\arg{dirname
} exists and is a directory.
1121 \membersection{::wxPathOnly
}\label{wxpathonly
}
1123 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1125 Returns the directory part of the filename.
1128 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1130 \func{void
}{wxUnix2DosFilename
}{\param{wxChar *
}{s
}}
1132 This function is deprecated, use
\helpref{wxFileName
}{wxfilename
} instead.
1134 Converts a Unix to a DOS filename by replacing forward
1135 slashes with backslashes.
1138 \membersection{wxCHANGE
\_UMASK}\label{wxchangeumask
}
1140 \func{}{wxCHANGE
\_UMASK}{\param{int
}{mask
}}
1142 Under Unix this macro changes the current process umask to the given value,
1143 unless it is equal to $-
1$ in which case nothing is done, and restores it to
1144 the original value on scope exit. It works by declaring a variable which sets
1145 umask to
\arg{mask
} in its constructor and restores it in its destructor.
1147 Under other platforms this macro expands to nothing.
1150 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1152 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1153 \param{const wxString\&
}{file3
}}
1155 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1159 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1161 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1163 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1164 {\it overwrite
} parameter is true (default), the destination file is overwritten
1165 if it exists, but if
{\it overwrite
} is false, the functions fails in this
1169 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1171 \func{wxString
}{wxGetCwd
}{\void}
1173 Returns a string containing the current (or working) directory.
1176 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1178 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1180 {\bf NB:
} This function is deprecated: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1182 Copies the current working directory into the buffer if supplied, or
1183 copies the working directory into new storage (which you
{\emph must
} delete
1184 yourself) if the buffer is NULL.
1186 {\it sz
} is the size of the buffer if supplied.
1189 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1191 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1193 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1195 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1196 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1197 %% is allocated for the temporary filename using {\it new}.
1199 %% Under Windows, the filename will include the drive and name of the
1200 %% directory allocated for temporary files (usually the contents of the
1201 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1203 %% It is the application's responsibility to create and delete the file.
1205 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1206 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1210 \membersection{::wxIsWild
}\label{wxiswild
}
1212 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1214 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1217 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1219 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1221 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1222 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1223 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1226 \membersection{::wxMkdir
}\label{wxmkdir
}
1228 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1230 Makes the directory
\arg{dir
}, returning true if successful.
1232 {\it perm
} is the access mask for the directory for the systems on which it is
1233 supported (Unix) and doesn't have any effect on the other ones.
1236 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1238 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1240 Parses the
\arg{wildCard
}, returning the number of filters.
1241 Returns
0 if none or if there's a problem.
1242 The arrays will contain an equal number of items found before the error.
1243 On platforms where native dialogs handle only one filter per entry,
1244 entries in arrays are automatically adjusted.
1245 \arg{wildCard
} is in the form:
1247 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1250 \membersection{::wxRemoveFile}\label{wxremovefile}
1252 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1254 Removes \arg{file}, returning true if successful.
1257 \membersection{::wxRenameFile}\label{wxrenamefile}
1259 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
1261 Renames \arg{file1} to \arg{file2}, returning true if successful.
1263 If \arg{overwrite} parameter is true (default), the destination file is
1264 overwritten if it exists, but if \arg{overwrite} is false, the functions fails
1268 \membersection{::wxRmdir}\label{wxrmdir}
1270 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1272 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1274 The {\it flags} parameter is reserved for future use.
1276 Please notice that there is also a wxRmDir() function which simply wraps the
1277 standard POSIX rmdir() function and so return an integer error code instead of
1278 a boolean value (but otherwise is currently identical to wxRmdir), don't
1279 confuse these two functions.
1282 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1284 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1286 Sets the current working directory, returning true if the operation succeeded.
1287 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1290 \membersection{::wxSplitPath}\label{wxsplitfunction}
1292 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1294 {\bf NB:} This function is obsolete, please use
1295 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1297 This function splits a full file name into components: the path (including possible disk/drive
1298 specification under Windows), the base name and the extension. Any of the output parameters
1299 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1300 a particular component.
1302 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1303 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1304 is a valid character in a filename).
1306 On entry, {\it fullname} should be non-NULL (it may be empty though).
1308 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1309 contains the file name and {\it ext} contains the file extension without leading dot. All
1310 three of them may be empty if the corresponding component is. The old contents of the
1311 strings pointed to by these parameters will be overwritten in any case (if the pointers
1315 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1317 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1319 Copies the given file to {\it stream}. Useful when converting an old application to
1320 use streams (within the document/view framework, for example).
1322 \wxheading{Include files}
1327 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1329 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1331 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1332 use streams (within the document/view framework, for example).
1334 \wxheading{Include files}
1340 \section{Network, user and OS functions}\label{networkfunctions}
1342 The functions in this section are used to retrieve information about the
1343 current computer and/or user characteristics.
1346 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1348 \func{wxString}{wxGetEmailAddress}{\void}
1350 \func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
1352 Copies the user's email address into the supplied buffer, by
1353 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1354 and \helpref{wxGetUserId}{wxgetuserid}.
1356 Returns true if successful, false otherwise.
1358 \wxheading{Include files}
1363 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1365 \func{wxMemorySize}{wxGetFreeMemory}{\void}
1367 Returns the amount of free memory in bytes under environments which
1368 support it, and -1 if not supported or failed to perform measurement.
1370 \wxheading{Include files}
1375 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1377 \func{wxString}{wxGetFullHostName}{\void}
1379 Returns the FQDN (fully qualified domain host name) or an empty string on
1382 \wxheading{See also}
1384 \helpref{wxGetHostName}{wxgethostname}
1386 \wxheading{Include files}
1391 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1393 \func{wxString}{wxGetHomeDir}{\void}
1395 Return the (current) user's home directory.
1397 \wxheading{See also}
1399 \helpref{wxGetUserHome}{wxgetuserhome}\\
1400 \helpref{wxStandardPaths}{wxstandardpaths}
1402 \wxheading{Include files}
1407 \membersection{::wxGetHostName}\label{wxgethostname}
1409 \func{wxString}{wxGetHostName}{\void}
1411 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1413 Copies the current host machine's name into the supplied buffer. Please note
1414 that the returned name is {\it not} fully qualified, i.e. it does not include
1417 Under Windows or NT, this function first looks in the environment
1418 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1419 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1421 The first variant of this function returns the hostname if successful or an
1422 empty string otherwise. The second (deprecated) function returns true
1423 if successful, false otherwise.
1425 \wxheading{See also}
1427 \helpref{wxGetFullHostName}{wxgetfullhostname}
1429 \wxheading{Include files}
1434 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1436 \func{wxString}{wxGetOsDescription}{\void}
1438 Returns the string containing the description of the current platform in a
1439 user-readable form. For example, this function may return strings like
1440 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1442 \wxheading{See also}
1444 \helpref{::wxGetOsVersion}{wxgetosversion}
1446 \wxheading{Include files}
1451 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1453 \func{wxOperatingSystemId}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1455 Gets the version and the operating system ID for currently running OS.
1456 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details about wxOperatingSystemId.
1458 \wxheading{See also}
1460 \helpref{::wxGetOsDescription}{wxgetosdescription},
1461 \helpref{wxPlatformInfo}{wxplatforminfo}
1463 \wxheading{Include files}
1468 \membersection{::wxIsPlatformLittleEndian}\label{wxisplatformlittleendian}
1470 \func{bool}{wxIsPlatformLittleEndian}{\void}
1472 Returns \true if the current platform is little endian (instead of big endian).
1473 The check is performed at run-time.
1475 \wxheading{See also}
1477 \helpref{Byte order macros}{byteordermacros}
1479 \wxheading{Include files}
1484 \membersection{::wxIsPlatform64Bit}\label{wxisplatform64bit}
1486 \func{bool}{wxIsPlatform64Bit}{\void}
1488 Returns \true if the operating system the program is running under is 64 bit.
1489 The check is performed at run-time and may differ from the value available at
1490 compile-time (at compile-time you can just check if {\tt sizeof(void*)==
8})
1491 since the program could be running in emulation mode or in a mixed
32/
64 bit system
1492 (bi-architecture operating system).
1494 Very important: this function is not
100\% reliable on some systems given the fact
1495 that there isn't always a standard way to do a reliable check on the OS architecture.
1497 \wxheading{Include files
}
1502 \membersection{::wxGetUserHome
}\label{wxgetuserhome
}
1504 \func{const wxChar *
}{wxGetUserHome
}{\param{const wxString\&
}{user = ""
}}
1506 Returns the home directory for the given user. If the username is empty
1507 (default value), this function behaves like
1508 \helpref{wxGetHomeDir
}{wxgethomedir
}.
1510 \wxheading{Include files
}
1515 \membersection{::wxGetUserId
}\label{wxgetuserid
}
1517 \func{wxString
}{wxGetUserId
}{\void}
1519 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1521 This function returns the "user id" also known as "login name" under Unix i.e.
1522 something like "jsmith". It uniquely identifies the current user (on this system).
1524 Under Windows or NT, this function first looks in the environment
1525 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
1526 in the
{\bf wxWidgets
} section of the WIN.INI file is tried.
1528 The first variant of this function returns the login name if successful or an
1529 empty string otherwise. The second (deprecated) function returns true
1530 if successful, false otherwise.
1532 \wxheading{See also
}
1534 \helpref{wxGetUserName
}{wxgetusername
}
1536 \wxheading{Include files
}
1541 \membersection{::wxGetUserName
}\label{wxgetusername
}
1543 \func{wxString
}{wxGetUserName
}{\void}
1545 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1547 This function returns the full user name (something like "Mr. John Smith").
1549 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
1550 in the
{\bf wxWidgets
} section of the WIN.INI file. If PenWindows
1551 is running, the entry
{\bf Current
} in the section
{\bf User
} of
1552 the PENWIN.INI file is used.
1554 The first variant of this function returns the user name if successful or an
1555 empty string otherwise. The second (deprecated) function returns
\true
1556 if successful,
\false otherwise.
1558 \wxheading{See also
}
1560 \helpref{wxGetUserId
}{wxgetuserid
}
1562 \wxheading{Include files
}
1568 \section{String functions
}\label{stringfunctions
}
1571 \membersection{::copystring
}\label{copystring
}
1573 \func{char *
}{copystring
}{\param{const char *
}{s
}}
1575 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
1576 deleted with the
{\it delete
} operator.
1578 This function is deprecated, use
\helpref{wxString
}{wxstring
} class instead.
1581 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
1583 \func{const wxChar *
}{wxGetTranslation
}{\param{const wxChar*
}{str
},
1584 \param{const wxChar*
}{domain = NULL
}}
1586 \func{const wxChar *
}{wxGetTranslation
}{\param{const wxChar*
}{str
},
\param{const wxChar*
}{strPlural
},
\param{size
\_t }{n
},
1587 \param{const wxChar*
}{domain = NULL
}}
1589 This function returns the translation of string
{\it str
} in the current
1590 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
1591 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
1592 original string is returned. In debug build, an error message is logged -- this
1593 should help to find the strings which were not yet translated. If
1594 {\it domain
} is specified then only that domain/catalog is searched
1595 for a matching string. As this function
1596 is used very often, an alternative (and also common in Unix world) syntax is
1597 provided: the
\helpref{\_()
}{underscore
} macro is defined to do the same thing
1598 as wxGetTranslation.
1600 The second form is used when retrieving translation of string that has
1601 different singular and plural form in English or different plural forms in some
1602 other language. It takes two extra arguments: as above,
\arg{str
}
1603 parameter must contain the singular form of the string to be converted and
1604 is used as the key for the search in the catalog. The
\arg{strPlural
} parameter
1605 is the plural form (in English). The parameter
\arg{n
} is used to determine the
1606 plural form. If no message catalog is found
\arg{str
} is returned if `n ==
1',
1607 otherwise
\arg{strPlural
}.
1609 See
\urlref{GNU gettext manual
}{http://www.gnu.org/manual/gettext/html
\_chapter/gettext
\_10.html\#SEC150
}
1610 for additional information on plural forms handling. For a shorter alternative
1611 see the
\helpref{wxPLURAL()
}{wxplural
} macro.
1613 Both versions call
\helpref{wxLocale::GetString
}{wxlocalegetstring
}.
1615 Note that this function is not suitable for literal strings in Unicode
1616 builds, since the literal strings must be enclosed into
1617 \helpref{\_T()
}{underscoret
} or
\helpref{wxT
}{wxt
} macro which makes them
1618 unrecognised by
\texttt{xgettext
}, and so they are not extracted to the message
1619 catalog. Instead, use the
\helpref{\_()
}{underscore
} and
1620 \helpref{wxPLURAL
}{wxplural
} macro for all literal strings.
1623 \membersection{::wxIsEmpty
}\label{wxisempty
}
1625 \func{bool
}{wxIsEmpty
}{\param{const char *
}{ p
}}
1627 Returns
\true if the pointer is either
{\tt NULL
} or points to an empty
1628 string,
\false otherwise.
1631 \membersection{::wxStrcmp
}\label{wxstrcmp
}
1633 \func{int
}{wxStrcmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1635 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1636 to or greater than
{\it p2
}. The comparison is case-sensitive.
1638 This function complements the standard C function
{\it stricmp()
} which performs
1639 case-insensitive comparison.
1642 \membersection{::wxStricmp
}\label{wxstricmp
}
1644 \func{int
}{wxStricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1646 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1647 to or greater than
{\it p2
}. The comparison is case-insensitive.
1649 This function complements the standard C function
{\it strcmp()
} which performs
1650 case-sensitive comparison.
1653 \membersection{::wxStringEq
}\label{wxstringeq
}
1655 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
1657 {\bf NB:
} This function is obsolete, use
\helpref{wxString
}{wxstring
} instead.
1662 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
1666 \membersection{::wxStringMatch
}\label{wxstringmatch
}
1668 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
1669 \param{bool
}{ subString = true
},
\param{bool
}{ exact = false
}}
1671 {\bf NB:
} This function is obsolete, use
\helpref{wxString::Find
}{wxstringfind
} instead.
1673 Returns
\true if the substring
{\it s1
} is found within
{\it s2
},
1674 ignoring case if
{\it exact
} is false. If
{\it subString
} is
\false,
1675 no substring matching is done.
1678 \membersection{::wxStringTokenize
}\label{wxstringtokenize
}
1680 \func{wxArrayString
}{wxStringTokenize
}{\param{const wxString\&
}{str
},\\
1681 \param{const wxString\&
}{delims = wxDEFAULT
\_DELIMITERS},\\
1682 \param{wxStringTokenizerMode
}{mode = wxTOKEN
\_DEFAULT}}
1684 This is a convenience function wrapping
1685 \helpref{wxStringTokenizer
}{wxstringtokenizer
} which simply returns all tokens
1686 found in the given
\arg{str
} in an array.
1689 \helpref{wxStringTokenizer::wxStringTokenizer
}{wxstringtokenizerwxstringtokenizer
}
1690 for the description of the other parameters.
1693 \membersection{::wxStrlen
}\label{wxstrlen
}
1695 \func{size
\_t}{wxStrlen
}{\param{const char *
}{ p
}}
1697 This is a safe version of standard function
{\it strlen()
}: it does exactly the
1698 same thing (i.e. returns the length of the string) except that it returns
0 if
1699 {\it p
} is the
{\tt NULL
} pointer.
1702 \membersection{::wxSnprintf
}\label{wxsnprintf
}
1704 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
1706 This function replaces the dangerous standard function
{\tt sprintf()
} and is
1707 like
{\tt snprintf()
} available on some platforms. The only difference with
1708 sprintf() is that an additional argument - buffer size - is taken and the
1709 buffer is never overflowed.
1711 Returns the number of characters copied to the buffer or -
1 if there is not
1714 \wxheading{See also
}
1716 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
1719 \membersection{wxT
}\label{wxt
}
1721 \func{wxChar
}{wxT
}{\param{char
}{ch
}}
1723 \func{const wxChar *
}{wxT
}{\param{const char *
}{s
}}
1725 wxT() is a macro which can be used with character and string literals (in other
1726 words,
{\tt 'x'
} or
{\tt "foo"
}) to automatically convert them to Unicode in
1727 Unicode build configuration. Please see the
1728 \helpref{Unicode overview
}{unicode
} for more information.
1730 This macro is simply returns the value passed to it without changes in ASCII
1731 build. In fact, its definition is:
1734 #define wxT(x) L ## x
1741 \membersection{wxTRANSLATE
}\label{wxtranslate
}
1743 \func{const wxChar *
}{wxTRANSLATE
}{\param{const char *
}{s
}}
1745 This macro doesn't do anything in the program code -- it simply expands to the
1746 value of its argument (except in Unicode build where it is equivalent to
1747 \helpref{wxT
}{wxt
} which makes it unnecessary to use both wxTRANSLATE and wxT
1748 with the same string which would be really unreadable).
1750 However it does have a purpose and it is to mark the literal strings for the
1751 extraction into the message catalog created by
{\tt xgettext
} program. Usually
1752 this is achieved using
\helpref{\_()
}{underscore
} but that macro not only marks
1753 the string for extraction but also expands into a
1754 \helpref{wxGetTranslation
}{wxgettranslation
} function call which means that it
1755 cannot be used in some situations, notably for static array
1758 Here is an example which should make it more clear: suppose that you have a
1759 static array of strings containing the weekday names and which have to be
1760 translated (note that it is a bad example, really, as
1761 \helpref{wxDateTime
}{wxdatetime
} already can be used to get the localized week
1762 day names already). If you write
1765 static const wxChar * const weekdays
[] =
{ _("Mon"), ..., _("Sun")
};
1767 // use weekdays
[n
] as usual
1770 the code wouldn't compile because the function calls are forbidden in the array
1771 initializer. So instead you should do
1774 static const wxChar * const weekdays
[] =
{ wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun")
};
1776 // use wxGetTranslation(weekdays
[n
])
1781 Note that although the code
{\bf would
} compile if you simply omit
1782 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1783 no translations for the weekday names in the program message catalog and
1784 wxGetTranslation wouldn't find them.
1786 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
1788 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argPtr
}}
1790 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list }
1791 argument instead of arbitrary number of parameters.
1793 Note that if
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is set to
1, then this function supports
1794 positional arguments (see
\helpref{wxString::Printf
}{wxstringprintf
} for more information).
1795 However other functions of the same family (wxPrintf, wxSprintf, wxFprintf, wxVfprintf,
1796 wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional parameters
1797 even when
\texttt{wxUSE
\_PRINTF\_POS\_PARAMS} is
1.
1799 \wxheading{See also
}
1801 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
1805 \membersection{\_}\label{underscore
}
1807 \func{const wxChar *
}{\_}{\param{const char *
}{s
}}
1809 This macro expands into a call to
\helpref{wxGetTranslation
}{wxgettranslation
}
1810 function, so it marks the message for the extraction by
{\tt xgettext
} just as
1811 \helpref{wxTRANSLATE
}{wxtranslate
} does, but also returns the translation of
1812 the string for the current locale during execution.
1814 Don't confuse this macro with
\helpref{\_T()
}{underscoret
}!
1817 \membersection{wxPLURAL
}\label{wxplural
}
1819 \func{const wxChar *
}{wxPLURAL
}{\param{const char *
}{sing
},
\param{const char *
}{plur
},
\param{size
\_t}{n
}}
1821 This macro is identical to
\helpref{\_()
}{underscore
} but for the plural variant
1822 of
\helpref{wxGetTranslation
}{wxgettranslation
}.
1825 \membersection{\_T}\label{underscoret
}
1827 \func{wxChar
}{\_T}{\param{char
}{ch
}}
1829 \func{const wxChar *
}{\_T}{\param{const wxChar
}{ch
}}
1831 This macro is exactly the same as
\helpref{wxT
}{wxt
} and is defined in
1832 wxWidgets simply because it may be more intuitive for Windows programmers as
1833 the standard Win32 headers also define it (as well as yet another name for the
1834 same macro which is
{\tt \_TEXT()
}).
1836 Don't confuse this macro with
\helpref{\_()
}{underscore
}!
1840 \section{Dialog functions
}\label{dialogfunctions
}
1842 Below are a number of convenience functions for getting input from the
1843 user or displaying messages. Note that in these functions the last three
1844 parameters are optional. However, it is recommended to pass a parent frame
1845 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1846 the front when the dialog box is popped up.
1849 \membersection{::wxAboutBox
}\label{wxaboutbox
}
1851 \func{void
}{wxAboutBox
}{\param{const wxAboutDialogInfo\&
}{info
}}
1853 This function shows the standard about dialog containing the information
1854 specified in
\arg{info
}. If the current platform has a native about dialog
1855 which is capable of showing all the fields in
\arg{info
}, the native dialog is
1856 used, otherwise the function falls back to the generic wxWidgets version of the
1857 dialog, i.e. does the same thing as
\helpref{wxGenericAboutBox()
}{wxgenericaboutbox
}.
1859 Here is an example of how this function may be used:
1861 void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
1863 wxAboutDialogInfo info;
1864 info.SetName(_("My Program"));
1865 info.SetVersion(_("
1.2.3 Beta"));
1866 info.SetDescription(_("This program does something great."));
1867 info.SetCopyright(_T("(C)
2007 Me <my@email.addre.ss>"));
1873 Please see the
\helpref{dialogs sample
}{sampledialogs
} for more examples of
1874 using this function and
\helpref{wxAboutDialogInfo
}{wxaboutdialoginfo
} for the
1875 description of the information which can be shown in the about dialog.
1877 \wxheading{Include files
}
1882 \membersection{::wxBeginBusyCursor
}\label{wxbeginbusycursor
}
1884 \func{void
}{wxBeginBusyCursor
}{\param{wxCursor *
}{cursor = wxHOURGLASS
\_CURSOR}}
1886 Changes the cursor to the given cursor for all windows in the application.
1887 Use
\helpref{wxEndBusyCursor
}{wxendbusycursor
} to revert the cursor back
1888 to its previous state. These two calls can be nested, and a counter
1889 ensures that only the outer calls take effect.
1891 See also
\helpref{wxIsBusy
}{wxisbusy
},
\helpref{wxBusyCursor
}{wxbusycursor
}.
1893 \wxheading{Include files
}
1898 \membersection{::wxBell
}\label{wxbell
}
1900 \func{void
}{wxBell
}{\void}
1902 Ring the system bell.
1904 \wxheading{Include files
}
1909 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
1911 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
1912 \param{size
\_t }{currentTip
}}
1914 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
1915 used with
\helpref{wxShowTip
}{wxshowtip
}.
1917 \docparam{filename
}{The name of the file containing the tips, one per line
}
1918 \docparam{currentTip
}{The index of the first tip to show - normally this index
1919 is remembered between the
2 program runs.
}
1921 \wxheading{See also
}
1923 \helpref{Tips overview
}{tipsoverview
}
1925 \wxheading{Include files
}
1930 \membersection{::wxDirSelector
}\label{wxdirselector
}
1932 \func{wxString
}{wxDirSelector
}{\param{const wxString\&
}{message = wxDirSelectorPromptStr
},\\
1933 \param{const wxString\&
}{default
\_path = ""
},\\
1934 \param{long
}{style =
0},
\param{const wxPoint\&
}{pos = wxDefaultPosition
},\\
1935 \param{wxWindow *
}{parent = NULL
}}
1937 Pops up a directory selector dialog. The arguments have the same meaning as
1938 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1939 and the default
\_path, if specified, is set as the initial selection.
1941 The application must check for an empty return value (if the user pressed
1942 Cancel). For example:
1945 const wxString& dir = wxDirSelector("Choose a folder");
1952 \wxheading{Include files
}
1957 \membersection{::wxFileSelector
}\label{wxfileselector
}
1959 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
1960 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
1961 \param{const wxString\&
}{wildcard = "*.*"
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = NULL
},\\
1962 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
1964 Pops up a file selector box. In Windows, this is the common file selector
1965 dialog. In X, this is a file selector box with the same functionality.
1966 The path and filename are distinct elements of a full file pathname.
1967 If path is empty, the current directory will be used. If filename is empty,
1968 no default filename will be supplied. The wildcard determines what files
1969 are displayed in the file selector, and file extension supplies a type
1970 extension for the required filename. Flags may be a combination of wxOPEN,
1971 wxSAVE, wxOVERWRITE
\_PROMPT or wxFILE
\_MUST\_EXIST. Note that wxMULTIPLE
1972 can only be used with
\helpref{wxFileDialog
}{wxfiledialog
} and not here as this
1973 function only returns a single file name.
1975 Both the Unix and Windows versions implement a wildcard filter. Typing a
1976 filename containing wildcards
(*, ?) in the filename text item, and
1977 clicking on Ok, will result in only those files matching the pattern being
1980 The wildcard may be a specification for multiple types of file
1981 with a description for each, such as:
1984 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1987 The application must check for an empty return value (the user pressed
1988 Cancel). For example:
1991 wxString filename = wxFileSelector("Choose a file to open");
1992 if ( !filename.empty() )
1994 // work with the file
1997 //else: cancelled by user
2000 \wxheading{Include files}
2005 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
2007 \func{void}{wxEndBusyCursor}{\void}
2009 Changes the cursor back to the original cursor, for all windows in the application.
2010 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
2012 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
2014 \wxheading{Include files}
2019 \membersection{::wxGenericAboutBox}\label{wxgenericaboutbox}
2021 \func{void}{wxGenericAboutBox}{\param{const wxAboutDialogInfo\& }{info}}
2023 This function does the same thing as \helpref{wxAboutBox}{wxaboutbox} except
2024 that it always uses the generic wxWidgets version of the dialog instead of the
2025 native one. This is mainly useful if you need to customize the dialog by e.g.
2026 adding custom controls to it (customizing the native dialog is not currently
2029 See the \helpref{dialogs sample}{sampledialogs} for an example of about dialog
2032 \wxheading{See also}
2034 \helpref{wxAboutDialogInfo}{wxaboutdialoginfo}
2036 \wxheading{Include files}
2039 <wx/generic/aboutdlgg.h>
2042 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
2044 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
2046 Shows the colour selection dialog and returns the colour selected by user or
2047 invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour
2048 is valid) if the dialog was cancelled.
2050 \wxheading{Parameters}
2052 \docparam{parent}{The parent window for the colour selection dialog}
2054 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
2056 \docparam{caption}{If given, this will be used for the dialog caption.}
2058 \wxheading{Include files}
2063 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
2065 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
2067 Shows the font selection dialog and returns the font selected by user or
2068 invalid font (use \helpref{wxFont:IsOk}{wxfontisok} to test whether a font
2069 is valid) if the dialog was cancelled.
2071 \wxheading{Parameters}
2073 \docparam{parent}{The parent window for the font selection dialog}
2075 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
2077 \docparam{caption}{If given, this will be used for the dialog caption.}
2079 \wxheading{Include files}
2085 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
2087 \func{size\_t}{wxGetMultipleChoices}{\\
2088 \param{wxArrayInt\& }{selections},\\
2089 \param{const wxString\& }{message},\\
2090 \param{const wxString\& }{caption},\\
2091 \param{const wxArrayString\& }{aChoices},\\
2092 \param{wxWindow *}{parent = NULL},\\
2093 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2094 \param{bool}{ centre = true},\\
2095 \param{int }{width=150}, \param{int }{height=200}}
2097 \func{size\_t}{wxGetMultipleChoices}{\\
2098 \param{wxArrayInt\& }{selections},\\
2099 \param{const wxString\& }{message},\\
2100 \param{const wxString\& }{caption},\\
2101 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2102 \param{wxWindow *}{parent = NULL},\\
2103 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2104 \param{bool}{ centre = true},\\
2105 \param{int }{width=150}, \param{int }{height=200}}
2107 Pops up a dialog box containing a message, OK/Cancel buttons and a
2108 multiple-selection listbox. The user may choose an arbitrary (including 0)
2109 number of items in the listbox whose indices will be returned in
2110 {\it selection} array. The initial contents of this array will be used to
2111 select the items when the dialog is shown.
2113 You may pass the list of strings to choose from either using {\it choices}
2114 which is an array of {\it n} strings for the listbox or by using a single
2115 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2117 If {\it centre} is true, the message text (which may include new line
2118 characters) is centred; if false, the message is left-justified.
2120 \wxheading{Include files}
2124 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2125 and {\tt choices}, and no {\tt selections} parameter; the function
2126 returns an array containing the user selections.}
2129 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
2131 \func{long}{wxGetNumberFromUser}{
2132 \param{const wxString\& }{message},
2133 \param{const wxString\& }{prompt},
2134 \param{const wxString\& }{caption},
2135 \param{long }{value},
2136 \param{long }{min = 0},
2137 \param{long }{max = 100},
2138 \param{wxWindow *}{parent = NULL},
2139 \param{const wxPoint\& }{pos = wxDefaultPosition}}
2141 Shows a dialog asking the user for numeric input. The dialogs title is set to
2142 {\it caption}, it contains a (possibly) multiline {\it message} above the
2143 single line {\it prompt} and the zone for entering the number.
2145 The number entered must be in the range {\it min}..{\it max} (both of which
2146 should be positive) and {\it value} is the initial value of it. If the user
2147 enters an invalid value or cancels the dialog, the function will return -1.
2149 Dialog is centered on its {\it parent} unless an explicit position is given in
2152 \wxheading{Include files}
2157 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
2159 \func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2160 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2161 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2163 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
2164 in the dialog is not shown on screen but replaced with stars. This is intended
2165 to be used for entering passwords as the function name implies.
2167 \wxheading{Include files}
2172 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
2174 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
2175 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
2176 \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}
2178 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
2179 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
2180 or press Cancel to return the empty string.
2182 If {\it centre} is true, the message text (which may include new line characters)
2183 is centred; if false, the message is left-justified.
2185 \wxheading{Include files}
2190 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
2192 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2193 \param{int }{nsel}, \param{int *}{selection},
2194 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2195 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2197 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
2198 listbox. The user may choose one or more item(s) and press OK or Cancel.
2200 The number of initially selected choices, and array of the selected indices,
2201 are passed in; this array will contain the user selections on exit, with
2202 the function returning the number of selections. {\it selection} must be
2203 as big as the number of choices, in case all are selected.
2205 If Cancel is pressed, -1 is returned.
2207 {\it choices} is an array of {\it n} strings for the listbox.
2209 If {\it centre} is true, the message text (which may include new line characters)
2210 is centred; if false, the message is left-justified.
2212 \wxheading{Include files}
2217 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
2219 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2220 \param{const wxString\& }{caption},\\
2221 \param{const wxArrayString\& }{aChoices},\\
2222 \param{wxWindow *}{parent = NULL},\\
2223 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2224 \param{bool}{ centre = true},\\
2225 \param{int }{width=150}, \param{int }{height=200}}
2227 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
2228 \param{const wxString\& }{caption},\\
2229 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2230 \param{wxWindow *}{parent = NULL},\\
2231 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2232 \param{bool}{ centre = true},\\
2233 \param{int }{width=150}, \param{int }{height=200}}
2235 Pops up a dialog box containing a message, OK/Cancel buttons and a
2236 single-selection listbox. The user may choose an item and press OK to return a
2237 string or Cancel to return the empty string. Use
2238 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
2239 valid choice and if you want to be able to detect pressing Cancel reliably.
2241 You may pass the list of strings to choose from either using {\it choices}
2242 which is an array of {\it n} strings for the listbox or by using a single
2243 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
2245 If {\it centre} is true, the message text (which may include new line
2246 characters) is centred; if false, the message is left-justified.
2248 \wxheading{Include files}
2252 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2256 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
2258 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2259 \param{const wxString\& }{caption},\\
2260 \param{const wxArrayString\& }{aChoices},\\
2261 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2262 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2264 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
2265 \param{const wxString\& }{caption},\\
2266 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2267 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
2268 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2270 As {\bf wxGetSingleChoice} but returns the index representing the selected
2271 string. If the user pressed cancel, -1 is returned.
2273 \wxheading{Include files}
2277 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2281 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2283 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2284 \param{const wxString\& }{caption},\\
2285 \param{const wxArrayString\& }{aChoices},\\
2286 \param{const wxString\& }{client\_data[]},\\
2287 \param{wxWindow *}{parent = NULL},\\
2288 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2289 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2291 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2292 \param{const wxString\& }{caption},\\
2293 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2294 \param{const wxString\& }{client\_data[]},\\
2295 \param{wxWindow *}{parent = NULL},\\
2296 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2297 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2299 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2300 corresponding to the strings, and returns one of these pointers or NULL if
2301 Cancel was pressed. The {\it client\_data} array must have the same number of
2302 elements as {\it choices} or {\it aChoices}!
2304 \wxheading{Include files}
2308 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2309 and {\tt choices}, and the client data array must have the
2310 same length as the choices array.}
2313 \membersection{::wxIsBusy}\label{wxisbusy}
2315 \func{bool}{wxIsBusy}{\void}
2317 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2318 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2320 See also \helpref{wxBusyCursor}{wxbusycursor}.
2322 \wxheading{Include files}
2327 \membersection{::wxMessageBox}\label{wxmessagebox}
2329 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2330 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2332 General purpose message dialog. {\it style} may be a bit list of the
2333 following identifiers:
2335 \begin{twocollist}\itemsep=0pt
2336 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2338 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with
2340 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2341 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2342 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2343 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2344 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2345 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2348 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2354 int answer = wxMessageBox("Quit program?", "Confirm",
2355 wxYES_NO | wxCANCEL, main_frame);
2356 if (answer == wxYES)
2357 main_frame->Close();
2361 {\it message} may contain newline characters, in which case the
2362 message will be split into separate lines, to cater for large messages.
2364 \wxheading{Include files}
2369 \membersection{::wxShowTip}\label{wxshowtip}
2371 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2372 \param{wxTipProvider *}{tipProvider},
2373 \param{bool }{showAtStartup = true}}
2375 This function shows a "startup tip" to the user. The return value is the
2376 state of the `Show tips at startup' checkbox.
2378 \docparam{parent}{The parent window for the modal dialog}
2380 \docparam{tipProvider}{An object which is used to get the text of the tips.
2381 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2383 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2384 otherwise. This is used as the initial value for "Show tips at startup"
2385 checkbox which is shown in the tips dialog.}
2387 \wxheading{See also}
2389 \helpref{Tips overview}{tipsoverview}
2391 \wxheading{Include files}
2398 \section{Math functions}\label{mathfunctions}
2400 \wxheading{Include files}
2405 \membersection{wxFinite}\label{wxfinite}
2407 \func{int}{wxFinite}{\param{double }{x}}
2409 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2410 returns 0 otherwise.
2413 \membersection{wxIsNaN}\label{wxisnan}
2415 \func{bool}{wxIsNaN}{\param{double }{x}}
2417 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2423 \section{GDI functions}\label{gdifunctions}
2425 The following are relevant to the GDI (Graphics Device Interface).
2427 \wxheading{Include files}
2432 \membersection{wxBITMAP}\label{wxbitmapmacro}
2434 \func{}{wxBITMAP}{bitmapName}
2436 This macro loads a bitmap from either application resources (on the platforms
2437 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2438 avoid using {\tt \#ifdef}s when creating bitmaps.
2440 \wxheading{See also}
2442 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2443 \helpref{wxICON}{wxiconmacro}
2445 \wxheading{Include files}
2450 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2452 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2453 \param{int *}{width}, \param{int *}{height}}
2455 \func{wxRect}{wxGetClientDisplayRect}{\void}
2457 Returns the dimensions of the work area on the display. On Windows
2458 this means the area not covered by the taskbar, etc. Other platforms
2459 are currently defaulting to the whole display until a way is found to
2460 provide this info for all window managers, etc.
2463 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2465 \func{bool}{wxColourDisplay}{\void}
2467 Returns true if the display is colour, false otherwise.
2470 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2472 \func{int}{wxDisplayDepth}{\void}
2474 Returns the depth of the display (a value of 1 denotes a monochrome display).
2477 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2479 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2481 \func{wxSize}{wxGetDisplaySize}{\void}
2483 Returns the display size in pixels.
2486 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2488 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2490 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2492 Returns the display size in millimeters.
2495 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2497 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2499 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2500 name. Under MSW, the cursor is loaded from the resource file and the icon is
2501 loaded from XPM file under other platforms.
2503 This macro should be used with
2504 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2506 \wxheading{Include files}
2511 \membersection{wxICON}\label{wxiconmacro}
2513 \func{}{wxICON}{iconName}
2515 This macro loads an icon from either application resources (on the platforms
2516 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2517 avoid using {\tt \#ifdef}s when creating icons.
2519 \wxheading{See also}
2521 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2522 \helpref{wxBITMAP}{wxbitmapmacro}
2524 \wxheading{Include files}
2529 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2531 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2532 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2534 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2535 makes it into a placeable metafile by prepending a header containing the given
2536 bounding box. The bounding box may be obtained from a device context after drawing
2537 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2539 In addition to adding the placeable metafile header, this function adds
2540 the equivalent of the following code to the start of the metafile data:
2543 SetMapMode(dc, MM_ANISOTROPIC);
2544 SetWindowOrg(dc, minX, minY);
2545 SetWindowExt(dc, maxX - minX, maxY - minY);
2548 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2550 Placeable metafiles may be imported by many Windows applications, and can be
2551 used in RTF (Rich Text Format) files.
2553 {\it scale} allows the specification of scale for the metafile.
2555 This function is only available under Windows.
2558 \membersection{::wxSetCursor}\label{wxsetcursor}
2560 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2562 Globally sets the cursor; only has an effect in Windows and GTK.
2563 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2567 \section{Printer settings}\label{printersettings}
2569 {\bf NB:} These routines are obsolete and should no longer be used!
2571 The following functions are used to control PostScript printing. Under
2572 Windows, PostScript output can only be sent to a file.
2574 \wxheading{Include files}
2579 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2581 \func{wxString}{wxGetPrinterCommand}{\void}
2583 Gets the printer command used to print a file. The default is {\tt lpr}.
2586 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2588 \func{wxString}{wxGetPrinterFile}{\void}
2590 Gets the PostScript output filename.
2593 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2595 \func{int}{wxGetPrinterMode}{\void}
2597 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2598 The default is PS\_PREVIEW.
2601 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2603 \func{wxString}{wxGetPrinterOptions}{\void}
2605 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2608 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2610 \func{int}{wxGetPrinterOrientation}{\void}
2612 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2615 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2617 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2619 Gets the command used to view a PostScript file. The default depends on the platform.
2622 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2624 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2626 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2629 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2631 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2633 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2636 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2638 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2640 Sets the printer command used to print a file. The default is {\tt lpr}.
2643 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2645 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2647 Sets the PostScript output filename.
2650 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2652 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2654 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2655 The default is PS\_PREVIEW.
2658 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2660 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2662 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2665 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2667 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2669 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2672 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2674 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2676 Sets the command used to view a PostScript file. The default depends on the platform.
2679 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2681 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2683 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2686 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2688 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2690 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2694 \section{Clipboard functions}\label{clipsboard}
2696 These clipboard functions are implemented for Windows only. The use of these functions
2697 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2700 \wxheading{Include files}
2705 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2707 \func{bool}{wxClipboardOpen}{\void}
2709 Returns true if this application has already opened the clipboard.
2712 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2714 \func{bool}{wxCloseClipboard}{\void}
2716 Closes the clipboard to allow other applications to use it.
2719 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2721 \func{bool}{wxEmptyClipboard}{\void}
2723 Empties the clipboard.
2726 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2728 \func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}}
2730 Enumerates the formats found in a list of available formats that belong
2731 to the clipboard. Each call to this function specifies a known
2732 available format; the function returns the format that appears next in
2735 {\it dataFormat} specifies a known format. If this parameter is zero,
2736 the function returns the first format in the list.
2738 The return value specifies the next known clipboard data format if the
2739 function is successful. It is zero if the {\it dataFormat} parameter specifies
2740 the last format in the list of available formats, or if the clipboard
2743 Before it enumerates the formats function, an application must open the clipboard by using the
2744 wxOpenClipboard function.
2747 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2749 \func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}}
2751 Gets data from the clipboard.
2753 {\it dataFormat} may be one of:
2755 \begin{itemize}\itemsep=0pt
2756 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2757 \item wxCF\_BITMAP: returns a new wxBitmap.
2760 The clipboard must have previously been opened for this call to succeed.
2763 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2765 \func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}}
2767 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2768 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2771 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2773 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}}
2775 Returns true if the given data format is available on the clipboard.
2778 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2780 \func{bool}{wxOpenClipboard}{\void}
2782 Opens the clipboard for passing data to it or getting data from it.
2785 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2787 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2789 Registers the clipboard data format name and returns an identifier.
2792 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2794 \func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}}
2796 Passes data to the clipboard.
2798 {\it dataFormat} may be one of:
2800 \begin{itemize}\itemsep=0pt
2801 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2802 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2803 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2804 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2807 The clipboard must have previously been opened for this call to succeed.
2810 \section{Miscellaneous functions}\label{miscellany}
2813 \membersection{wxCONCAT}\label{wxconcat}
2815 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2817 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2820 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2822 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2824 When loading a function from a DLL you always have to cast the returned
2825 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2826 repeat this type twice if you want to declare and define a function pointer all
2829 This macro makes this slightly less painful by allowing you to specify the
2830 type only once, as the first parameter, and creating a variable of this type
2831 named after the function but with {\tt pfn} prefix and initialized with the
2832 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2835 \wxheading{Parameters}
2837 \docparam{type}{the type of the function}
2839 \docparam{name}{the name of the function to load, not a string (without quotes,
2840 it is quoted automatically by the macro)}
2842 \docparam{dynlib}{the library to load the function from}
2846 \membersection{wxEXPLICIT}\label{wxexplicit}
2848 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2849 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2850 code which might have to be compiled with an old compiler without support for
2851 this language feature but still take advantage of it when it is available.
2855 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2857 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2859 For normal keys, returns \true if the specified key is currently down.
2861 For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns
2862 \true if the key is toggled such that its LED indicator is lit. There is
2863 currently no way to test whether togglable keys are up or down.
2865 Even though there are virtual key codes defined for mouse buttons, they
2866 cannot be used with this function currently.
2868 \wxheading{Include files}
2873 \membersection{wxLL}\label{wxll}
2875 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2877 This macro is defined for the platforms with a native 64 bit integer type and
2878 allows to define 64 bit compile time constants:
2882 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2886 \wxheading{Include files}
2890 \wxheading{See also}
2892 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2895 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2897 This macro is defined to contain the {\tt printf()} format specifier using
2898 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2899 printed. Example of using it:
2903 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2904 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2908 \wxheading{See also}
2910 \helpref{wxLL}{wxll}
2912 \wxheading{Include files}
2917 \membersection{::wxNewId}\label{wxnewid}
2919 \func{long}{wxNewId}{\void}
2921 Generates an integer identifier unique to this run of the program.
2923 \wxheading{Include files}
2928 \membersection{wxON\_BLOCK\_EXIT}\label{wxonblockexit}
2930 \func{}{wxON\_BLOCK\_EXIT0}{\param{}{func}}
2931 \func{}{wxON\_BLOCK\_EXIT1}{\param{}{func}, \param{}{p1}}
2932 \func{}{wxON\_BLOCK\_EXIT2}{\param{}{func}, \param{}{p1}, \param{}{p2}}
2934 This family of macros allows to ensure that the global function \arg{func}
2935 with 0, 1, 2 or more parameters (up to some implementaton-defined limit) is
2936 executed on scope exit, whether due to a normal function return or because an
2937 exception has been thrown. A typical example of its usage:
2939 void *buf = malloc(size);
2940 wxON_BLOCK_EXIT1(free, buf);
2943 Please see the original article by Andrei Alexandrescu and Petru Marginean
2944 published in December 2000 issue of \emph{C/C++ Users Journal} for more
2947 \wxheading{Include files}
2951 \wxheading{See also}
2953 \helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}
2956 \membersection{wxON\_BLOCK\_EXIT\_OBJ}\label{wxonblockexitobj}
2958 \func{}{wxON\_BLOCK\_EXIT\_OBJ0}{\param{}{obj}, \param{}{method}}
2959 \func{}{wxON\_BLOCK\_EXIT\_OBJ1}{\param{}{obj}, \param{}{method}, \param{}{p1}}
2960 \func{}{wxON\_BLOCK\_EXIT\_OBJ2}{\param{}{obj}, \param{}{method}, \param{}{p1}, \param{}{p2}}
2962 This family of macros is similar to \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}
2963 but calls a method of the given object instead of a free function.
2965 \wxheading{Include files}
2970 \membersection{::wxRegisterId}\label{wxregisterid}
2972 \func{void}{wxRegisterId}{\param{long}{ id}}
2974 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2977 \wxheading{Include files}
2982 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2984 \func{void}{wxDDECleanUp}{\void}
2986 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
2987 called by the application.
2989 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2991 \wxheading{Include files}
2996 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2998 \func{void}{wxDDEInitialize}{\void}
3000 Initializes the DDE system. May be called multiple times without harm.
3002 This no longer needs to be called by the application: it will be called
3003 by wxWidgets if necessary.
3005 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
3006 \helpref{wxDDECleanUp}{wxddecleanup}.
3008 \wxheading{Include files}
3013 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
3015 \func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}
3017 This function enables or disables all top level windows. It is used by
3018 \helpref{::wxSafeYield}{wxsafeyield}.
3020 \wxheading{Include files}
3025 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
3027 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
3029 Find a menu item identifier associated with the given frame's menu bar.
3031 \wxheading{Include files}
3036 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
3038 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
3040 {\bf NB:} This function is obsolete, please use
3041 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
3043 Find a window by its label. Depending on the type of window, the label may be a window title
3044 or panel item label. If {\it parent} is NULL, the search will start from all top-level
3045 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3046 The search is recursive in both cases.
3048 \wxheading{Include files}
3053 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
3055 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
3057 {\bf NB:} This function is obsolete, please use
3058 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
3060 Find a window by its name (as given in a window constructor or {\bf Create} function call).
3061 If {\it parent} is NULL, the search will start from all top-level
3062 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
3063 The search is recursive in both cases.
3065 If no such named window is found, {\bf wxFindWindowByLabel} is called.
3067 \wxheading{Include files}
3072 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
3074 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
3076 Find the deepest window at the given mouse position in screen coordinates,
3077 returning the window if found, or NULL if not.
3080 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
3082 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
3084 Find the deepest window at the mouse pointer position, returning the window
3085 and current pointer position in screen coordinates.
3088 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
3090 \func{wxWindow *}{wxGetActiveWindow}{\void}
3092 Gets the currently active window (implemented for MSW and GTK only currently,
3093 always returns \NULL in the other ports).
3095 \wxheading{Include files}
3100 \membersection{::wxGetBatteryState}\label{wxgetbatterystate}
3102 \func{wxBatteryState}{wxGetBatteryState}{\void}
3104 Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
3105 \texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
3106 \texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
3107 \texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
3108 this feature is not implemented (currently everywhere but MS Windows).
3110 \wxheading{Include files}
3115 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
3117 \func{wxString}{wxGetDisplayName}{\void}
3119 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
3121 \wxheading{Include files}
3126 \membersection{::wxGetPowerType}\label{wxgetpowertype}
3128 \func{wxPowerType}{wxGetPowerType}{\void}
3130 Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
3131 \texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
3132 \texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
3133 feature is not implemented (currently everywhere but MS Windows).
3135 \wxheading{Include files}
3140 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
3142 \func{wxPoint}{wxGetMousePosition}{\void}
3144 Returns the mouse position in screen coordinates.
3146 \wxheading{Include files}
3151 \membersection{::wxGetMouseState}\label{wxgetmousestate}
3153 \func{wxMouseState}{wxGetMouseState}{\void}
3155 Returns the current state of the mouse. Returns a wxMouseState
3156 instance that contains the current position of the mouse pointer in
3157 screen coordinants, as well as boolean values indicating the up/down
3158 status of the mouse buttons and the modifier keys.
3160 \wxheading{Include files}
3164 wxMouseState has the following interface:
3185 void SetX(wxCoord x);
3186 void SetY(wxCoord y);
3188 void SetLeftDown(bool down);
3189 void SetMiddleDown(bool down);
3190 void SetRightDown(bool down);
3192 void SetControlDown(bool down);
3193 void SetShiftDown(bool down);
3194 void SetAltDown(bool down);
3195 void SetMetaDown(bool down);
3200 \membersection{::wxGetResource}\label{wxgetresource}
3202 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3203 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
3205 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3206 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
3208 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3209 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
3211 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3212 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
3214 Gets a resource value from the resource database (for example, WIN.INI, or
3215 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
3216 otherwise the specified file is used.
3218 Under X, if an application class (wxApp::GetClassName) has been defined,
3219 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
3220 an applications default file when merging all resource databases.
3222 The reason for passing the result in an argument is that it
3223 can be convenient to define a default value, which gets overridden
3224 if the value exists in the resource file. It saves a separate
3225 test for that resource's existence, and it also allows
3226 the overloading of the function for different types.
3228 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
3230 \wxheading{Include files}
3235 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
3237 \func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}}
3239 Returns label that should be used for given {\it id} element.
3241 \wxheading{Parameters}
3243 \docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.}
3245 \docparam{withCodes}{if false then strip accelerator code from the label;
3246 usefull for getting labels without accelerator char code like for toolbar tooltip or
3247 under platforms without traditional keyboard like smartphones}
3249 \docparam{accelerator}{optional accelerator string automatically added to label; useful
3250 for building labels for \helpref{wxMenuItem}{wxmenuitem}}
3252 \wxheading{Include files}
3257 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
3259 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
3261 Returns the first top level parent of the given window, or in other words, the
3262 frame or dialog containing it, or {\tt NULL}.
3264 \wxheading{Include files}
3269 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
3271 \func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}}
3273 Open the \arg{url} in user's default browser. If \arg{flags} parameter contains
3274 \texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL
3275 (currently this is only supported under Windows).
3277 Returns \true if the application was successfully launched.
3279 Note that for some configurations of the running user, the application which
3280 is launched to open the given URL may be URL-dependent (e.g. a browser may be used for
3281 local URLs while another one may be used for remote URLs).
3283 \wxheading{Include files}
3288 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
3290 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
3292 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
3293 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
3295 The resource must be defined in the {\tt .rc} file using the following syntax:
3298 myResource TEXT file.ext
3301 where {\tt file.ext} is a file that the resource compiler can find.
3303 This function is available under Windows only.
3305 \wxheading{Include files}
3310 \membersection{::wxPostDelete}\label{wxpostdelete}
3312 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
3314 Tells the system to delete the specified object when
3315 all other events have been processed. In some environments, it is
3316 necessary to use this instead of deleting a frame directly with the
3317 delete operator, because some GUIs will still send events to a deleted window.
3319 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
3321 \wxheading{Include files}
3326 \membersection{::wxPostEvent}\label{wxpostevent}
3328 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
3330 In a GUI application, this function posts {\it event} to the specified {\it dest}
3331 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
3332 Otherwise, it dispatches {\it event} immediately using
3333 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
3334 See the respective documentation for details (and caveats).
3336 \wxheading{Include files}
3341 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
3343 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
3345 Under X only, sets the current display name. This is the X host and display name such
3346 as ``colonsay:0.0", and the function indicates which display should be used for creating
3347 windows from this point on. Setting the display within an application allows multiple
3348 displays to be used.
3350 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
3352 \wxheading{Include files}
3357 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
3359 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{str}, \param{int }{flags = wxStrip\_All}}
3361 Strips any menu codes from \arg{str} and returns the result.
3363 By default, the functions strips both the mnemonics character (\texttt{'\&'})
3364 which is used to indicate a keyboard shortkey, and the accelerators, which are
3365 used only in the menu items and are separated from the main text by the
3366 \texttt{$\backslash$t} (TAB) character. By using \arg{flags} of
3367 \texttt{wxStrip\_Mnemonics} or \texttt{wxStrip\_Accel} to strip only the former
3368 or the latter part, respectively.
3370 Notice that in most cases
3371 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} or
3372 \helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} can be used instead.
3374 \wxheading{Include files}
3379 \membersection{wxSTRINGIZE}\label{wxstringize}
3381 \func{}{wxSTRINGIZE}{\param{}{x}}
3383 Returns the string representation of the given symbol which can be either a
3384 literal or a macro (hence the advantage of using this macro instead of the
3385 standard preprocessor \texttt{\#} operator which doesn't work with macros).
3387 Notice that this macro always produces a \texttt{char} string, use
3388 \helpref{wxSTRINGIZE\_T}{wxstringizet} to build a wide string Unicode build.
3390 \wxheading{See also}
3392 \helpref{wxCONCAT}{wxconcat}
3395 \membersection{wxSTRINGIZE\_T}\label{wxstringizet}
3397 \func{}{wxSTRINGIZE\_T}{\param{}{x}}
3399 Returns the string representation of the given symbol as either an ASCII or
3400 Unicode string, depending on the current build. This is the Unicode-friendly
3401 equivalent of \helpref{wxSTRINGIZE}{wxstringize}.
3404 \membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning}
3406 \func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}}
3408 GNU C++ compiler gives a warning for any class whose destructor is private
3409 unless it has a friend. This warning may sometimes be useful but it doesn't
3410 make sense for reference counted class which always delete themselves (hence
3411 destructor should be private) but don't necessarily have any friends, so this
3412 macro is provided to disable the warning in such case. The \arg{name} parameter
3413 should be the name of the class but is only used to construct a unique friend
3414 class name internally. Example of using the macro:
3420 RefCounted() { m_nRef = 1; }
3421 void IncRef() { m_nRef++ ; }
3422 void DecRef() { if ( !--m_nRef ) delete this; }
3427 wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
3431 Notice that there should be no semicolon after this macro.
3434 \membersection{wxULL}\label{wxull}
3436 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
3438 This macro is defined for the platforms with a native 64 bit integer type and
3439 allows to define unsigned 64 bit compile time constants:
3443 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
3447 \wxheading{Include files}
3451 \wxheading{See also}
3453 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
3456 \membersection{wxVaCopy}\label{wxvacopy}
3458 \func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}}
3460 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
3461 which support it or its replacement for those that don't. It must be used to
3462 preserve the value of a \texttt{va\_list} object if you need to use it after
3463 passing it to another function because it can be modified by the latter.
3465 As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
3469 \membersection{::wxWriteResource}\label{wxwriteresource}
3471 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3472 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
3474 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3475 \param{float }{value}, \param{const wxString\& }{file = NULL}}
3477 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3478 \param{long }{value}, \param{const wxString\& }{file = NULL}}
3480 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
3481 \param{int }{value}, \param{const wxString\& }{file = NULL}}
3483 Writes a resource value into the resource database (for example, WIN.INI, or
3484 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
3485 otherwise the specified file is used.
3487 Under X, the resource databases are cached until the internal function
3488 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
3489 all updated resource databases are written to their files.
3491 Note that it is considered bad manners to write to the .Xdefaults
3492 file under Unix, although the WIN.INI file is fair game under Windows.
3494 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
3496 \wxheading{Include files}
3501 \membersection{\_\_WXFUNCTION\_\_}\label{wxfunction}
3503 \func{}{\_\_WXFUNCTION\_\_}{\void}
3505 This macro expands to the name of the current function if the compiler supports
3506 any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables
3507 or macros or to \NULL if none of them is available.
3511 \section{Byte order macros}\label{byteordermacros}
3513 The endian-ness issues (that is the difference between big-endian and
3514 little-endian architectures) are important for the portable programs working
3515 with the external binary data (for example, data files or data coming from
3516 network) which is usually in some fixed, platform-independent format. The
3517 macros are helpful for transforming the data to the correct format.
3520 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3522 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3524 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3526 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3528 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3530 These macros will swap the bytes of the {\it value} variable from little
3531 endian to big endian or vice versa unconditionally, i.e. independently of the
3535 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3537 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3539 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3541 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3543 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3545 This macro will swap the bytes of the {\it value} variable from little
3546 endian to big endian or vice versa if the program is compiled on a
3547 big-endian architecture (such as Sun work stations). If the program has
3548 been compiled on a little-endian architecture, the value will be unchanged.
3550 Use these macros to read data from and write data to a file that stores
3551 data in little-endian (for example Intel i386) format.
3554 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3556 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3558 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3560 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3562 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3564 This macro will swap the bytes of the {\it value} variable from little
3565 endian to big endian or vice versa if the program is compiled on a
3566 little-endian architecture (such as Intel PCs). If the program has
3567 been compiled on a big-endian architecture, the value will be unchanged.
3569 Use these macros to read data from and write data to a file that stores
3570 data in big-endian format.
3574 \section{RTTI functions}\label{rttimacros}
3576 wxWidgets uses its own RTTI ("run-time type identification") system which
3577 predates the current standard C++ RTTI and so is kept for backwards
3578 compatibility reasons but also because it allows some things which the
3579 standard RTTI doesn't directly support (such as creating a class from its
3582 The standard C++ RTTI can be used in the user code without any problems and in
3583 general you shouldn't need to use the functions and the macros in this section
3584 unless you are thinking of modifying or adding any wxWidgets classes.
3586 \wxheading{See also}
3588 \helpref{RTTI overview}{runtimeclassoverview}
3591 \membersection{CLASSINFO}\label{classinfo}
3593 \func{wxClassInfo *}{CLASSINFO}{className}
3595 Returns a pointer to the wxClassInfo object associated with this class.
3597 \wxheading{Include files}
3602 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3604 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3606 Used inside a class declaration to declare that the class should be
3607 made known to the class hierarchy, but objects of this class cannot be created
3608 dynamically. The same as DECLARE\_CLASS.
3613 class wxCommand: public wxObject
3615 DECLARE_ABSTRACT_CLASS(wxCommand)
3624 \wxheading{Include files}
3629 \membersection{DECLARE\_APP}\label{declareapp}
3631 \func{}{DECLARE\_APP}{className}
3633 This is used in headers to create a forward declaration of the
3634 \helpref{wxGetApp}{wxgetapp} function implemented by
3635 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3636 {\tt className\& wxGetApp(void)}.
3644 \wxheading{Include files}
3649 \membersection{DECLARE\_CLASS}\label{declareclass}
3651 \func{}{DECLARE\_CLASS}{className}
3653 Used inside a class declaration to declare that the class should be
3654 made known to the class hierarchy, but objects of this class cannot be created
3655 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3657 \wxheading{Include files}
3662 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3664 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3666 Used inside a class declaration to make the class known to wxWidgets RTTI
3667 system and also declare that the objects of this class should be dynamically
3668 creatable from run-time type information. Notice that this implies that the
3669 class should have a default constructor, if this is not the case consider using
3670 \helpref{DECLARE\_CLASS}{declareclass}.
3675 class wxFrame: public wxWindow
3677 DECLARE_DYNAMIC_CLASS(wxFrame)
3680 const wxString& frameTitle;
3686 \wxheading{Include files}
3691 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3693 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3695 Used in a C++ implementation file to complete the declaration of
3696 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3701 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3703 wxCommand::wxCommand(void)
3709 \wxheading{Include files}
3714 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3716 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3718 Used in a C++ implementation file to complete the declaration of
3719 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3721 \wxheading{Include files}
3726 \membersection{IMPLEMENT\_APP}\label{implementapp}
3728 \func{}{IMPLEMENT\_APP}{className}
3730 This is used in the application class implementation file to make the application class known to
3731 wxWidgets for dynamic construction. You use this instead of
3742 IMPLEMENT_APP(MyApp)
3745 See also \helpref{DECLARE\_APP}{declareapp}.
3747 \wxheading{Include files}
3752 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3754 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3756 Used in a C++ implementation file to complete the declaration of
3757 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3759 \wxheading{Include files}
3764 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3766 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3768 Used in a C++ implementation file to complete the declaration of a
3769 class that has run-time type information and two base classes. The
3770 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3772 \wxheading{Include files}
3777 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3779 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3781 Used in a C++ implementation file to complete the declaration of
3782 a class that has run-time type information, and whose instances
3783 can be created dynamically.
3788 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3790 wxFrame::wxFrame(void)
3796 \wxheading{Include files}
3801 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3803 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3805 Used in a C++ implementation file to complete the declaration of
3806 a class that has run-time type information, and whose instances
3807 can be created dynamically. Use this for classes derived from two
3810 \wxheading{Include files}
3815 \membersection{wxConstCast}\label{wxconstcast}
3817 \func{classname *}{wxConstCast}{ptr, classname}
3819 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3820 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3822 \wxheading{See also}
3824 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3825 \helpref{wxDynamicCast}{wxdynamiccast}\\
3826 \helpref{wxStaticCast}{wxstaticcast}
3829 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3831 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3833 Creates and returns an object of the given class, if the class has been
3834 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3837 \membersection{WXDEBUG\_NEW}\label{debugnew}
3839 \func{}{WXDEBUG\_NEW}{arg}
3841 This is defined in debug mode to be call the redefined new operator
3842 with filename and line number arguments. The definition is:
3845 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3848 In non-debug mode, this is defined as the normal new operator.
3850 \wxheading{Include files}
3855 \membersection{wxDynamicCast}\label{wxdynamiccast}
3857 \func{classname *}{wxDynamicCast}{ptr, classname}
3859 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3860 the pointer is of this type (the check is done during the run-time) or
3861 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3862 wxObject::IsKindOf() function.
3864 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3870 wxWindow *win = wxWindow::FindFocus();
3871 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3874 // a text control has the focus...
3878 // no window has the focus or it is not a text control
3882 \wxheading{See also}
3884 \helpref{RTTI overview}{runtimeclassoverview}\\
3885 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3886 \helpref{wxConstCast}{wxconstcast}\\
3887 \helpref{wxStaticCast}{wxstaticcast}
3890 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3892 \func{classname *}{wxDynamicCastThis}{classname}
3894 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3895 latter provokes spurious compilation warnings from some compilers (because it
3896 tests whether {\tt this} pointer is non-{\tt NULL} which is always true), so
3897 this macro should be used to avoid them.
3899 \wxheading{See also}
3901 \helpref{wxDynamicCast}{wxdynamiccast}
3904 \membersection{wxStaticCast}\label{wxstaticcast}
3906 \func{classname *}{wxStaticCast}{ptr, classname}
3908 This macro checks that the cast is valid in debug mode (an assert failure will
3909 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3910 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3912 \wxheading{See also}
3914 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3915 \helpref{wxDynamicCast}{wxdynamiccast}\\
3916 \helpref{wxConstCast}{wxconstcast}
3919 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3921 \func{T}{wx\_const\_cast}{T, x}
3923 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3924 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3925 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3926 arguments is the same as for the standard cast.
3928 \wxheading{See also}
3930 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3931 \helpref{wx\_static\_cast}{wxstaticcastraw}
3934 \membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
3936 \func{T}{wx\_reinterpret\_cast}{T, x}
3938 Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
3939 \texttt{(T)x} for old compilers.
3941 \wxheading{See also}
3943 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3944 \helpref{wx\_static\_cast}{wxstaticcastraw}
3947 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3949 \func{T}{wx\_static\_cast}{T, x}
3951 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3952 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3953 there are no checks being done and the meaning of the macro arguments is exactly
3954 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3955 star is not appended to it.
3957 \wxheading{See also}
3959 \helpref{wx\_const\_cast}{wxconstcastraw},\\
3960 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
3961 \helpref{wx\_truncate\_cast}{wxtruncatecast}
3964 \membersection{wx\_truncate\_cast}\label{wxtruncatecast}
3966 \func{T}{wx\_truncate\_cast}{T, x}
3968 This case doesn't correspond to any standard cast but exists solely to make
3969 casts which possibly result in a truncation of an integer value more readable.
3971 \wxheading{See also}
3973 \helpref{wx\_static\_cast}{wxstaticcastraw}
3976 \section{Log functions}\label{logfunctions}
3978 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3979 further information. The functions use (implicitly) the currently active log
3980 target, so their descriptions here may not apply if the log target is not the
3981 standard one (installed by wxWidgets in the beginning of the program).
3983 \wxheading{Include files}
3988 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3990 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3992 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3993 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3995 Display a debugging message; under Windows, this will appear on the
3996 debugger command window, and under Unix, it will be written to standard
3999 The syntax is identical to {\bf printf}: pass a format string and a
4000 variable list of arguments.
4002 {\bf Tip:} under Windows, if your application crashes before the
4003 message appears in the debugging window, put a wxYield call after
4004 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
4005 (at least for Watcom C++): preformat your messages and use OutputDebugString
4008 \wxheading{Include files}
4013 \membersection{::wxError}\label{wxerror}
4015 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
4017 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
4020 Displays {\it msg} and continues. This writes to standard error under
4021 Unix, and pops up a message box under Windows. Used for internal
4022 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
4024 \wxheading{Include files}
4029 \membersection{::wxFatalError}\label{wxfatalerror}
4031 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
4033 {\bf NB:} This function is now obsolete, please use
4034 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
4036 Displays {\it msg} and exits. This writes to standard error under Unix,
4037 and pops up a message box under Windows. Used for fatal internal
4038 wxWidgets errors. See also \helpref{wxError}{wxerror}.
4040 \wxheading{Include files}
4045 \membersection{::wxLogError}\label{wxlogerror}
4047 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
4049 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4051 The functions to use for error messages, i.e. the messages that must be shown
4052 to the user. The default processing is to pop up a message box to inform the
4056 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
4058 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
4060 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4062 Like \helpref{wxLogError}{wxlogerror}, but also
4063 terminates the program with the exit code 3. Using {\it abort()} standard
4064 function also terminates the program with this exit code.
4067 \membersection{::wxLogWarning}\label{wxlogwarning}
4069 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
4071 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4073 For warnings - they are also normally shown to the user, but don't interrupt
4077 \membersection{::wxLogMessage}\label{wxlogmessage}
4079 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
4081 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4083 For all normal, informational messages. They also appear in a message box by
4084 default (but it can be changed).
4086 \membersection{::wxLogVerbose}\label{wxlogverbose}
4088 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
4090 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4092 For verbose output. Normally, it is suppressed, but
4093 might be activated if the user wishes to know more details about the program
4094 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
4097 \membersection{::wxLogStatus}\label{wxlogstatus}
4099 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
4101 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4103 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
4105 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4107 Messages logged by these functions will appear in the statusbar of the {\it
4108 frame} or of the top level application window by default (i.e. when using
4109 the second version of the functions).
4111 If the target frame doesn't have a statusbar, the message will be lost.
4114 \membersection{::wxLogSysError}\label{wxlogsyserror}
4116 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
4118 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4120 Mostly used by wxWidgets itself, but might be handy for logging errors after
4121 system call (API function) failure. It logs the specified message text as well
4122 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
4123 on the platform) and the corresponding error message. The second form
4124 of this function takes the error code explicitly as the first argument.
4126 \wxheading{See also}
4128 \helpref{wxSysErrorCode}{wxsyserrorcode},
4129 \helpref{wxSysErrorMsg}{wxsyserrormsg}
4132 \membersection{::wxLogDebug}\label{wxlogdebug}
4134 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
4136 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4138 The right functions for debug output. They only do something in debug
4139 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
4140 nothing in release mode (otherwise).
4143 \membersection{::wxLogTrace}\label{wxlogtrace}
4145 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
4147 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
4149 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
4151 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4153 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
4155 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
4157 As {\bf wxLogDebug}, trace functions only do something in debug build and
4158 expand to nothing in the release one. The reason for making
4159 it a separate function from it is that usually there are a lot of trace
4160 messages, so it might make sense to separate them from other debug messages.
4162 The trace messages also usually can be separated into different categories and
4163 the second and third versions of this function only log the message if the
4164 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
4165 allows to selectively trace only some operations and not others by changing
4166 the value of the trace mask (possible during the run-time).
4168 For the second function (taking a string mask), the message is logged only if
4169 the mask has been previously enabled by the call to
4170 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
4171 \helpref{{\tt WXTRACE} environment variable}{envvars}.
4172 The predefined string trace masks
4173 used by wxWidgets are:
4175 \begin{itemize}\itemsep=0pt
4176 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
4177 \item wxTRACE\_Messages: trace window messages/X callbacks
4178 \item wxTRACE\_ResAlloc: trace GDI resource allocation
4179 \item wxTRACE\_RefCount: trace various ref counting operations
4180 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
4183 {\bf Caveats:} since both the mask and the format string are strings,
4184 this might lead to function signature confusion in some cases:
4185 if you intend to call the format string only version of wxLogTrace,
4186 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.
4187 In this case you'll unfortunately have to avoid having two leading
4188 string parameters, e.g. by adding a bogus integer (with its \%d format string).
4190 The third version of the function only logs the message if all the bits
4191 corresponding to the {\it mask} are set in the wxLog trace mask which can be
4192 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
4193 flexible than the previous one because it doesn't allow defining the user
4194 trace masks easily - this is why it is deprecated in favour of using string
4197 \begin{itemize}\itemsep=0pt
4198 \item wxTraceMemAlloc: trace memory allocation (new/delete)
4199 \item wxTraceMessages: trace window messages/X callbacks
4200 \item wxTraceResAlloc: trace GDI resource allocation
4201 \item wxTraceRefCount: trace various ref counting operations
4202 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
4206 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
4208 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
4210 This function shows a message to the user in a safe way and should be safe to
4211 call even before the application has been initialized or if it is currently in
4212 some other strange state (for example, about to crash). Under Windows this
4213 function shows a message box using a native dialog instead of
4214 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
4215 it simply prints the message to the standard output using the title as prefix.
4217 \wxheading{Parameters}
4219 \docparam{title}{The title of the message box shown to the user or the prefix
4220 of the message string}
4222 \docparam{text}{The text to show to the user}
4224 \wxheading{See also}
4226 \helpref{wxLogFatalError}{wxlogfatalerror}
4228 \wxheading{Include files}
4233 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
4235 \func{unsigned long}{wxSysErrorCode}{\void}
4237 Returns the error code from the last system call. This function uses
4238 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
4240 \wxheading{See also}
4242 \helpref{wxSysErrorMsg}{wxsyserrormsg},
4243 \helpref{wxLogSysError}{wxlogsyserror}
4246 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
4248 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
4250 Returns the error message corresponding to the given system error code. If
4251 {\it errCode} is $0$ (default), the last error code (as returned by
4252 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
4254 \wxheading{See also}
4256 \helpref{wxSysErrorCode}{wxsyserrorcode},
4257 \helpref{wxLogSysError}{wxlogsyserror}
4260 \membersection{WXTRACE}\label{trace}
4262 \wxheading{Include files}
4266 \func{}{WXTRACE}{formatString, ...}
4268 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4270 Calls wxTrace with printf-style variable argument syntax. Output
4271 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4273 \wxheading{Include files}
4278 \membersection{WXTRACELEVEL}\label{tracelevel}
4280 \func{}{WXTRACELEVEL}{level, formatString, ...}
4282 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4284 Calls wxTraceLevel with printf-style variable argument syntax. Output
4285 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4286 The first argument should be the level at which this information is appropriate.
4287 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4290 \wxheading{Include files}
4295 \membersection{::wxTrace}\label{wxtrace}
4297 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
4299 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4301 Takes printf-style variable argument syntax. Output
4302 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4304 \wxheading{Include files}
4309 \membersection{::wxTraceLevel}\label{wxtracelevel}
4311 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
4313 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
4315 Takes printf-style variable argument syntax. Output
4316 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
4317 The first argument should be the level at which this information is appropriate.
4318 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
4321 \wxheading{Include files}
4327 \section{Time functions}\label{timefunctions}
4329 The functions in this section deal with getting the current time and
4330 starting/stopping the global timers. Please note that the timer functions are
4331 deprecated because they work with one global timer only and
4332 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
4333 should be used instead. For retrieving the current time, you may also use
4334 \helpref{wxDateTime::Now}{wxdatetimenow} or
4335 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
4338 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
4340 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
4342 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
4344 If {\it resetTimer} is true (the default), the timer is reset to zero
4347 See also \helpref{wxTimer}{wxtimer}.
4349 \wxheading{Include files}
4354 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
4356 \func{long}{wxGetLocalTime}{\void}
4358 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
4360 \wxheading{See also}
4362 \helpref{wxDateTime::Now}{wxdatetimenow}
4364 \wxheading{Include files}
4369 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
4371 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
4373 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
4375 \wxheading{See also}
4377 \helpref{wxDateTime::Now}{wxdatetimenow},\\
4378 \helpref{wxLongLong}{wxlonglong}
4380 \wxheading{Include files}
4385 \membersection{::wxGetUTCTime}\label{wxgetutctime}
4387 \func{long}{wxGetUTCTime}{\void}
4389 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
4391 \wxheading{See also}
4393 \helpref{wxDateTime::Now}{wxdatetimenow}
4395 \wxheading{Include files}
4400 \membersection{::wxMicroSleep}\label{wxmicrosleep}
4402 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
4404 Sleeps for the specified number of microseconds. The microsecond resolution may
4405 not, in fact, be available on all platforms (currently only Unix platforms with
4406 nanosleep(2) may provide it) in which case this is the same as
4407 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
4409 \wxheading{Include files}
4414 \membersection{::wxMilliSleep}\label{wxmillisleep}
4416 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
4418 Sleeps for the specified number of milliseconds. Notice that usage of this
4419 function is encouraged instead of calling usleep(3) directly because the
4420 standard usleep() function is not MT safe.
4422 \wxheading{Include files}
4427 \membersection{::wxNow}\label{wxnow}
4429 \func{wxString}{wxNow}{\void}
4431 Returns a string representing the current date and time.
4433 \wxheading{Include files}
4438 \membersection{::wxSleep}\label{wxsleep}
4440 \func{void}{wxSleep}{\param{int}{ secs}}
4442 Sleeps for the specified number of seconds.
4444 \wxheading{Include files}
4449 \membersection{::wxStartTimer}\label{wxstarttimer}
4451 \func{void}{wxStartTimer}{\void}
4453 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
4455 See also \helpref{wxTimer}{wxtimer}.
4457 \wxheading{Include files}
4462 \membersection{::wxUsleep}\label{wxusleep}
4464 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
4466 This function is deprecated because its name is misleading: notice that the
4467 argument is in milliseconds, not microseconds. Please use either
4468 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
4469 depending on the resolution you need.
4473 \section{Debugging macros and functions}\label{debugmacros}
4475 Useful macros and functions for error checking and defensive programming.
4476 wxWidgets defines three families of the assert-like macros:
4477 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
4478 (in other words, in the debug build) but disappear completely in the release
4479 build. On the other hand, the wxCHECK macros stay event in release builds but a
4480 check failure doesn't generate any user-visible effects then. Finally, the
4481 compile time assertions don't happen during the run-time but result in the
4482 compilation error messages if the condition they check fail.
4484 \wxheading{Include files}
4489 \membersection{::wxOnAssert}\label{wxonassert}
4491 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
4493 This function is called whenever one of debugging macros fails (i.e. condition
4494 is false in an assertion). It is only defined in the debug mode, in release
4495 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
4497 To override the default behaviour in the debug builds which is to show the user
4498 a dialog asking whether he wants to abort the program, continue or continue
4499 ignoring any subsequent assert failures, you may override
4500 \helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if
4501 the global application object exists.
4504 \membersection{wxASSERT}\label{wxassert}
4506 \func{}{wxASSERT}{\param{}{condition}}
4508 Assert macro. An error message will be generated if the condition is false in
4509 debug mode, but nothing will be done in the release build.
4511 Please note that the condition in wxASSERT() should have no side effects
4512 because it will not be executed in release mode at all.
4514 \wxheading{See also}
4516 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4517 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4520 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
4522 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
4524 This macro results in a
4525 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
4526 of the given type {\it type} is less than {\it size} bits.
4528 You may use it like this, for example:
4531 // we rely on the int being able to hold values up to 2^32
4532 wxASSERT_MIN_BITSIZE(int, 32);
4534 // can't work with the platforms using UTF-8 for wchar_t
4535 wxASSERT_MIN_BITSIZE(wchar_t, 16);
4539 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
4541 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
4543 Assert macro with message. An error message will be generated if the condition is false.
4545 \wxheading{See also}
4547 \helpref{wxASSERT}{wxassert},\\
4548 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
4551 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4553 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4555 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4556 specified {\it condition} is false. The compiler error message should include
4557 the {\it msg} identifier - please note that it must be a valid C++ identifier
4558 and not a string unlike in the other cases.
4560 This macro is mostly useful for testing the expressions involving the
4561 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4562 sometimes desirable to test them at the compile time.
4564 Note that this macro internally declares a struct whose name it tries to make
4565 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4566 use it on the same line in two different source files. In this case you may
4567 either change the line in which either of them appears on or use the
4568 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4570 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4571 if you use this macro with `Program Database For Edit And Continue'
4572 (\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
4573 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4575 \wxheading{See also}
4577 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4578 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4581 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4583 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4585 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4586 except that it allows you to specify a unique {\it name} for the struct
4587 internally defined by this macro to avoid getting the compilation errors
4588 described \helpref{above}{wxcompiletimeassert}.
4591 \membersection{wxFAIL}\label{wxfail}
4593 \func{}{wxFAIL}{\void}
4595 Will always generate an assert error if this code is reached (in debug mode).
4597 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4600 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4602 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4604 Will always generate an assert error with specified message if this code is reached (in debug mode).
4606 This macro is useful for marking unreachable" code areas, for example
4607 it may be used in the "default:" branch of a switch statement if all possible
4608 cases are processed above.
4610 \wxheading{See also}
4612 \helpref{wxFAIL}{wxfail}
4615 \membersection{wxCHECK}\label{wxcheck}
4617 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4619 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4620 This check is done even in release mode.
4623 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4625 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4627 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4628 This check is done even in release mode.
4630 This macro may be only used in non-void functions, see also
4631 \helpref{wxCHECK\_RET}{wxcheckret}.
4634 \membersection{wxCHECK\_RET}\label{wxcheckret}
4636 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4638 Checks that the condition is true, and returns if not (FAILs with given error
4639 message in debug mode). This check is done even in release mode.
4641 This macro should be used in void functions instead of
4642 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4645 \membersection{wxCHECK2}\label{wxcheck2}
4647 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4649 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4650 {\it operation} if it is not. This is a generalisation of
4651 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4652 returning from the function must be done when the {\it condition} is false.
4654 This check is done even in release mode.
4657 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4659 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4661 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4662 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4663 instead of wxFAIL() if the {\it condition} is false.
4666 \membersection{::wxTrap}\label{wxtrap}
4668 \func{void}{wxTrap}{\void}
4670 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4671 debugger exception meaning that the control is passed to the debugger if one is
4672 attached to the process. Otherwise the program just terminates abnormally.
4674 In release mode this function does nothing.
4676 \wxheading{Include files}
4682 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4684 \func{bool}{wxIsDebuggerRunning}{\void}
4686 Returns \true if the program is running under debugger, \false otherwise.
4688 Please note that this function is currently only implemented for Win32 and Mac
4689 builds using CodeWarrior and always returns \false elsewhere.
4694 \section{Environment access functions}\label{environfunctions}
4696 The functions in this section allow to access (get) or change value of
4697 environment variables in a portable way. They are currently implemented under
4698 Win32 and POSIX-like systems (Unix).
4700 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4702 \wxheading{Include files}
4707 \membersection{wxGetenv}\label{wxgetenvmacro}
4709 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4711 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4714 Note that under Win32 it may not return correct value for the variables set
4715 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4719 \membersection{wxGetEnv}\label{wxgetenv}
4721 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4723 Returns the current value of the environment variable {\it var} in {\it value}.
4724 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4725 and are not interested in its value.
4727 Returns \true if the variable exists, \false otherwise.
4730 \membersection{wxSetEnv}\label{wxsetenv}
4732 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4734 Sets the value of the environment variable {\it var} (adding it if necessary)
4737 Returns \true on success.
4740 \membersection{wxUnsetEnv}\label{wxunsetenv}
4742 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4744 Removes the variable {\it var} from the environment.
4745 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4748 Returns \true on success.