1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions and macros defined in wxWidgets are described here: you can
6 either look up a function using the alphabetical listing of them or find it in
7 the corresponding topic.
9 \section{Alphabetical functions and macros list
}
11 \helpref{CLASSINFO
}{classinfo
}\\
12 \helpref{copystring
}{copystring
}\\
13 \helpref{DECLARE
\_ABSTRACT\_CLASS}{declareabstractclass
}\\
14 \helpref{DECLARE
\_APP}{declareapp
}\\
15 \helpref{DECLARE
\_CLASS}{declareclass
}\\
16 \helpref{DECLARE
\_DYNAMIC\_CLASS}{declaredynamicclass
}\\
17 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS2}{implementabstractclass2
}\\
18 \helpref{IMPLEMENT
\_ABSTRACT\_CLASS}{implementabstractclass
}\\
19 \helpref{IMPLEMENT
\_APP}{implementapp
}\\
20 \helpref{IMPLEMENT
\_CLASS2}{implementclass2
}\\
21 \helpref{IMPLEMENT
\_CLASS}{implementclass
}\\
22 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS2}{implementdynamicclass2
}\\
23 \helpref{IMPLEMENT
\_DYNAMIC\_CLASS}{implementdynamicclass
}\\
24 \helpref{wxCONCAT
}{wxconcat
}\\
25 \helpref{WXDEBUG
\_NEW}{debugnew
}\\
26 \helpref{WXTRACELEVEL
}{tracelevel
}\\
27 \helpref{WXTRACE
}{trace
}\\
28 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
29 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
30 \helpref{wxASSERT
}{wxassert
}\\
31 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
32 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
33 \helpref{wxBell
}{wxbell
}\\
34 \helpref{wxCHECK
}{wxcheck
}\\
35 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
36 \helpref{wxCHECK2
}{wxcheck2
}\\
37 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
38 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
39 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
40 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
41 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
42 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
43 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
44 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
45 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
46 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
47 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
48 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
49 \helpref{wxConstCast
}{wxconstcast
}\\
50 \helpref{wxCopyFile
}{wxcopyfile
}\\
51 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
52 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
53 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}\\
54 \helpref{wxCRIT
\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember
}\\
55 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}\\
56 \helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
}\\
% wxcs already taken!
57 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
58 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
59 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
60 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
61 \helpref{wxDirExists
}{functionwxdirexists
}\\
62 \helpref{wxDirSelector
}{wxdirselector
}\\
63 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
64 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
65 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
66 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
67 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
68 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
69 \helpref{wxDYNLIB
\_FUNCTION}{wxdynlibfunction
}\\
70 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
71 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
72 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
73 \helpref{wxENTER
\_CRIT\_SECT}{wxentercritsect
}\\
74 \helpref{wxEntry
}{wxentry
}\\
75 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
76 \helpref{wxError
}{wxerror
}\\
77 \helpref{wxExecute
}{wxexecute
}\\
78 \helpref{wxExit
}{wxexit
}\\
79 \helpref{wxEXPLICIT
}{wxexplicit
}\\
80 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
81 \helpref{wxFAIL
}{wxfail
}\\
82 \helpref{wxFatalError
}{wxfatalerror
}\\
83 \helpref{wxFileExists
}{functionwxfileexists
}\\
84 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
85 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
86 \helpref{wxFileSelector
}{wxfileselector
}\\
87 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
88 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
89 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
90 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
91 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
92 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
93 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
94 \helpref{wxFinite
}{wxfinite
}\\
95 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
96 \helpref{wxGetApp
}{wxgetapp
}\\
97 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
98 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
99 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
100 \helpref{wxGetCwd
}{wxgetcwd
}\\
101 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
102 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
103 \helpref{wxGetElapsedTime
}{wxgetelapsedtime
}\\
104 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
105 \helpref{wxGetEnv
}{wxgetenv
}\\
106 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
107 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
108 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
109 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
110 \helpref{wxGetHostName
}{wxgethostname
}\\
111 \helpref{wxGetKeyState
}{wxgetkeystate
}\\
112 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
113 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
114 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
115 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
116 \helpref{wxGetMultipleChoice
}{wxgetmultiplechoice
}\\
117 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
118 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
119 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
120 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
121 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
122 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
123 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
124 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
125 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
126 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
127 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
128 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
129 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
130 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
131 \helpref{wxGetResource
}{wxgetresource
}\\
132 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
133 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
134 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
135 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
136 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
137 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
138 \helpref{wxGetTranslation
}{wxgettranslation
}\\
139 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
140 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
141 \helpref{wxGetUserId
}{wxgetuserid
}\\
142 \helpref{wxGetUserName
}{wxgetusername
}\\
143 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
144 \helpref{wxGetenv
}{wxgetenvmacro
}\\
145 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
146 \helpref{wxICON
}{wxiconmacro
}\\
147 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
148 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
149 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
150 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
151 \helpref{wxInitialize
}{wxinitialize
}\\
152 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
153 \helpref{wxIsBusy
}{wxisbusy
}\\
154 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
155 \helpref{wxIsDebuggerRunning
}{wxisdebuggerrunning
}\\
156 \helpref{wxIsEmpty
}{wxisempty
}\\
157 \helpref{wxIsMainThread
}{wxismainthread
}\\
158 \helpref{wxIsNaN
}{wxisnan
}\\
159 \helpref{wxIsWild
}{wxiswild
}\\
160 \helpref{wxKill
}{wxkill
}\\
161 \helpref{wxLEAVE
\_CRIT\_SECT}{wxleavecritsect
}\\
162 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
163 \helpref{wxLogDebug
}{wxlogdebug
}\\
164 \helpref{wxLogError
}{wxlogerror
}\\
165 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
166 \helpref{wxLogMessage
}{wxlogmessage
}\\
167 \helpref{wxLogStatus
}{wxlogstatus
}\\
168 \helpref{wxLogSysError
}{wxlogsyserror
}\\
169 \helpref{wxLogTrace
}{wxlogtrace
}\\
170 \helpref{wxLogVerbose
}{wxlogverbose
}\\
171 \helpref{wxLogWarning
}{wxlogwarning
}\\
172 \helpref{wxLL
}{wxll
}\\
173 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
174 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
175 \helpref{wxMatchWild
}{wxmatchwild
}\\
176 \helpref{wxMessageBox
}{wxmessagebox
}\\
177 \helpref{wxMilliSleep
}{wxmillisleep
}\\
178 \helpref{wxMicroSleep
}{wxmicrosleep
}\\
179 \helpref{wxMkdir
}{wxmkdir
}\\
180 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
181 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
182 \helpref{wxNewId
}{wxnewid
}\\
183 \helpref{wxNow
}{wxnow
}\\
184 \helpref{wxOnAssert
}{wxonassert
}\\
185 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
186 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
187 \helpref{wxPathOnly
}{wxpathonly
}\\
188 \helpref{wxPostDelete
}{wxpostdelete
}\\
189 \helpref{wxPostEvent
}{wxpostevent
}\\
190 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
191 \helpref{wxRegisterId
}{wxregisterid
}\\
192 \helpref{wxRemoveFile
}{wxremovefile
}\\
193 \helpref{wxRenameFile
}{wxrenamefile
}\\
194 \helpref{wxRmdir
}{wxrmdir
}\\
195 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
196 \helpref{wxSafeYield
}{wxsafeyield
}\\
197 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
198 \helpref{wxSetCursor
}{wxsetcursor
}\\
199 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
200 \helpref{wxSetEnv
}{wxsetenv
}\\
201 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
202 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
203 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
204 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
205 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
206 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
207 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
208 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
209 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
210 \helpref{wxShell
}{wxshell
}\\
211 \helpref{wxShowTip
}{wxshowtip
}\\
212 \helpref{wxShutdown
}{wxshutdown
}\\
213 \helpref{wxSleep
}{wxsleep
}\\
214 \helpref{wxSnprintf
}{wxsnprintf
}\\
215 \helpref{wxSplitPath
}{wxsplitfunction
}\\
216 \helpref{wxStartTimer
}{wxstarttimer
}\\
217 \helpref{wxStaticCast
}{wxstaticcast
}\\
218 \helpref{wxStrcmp
}{wxstrcmp
}\\
219 \helpref{wxStricmp
}{wxstricmp
}\\
220 \helpref{wxStringEq
}{wxstringeq
}\\
221 \helpref{wxStringMatch
}{wxstringmatch
}\\
222 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
223 \helpref{wxStrlen
}{wxstrlen
}\\
224 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
225 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
227 \helpref{wxTraceLevel
}{wxtracelevel
}\\
228 \helpref{wxTrace
}{wxtrace
}\\
229 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
230 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
231 \helpref{wxTrap
}{wxtrap
}\\
232 \helpref{wxULL
}{wxull
}\\
233 \helpref{wxUninitialize
}{wxuninitialize
}\\
234 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
235 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
236 \helpref{wxUsleep
}{wxusleep
}\\
237 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
238 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
239 \helpref{wxWriteResource
}{wxwriteresource
}\\
240 \helpref{wxYield
}{wxyield
}\\
241 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
242 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
243 \helpref{\_}{underscore
}\\
244 \helpref{\_T}{underscoret
}
248 \section{Version macros
}\label{versionfunctions
}
250 The following constants are defined in wxWidgets:
252 \begin{itemize
}\itemsep=
0pt
253 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
254 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
255 \item {\tt wxRELEASE
\_NUMBER} is the release number
258 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
261 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
262 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
263 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
266 \wxheading{Include files
}
268 <wx/version.h> or <wx/defs.h>
271 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
273 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
275 This is a macro which evaluates to true if the current wxWidgets version is at
276 least major.minor.release.
278 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
279 the following can be done:
283 #if wxCHECK_VERSION(
2,
2,
0)
284 if ( s.StartsWith("foo") )
285 #else // replacement code for old version
286 if ( strncmp(s, "foo",
3) ==
0 )
294 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
296 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
298 Returns $
1$ if the compiler being used to compile the code is GNU C++
299 compiler (g++) version major.minor.release or greater. Otherwise, and also if
300 the compiler is not GNU C++ at all, returns $
0$.
303 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
305 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
307 Returns $
1$ if the version of w32api headers used is major.minor.release or
308 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
309 Win32 at all, returns $
0$.
313 \section{Application initialization and termination
}\label{appinifunctions
}
315 The functions in this section are used on application startup/shutdown and also
316 to control the behaviour of the main event loop of the GUI programs.
319 \membersection{::wxEntry
}\label{wxentry
}
321 This initializes wxWidgets in a platform-dependent way. Use this if you
322 are not using the default wxWidgets entry code (e.g. main or WinMain). For example,
323 you can initialize wxWidgets from an Microsoft Foundation Classes application using
326 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
327 \param{const wxString\&
}{commandLine
},
\param{int
}{ cmdShow
},
\param{bool
}{ enterLoop = true
}}
329 wxWidgets initialization under Windows (non-DLL). If
{\it enterLoop
} is false, the
330 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets
331 message loop will be entered.
333 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
334 \param{WORD
}{ wDataSegment
},
\param{WORD
}{ wHeapSize
},
\param{const wxString\&
}{ commandLine
}}
336 wxWidgets initialization under Windows (for applications constructed as a DLL).
338 \func{int
}{wxEntry
}{\param{int
}{ argc
},
\param{const wxString\& *
}{argv
}}
340 wxWidgets initialization under Unix.
344 To clean up wxWidgets, call wxApp::OnExit followed by the static function
345 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
348 int CTheApp::ExitInstance()
350 // OnExit isn't called by CleanUp so must be called explicitly.
354 return CWinApp::ExitInstance();
358 \wxheading{Include files
}
364 \membersection{::wxGetApp
}\label{wxgetapp
}
366 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
368 This function doesn't exist in wxWidgets but it is created by using
369 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
370 anywhere but in the same module where this macro is used, you must make it
371 available using
\helpref{DECLARE
\_APP}{declareapp
}.
373 The advantage of using this function compared to directly using the global
374 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
375 allow you to access the functions specific to your application class but not
376 present in wxApp while wxGetApp() returns the object of the right type.
379 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
381 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
383 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
384 faults under Windows or segmentation violations in the Unix world) will be
385 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
386 By default, i.e. before this function is called, they will be handled in the
387 normal way which usually just means that the application will be terminated.
388 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
389 this default behaviour.
392 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
394 \func{void
}{wxInitAllImageHandlers
}{\void}
396 Initializes all available image handlers. For a list of available handlers,
397 see
\helpref{wxImage
}{wximage
}.
401 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
403 \wxheading{Include files
}
408 \membersection{::wxInitialize
}\label{wxinitialize
}
410 \func{bool
}{wxInitialize
}{\void}
412 This function is used in wxBase only and only if you don't create
413 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
414 {\tt main()
} function before calling any other wxWidgets functions.
416 If the function returns
{\tt false
} the initialization could not be performed,
417 in this case the library cannot be used and
418 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
420 This function may be called several times but
421 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
422 call to this function.
424 \wxheading{Include files
}
429 \membersection{::wxSafeYield
}\label{wxsafeyield
}
431 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
432 onlyIfNeeded = false
}}
434 This function is similar to wxYield, except that it disables the user input to
435 all program windows before calling wxYield and re-enables it again
436 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
437 allowing the implementation of some limited user interaction.
439 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
441 \wxheading{Include files
}
446 \membersection{::wxUninitialize
}\label{wxuninitialize
}
448 \func{void
}{wxUninitialize
}{\void}
450 This function is for use in console (wxBase) programs only. It must be called
451 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
453 \wxheading{Include files
}
458 \membersection{::wxYield
}\label{wxyield
}
460 \func{bool
}{wxYield
}{\void}
462 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
464 This function is kept only for backwards compatibility. Please use
465 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
467 \wxheading{Include files
}
469 <wx/app.h> or <wx/utils.h>
472 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
474 \func{void
}{wxWakeUpIdle
}{\void}
476 This functions wakes up the (internal and platform dependent) idle system, i.e. it
477 will force the system to send an idle event even if the system currently
{\it is
}
478 idle and thus would not send any idle event until after some other event would get
479 sent. This is also useful for sending events between two threads and is used by
480 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
481 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
483 \wxheading{Include files
}
489 \section{Process control functions
}\label{processfunctions
}
491 The functions in this section are used to launch or terminate the other
495 \membersection{::wxExecute
}\label{wxexecute
}
497 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
499 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
501 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
503 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
505 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
}}
507 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
508 only takes the
{\tt command
} argument,
509 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
512 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
}}
514 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
515 and it only takes the
{\tt command
} argument,
516 and returns a
3-element list
{\tt ( status, output, errors )
}, where
517 {\tt output
} and
{\tt errors
} are array references.
}
519 Executes another program in Unix or Windows.
521 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
523 The second form takes an array of values: a command, any number of
524 arguments, terminated by NULL.
526 The semantics of the third and fourth versions is different from the first two
527 and is described in more details below.
529 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
530 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
531 application waits until the other program has terminated.
533 In the case of synchronous execution, the return value is the exit code of
534 the process (which terminates by the moment the function returns) and will be
535 $-
1$ if the process couldn't be started and typically
0 if the process
536 terminated successfully. Also, while waiting for the process to
537 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. The caller
538 should ensure that this can cause no recursion, in the simplest case by
539 calling
\helpref{wxEnableTopLevelWindows(false)
}{wxenabletoplevelwindows
}.
541 For asynchronous execution, however, the return value is the process id and
542 zero value indicates that the command could not be executed. As an added
543 complication, the return value of $-
1$ in this case indicates that we didn't
544 launch a new process, but connected to the running one (this can only happen in
545 case of using DDE under Windows for command execution). In particular, in this,
546 and only this, case the calling code will not get the notification about
549 If callback isn't NULL and if execution is asynchronous,
550 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
551 the process finishes. Specifying this parameter also allows you to redirect the
552 standard input and/or output of the process being launched by calling
553 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
554 under Windows the process window is not shown by default (this avoids having to
555 flush an unnecessary console for the processes which don't create any windows
556 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
557 happening, i.e. with this flag the child process window will be shown normally.
559 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
560 that the new process is a group leader (this will create a new session if
561 needed). Calling
\helpref{wxKill
}{wxkill
} with the argument of -pid where pid
562 is the process ID of the new process will kill this process as well as all of
563 its children (except those which have started their own session).
565 Finally, you may use the third overloaded version of this function to execute
566 a process (always synchronously) and capture its output in the array
567 {\it output
}. The fourth version adds the possibility to additionally capture
568 the messages from standard error output in the
{\it errors
} array.
570 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
571 this function from another thread will result in an assert failure in debug
572 build and won't work.
576 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
578 \wxheading{Parameters
}
580 \docparam{command
}{The command to execute and any parameters to pass to it as a
583 \docparam{argv
}{The command to execute should be the first element of this
584 array, any additional ones are the command parameters and the array must be
585 terminated with a NULL pointer.
}
587 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
588 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
590 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
592 \wxheading{Include files
}
597 \membersection{::wxExit
}\label{wxexit
}
599 \func{void
}{wxExit
}{\void}
601 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
602 Should only be used in an emergency: normally the top-level frame
603 should be deleted (after deleting all other frames) to terminate the
604 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
606 \wxheading{Include files
}
611 \membersection{::wxKill
}\label{wxkill
}
613 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
}}
615 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
616 process with PID
{\it pid
}. The valid signal values are
621 wxSIGNONE =
0, // verify if the process exists under Unix
630 wxSIGKILL, // forcefully kill, dangerous!
636 wxSIGTERM // terminate the process gently
640 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
641 under both Unix and Windows but all the other signals are equivalent to
642 {\tt wxSIGTERM
} under Windows.
644 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
645 be filled with an element of
{\tt wxKillError
} enum:
650 wxKILL_OK, // no error
651 wxKILL_BAD_SIGNAL, // no such signal
652 wxKILL_ACCESS_DENIED, // permission denied
653 wxKILL_NO_PROCESS, // no such process
654 wxKILL_ERROR // another, unspecified error
660 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
661 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
662 \helpref{Exec sample
}{sampleexec
}
664 \wxheading{Include files
}
669 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
671 \func{unsigned long
}{wxGetProcessId
}{\void}
673 Returns the number uniquely identifying the current process in the system.
675 If an error occurs, $
0$ is returned.
677 \wxheading{Include files
}
682 \membersection{::wxShell
}\label{wxshell
}
684 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
686 Executes a command in an interactive shell window. If no command is
687 specified, then just the shell is spawned.
689 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
691 \wxheading{Include files
}
696 \membersection{::wxShutdown
}\label{wxshutdown
}
698 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
700 This function shuts down or reboots the computer depending on the value of the
701 {\it flags
}. Please notice that doing this requires the corresponding access
702 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privelege under Windows NT)
703 and that this function is only implemented under Unix and Win32.
705 \wxheading{Parameters
}
707 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
711 {\tt true
} on success,
{\tt false
} if an error occured.
713 \wxheading{Include files
}
719 \section{Thread functions
}\label{threadfunctions
}
721 The functions and macros here mainly exist to make it writing the code which
722 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
723 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
725 For example, a static variable must be protected against simultaneous access by
726 multiple threads in the former configuration but in the latter the extra
727 overhead of using the critical section is not needed. To solve this problem,
728 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
729 to create and use the critical section only when needed.
731 \wxheading{Include files
}
737 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
741 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
743 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
745 This macro declares a (static) critical section object named
{\it cs
} if
746 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
750 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
752 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
754 This macro declares a critical section object named
{\it cs
} if
755 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
756 include the
{\tt static
} keyword (unlike
757 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
758 a class or struct member which explains its name.
762 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
764 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
766 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
767 object named
{\it name
} and associated with the critical section
{\it cs
} if
768 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
772 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
774 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
776 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
777 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
778 section object and also the lock object associated with it. Because of this, it
779 can be only used inside a function, not at global scope. For example:
784 static int s_counter =
0;
786 wxCRITICAL_SECTION(counter);
792 (note that we suppose that the function is called the first time from the main
793 thread so that the critical section object is initialized correctly by the time
794 other threads start calling it, if this is not the case this approach can
795 {\bf not
} be used and the critical section must be made a global instead).
799 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
801 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
803 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
804 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
808 \membersection{::wxIsMainThread
}\label{wxismainthread
}
810 \func{bool
}{wxIsMainThread
}{\void}
812 Returns
{\tt true
} if this thread is the main one. Always returns
{\tt true
} if
813 {\tt wxUSE
\_THREADS} is $
0$.
817 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
819 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
821 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
822 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
826 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
828 \func{void
}{wxMutexGuiEnter
}{\void}
830 This function must be called when any thread other than the main GUI thread
831 wants to get access to the GUI library. This function will block the execution
832 of the calling thread until the main thread (or any other thread holding the
833 main GUI lock) leaves the GUI library and no other thread will enter the GUI
834 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
836 Typically, these functions are used like this:
839 void MyThread::Foo(void)
841 // before doing any GUI calls we must ensure that this thread is the only
847 my_window->DrawSomething();
853 Note that under GTK, no creation of top-level windows is allowed in any
854 thread but the main one.
856 This function is only defined on platforms which support preemptive
860 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
862 \func{void
}{wxMutexGuiLeave
}{\void}
864 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
866 This function is only defined on platforms which support preemptive
871 \section{File functions
}\label{filefunctions
}
873 \wxheading{Include files
}
879 \helpref{wxPathList
}{wxpathlist
}\\
880 \helpref{wxDir
}{wxdir
}\\
881 \helpref{wxFile
}{wxfile
}\\
882 \helpref{wxFileName
}{wxfilename
}
885 \membersection{::wxDirExists
}\label{functionwxdirexists
}
887 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
889 Returns true if the directory exists.
892 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
894 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
896 Converts a DOS to a Unix filename by replacing backslashes with forward
900 \membersection{::wxFileExists
}\label{functionwxfileexists
}
902 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
904 Returns true if the file exists and is a plain file.
907 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
909 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
911 Returns time of last modification of given file.
914 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
916 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
918 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
920 {\bf NB:
} This function is obsolete, please use
921 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
923 Returns the filename for a full path. The second form returns a pointer to
924 temporary storage that should not be deallocated.
927 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
929 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
931 This function does directory searching; returns the first file
932 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
933 get the next matching file. Neither will
report the current directory "." or the
934 parent directory "..".
936 {\it spec
} may contain wildcards.
938 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
943 wxString f = wxFindFirstFile("/home/project/*.*");
944 while ( !f.IsEmpty() )
947 f = wxFindNextFile();
952 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
954 \func{wxString
}{wxFindNextFile
}{\void}
956 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
958 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
961 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
963 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
965 This function returns the total number of bytes and number of free bytes on
966 the disk containing the directory
{\it path
} (it should exist). Both
967 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
968 information is not needed.
972 {\tt true
} on success,
{\tt false
} if an error occured (for example, the
973 directory doesn't exist).
975 \wxheading{Portability
}
977 This function is implemented for Win32,
978 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
980 This function first appeared in wxWidgets
2.3.2.
983 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
985 \func{wxString
}{wxGetOSDirectory
}{\void}
987 Returns the Windows directory under Windows; on other platforms returns the empty string.
990 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
992 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
994 Returns true if the argument is an absolute filename, i.e. with a slash
995 or drive name at the beginning.
998 \membersection{::wxPathOnly
}\label{wxpathonly
}
1000 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1002 Returns the directory part of the filename.
1005 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1007 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
1009 Converts a Unix to a DOS filename by replacing forward
1010 slashes with backslashes.
1013 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1015 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1016 \param{const wxString\&
}{file3
}}
1018 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1022 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1024 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1026 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1027 {\it overwrite
} parameter is true (default), the destination file is overwritten
1028 if it exists, but if
{\it overwrite
} is false, the functions fails in this
1032 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1034 \func{wxString
}{wxGetCwd
}{\void}
1036 Returns a string containing the current (or working) directory.
1039 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1041 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1043 {\bf NB:
} This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1045 Copies the current working directory into the buffer if supplied, or
1046 copies the working directory into new storage (which you
{\emph must
} delete
1047 yourself) if the buffer is NULL.
1049 {\it sz
} is the size of the buffer if supplied.
1052 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1054 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1056 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1058 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1059 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1060 %% is allocated for the temporary filename using {\it new}.
1062 %% Under Windows, the filename will include the drive and name of the
1063 %% directory allocated for temporary files (usually the contents of the
1064 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1066 %% It is the application's responsibility to create and delete the file.
1068 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1069 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1073 \membersection{::wxIsWild
}\label{wxiswild
}
1075 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1077 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1080 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1082 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1084 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1085 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1086 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1089 \membersection{::wxMkdir
}\label{wxmkdir
}
1091 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1093 Makes the directory
\arg{dir
}, returning true if successful.
1095 {\it perm
} is the access mask for the directory for the systems on which it is
1096 supported (Unix) and doesn't have effect for the other ones.
1099 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1101 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1103 Parses the
\arg{wildCard
}, returning the number of filters.
1104 Returns
0 if none or if there's a problem.
1105 The arrays will contain an equal number of items found before the error.
1106 On platforms where native dialogs handle only one filter per entry,
1107 entries in arrays are automatically adjusted.
1108 \arg{wildCard
} is in the form:
1110 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1113 \membersection{::wxRemoveFile}\label{wxremovefile}
1115 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1117 Removes \arg{file}, returning true if successful.
1120 \membersection{::wxRenameFile}\label{wxrenamefile}
1122 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
1124 Renames \arg{file1} to \arg{file2}, returning true if successful.
1127 \membersection{::wxRmdir}\label{wxrmdir}
1129 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1131 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1133 The {\it flags} parameter is reserved for future use.
1136 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1138 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1140 Sets the current working directory, returning true if the operation succeeded.
1141 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1144 \membersection{::wxSplitPath}\label{wxsplitfunction}
1146 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1148 {\bf NB:} This function is obsolete, please use
1149 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1151 This function splits a full file name into components: the path (including possible disk/drive
1152 specification under Windows), the base name and the extension. Any of the output parameters
1153 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1154 a particular component.
1156 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1157 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1158 is a valid character in a filename).
1160 On entry, {\it fullname} should be non-NULL (it may be empty though).
1162 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1163 contains the file name and {\it ext} contains the file extension without leading dot. All
1164 three of them may be empty if the corresponding component is. The old contents of the
1165 strings pointed to by these parameters will be overwritten in any case (if the pointers
1169 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1171 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1173 Copies the given file to {\it stream}. Useful when converting an old application to
1174 use streams (within the document/view framework, for example).
1176 \wxheading{Include files}
1181 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1183 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1185 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1186 use streams (within the document/view framework, for example).
1188 \wxheading{Include files}
1194 \section{Network, user and OS functions}\label{networkfunctions}
1196 The functions in this section are used to retrieve information about the
1197 current computer and/or user characteristics.
1200 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1202 \func{long}{wxGetFreeMemory}{\void}
1204 Returns the amount of free memory in bytes under environments which
1205 support it, and -1 if not supported. Currently, it is supported only
1206 under Windows, Linux and Solaris.
1208 \wxheading{Include files}
1213 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1215 \func{wxString}{wxGetFullHostName}{\void}
1217 Returns the FQDN (fully qualified domain host name) or an empty string on
1220 \wxheading{See also}
1222 \helpref{wxGetHostName}{wxgethostname}
1224 \wxheading{Include files}
1229 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1231 \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
1233 Copies the user's email address into the supplied buffer, by
1234 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1235 and \helpref{wxGetUserId}{wxgetuserid}.
1237 Returns true if successful, false otherwise.
1239 \wxheading{Include files}
1244 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1246 \func{wxString}{wxGetHomeDir}{\void}
1248 Return the (current) user's home directory.
1250 \wxheading{See also}
1252 \helpref{wxGetUserHome}{wxgetuserhome}
1254 \wxheading{Include files}
1259 \membersection{::wxGetHostName}\label{wxgethostname}
1261 \func{wxString}{wxGetHostName}{\void}
1263 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1265 Copies the current host machine's name into the supplied buffer. Please note
1266 that the returned name is {\it not} fully qualified, i.e. it does not include
1269 Under Windows or NT, this function first looks in the environment
1270 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1271 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1273 The first variant of this function returns the hostname if successful or an
1274 empty string otherwise. The second (deprecated) function returns true
1275 if successful, false otherwise.
1277 \wxheading{See also}
1279 \helpref{wxGetFullHostName}{wxgetfullhostname}
1281 \wxheading{Include files}
1286 \membersection{::wxGetUserId}\label{wxgetuserid}
1288 \func{wxString}{wxGetUserId}{\void}
1290 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
1292 This function returns the "user id" also known as "login name" under Unix i.e.
1293 something like "jsmith". It uniquely identifies the current user (on this system).
1295 Under Windows or NT, this function first looks in the environment
1296 variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
1297 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1299 The first variant of this function returns the login name if successful or an
1300 empty string otherwise. The second (deprecated) function returns true
1301 if successful, false otherwise.
1303 \wxheading{See also}
1305 \helpref{wxGetUserName}{wxgetusername}
1307 \wxheading{Include files}
1312 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1314 \func{wxString}{wxGetOsDescription}{\void}
1316 Returns the string containing the description of the current platform in a
1317 user-readable form. For example, this function may return strings like
1318 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1320 \wxheading{See also}
1322 \helpref{::wxGetOsVersion}{wxgetosversion}
1324 \wxheading{Include files}
1329 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1331 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1333 Gets operating system version information.
1335 \begin{twocollist}\itemsep=0pt
1336 \twocolitemruled{Platform}{Return types}
1337 \twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X.
1339 Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. }
1340 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1341 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1342 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1343 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1344 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1345 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1346 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1347 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1348 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1351 \wxheading{See also}
1353 \helpref{::wxGetOsDescription}{wxgetosdescription}
1355 \wxheading{Include files}
1360 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1362 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1364 Returns the home directory for the given user. If the username is empty
1365 (default value), this function behaves like
1366 \helpref{wxGetHomeDir}{wxgethomedir}.
1368 \wxheading{Include files}
1373 \membersection{::wxGetUserName}\label{wxgetusername}
1375 \func{wxString}{wxGetUserName}{\void}
1377 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
1379 This function returns the full user name (something like "Mr. John Smith").
1381 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
1382 in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows
1383 is running, the entry {\bf Current} in the section {\bf User} of
1384 the PENWIN.INI file is used.
1386 The first variant of this function returns the user name if successful or an
1387 empty string otherwise. The second (deprecated) function returns {\tt true}
1388 if successful, {\tt false} otherwise.
1390 \wxheading{See also}
1392 \helpref{wxGetUserId}{wxgetuserid}
1394 \wxheading{Include files}
1400 \section{String functions}
1403 \membersection{::copystring}\label{copystring}
1405 \func{char *}{copystring}{\param{const char *}{s}}
1407 Makes a copy of the string {\it s} using the C++ new operator, so it can be
1408 deleted with the {\it delete} operator.
1410 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
1413 \membersection{::wxGetTranslation}\label{wxgettranslation}
1415 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
1417 \func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}}
1419 This function returns the translation of string {\it str} in the current
1420 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
1421 message catalogs (see \helpref{internationalization overview}{internationalization}), the
1422 original string is returned. In debug build, an error message is logged -- this
1423 should help to find the strings which were not yet translated. As this function
1424 is used very often, an alternative (and also common in Unix world) syntax is
1425 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
1426 as wxGetTranslation.
1428 The second form is used when retrieving translation of string that has
1429 different singular and plural form in English or different plural forms in some
1430 other language. It takes two extra arguments: \arg{str}
1431 parameter must contain the singular form of the string to be converted.
1432 It is also used as the key for the search in the catalog.
1433 The \arg{strPlural} parameter is the plural form (in English).
1434 The parameter \arg{n} is used to determine the plural form. If no
1435 message catalog is found \arg{str} is returned if `n == 1',
1436 otherwise \arg{strPlural}.
1437 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
1439 Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}.
1441 \membersection{::wxIsEmpty}\label{wxisempty}
1443 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}
1445 Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
1446 string, {\tt false} otherwise.
1449 \membersection{::wxStrcmp}\label{wxstrcmp}
1451 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1453 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1454 to or greater than {\it p2}. The comparison is case-sensitive.
1456 This function complements the standard C function {\it stricmp()} which performs
1457 case-insensitive comparison.
1460 \membersection{::wxStricmp}\label{wxstricmp}
1462 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1464 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1465 to or greater than {\it p2}. The comparison is case-insensitive.
1467 This function complements the standard C function {\it strcmp()} which performs
1468 case-sensitive comparison.
1471 \membersection{::wxStringMatch}\label{wxstringmatch}
1473 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
1474 \param{bool}{ subString = true}, \param{bool}{ exact = false}}
1476 {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
1478 Returns {\tt true} if the substring {\it s1} is found within {\it s2},
1479 ignoring case if {\it exact} is false. If {\it subString} is {\tt false},
1480 no substring matching is done.
1483 \membersection{::wxStringEq}\label{wxstringeq}
1485 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
1487 {\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
1492 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
1496 \membersection{::wxStrlen}\label{wxstrlen}
1498 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
1500 This is a safe version of standard function {\it strlen()}: it does exactly the
1501 same thing (i.e. returns the length of the string) except that it returns 0 if
1502 {\it p} is the {\tt NULL} pointer.
1505 \membersection{::wxSnprintf}\label{wxsnprintf}
1507 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
1509 This function replaces the dangerous standard function {\tt sprintf()} and is
1510 like {\tt snprintf()} available on some platforms. The only difference with
1511 sprintf() is that an additional argument - buffer size - is taken and the
1512 buffer is never overflowed.
1514 Returns the number of characters copied to the buffer or -1 if there is not
1517 \wxheading{See also}
1519 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
1522 \membersection{wxT}\label{wxt}
1524 \func{wxChar}{wxT}{\param{char }{ch}}
1526 \func{const wxChar *}{wxT}{\param{const char *}{s}}
1528 wxT() is a macro which can be used with character and string literals (in other
1529 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
1530 Unicode build configuration. Please see the
1531 \helpref{Unicode overview}{unicode} for more information.
1533 This macro is simply returns the value passed to it without changes in ASCII
1534 build. In fact, its definition is:
1537 #define wxT(x) L ## x
1544 \membersection{wxTRANSLATE}\label{wxtranslate}
1546 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
1548 This macro doesn't do anything in the program code -- it simply expands to the
1549 value of its argument (except in Unicode build where it is equivalent to
1550 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
1551 with the same string which would be really unreadable).
1553 However it does have a purpose and it is to mark the literal strings for the
1554 extraction into the message catalog created by {\tt xgettext} program. Usually
1555 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
1556 the string for extraction but also expands into a
1557 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
1558 cannot be used in some situations, notably for static array
1561 Here is an example which should make it more clear: suppose that you have a
1562 static array of strings containing the weekday names and which have to be
1563 translated (note that it is a bad example, really, as
1564 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
1565 day names already). If you write
1568 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
1570 // use weekdays[n] as usual
1573 the code wouldn't compile because the function calls are forbidden in the array
1574 initializer. So instead you should do
1577 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
1579 // use wxGetTranslation(weekdays[n])
1584 Note that although the code {\bf would} compile if you simply omit
1585 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1586 no translations for the weekday names in the program message catalog and
1587 wxGetTranslation wouldn't find them.
1589 \membersection{::wxVsnprintf}\label{wxvsnprintf}
1591 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
1593 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
1594 argument instead of arbitrary number of parameters.
1596 \wxheading{See also}
1598 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
1602 \membersection{\_}\label{underscore}
1604 \func{const wxChar *}{\_}{\param{const char *}{s}}
1606 This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}
1607 function, so it marks the message for the extraction by {\tt xgettext} just as
1608 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
1609 the string for the current locale during execution.
1611 Don't confuse this macro with \helpref{\_T()}{underscoret}!
1614 \membersection{\_T}\label{underscoret}
1616 \func{wxChar}{\_T}{\param{char }{ch}}
1618 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
1620 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in
1621 wxWidgets simply because it may be more intuitive for Windows programmers as
1622 the standard Win32 headers also define it (as well as yet another name for the
1623 same macro which is {\tt \_TEXT()}).
1625 Don't confuse this macro with \helpref{\_()}{underscore}!
1629 \section{Dialog functions}\label{dialogfunctions}
1631 Below are a number of convenience functions for getting input from the
1632 user or displaying messages. Note that in these functions the last three
1633 parameters are optional. However, it is recommended to pass a parent frame
1634 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1635 the front when the dialog box is popped up.
1638 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1640 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1642 Changes the cursor to the given cursor for all windows in the application.
1643 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1644 to its previous state. These two calls can be nested, and a counter
1645 ensures that only the outer calls take effect.
1647 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1649 \wxheading{Include files}
1654 \membersection{::wxBell}\label{wxbell}
1656 \func{void}{wxBell}{\void}
1658 Ring the system bell.
1660 \wxheading{Include files}
1665 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
1667 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
1668 \param{size\_t }{currentTip}}
1670 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
1671 used with \helpref{wxShowTip}{wxshowtip}.
1673 \docparam{filename}{The name of the file containing the tips, one per line}
1674 \docparam{currentTip}{The index of the first tip to show - normally this index
1675 is remembered between the 2 program runs.}
1677 \wxheading{See also}
1679 \helpref{Tips overview}{tipsoverview}
1681 \wxheading{Include files}
1686 \membersection{::wxDirSelector}\label{wxdirselector}
1688 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
1689 \param{const wxString\& }{default\_path = ""},\\
1690 \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition},\\
1691 \param{wxWindow *}{parent = NULL}}
1693 Pops up a directory selector dialog. The arguments have the same meaning as
1694 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1695 and the default\_path, if specified, is set as the initial selection.
1697 The application must check for an empty return value (if the user pressed
1698 Cancel). For example:
1701 const wxString& dir = wxDirSelector("Choose a folder");
1708 \wxheading{Include files}
1713 \membersection{::wxFileSelector}\label{wxfileselector}
1715 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
1716 \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
1717 \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
1718 \param{int}{ x = -1}, \param{int}{ y = -1}}
1720 Pops up a file selector box. In Windows, this is the common file selector
1721 dialog. In X, this is a file selector box with the same functionality.
1722 The path and filename are distinct elements of a full file pathname.
1723 If path is empty, the current directory will be used. If filename is empty,
1724 no default filename will be supplied. The wildcard determines what files
1725 are displayed in the file selector, and file extension supplies a type
1726 extension for the required filename. Flags may be a combination of wxOPEN,
1727 wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
1729 Both the Unix and Windows versions implement a wildcard filter. Typing a
1730 filename containing wildcards (*, ?) in the filename text item, and
1731 clicking on Ok, will result in only those files matching the pattern being
1734 The wildcard may be a specification for multiple types of file
1735 with a description for each, such as:
1738 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1741 The application must check for an empty return value (the user pressed
1742 Cancel). For example:
1745 wxString filename = wxFileSelector("Choose a file to open");
1746 if ( !filename.empty() )
1748 // work with the file
1751 //else: cancelled by user
1754 \wxheading{Include files}
1759 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1761 \func{void}{wxEndBusyCursor}{\void}
1763 Changes the cursor back to the original cursor, for all windows in the application.
1764 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1766 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1768 \wxheading{Include files}
1773 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
1775 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
1777 Shows the colour selection dialog and returns the colour selected by user or
1778 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
1779 is valid) if the dialog was cancelled.
1781 \wxheading{Parameters}
1783 \docparam{parent}{The parent window for the colour selection dialog}
1785 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
1787 \wxheading{Include files}
1792 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
1794 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
1796 Shows the font selection dialog and returns the font selected by user or
1797 invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
1798 is valid) if the dialog was cancelled.
1800 \wxheading{Parameters}
1802 \docparam{parent}{The parent window for the font selection dialog}
1804 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
1806 \wxheading{Include files}
1812 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
1814 \func{size\_t}{wxGetMultipleChoices}{\\
1815 \param{wxArrayInt\& }{selections},\\
1816 \param{const wxString\& }{message},\\
1817 \param{const wxString\& }{caption},\\
1818 \param{const wxArrayString\& }{aChoices},\\
1819 \param{wxWindow *}{parent = NULL},\\
1820 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1821 \param{bool}{ centre = true},\\
1822 \param{int }{width=150}, \param{int }{height=200}}
1824 \func{size\_t}{wxGetMultipleChoices}{\\
1825 \param{wxArrayInt\& }{selections},\\
1826 \param{const wxString\& }{message},\\
1827 \param{const wxString\& }{caption},\\
1828 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1829 \param{wxWindow *}{parent = NULL},\\
1830 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1831 \param{bool}{ centre = true},\\
1832 \param{int }{width=150}, \param{int }{height=200}}
1834 Pops up a dialog box containing a message, OK/Cancel buttons and a
1835 multiple-selection listbox. The user may choose an arbitrary (including 0)
1836 number of items in the listbox whose indices will be returned in
1837 {\it selection} array. The initial contents of this array will be used to
1838 select the items when the dialog is shown.
1840 You may pass the list of strings to choose from either using {\it choices}
1841 which is an array of {\it n} strings for the listbox or by using a single
1842 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1844 If {\it centre} is true, the message text (which may include new line
1845 characters) is centred; if false, the message is left-justified.
1847 \wxheading{Include files}
1851 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1852 and {\tt choices}, and no {\tt selections} parameter; the function
1853 returns an array containing the user selections.}
1856 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
1858 \func{long}{wxGetNumberFromUser}{
1859 \param{const wxString\& }{message},
1860 \param{const wxString\& }{prompt},
1861 \param{const wxString\& }{caption},
1862 \param{long }{value},
1863 \param{long }{min = 0},
1864 \param{long }{max = 100},
1865 \param{wxWindow *}{parent = NULL},
1866 \param{const wxPoint\& }{pos = wxDefaultPosition}}
1868 Shows a dialog asking the user for numeric input. The dialogs title is set to
1869 {\it caption}, it contains a (possibly) multiline {\it message} above the
1870 single line {\it prompt} and the zone for entering the number.
1872 The number entered must be in the range {\it min}..{\it max} (both of which
1873 should be positive) and {\it value} is the initial value of it. If the user
1874 enters an invalid value or cancels the dialog, the function will return -1.
1876 Dialog is centered on its {\it parent} unless an explicit position is given in
1879 \wxheading{Include files}
1884 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
1886 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1887 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
1889 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
1890 in the dialog is not shown on screen but replaced with stars. This is intended
1891 to be used for entering passwords as the function name implies.
1893 \wxheading{Include files}
1898 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
1900 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1901 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
1902 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}}
1904 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
1905 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
1906 or press Cancel to return the empty string.
1908 If {\it centre} is true, the message text (which may include new line characters)
1909 is centred; if false, the message is left-justified.
1911 \wxheading{Include files}
1916 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
1918 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1919 \param{int }{nsel}, \param{int *}{selection},
1920 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1921 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1923 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
1924 listbox. The user may choose one or more item(s) and press OK or Cancel.
1926 The number of initially selected choices, and array of the selected indices,
1927 are passed in; this array will contain the user selections on exit, with
1928 the function returning the number of selections. {\it selection} must be
1929 as big as the number of choices, in case all are selected.
1931 If Cancel is pressed, -1 is returned.
1933 {\it choices} is an array of {\it n} strings for the listbox.
1935 If {\it centre} is true, the message text (which may include new line characters)
1936 is centred; if false, the message is left-justified.
1938 \wxheading{Include files}
1943 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
1945 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1946 \param{const wxString\& }{caption},\\
1947 \param{const wxArrayString\& }{aChoices},\\
1948 \param{wxWindow *}{parent = NULL},\\
1949 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1950 \param{bool}{ centre = true},\\
1951 \param{int }{width=150}, \param{int }{height=200}}
1953 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1954 \param{const wxString\& }{caption},\\
1955 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1956 \param{wxWindow *}{parent = NULL},\\
1957 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1958 \param{bool}{ centre = true},\\
1959 \param{int }{width=150}, \param{int }{height=200}}
1961 Pops up a dialog box containing a message, OK/Cancel buttons and a
1962 single-selection listbox. The user may choose an item and press OK to return a
1963 string or Cancel to return the empty string. Use
1964 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
1965 valid choice and if you want to be able to detect pressing Cancel reliably.
1967 You may pass the list of strings to choose from either using {\it choices}
1968 which is an array of {\it n} strings for the listbox or by using a single
1969 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1971 If {\it centre} is true, the message text (which may include new line
1972 characters) is centred; if false, the message is left-justified.
1974 \wxheading{Include files}
1978 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1982 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
1984 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1985 \param{const wxString\& }{caption},\\
1986 \param{const wxArrayString\& }{aChoices},\\
1987 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1988 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1990 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1991 \param{const wxString\& }{caption},\\
1992 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1993 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1994 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1996 As {\bf wxGetSingleChoice} but returns the index representing the selected
1997 string. If the user pressed cancel, -1 is returned.
1999 \wxheading{Include files}
2003 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2007 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2009 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2010 \param{const wxString\& }{caption},\\
2011 \param{const wxArrayString\& }{aChoices},\\
2012 \param{const wxString\& }{client\_data[]},\\
2013 \param{wxWindow *}{parent = NULL},\\
2014 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2015 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2017 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2018 \param{const wxString\& }{caption},\\
2019 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2020 \param{const wxString\& }{client\_data[]},\\
2021 \param{wxWindow *}{parent = NULL},\\
2022 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2023 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2025 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2026 corresponding to the strings, and returns one of these pointers or NULL if
2027 Cancel was pressed. The {\it client\_data} array must have the same number of
2028 elements as {\it choices} or {\it aChoices}!
2030 \wxheading{Include files}
2034 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2035 and {\tt choices}, and the client data array must have the
2036 same length as the choices array.}
2039 \membersection{::wxIsBusy}\label{wxisbusy}
2041 \func{bool}{wxIsBusy}{\void}
2043 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2044 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2046 See also \helpref{wxBusyCursor}{wxbusycursor}.
2048 \wxheading{Include files}
2053 \membersection{::wxMessageBox}\label{wxmessagebox}
2055 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2056 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2058 General purpose message dialog. {\it style} may be a bit list of the
2059 following identifiers:
2061 \begin{twocollist}\itemsep=0pt
2062 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2064 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
2066 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2067 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2068 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2069 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2070 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2071 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2074 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2080 int answer = wxMessageBox("Quit program?", "Confirm",
2081 wxYES_NO | wxCANCEL, main_frame);
2082 if (answer == wxYES)
2083 main_frame->Close();
2087 {\it message} may contain newline characters, in which case the
2088 message will be split into separate lines, to cater for large messages.
2090 \wxheading{Include files}
2095 \membersection{::wxShowTip}\label{wxshowtip}
2097 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2098 \param{wxTipProvider *}{tipProvider},
2099 \param{bool }{showAtStartup = true}}
2101 This function shows a "startup tip" to the user. The return value is the
2102 state of the ``Show tips at startup'' checkbox.
2104 \docparam{parent}{The parent window for the modal dialog}
2106 \docparam{tipProvider}{An object which is used to get the text of the tips.
2107 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2109 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2110 otherwise. This is used as the initial value for "Show tips at startup"
2111 checkbox which is shown in the tips dialog.}
2113 \wxheading{See also}
2115 \helpref{Tips overview}{tipsoverview}
2117 \wxheading{Include files}
2124 \section{Math functions}
2126 \wxheading{Include files}
2131 \membersection{wxFinite}\label{wxfinite}
2133 \func{int}{wxFinite}{\param{double }{x}}
2135 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2136 returns 0 otherwise.
2139 \membersection{wxIsNaN}\label{wxisnan}
2141 \func{bool}{wxIsNaN}{\param{double }{x}}
2143 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2149 \section{GDI functions}\label{gdifunctions}
2151 The following are relevant to the GDI (Graphics Device Interface).
2153 \wxheading{Include files}
2158 \membersection{wxBITMAP}\label{wxbitmapmacro}
2160 \func{}{wxBITMAP}{bitmapName}
2162 This macro loads a bitmap from either application resources (on the platforms
2163 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2164 avoid using {\tt \#ifdef}s when creating bitmaps.
2166 \wxheading{See also}
2168 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2169 \helpref{wxICON}{wxiconmacro}
2171 \wxheading{Include files}
2176 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2178 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2179 \param{int *}{width}, \param{int *}{height}}
2181 \func{wxRect}{wxGetClientDisplayRect}{\void}
2183 Returns the dimensions of the work area on the display. On Windows
2184 this means the area not covered by the taskbar, etc. Other platforms
2185 are currently defaulting to the whole display until a way is found to
2186 provide this info for all window managers, etc.
2189 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2191 \func{bool}{wxColourDisplay}{\void}
2193 Returns true if the display is colour, false otherwise.
2196 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2198 \func{int}{wxDisplayDepth}{\void}
2200 Returns the depth of the display (a value of 1 denotes a monochrome display).
2203 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2205 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2207 \func{wxSize}{wxGetDisplaySize}{\void}
2209 Returns the display size in pixels.
2212 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2214 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2216 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2218 Returns the display size in millimeters.
2221 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2223 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2225 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2226 name. Under MSW, the cursor is loaded from the resource file and the icon is
2227 loaded from XPM file under other platforms.
2229 This macro should be used with
2230 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2232 \wxheading{Include files}
2237 \membersection{wxICON}\label{wxiconmacro}
2239 \func{}{wxICON}{iconName}
2241 This macro loads an icon from either application resources (on the platforms
2242 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2243 avoid using {\tt \#ifdef}s when creating icons.
2245 \wxheading{See also}
2247 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2248 \helpref{wxBITMAP}{wxbitmapmacro}
2250 \wxheading{Include files}
2255 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2257 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2258 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2260 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2261 makes it into a placeable metafile by prepending a header containing the given
2262 bounding box. The bounding box may be obtained from a device context after drawing
2263 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2265 In addition to adding the placeable metafile header, this function adds
2266 the equivalent of the following code to the start of the metafile data:
2269 SetMapMode(dc, MM_ANISOTROPIC);
2270 SetWindowOrg(dc, minX, minY);
2271 SetWindowExt(dc, maxX - minX, maxY - minY);
2274 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2276 Placeable metafiles may be imported by many Windows applications, and can be
2277 used in RTF (Rich Text Format) files.
2279 {\it scale} allows the specification of scale for the metafile.
2281 This function is only available under Windows.
2284 \membersection{::wxSetCursor}\label{wxsetcursor}
2286 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2288 Globally sets the cursor; only has an effect in Windows and GTK.
2289 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2293 \section{Printer settings}\label{printersettings}
2295 {\bf NB:} These routines are obsolete and should no longer be used!
2297 The following functions are used to control PostScript printing. Under
2298 Windows, PostScript output can only be sent to a file.
2300 \wxheading{Include files}
2305 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2307 \func{wxString}{wxGetPrinterCommand}{\void}
2309 Gets the printer command used to print a file. The default is {\tt lpr}.
2312 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2314 \func{wxString}{wxGetPrinterFile}{\void}
2316 Gets the PostScript output filename.
2319 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2321 \func{int}{wxGetPrinterMode}{\void}
2323 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2324 The default is PS\_PREVIEW.
2327 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2329 \func{wxString}{wxGetPrinterOptions}{\void}
2331 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2334 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2336 \func{int}{wxGetPrinterOrientation}{\void}
2338 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2341 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2343 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2345 Gets the command used to view a PostScript file. The default depends on the platform.
2348 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2350 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2352 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2355 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2357 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2359 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2362 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2364 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2366 Sets the printer command used to print a file. The default is {\tt lpr}.
2369 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2371 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2373 Sets the PostScript output filename.
2376 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2378 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2380 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2381 The default is PS\_PREVIEW.
2384 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2386 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2388 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2391 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2393 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2395 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2398 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2400 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2402 Sets the command used to view a PostScript file. The default depends on the platform.
2405 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2407 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2409 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2412 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2414 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2416 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2420 \section{Clipboard functions}\label{clipsboard}
2422 These clipboard functions are implemented for Windows only. The use of these functions
2423 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2426 \wxheading{Include files}
2431 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2433 \func{bool}{wxClipboardOpen}{\void}
2435 Returns true if this application has already opened the clipboard.
2438 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2440 \func{bool}{wxCloseClipboard}{\void}
2442 Closes the clipboard to allow other applications to use it.
2445 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2447 \func{bool}{wxEmptyClipboard}{\void}
2449 Empties the clipboard.
2452 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2454 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
2456 Enumerates the formats found in a list of available formats that belong
2457 to the clipboard. Each call to this function specifies a known
2458 available format; the function returns the format that appears next in
2461 {\it dataFormat} specifies a known format. If this parameter is zero,
2462 the function returns the first format in the list.
2464 The return value specifies the next known clipboard data format if the
2465 function is successful. It is zero if the {\it dataFormat} parameter specifies
2466 the last format in the list of available formats, or if the clipboard
2469 Before it enumerates the formats function, an application must open the clipboard by using the
2470 wxOpenClipboard function.
2473 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2475 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
2477 Gets data from the clipboard.
2479 {\it dataFormat} may be one of:
2481 \begin{itemize}\itemsep=0pt
2482 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2483 \item wxCF\_BITMAP: returns a new wxBitmap.
2486 The clipboard must have previously been opened for this call to succeed.
2489 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2491 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
2493 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2494 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2497 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2499 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
2501 Returns true if the given data format is available on the clipboard.
2504 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2506 \func{bool}{wxOpenClipboard}{\void}
2508 Opens the clipboard for passing data to it or getting data from it.
2511 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2513 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2515 Registers the clipboard data format name and returns an identifier.
2518 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2520 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
2522 Passes data to the clipboard.
2524 {\it dataFormat} may be one of:
2526 \begin{itemize}\itemsep=0pt
2527 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2528 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2529 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2530 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2533 The clipboard must have previously been opened for this call to succeed.
2538 \section{Miscellaneous functions}\label{miscellany}
2541 \membersection{wxCONCAT}\label{wxconcat}
2543 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2545 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2548 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2550 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2552 When loading a function from a DLL you always have to cast the returned
2553 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2554 repeat this type twice if you want to declare and define a function pointer all
2557 This macro makes this slightly less painful by allowing you to specify the
2558 type only once, as the first parameter, and creating a variable of this type
2559 named after the function but with {\tt pfn} prefix and initialized with the
2560 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2563 \wxheading{Parameters}
2565 \docparam{type}{the type of the function}
2567 \docparam{name}{the name of the function to load, not a string (without quotes,
2568 it is quoted automatically by the macro)}
2570 \docparam{dynlib}{the library to load the function from}
2574 \membersection{wxEXPLICIT}\label{wxexplicit}
2576 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2577 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2578 code which might have to be compiled with an old compiler without support for
2579 this language feature but still take advantage of it when it is available.
2582 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2584 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2586 Returns \true if the key parameter is currently pressed on the keyboard, or
2587 with modifier keys, (caps lock, etc) if the key is active (the led light is
2590 \wxheading{Include files}
2595 \membersection{wxLL}\label{wxll}
2597 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2599 This macro is defined for the platforms with a native 64 bit integer type and
2600 allows to define 64 bit compile time constants:
2604 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2608 \wxheading{Include files}
2612 \wxheading{See also}
2614 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2617 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2619 This macro is defined to contain the {\tt printf()} format specifier using
2620 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2621 printed. Example of using it:
2625 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2626 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2630 \wxheading{See also}
2632 \helpref{wxLL}{wxll}
2634 \wxheading{Include files}
2639 \membersection{::wxNewId}\label{wxnewid}
2641 \func{long}{wxNewId}{\void}
2643 Generates an integer identifier unique to this run of the program.
2645 \wxheading{Include files}
2650 \membersection{::wxRegisterId}\label{wxregisterid}
2652 \func{void}{wxRegisterId}{\param{long}{ id}}
2654 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2657 \wxheading{Include files}
2662 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2664 \func{void}{wxDDECleanUp}{\void}
2666 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
2667 called by the application.
2669 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2671 \wxheading{Include files}
2676 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2678 \func{void}{wxDDEInitialize}{\void}
2680 Initializes the DDE system. May be called multiple times without harm.
2682 This no longer needs to be called by the application: it will be called
2683 by wxWidgets if necessary.
2685 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
2686 \helpref{wxDDECleanUp}{wxddecleanup}.
2688 \wxheading{Include files}
2693 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
2695 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
2697 This function enables or disables all top level windows. It is used by
2698 \helpref{::wxSafeYield}{wxsafeyield}.
2700 \wxheading{Include files}
2705 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
2707 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
2709 Find a menu item identifier associated with the given frame's menu bar.
2711 \wxheading{Include files}
2716 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
2718 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
2720 {\bf NB:} This function is obsolete, please use
2721 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
2723 Find a window by its label. Depending on the type of window, the label may be a window title
2724 or panel item label. If {\it parent} is NULL, the search will start from all top-level
2725 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2726 The search is recursive in both cases.
2728 \wxheading{Include files}
2733 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
2735 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
2737 {\bf NB:} This function is obsolete, please use
2738 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
2740 Find a window by its name (as given in a window constructor or {\bf Create} function call).
2741 If {\it parent} is NULL, the search will start from all top-level
2742 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2743 The search is recursive in both cases.
2745 If no such named window is found, {\bf wxFindWindowByLabel} is called.
2747 \wxheading{Include files}
2752 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
2754 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
2756 Find the deepest window at the given mouse position in screen coordinates,
2757 returning the window if found, or NULL if not.
2760 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
2762 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
2764 Find the deepest window at the mouse pointer position, returning the window
2765 and current pointer position in screen coordinates.
2768 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
2770 \func{wxWindow *}{wxGetActiveWindow}{\void}
2772 Gets the currently active window (Windows only).
2774 \wxheading{Include files}
2779 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
2781 \func{wxString}{wxGetDisplayName}{\void}
2783 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
2785 \wxheading{Include files}
2790 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
2792 \func{wxPoint}{wxGetMousePosition}{\void}
2794 Returns the mouse position in screen coordinates.
2796 \wxheading{Include files}
2801 \membersection{::wxGetResource}\label{wxgetresource}
2803 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2804 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
2806 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2807 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
2809 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2810 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
2812 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2813 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
2815 Gets a resource value from the resource database (for example, WIN.INI, or
2816 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2817 otherwise the specified file is used.
2819 Under X, if an application class (wxApp::GetClassName) has been defined,
2820 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
2821 an applications default file when merging all resource databases.
2823 The reason for passing the result in an argument is that it
2824 can be convenient to define a default value, which gets overridden
2825 if the value exists in the resource file. It saves a separate
2826 test for that resource's existence, and it also allows
2827 the overloading of the function for different types.
2829 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
2831 \wxheading{Include files}
2836 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
2838 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
2840 Returns the first top level parent of the given window, or in other words, the
2841 frame or dialog containing it, or {\tt NULL}.
2843 \wxheading{Include files}
2848 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
2850 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
2852 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
2853 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
2855 The resource must be defined in the {\tt .rc} file using the following syntax:
2858 myResource TEXT file.ext
2861 where {\tt file.ext} is a file that the resource compiler can find.
2863 This function is available under Windows only.
2865 \wxheading{Include files}
2870 \membersection{::wxPostDelete}\label{wxpostdelete}
2872 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
2874 Tells the system to delete the specified object when
2875 all other events have been processed. In some environments, it is
2876 necessary to use this instead of deleting a frame directly with the
2877 delete operator, because some GUIs will still send events to a deleted window.
2879 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
2881 \wxheading{Include files}
2886 \membersection{::wxPostEvent}\label{wxpostevent}
2888 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
2890 In a GUI application, this function posts {\it event} to the specified {\it dest}
2891 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2892 Otherwise, it dispatches {\it event} immediately using
2893 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
2894 See the respective documentation for details (and caveats).
2896 \wxheading{Include files}
2901 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
2903 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
2905 Under X only, sets the current display name. This is the X host and display name such
2906 as ``colonsay:0.0", and the function indicates which display should be used for creating
2907 windows from this point on. Setting the display within an application allows multiple
2908 displays to be used.
2910 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
2912 \wxheading{Include files}
2917 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
2919 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
2921 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
2923 {\bf NB:} This function is obsolete, please use
2924 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
2926 Strips any menu codes from {\it in} and places the result
2927 in {\it out} (or returns the new string, in the first form).
2929 Menu codes include \& (mark the next character with an underline
2930 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
2932 \wxheading{Include files}
2937 \membersection{wxULL}\label{wxull}
2939 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
2941 This macro is defined for the platforms with a native 64 bit integer type and
2942 allows to define unsigned 64 bit compile time constants:
2946 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
2950 \wxheading{Include files}
2954 \wxheading{See also}
2956 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
2959 \membersection{::wxWriteResource}\label{wxwriteresource}
2961 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2962 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
2964 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2965 \param{float }{value}, \param{const wxString\& }{file = NULL}}
2967 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2968 \param{long }{value}, \param{const wxString\& }{file = NULL}}
2970 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2971 \param{int }{value}, \param{const wxString\& }{file = NULL}}
2973 Writes a resource value into the resource database (for example, WIN.INI, or
2974 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2975 otherwise the specified file is used.
2977 Under X, the resource databases are cached until the internal function
2978 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
2979 all updated resource databases are written to their files.
2981 Note that it is considered bad manners to write to the .Xdefaults
2982 file under Unix, although the WIN.INI file is fair game under Windows.
2984 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
2986 \wxheading{Include files}
2992 \section{Byte order macros}\label{byteordermacros}
2994 The endian-ness issues (that is the difference between big-endian and
2995 little-endian architectures) are important for the portable programs working
2996 with the external binary data (for example, data files or data coming from
2997 network) which is usually in some fixed, platform-independent format. The
2998 macros are helpful for transforming the data to the correct format.
3001 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3003 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3005 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3007 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3009 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3011 These macros will swap the bytes of the {\it value} variable from little
3012 endian to big endian or vice versa unconditionally, i.e. independently of the
3016 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3018 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3020 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3022 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3024 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3026 This macro will swap the bytes of the {\it value} variable from little
3027 endian to big endian or vice versa if the program is compiled on a
3028 big-endian architecture (such as Sun work stations). If the program has
3029 been compiled on a little-endian architecture, the value will be unchanged.
3031 Use these macros to read data from and write data to a file that stores
3032 data in little-endian (for example Intel i386) format.
3035 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3037 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3039 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3041 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3043 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3045 This macro will swap the bytes of the {\it value} variable from little
3046 endian to big endian or vice versa if the program is compiled on a
3047 little-endian architecture (such as Intel PCs). If the program has
3048 been compiled on a big-endian architecture, the value will be unchanged.
3050 Use these macros to read data from and write data to a file that stores
3051 data in big-endian format.
3055 \section{RTTI functions}\label{rttimacros}
3057 wxWidgets uses its own RTTI ("run-time type identification") system which
3058 predates the current standard C++ RTTI and so is kept for backwards
3059 compatibility reasons but also because it allows some things which the
3060 standard RTTI doesn't directly support (such as creating a class from its
3063 The standard C++ RTTI can be used in the user code without any problems and in
3064 general you shouldn't need to use the functions and the macros in this section
3065 unless you are thinking of modifying or adding any wxWidgets classes.
3067 \wxheading{See also}
3069 \helpref{RTTI overview}{runtimeclassoverview}
3072 \membersection{CLASSINFO}\label{classinfo}
3074 \func{wxClassInfo *}{CLASSINFO}{className}
3076 Returns a pointer to the wxClassInfo object associated with this class.
3078 \wxheading{Include files}
3083 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3085 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3087 Used inside a class declaration to declare that the class should be
3088 made known to the class hierarchy, but objects of this class cannot be created
3089 dynamically. The same as DECLARE\_CLASS.
3094 class wxCommand: public wxObject
3096 DECLARE_ABSTRACT_CLASS(wxCommand)
3105 \wxheading{Include files}
3110 \membersection{DECLARE\_APP}\label{declareapp}
3112 \func{}{DECLARE\_APP}{className}
3114 This is used in headers to create a forward declaration of the
3115 \helpref{wxGetApp}{wxgetapp} function implemented by
3116 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3117 {\tt className\& wxGetApp(void)}.
3125 \wxheading{Include files}
3130 \membersection{DECLARE\_CLASS}\label{declareclass}
3132 \func{}{DECLARE\_CLASS}{className}
3134 Used inside a class declaration to declare that the class should be
3135 made known to the class hierarchy, but objects of this class cannot be created
3136 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3138 \wxheading{Include files}
3143 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3145 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3147 Used inside a class declaration to declare that the objects of this class should be dynamically
3148 creatable from run-time type information.
3153 class wxFrame: public wxWindow
3155 DECLARE_DYNAMIC_CLASS(wxFrame)
3158 const wxString& frameTitle;
3164 \wxheading{Include files}
3169 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3171 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3173 Used in a C++ implementation file to complete the declaration of
3174 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3179 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3181 wxCommand::wxCommand(void)
3187 \wxheading{Include files}
3192 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3194 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3196 Used in a C++ implementation file to complete the declaration of
3197 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3199 \wxheading{Include files}
3204 \membersection{IMPLEMENT\_APP}\label{implementapp}
3206 \func{}{IMPLEMENT\_APP}{className}
3208 This is used in the application class implementation file to make the application class known to
3209 wxWidgets for dynamic construction. You use this instead of
3220 IMPLEMENT_APP(MyApp)
3223 See also \helpref{DECLARE\_APP}{declareapp}.
3225 \wxheading{Include files}
3230 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3232 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3234 Used in a C++ implementation file to complete the declaration of
3235 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3237 \wxheading{Include files}
3242 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3244 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3246 Used in a C++ implementation file to complete the declaration of a
3247 class that has run-time type information and two base classes. The
3248 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3250 \wxheading{Include files}
3255 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3257 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3259 Used in a C++ implementation file to complete the declaration of
3260 a class that has run-time type information, and whose instances
3261 can be created dynamically.
3266 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3268 wxFrame::wxFrame(void)
3274 \wxheading{Include files}
3279 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3281 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3283 Used in a C++ implementation file to complete the declaration of
3284 a class that has run-time type information, and whose instances
3285 can be created dynamically. Use this for classes derived from two
3288 \wxheading{Include files}
3293 \membersection{wxConstCast}\label{wxconstcast}
3295 \func{classname *}{wxConstCast}{ptr, classname}
3297 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3298 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3300 \wxheading{See also}
3302 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3303 \helpref{wxDynamicCast}{wxdynamiccast}\\
3304 \helpref{wxStaticCast}{wxstaticcast}
3307 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3309 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3311 Creates and returns an object of the given class, if the class has been
3312 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3315 \membersection{WXDEBUG\_NEW}\label{debugnew}
3317 \func{}{WXDEBUG\_NEW}{arg}
3319 This is defined in debug mode to be call the redefined new operator
3320 with filename and line number arguments. The definition is:
3323 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3326 In non-debug mode, this is defined as the normal new operator.
3328 \wxheading{Include files}
3333 \membersection{wxDynamicCast}\label{wxdynamiccast}
3335 \func{classname *}{wxDynamicCast}{ptr, classname}
3337 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3338 the pointer is of this type (the check is done during the run-time) or
3339 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3340 wxObject::IsKindOf() function.
3342 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3348 wxWindow *win = wxWindow::FindFocus();
3349 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3352 // a text control has the focus...
3356 // no window has the focus or it is not a text control
3360 \wxheading{See also}
3362 \helpref{RTTI overview}{runtimeclassoverview}\\
3363 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3364 \helpref{wxConstCast}{wxconstcast}\\
3365 \helpref{wxStatiicCast}{wxstaticcast}
3368 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3370 \func{classname *}{wxDynamicCastThis}{classname}
3372 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3373 latter provokes spurious compilation warnings from some compilers (because it
3374 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
3375 this macro should be used to avoid them.
3377 \wxheading{See also}
3379 \helpref{wxDynamicCast}{wxdynamiccast}
3382 \membersection{wxStaticCast}\label{wxstaticcast}
3384 \func{classname *}{wxStaticCast}{ptr, classname}
3386 This macro checks that the cast is valid in debug mode (an assert failure will
3387 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3388 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3390 \wxheading{See also}
3392 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3393 \helpref{wxDynamicCast}{wxdynamiccast}\\
3394 \helpref{wxConstCast}{wxconstcast}
3397 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3399 \func{T}{wx\_const\_cast}{T, x}
3401 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3402 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3403 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3404 arguments is the same as for the standard cast.
3406 \wxheading{See also}
3408 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3411 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3413 \func{T}{wx\_static\_cast}{T, x}
3415 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3416 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3417 there are no checks being done and the meaning of the macro arguments is exactly
3418 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3419 star is not appended to it.
3421 \wxheading{See also}
3423 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3427 \section{Log functions}\label{logfunctions}
3429 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3430 further information. The functions use (implicitly) the currently active log
3431 target, so their descriptions here may not apply if the log target is not the
3432 standard one (installed by wxWidgets in the beginning of the program).
3434 \wxheading{Include files}
3439 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3441 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3443 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3444 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3446 Display a debugging message; under Windows, this will appear on the
3447 debugger command window, and under Unix, it will be written to standard
3450 The syntax is identical to {\bf printf}: pass a format string and a
3451 variable list of arguments.
3453 {\bf Tip:} under Windows, if your application crashes before the
3454 message appears in the debugging window, put a wxYield call after
3455 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3456 (at least for Watcom C++): preformat your messages and use OutputDebugString
3459 \wxheading{Include files}
3464 \membersection{::wxError}\label{wxerror}
3466 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
3468 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3471 Displays {\it msg} and continues. This writes to standard error under
3472 Unix, and pops up a message box under Windows. Used for internal
3473 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
3475 \wxheading{Include files}
3480 \membersection{::wxFatalError}\label{wxfatalerror}
3482 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
3484 {\bf NB:} This function is now obsolete, please use
3485 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3487 Displays {\it msg} and exits. This writes to standard error under Unix,
3488 and pops up a message box under Windows. Used for fatal internal
3489 wxWidgets errors. See also \helpref{wxError}{wxerror}.
3491 \wxheading{Include files}
3496 \membersection{::wxLogError}\label{wxlogerror}
3498 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
3500 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3502 The functions to use for error messages, i.e. the messages that must be shown
3503 to the user. The default processing is to pop up a message box to inform the
3507 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
3509 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
3511 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3513 Like \helpref{wxLogError}{wxlogerror}, but also
3514 terminates the program with the exit code 3. Using {\it abort()} standard
3515 function also terminates the program with this exit code.
3518 \membersection{::wxLogWarning}\label{wxlogwarning}
3520 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
3522 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3524 For warnings - they are also normally shown to the user, but don't interrupt
3528 \membersection{::wxLogMessage}\label{wxlogmessage}
3530 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
3532 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3534 For all normal, informational messages. They also appear in a message box by
3535 default (but it can be changed). Notice that the standard behaviour is to not
3536 show informational messages if there are any errors later - the logic being
3537 that the later error messages make the informational messages preceding them
3541 \membersection{::wxLogVerbose}\label{wxlogverbose}
3543 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
3545 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3547 For verbose output. Normally, it is suppressed, but
3548 might be activated if the user wishes to know more details about the program
3549 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
3552 \membersection{::wxLogStatus}\label{wxlogstatus}
3554 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
3556 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3558 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
3560 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3562 Messages logged by these functions will appear in the statusbar of the {\it
3563 frame} or of the top level application window by default (i.e. when using
3564 the second version of the functions).
3566 If the target frame doesn't have a statusbar, the message will be lost.
3569 \membersection{::wxLogSysError}\label{wxlogsyserror}
3571 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
3573 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3575 Mostly used by wxWidgets itself, but might be handy for logging errors after
3576 system call (API function) failure. It logs the specified message text as well
3577 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
3578 on the platform) and the corresponding error message. The second form
3579 of this function takes the error code explicitly as the first argument.
3581 \wxheading{See also}
3583 \helpref{wxSysErrorCode}{wxsyserrorcode},
3584 \helpref{wxSysErrorMsg}{wxsyserrormsg}
3587 \membersection{::wxLogDebug}\label{wxlogdebug}
3589 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
3591 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3593 The right functions for debug output. They only do something in debug
3594 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
3595 nothing in release mode (otherwise).
3598 \membersection{::wxLogTrace}\label{wxlogtrace}
3600 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
3602 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3604 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
3606 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3608 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
3610 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3612 As {\bf wxLogDebug}, trace functions only do something in debug build and
3613 expand to nothing in the release one. The reason for making
3614 it a separate function from it is that usually there are a lot of trace
3615 messages, so it might make sense to separate them from other debug messages.
3617 The trace messages also usually can be separated into different categories and
3618 the second and third versions of this function only log the message if the
3619 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
3620 allows to selectively trace only some operations and not others by changing
3621 the value of the trace mask (possible during the run-time).
3623 For the second function (taking a string mask), the message is logged only if
3624 the mask has been previously enabled by the call to
3625 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
3626 \helpref{{\tt WXTRACE} environment variable}{envvars}.
3627 The predefined string trace masks
3628 used by wxWidgets are:
3630 \begin{itemize}\itemsep=0pt
3631 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
3632 \item wxTRACE\_Messages: trace window messages/X callbacks
3633 \item wxTRACE\_ResAlloc: trace GDI resource allocation
3634 \item wxTRACE\_RefCount: trace various ref counting operations
3635 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
3638 The third version of the function only logs the message if all the bit
3639 corresponding to the {\it mask} are set in the wxLog trace mask which can be
3640 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
3641 flexible than the previous one because it doesn't allow defining the user
3642 trace masks easily - this is why it is deprecated in favour of using string
3645 \begin{itemize}\itemsep=0pt
3646 \item wxTraceMemAlloc: trace memory allocation (new/delete)
3647 \item wxTraceMessages: trace window messages/X callbacks
3648 \item wxTraceResAlloc: trace GDI resource allocation
3649 \item wxTraceRefCount: trace various ref counting operations
3650 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
3654 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
3656 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
3658 This function shows a message to the user in a safe way and should be safe to
3659 call even before the application has been initialized or if it is currently in
3660 some other strange state (for example, about to crash). Under Windows this
3661 function shows a message box using a native dialog instead of
3662 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
3663 it simply prints the message to the standard output using the title as prefix.
3665 \wxheading{Parameters}
3667 \docparam{title}{The title of the message box shown to the user or the prefix
3668 of the message string}
3670 \docparam{text}{The text to show to the user}
3672 \wxheading{See also}
3674 \helpref{wxLogFatalError}{wxlogfatalerror}
3676 \wxheading{Include files}
3681 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
3683 \func{unsigned long}{wxSysErrorCode}{\void}
3685 Returns the error code from the last system call. This function uses
3686 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
3688 \wxheading{See also}
3690 \helpref{wxSysErrorMsg}{wxsyserrormsg},
3691 \helpref{wxLogSysError}{wxlogsyserror}
3694 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
3696 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
3698 Returns the error message corresponding to the given system error code. If
3699 {\it errCode} is $0$ (default), the last error code (as returned by
3700 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
3702 \wxheading{See also}
3704 \helpref{wxSysErrorCode}{wxsyserrorcode},
3705 \helpref{wxLogSysError}{wxlogsyserror}
3708 \membersection{WXTRACE}\label{trace}
3710 \wxheading{Include files}
3714 \func{}{WXTRACE}{formatString, ...}
3716 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3718 Calls wxTrace with printf-style variable argument syntax. Output
3719 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3721 \wxheading{Include files}
3726 \membersection{WXTRACELEVEL}\label{tracelevel}
3728 \func{}{WXTRACELEVEL}{level, formatString, ...}
3730 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3732 Calls wxTraceLevel with printf-style variable argument syntax. Output
3733 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3734 The first argument should be the level at which this information is appropriate.
3735 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3738 \wxheading{Include files}
3743 \membersection{::wxTrace}\label{wxtrace}
3745 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
3747 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3749 Takes printf-style variable argument syntax. Output
3750 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3752 \wxheading{Include files}
3757 \membersection{::wxTraceLevel}\label{wxtracelevel}
3759 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
3761 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3763 Takes printf-style variable argument syntax. Output
3764 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3765 The first argument should be the level at which this information is appropriate.
3766 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3769 \wxheading{Include files}
3775 \section{Time functions}\label{timefunctions}
3777 The functions in this section deal with getting the current time and
3778 starting/stopping the global timers. Please note that the timer functions are
3779 deprecated because they work with one global timer only and
3780 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
3781 should be used instead. For retrieving the current time, you may also use
3782 \helpref{wxDateTime::Now}{wxdatetimenow} or
3783 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
3786 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
3788 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
3790 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
3792 If {\it resetTimer} is true (the default), the timer is reset to zero
3795 See also \helpref{wxTimer}{wxtimer}.
3797 \wxheading{Include files}
3802 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
3804 \func{long}{wxGetLocalTime}{\void}
3806 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
3808 \wxheading{See also}
3810 \helpref{wxDateTime::Now}{wxdatetimenow}
3812 \wxheading{Include files}
3817 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
3819 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
3821 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
3823 \wxheading{See also}
3825 \helpref{wxDateTime::Now}{wxdatetimenow},\\
3826 \helpref{wxLongLong}{wxlonglong}
3828 \wxheading{Include files}
3833 \membersection{::wxGetUTCTime}\label{wxgetutctime}
3835 \func{long}{wxGetUTCTime}{\void}
3837 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
3839 \wxheading{See also}
3841 \helpref{wxDateTime::Now}{wxdatetimenow}
3843 \wxheading{Include files}
3848 \membersection{::wxMicroSleep}\label{wxmicrosleep}
3850 \func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
3852 Sleeps for the specified number of microseconds. The microsecond resolution may
3853 not, in fact, be available on all platforms (currently only Unix platforms with
3854 nanosleep(2) may provide it) in which case this is the same as
3855 \helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
3857 \wxheading{Include files}
3862 \membersection{::wxMilliSleep}\label{wxmillisleep}
3864 \func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}}
3866 Sleeps for the specified number of milliseconds. Notice that usage of this
3867 function is encouraged instead of calling usleep(3) directly because the
3868 standard usleep() function is not MT safe.
3870 \wxheading{Include files}
3875 \membersection{::wxNow}\label{wxnow}
3877 \func{wxString}{wxNow}{\void}
3879 Returns a string representing the current date and time.
3881 \wxheading{Include files}
3886 \membersection{::wxSleep}\label{wxsleep}
3888 \func{void}{wxSleep}{\param{int}{ secs}}
3890 Sleeps for the specified number of seconds.
3892 \wxheading{Include files}
3897 \membersection{::wxStartTimer}\label{wxstarttimer}
3899 \func{void}{wxStartTimer}{\void}
3901 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
3903 See also \helpref{wxTimer}{wxtimer}.
3905 \wxheading{Include files}
3910 \membersection{::wxUsleep}\label{wxusleep}
3912 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
3914 This function is deprecated because its name is misleading: notice that the
3915 argument is in milliseconds, not microseconds. Please use either
3916 \helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
3917 depending on the resolution you need.
3921 \section{Debugging macros and functions}\label{debugmacros}
3923 Useful macros and functions for error checking and defensive programming.
3924 wxWidgets defines three families of the assert-like macros:
3925 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
3926 (in other words, in the debug build) but disappear completely in the release
3927 build. On the other hand, the wxCHECK macros stay event in release builds but a
3928 check failure doesn't generate any user-visible effects then. Finally, the
3929 compile time assertions don't happen during the run-time but result in the
3930 compilation error messages if the condition they check fail.
3932 \wxheading{Include files}
3937 \membersection{::wxOnAssert}\label{wxonassert}
3939 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
3941 This function is called whenever one of debugging macros fails (i.e. condition
3942 is false in an assertion). It is only defined in the debug mode, in release
3943 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
3945 To override the default behaviour in the debug builds which is to show the user
3946 a dialog asking whether he wants to abort the program, continue or continue
3947 ignoring any subsequent assert failures, you may override
3948 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
3949 the global application object exists.
3952 \membersection{wxASSERT}\label{wxassert}
3954 \func{}{wxASSERT}{\param{}{condition}}
3956 Assert macro. An error message will be generated if the condition is false in
3957 debug mode, but nothing will be done in the release build.
3959 Please note that the condition in wxASSERT() should have no side effects
3960 because it will not be executed in release mode at all.
3962 \wxheading{See also}
3964 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
3965 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3968 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
3970 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
3972 This macro results in a
3973 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
3974 of the given type {\it type} is less than {\it size} bits.
3976 You may use it like this, for example:
3979 // we rely on the int being able to hold values up to 2^32
3980 wxASSERT_MIN_BITSIZE(int, 32);
3982 // can't work with the platforms using UTF-8 for wchar_t
3983 wxASSERT_MIN_BITSIZE(wchar_t, 16);
3987 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
3989 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
3991 Assert macro with message. An error message will be generated if the condition is false.
3993 \wxheading{See also}
3995 \helpref{wxASSERT}{wxassert},\\
3996 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3999 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
4001 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
4003 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
4004 specified {\it condition} is false. The compiler error message should include
4005 the {\it msg} identifier - please note that it must be a valid C++ identifier
4006 and not a string unlike in the other cases.
4008 This macro is mostly useful for testing the expressions involving the
4009 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
4010 sometimes desirable to test them at the compile time.
4012 Note that this macro internally declares a struct whose name it tries to make
4013 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
4014 use it on the same line in two different source files. In this case you may
4015 either change the line in which either of them appears on or use the
4016 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
4018 Also note that Microsoft Visual C++ has a bug which results in compiler errors
4019 if you use this macro with ``Program Database For Edit And Continue''
4020 (\texttt{/ZI}) option, so you shouldn't use it (``Program Database''
4021 (\texttt{/Zi}) is ok though) for the code making use of this macro.
4023 \wxheading{See also}
4025 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4026 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4029 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4031 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4033 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4034 except that it allows you to specify a unique {\it name} for the struct
4035 internally defined by this macro to avoid getting the compilation errors
4036 described \helpref{above}{wxcompiletimeassert}.
4039 \membersection{wxFAIL}\label{wxfail}
4041 \func{}{wxFAIL}{\void}
4043 Will always generate an assert error if this code is reached (in debug mode).
4045 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4048 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4050 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4052 Will always generate an assert error with specified message if this code is reached (in debug mode).
4054 This macro is useful for marking unreachable" code areas, for example
4055 it may be used in the "default:" branch of a switch statement if all possible
4056 cases are processed above.
4058 \wxheading{See also}
4060 \helpref{wxFAIL}{wxfail}
4063 \membersection{wxCHECK}\label{wxcheck}
4065 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4067 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4068 This check is done even in release mode.
4071 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4073 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4075 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4076 This check is done even in release mode.
4078 This macro may be only used in non void functions, see also
4079 \helpref{wxCHECK\_RET}{wxcheckret}.
4082 \membersection{wxCHECK\_RET}\label{wxcheckret}
4084 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4086 Checks that the condition is true, and returns if not (FAILs with given error
4087 message in debug mode). This check is done even in release mode.
4089 This macro should be used in void functions instead of
4090 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4093 \membersection{wxCHECK2}\label{wxcheck2}
4095 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4097 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4098 {\it operation} if it is not. This is a generalisation of
4099 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4100 returning from the function must be done when the {\it condition} is false.
4102 This check is done even in release mode.
4105 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4107 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4109 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4110 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4111 instead of wxFAIL() if the {\it condition} is false.
4114 \membersection{::wxTrap}\label{wxtrap}
4116 \func{void}{wxTrap}{\void}
4118 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4119 debugger exception meaning that the control is passed to the debugger if one is
4120 attached to the process. Otherwise the program just terminates abnormally.
4122 In release mode this function does nothing.
4124 \wxheading{Include files}
4130 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4132 \func{bool}{wxIsDebuggerRunning}{\void}
4134 Returns {\tt true} if the program is running under debugger, {\tt false}
4137 Please note that this function is currently only implemented for Mac builds
4138 using CodeWarrior and always returns {\tt false} elsewhere.
4143 \section{Environment access functions}\label{environfunctions}
4145 The functions in this section allow to access (get) or change value of
4146 environment variables in a portable way. They are currently implemented under
4147 Win32 and POSIX-like systems (Unix).
4149 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4151 \wxheading{Include files}
4156 \membersection{wxGetenv}\label{wxgetenvmacro}
4158 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4160 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4163 Note that under Win32 it may not return correct value for the variables set
4164 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4168 \membersection{wxGetEnv}\label{wxgetenv}
4170 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4172 Returns the current value of the environment variable {\it var} in {\it value}.
4173 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4174 and are not interested in its value.
4176 Returns {\tt true} if the variable exists, {\tt false} otherwise.
4179 \membersection{wxSetEnv}\label{wxsetenv}
4181 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4183 Sets the value of the environment variable {\it var} (adding it if necessary)
4186 Returns {\tt true} on success.
4189 \membersection{wxUnsetEnv}\label{wxunsetenv}
4191 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4193 Removes the variable {\it var} from the environment.
4194 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4197 Returns {\tt true} on success.