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{wxMkdir
}{wxmkdir
}\\
178 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
179 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
180 \helpref{wxNewId
}{wxnewid
}\\
181 \helpref{wxNow
}{wxnow
}\\
182 \helpref{wxOnAssert
}{wxonassert
}\\
183 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
184 \helpref{wxParseCommonDialogsFilter
}{wxparsecommondialogsfilter
}\\
185 \helpref{wxPathOnly
}{wxpathonly
}\\
186 \helpref{wxPostDelete
}{wxpostdelete
}\\
187 \helpref{wxPostEvent
}{wxpostevent
}\\
188 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
189 \helpref{wxRegisterId
}{wxregisterid
}\\
190 \helpref{wxRemoveFile
}{wxremovefile
}\\
191 \helpref{wxRenameFile
}{wxrenamefile
}\\
192 \helpref{wxRmdir
}{wxrmdir
}\\
193 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
194 \helpref{wxSafeYield
}{wxsafeyield
}\\
195 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
196 \helpref{wxSetCursor
}{wxsetcursor
}\\
197 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
198 \helpref{wxSetEnv
}{wxsetenv
}\\
199 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
200 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
201 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
202 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
203 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
204 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
205 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
206 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
207 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
208 \helpref{wxShell
}{wxshell
}\\
209 \helpref{wxShowTip
}{wxshowtip
}\\
210 \helpref{wxShutdown
}{wxshutdown
}\\
211 \helpref{wxSleep
}{wxsleep
}\\
212 \helpref{wxSnprintf
}{wxsnprintf
}\\
213 \helpref{wxSplitPath
}{wxsplitfunction
}\\
214 \helpref{wxStartTimer
}{wxstarttimer
}\\
215 \helpref{wxStaticCast
}{wxstaticcast
}\\
216 \helpref{wxStrcmp
}{wxstrcmp
}\\
217 \helpref{wxStricmp
}{wxstricmp
}\\
218 \helpref{wxStringEq
}{wxstringeq
}\\
219 \helpref{wxStringMatch
}{wxstringmatch
}\\
220 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
221 \helpref{wxStrlen
}{wxstrlen
}\\
222 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
223 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
225 \helpref{wxTraceLevel
}{wxtracelevel
}\\
226 \helpref{wxTrace
}{wxtrace
}\\
227 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
228 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
229 \helpref{wxTrap
}{wxtrap
}\\
230 \helpref{wxULL
}{wxull
}\\
231 \helpref{wxUninitialize
}{wxuninitialize
}\\
232 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
233 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
234 \helpref{wxUsleep
}{wxusleep
}\\
235 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
236 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
237 \helpref{wxWriteResource
}{wxwriteresource
}\\
238 \helpref{wxYield
}{wxyield
}\\
239 \helpref{wx
\_const\_cast}{wxconstcastraw
}\\
240 \helpref{wx
\_static\_cast}{wxstaticcastraw
}\\
241 \helpref{\_}{underscore
}\\
242 \helpref{\_T}{underscoret
}
246 \section{Version macros
}\label{versionfunctions
}
248 The following constants are defined in wxWidgets:
250 \begin{itemize
}\itemsep=
0pt
251 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWidgets
252 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWidgets
253 \item {\tt wxRELEASE
\_NUMBER} is the release number
256 For example, the values or these constants for wxWidgets
2.1.15 are
2,
1 and
259 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
260 the full wxWidgets version and
{\tt wxVERSION
\_NUMBER} is a combination of the
261 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
264 \wxheading{Include files
}
266 <wx/version.h> or <wx/defs.h>
269 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
271 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
273 This is a macro which evaluates to true if the current wxWidgets version is at
274 least major.minor.release.
276 For example, to test if the program is compiled with wxWidgets
2.2 or higher,
277 the following can be done:
281 #if wxCHECK_VERSION(
2,
2,
0)
282 if ( s.StartsWith("foo") )
283 #else // replacement code for old version
284 if ( strncmp(s, "foo",
3) ==
0 )
292 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
294 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
296 Returns $
1$ if the compiler being used to compile the code is GNU C++
297 compiler (g++) version major.minor.release or greater. Otherwise, and also if
298 the compiler is not GNU C++ at all, returns $
0$.
301 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
303 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
305 Returns $
1$ if the version of w32api headers used is major.minor.release or
306 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
307 Win32 at all, returns $
0$.
311 \section{Application initialization and termination
}\label{appinifunctions
}
313 The functions in this section are used on application startup/shutdown and also
314 to control the behaviour of the main event loop of the GUI programs.
317 \membersection{::wxEntry
}\label{wxentry
}
319 This initializes wxWidgets in a platform-dependent way. Use this if you
320 are not using the default wxWidgets entry code (e.g. main or WinMain). For example,
321 you can initialize wxWidgets from an Microsoft Foundation Classes application using
324 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
325 \param{const wxString\&
}{commandLine
},
\param{int
}{ cmdShow
},
\param{bool
}{ enterLoop = true
}}
327 wxWidgets initialization under Windows (non-DLL). If
{\it enterLoop
} is false, the
328 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets
329 message loop will be entered.
331 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
332 \param{WORD
}{ wDataSegment
},
\param{WORD
}{ wHeapSize
},
\param{const wxString\&
}{ commandLine
}}
334 wxWidgets initialization under Windows (for applications constructed as a DLL).
336 \func{int
}{wxEntry
}{\param{int
}{ argc
},
\param{const wxString\& *
}{argv
}}
338 wxWidgets initialization under Unix.
342 To clean up wxWidgets, call wxApp::OnExit followed by the static function
343 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:
346 int CTheApp::ExitInstance()
348 // OnExit isn't called by CleanUp so must be called explicitly.
352 return CWinApp::ExitInstance();
356 \wxheading{Include files
}
362 \membersection{::wxGetApp
}\label{wxgetapp
}
364 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
366 This function doesn't exist in wxWidgets but it is created by using
367 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
368 anywhere but in the same module where this macro is used, you must make it
369 available using
\helpref{DECLARE
\_APP}{declareapp
}.
371 The advantage of using this function compared to directly using the global
372 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
373 allow you to access the functions specific to your application class but not
374 present in wxApp while wxGetApp() returns the object of the right type.
377 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
379 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
381 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
382 faults under Windows or segmentation violations in the Unix world) will be
383 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
384 By default, i.e. before this function is called, they will be handled in the
385 normal way which usually just means that the application will be terminated.
386 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
387 this default behaviour.
390 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
392 \func{void
}{wxInitAllImageHandlers
}{\void}
394 Initializes all available image handlers. For a list of available handlers,
395 see
\helpref{wxImage
}{wximage
}.
399 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
401 \wxheading{Include files
}
406 \membersection{::wxInitialize
}\label{wxinitialize
}
408 \func{bool
}{wxInitialize
}{\void}
410 This function is used in wxBase only and only if you don't create
411 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
412 {\tt main()
} function before calling any other wxWidgets functions.
414 If the function returns
{\tt false
} the initialization could not be performed,
415 in this case the library cannot be used and
416 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
418 This function may be called several times but
419 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
420 call to this function.
422 \wxheading{Include files
}
427 \membersection{::wxSafeYield
}\label{wxsafeyield
}
429 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
430 onlyIfNeeded = false
}}
432 This function is similar to wxYield, except that it disables the user input to
433 all program windows before calling wxYield and re-enables it again
434 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
435 allowing the implementation of some limited user interaction.
437 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
439 \wxheading{Include files
}
444 \membersection{::wxUninitialize
}\label{wxuninitialize
}
446 \func{void
}{wxUninitialize
}{\void}
448 This function is for use in console (wxBase) programs only. It must be called
449 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
451 \wxheading{Include files
}
456 \membersection{::wxYield
}\label{wxyield
}
458 \func{bool
}{wxYield
}{\void}
460 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
462 This function is kept only for backwards compatibility. Please use
463 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
465 \wxheading{Include files
}
467 <wx/app.h> or <wx/utils.h>
470 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
472 \func{void
}{wxWakeUpIdle
}{\void}
474 This functions wakes up the (internal and platform dependent) idle system, i.e. it
475 will force the system to send an idle event even if the system currently
{\it is
}
476 idle and thus would not send any idle event until after some other event would get
477 sent. This is also useful for sending events between two threads and is used by
478 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
479 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
481 \wxheading{Include files
}
487 \section{Process control functions
}\label{processfunctions
}
489 The functions in this section are used to launch or terminate the other
493 \membersection{::wxExecute
}\label{wxexecute
}
495 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
497 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteCommand
}}
499 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
501 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteArgs
}}
503 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
}}
505 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdout
} and it
506 only takes the
{\tt command
} argument,
507 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
510 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
}}
512 \perlnote{In wxPerl this function is called
\texttt{Wx::ExecuteStdoutStderr
}
513 and it only takes the
{\tt command
} argument,
514 and returns a
3-element list
{\tt ( status, output, errors )
}, where
515 {\tt output
} and
{\tt errors
} are array references.
}
517 Executes another program in Unix or Windows.
519 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
521 The second form takes an array of values: a command, any number of
522 arguments, terminated by NULL.
524 The semantics of the third and fourth versions is different from the first two
525 and is described in more details below.
527 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
528 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
529 application waits until the other program has terminated.
531 In the case of synchronous execution, the return value is the exit code of
532 the process (which terminates by the moment the function returns) and will be
533 $-
1$ if the process couldn't be started and typically
0 if the process
534 terminated successfully. Also, while waiting for the process to
535 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. The caller
536 should ensure that this can cause no recursion, in the simplest case by
537 calling
\helpref{wxEnableTopLevelWindows(false)
}{wxenabletoplevelwindows
}.
539 For asynchronous execution, however, the return value is the process id and
540 zero value indicates that the command could not be executed. As an added
541 complication, the return value of $-
1$ in this case indicates that we didn't
542 launch a new process, but connected to the running one (this can only happen in
543 case of using DDE under Windows for command execution). In particular, in this,
544 and only this, case the calling code will not get the notification about
547 If callback isn't NULL and if execution is asynchronous,
548 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
549 the process finishes. Specifying this parameter also allows you to redirect the
550 standard input and/or output of the process being launched by calling
551 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
552 under Windows the process window is not shown by default (this avoids having to
553 flush an unnecessary console for the processes which don't create any windows
554 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
555 happening, i.e. with this flag the child process window will be shown normally.
557 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
558 that the new process is a group leader (this will create a new session if
559 needed). Calling
\helpref{wxKill
}{wxkill
} with the argument of -pid where pid
560 is the process ID of the new process will kill this process as well as all of
561 its children (except those which have started their own session).
563 Finally, you may use the third overloaded version of this function to execute
564 a process (always synchronously) and capture its output in the array
565 {\it output
}. The fourth version adds the possibility to additionally capture
566 the messages from standard error output in the
{\it errors
} array.
568 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
569 this function from another thread will result in an assert failure in debug
570 build and won't work.
574 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
576 \wxheading{Parameters
}
578 \docparam{command
}{The command to execute and any parameters to pass to it as a
581 \docparam{argv
}{The command to execute should be the first element of this
582 array, any additional ones are the command parameters and the array must be
583 terminated with a NULL pointer.
}
585 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
\rtfsp
586 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
588 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
590 \wxheading{Include files
}
595 \membersection{::wxExit
}\label{wxexit
}
597 \func{void
}{wxExit
}{\void}
599 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
600 Should only be used in an emergency: normally the top-level frame
601 should be deleted (after deleting all other frames) to terminate the
602 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
604 \wxheading{Include files
}
609 \membersection{::wxKill
}\label{wxkill
}
611 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
}}
613 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
614 process with PID
{\it pid
}. The valid signal values are
619 wxSIGNONE =
0, // verify if the process exists under Unix
628 wxSIGKILL, // forcefully kill, dangerous!
634 wxSIGTERM // terminate the process gently
638 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
639 under both Unix and Windows but all the other signals are equivalent to
640 {\tt wxSIGTERM
} under Windows.
642 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
643 be filled with an element of
{\tt wxKillError
} enum:
648 wxKILL_OK, // no error
649 wxKILL_BAD_SIGNAL, // no such signal
650 wxKILL_ACCESS_DENIED, // permission denied
651 wxKILL_NO_PROCESS, // no such process
652 wxKILL_ERROR // another, unspecified error
658 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
659 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
660 \helpref{Exec sample
}{sampleexec
}
662 \wxheading{Include files
}
667 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
669 \func{unsigned long
}{wxGetProcessId
}{\void}
671 Returns the number uniquely identifying the current process in the system.
673 If an error occurs, $
0$ is returned.
675 \wxheading{Include files
}
680 \membersection{::wxShell
}\label{wxshell
}
682 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
684 Executes a command in an interactive shell window. If no command is
685 specified, then just the shell is spawned.
687 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
689 \wxheading{Include files
}
694 \membersection{::wxShutdown
}\label{wxshutdown
}
696 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
698 This function shuts down or reboots the computer depending on the value of the
699 {\it flags
}. Please notice that doing this requires the corresponding access
700 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privelege under Windows NT)
701 and that this function is only implemented under Unix and Win32.
703 \wxheading{Parameters
}
705 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
709 {\tt true
} on success,
{\tt false
} if an error occured.
711 \wxheading{Include files
}
717 \section{Thread functions
}\label{threadfunctions
}
719 The functions and macros here mainly exist to make it writing the code which
720 may be compiled in multi thread build (
{\tt wxUSE
\_THREADS} $=
1$) as well as
721 in single thread configuration (
{\tt wxUSE
\_THREADS} $=
0$).
723 For example, a static variable must be protected against simultaneous access by
724 multiple threads in the former configuration but in the latter the extra
725 overhead of using the critical section is not needed. To solve this problem,
726 the
\helpref{wxCRITICAL
\_SECTION}{wxcriticalsectionmacro
} macro may be used
727 to create and use the critical section only when needed.
729 \wxheading{Include files
}
735 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
739 \membersection{wxCRIT
\_SECT\_DECLARE}\label{wxcritsectdeclare
}
741 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
743 This macro declares a (static) critical section object named
{\it cs
} if
744 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
748 \membersection{wxCRIT
\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember
}
750 \func{}{wxCRIT
\_SECT\_DECLARE}{\param{}{cs
}}
752 This macro declares a critical section object named
{\it cs
} if
753 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$. As it doesn't
754 include the
{\tt static
} keyword (unlike
755 \helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
}), it can be used to declare
756 a class or struct member which explains its name.
760 \membersection{wxCRIT
\_SECT\_LOCKER}\label{wxcritsectlocker
}
762 \func{}{wxCRIT
\_SECT\_LOCKER}{\param{}{name
},
\param{}{cs
}}
764 This macro creates a
\helpref{critical section lock
}{wxcriticalsectionlocker
}
765 object named
{\it name
} and associated with the critical section
{\it cs
} if
766 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
770 \membersection{wxCRITICAL
\_SECTION}\label{wxcriticalsectionmacro
}
772 \func{}{wxCRITICAL
\_SECTION}{\param{}{name
}}
774 This macro combines
\helpref{wxCRIT
\_SECT\_DECLARE}{wxcritsectdeclare
} and
775 \helpref{wxCRIT
\_SECT\_LOCKER}{wxcritsectlocker
}: it creates a static critical
776 section object and also the lock object associated with it. Because of this, it
777 can be only used inside a function, not at global scope. For example:
782 static int s_counter =
0;
784 wxCRITICAL_SECTION(counter);
790 (note that we suppose that the function is called the first time from the main
791 thread so that the critical section object is initialized correctly by the time
792 other threads start calling it, if this is not the case this approach can
793 {\bf not
} be used and the critical section must be made a global instead).
797 \membersection{wxENTER
\_CRIT\_SECT}\label{wxentercritsect
}
799 \func{}{wxENTER
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
801 This macro is equivalent to
\helpref{cs.Enter()
}{wxcriticalsectionenter
} if
802 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
806 \membersection{::wxIsMainThread
}\label{wxismainthread
}
808 \func{bool
}{wxIsMainThread
}{\void}
810 Returns
{\tt true
} if this thread is the main one. Always returns
{\tt true
} if
811 {\tt wxUSE
\_THREADS} is $
0$.
815 \membersection{wxLEAVE
\_CRIT\_SECT}\label{wxleavecritsect
}
817 \func{}{wxLEAVE
\_CRIT\_SECT}{\param{wxCriticalSection\&
}{cs
}}
819 This macro is equivalent to
\helpref{cs.Leave()
}{wxcriticalsectionleave
} if
820 {\tt wxUSE
\_THREADS} is $
1$ and does nothing if it is $
0$.
824 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
826 \func{void
}{wxMutexGuiEnter
}{\void}
828 This function must be called when any thread other than the main GUI thread
829 wants to get access to the GUI library. This function will block the execution
830 of the calling thread until the main thread (or any other thread holding the
831 main GUI lock) leaves the GUI library and no other thread will enter the GUI
832 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
834 Typically, these functions are used like this:
837 void MyThread::Foo(void)
839 // before doing any GUI calls we must ensure that this thread is the only
845 my_window->DrawSomething();
851 Note that under GTK, no creation of top-level windows is allowed in any
852 thread but the main one.
854 This function is only defined on platforms which support preemptive
858 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
860 \func{void
}{wxMutexGuiLeave
}{\void}
862 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
864 This function is only defined on platforms which support preemptive
869 \section{File functions
}\label{filefunctions
}
871 \wxheading{Include files
}
877 \helpref{wxPathList
}{wxpathlist
}\\
878 \helpref{wxDir
}{wxdir
}\\
879 \helpref{wxFile
}{wxfile
}\\
880 \helpref{wxFileName
}{wxfilename
}
883 \membersection{::wxDirExists
}\label{functionwxdirexists
}
885 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
887 Returns true if the directory exists.
890 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
892 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
894 Converts a DOS to a Unix filename by replacing backslashes with forward
898 \membersection{::wxFileExists
}\label{functionwxfileexists
}
900 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
902 Returns true if the file exists and is a plain file.
905 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
907 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
909 Returns time of last modification of given file.
912 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
914 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
916 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
918 {\bf NB:
} This function is obsolete, please use
919 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
921 Returns the filename for a full path. The second form returns a pointer to
922 temporary storage that should not be deallocated.
925 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
927 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
929 This function does directory searching; returns the first file
930 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
931 get the next matching file. Neither will
report the current directory "." or the
932 parent directory "..".
934 {\it spec
} may contain wildcards.
936 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
941 wxString f = wxFindFirstFile("/home/project/*.*");
942 while ( !f.IsEmpty() )
945 f = wxFindNextFile();
950 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
952 \func{wxString
}{wxFindNextFile
}{\void}
954 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
956 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
959 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
961 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
963 This function returns the total number of bytes and number of free bytes on
964 the disk containing the directory
{\it path
} (it should exist). Both
965 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
966 information is not needed.
970 {\tt true
} on success,
{\tt false
} if an error occured (for example, the
971 directory doesn't exist).
973 \wxheading{Portability
}
975 This function is implemented for Win32,
976 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
978 This function first appeared in wxWidgets
2.3.2.
981 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
983 \func{wxString
}{wxGetOSDirectory
}{\void}
985 Returns the Windows directory under Windows; on other platforms returns the empty string.
988 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
990 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
992 Returns true if the argument is an absolute filename, i.e. with a slash
993 or drive name at the beginning.
996 \membersection{::wxPathOnly
}\label{wxpathonly
}
998 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
1000 Returns the directory part of the filename.
1003 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
1005 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
1007 Converts a Unix to a DOS filename by replacing forward
1008 slashes with backslashes.
1011 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
1013 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
1014 \param{const wxString\&
}{file3
}}
1016 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
1020 \membersection{::wxCopyFile
}\label{wxcopyfile
}
1022 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
1024 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
1025 {\it overwrite
} parameter is true (default), the destination file is overwritten
1026 if it exists, but if
{\it overwrite
} is false, the functions fails in this
1030 \membersection{::wxGetCwd
}\label{wxgetcwd
}
1032 \func{wxString
}{wxGetCwd
}{\void}
1034 Returns a string containing the current (or working) directory.
1037 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
1039 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
1041 {\bf NB:
} This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
1043 Copies the current working directory into the buffer if supplied, or
1044 copies the working directory into new storage (which you
{\emph must
} delete
1045 yourself) if the buffer is NULL.
1047 {\it sz
} is the size of the buffer if supplied.
1050 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
1052 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
1054 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
1056 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
1057 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
1058 %% is allocated for the temporary filename using {\it new}.
1060 %% Under Windows, the filename will include the drive and name of the
1061 %% directory allocated for temporary files (usually the contents of the
1062 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
1064 %% It is the application's responsibility to create and delete the file.
1066 {\bf NB:
} These functions are obsolete, please use
\rtfsp
1067 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
1071 \membersection{::wxIsWild
}\label{wxiswild
}
1073 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
1075 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
1078 \membersection{::wxMatchWild
}\label{wxmatchwild
}
1080 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
1082 Returns true if the
\arg{pattern
}\/ matches the
{\it text
}\/; if
{\it
1083 dot
\_special}\/ is true, filenames beginning with a dot are not matched
1084 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
1087 \membersection{::wxMkdir
}\label{wxmkdir
}
1089 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
1091 Makes the directory
\arg{dir
}, returning true if successful.
1093 {\it perm
} is the access mask for the directory for the systems on which it is
1094 supported (Unix) and doesn't have effect for the other ones.
1097 \membersection{::wxParseCommonDialogsFilter
}\label{wxparsecommondialogsfilter
}
1099 \func{int
}{wxParseCommonDialogsFilter
}{\param{const wxString\&
}{wildCard
},
\param{wxArrayString\&
}{descriptions
},
\param{wxArrayString\&
}{filters
}}
1101 Parses the
\arg{wildCard
}, returning the number of filters.
1102 Returns
0 if none or if there's a problem.
1103 The arrays will contain an equal number of items found before the error.
1104 On platforms where native dialogs handle only one filter per entry,
1105 entries in arrays are automatically adjusted.
1106 \arg{wildCard
} is in the form:
1108 "All files
(*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
1111 \membersection{::wxRemoveFile}\label{wxremovefile}
1113 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
1115 Removes \arg{file}, returning true if successful.
1118 \membersection{::wxRenameFile}\label{wxrenamefile}
1120 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
1122 Renames \arg{file1} to \arg{file2}, returning true if successful.
1125 \membersection{::wxRmdir}\label{wxrmdir}
1127 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
1129 Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
1131 The {\it flags} parameter is reserved for future use.
1134 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
1136 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
1138 Sets the current working directory, returning true if the operation succeeded.
1139 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
1142 \membersection{::wxSplitPath}\label{wxsplitfunction}
1144 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
1146 {\bf NB:} This function is obsolete, please use
1147 \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
1149 This function splits a full file name into components: the path (including possible disk/drive
1150 specification under Windows), the base name and the extension. Any of the output parameters
1151 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
1152 a particular component.
1154 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
1155 Windows, however it will not consider backslashes as path separators under Unix (where backslash
1156 is a valid character in a filename).
1158 On entry, {\it fullname} should be non-NULL (it may be empty though).
1160 On return, {\it path} contains the file path (without the trailing separator), {\it name}
1161 contains the file name and {\it ext} contains the file extension without leading dot. All
1162 three of them may be empty if the corresponding component is. The old contents of the
1163 strings pointed to by these parameters will be overwritten in any case (if the pointers
1167 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
1169 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
1171 Copies the given file to {\it stream}. Useful when converting an old application to
1172 use streams (within the document/view framework, for example).
1174 \wxheading{Include files}
1179 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
1181 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
1183 Copies the given stream to the file {\it filename}. Useful when converting an old application to
1184 use streams (within the document/view framework, for example).
1186 \wxheading{Include files}
1192 \section{Network, user and OS functions}\label{networkfunctions}
1194 The functions in this section are used to retrieve information about the
1195 current computer and/or user characteristics.
1198 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1200 \func{long}{wxGetFreeMemory}{\void}
1202 Returns the amount of free memory in bytes under environments which
1203 support it, and -1 if not supported. Currently, it is supported only
1204 under Windows, Linux and Solaris.
1206 \wxheading{Include files}
1211 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
1213 \func{wxString}{wxGetFullHostName}{\void}
1215 Returns the FQDN (fully qualified domain host name) or an empty string on
1218 \wxheading{See also}
1220 \helpref{wxGetHostName}{wxgethostname}
1222 \wxheading{Include files}
1227 \membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
1229 \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
1231 Copies the user's email address into the supplied buffer, by
1232 concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
1233 and \helpref{wxGetUserId}{wxgetuserid}.
1235 Returns true if successful, false otherwise.
1237 \wxheading{Include files}
1242 \membersection{::wxGetHomeDir}\label{wxgethomedir}
1244 \func{wxString}{wxGetHomeDir}{\void}
1246 Return the (current) user's home directory.
1248 \wxheading{See also}
1250 \helpref{wxGetUserHome}{wxgetuserhome}
1252 \wxheading{Include files}
1257 \membersection{::wxGetHostName}\label{wxgethostname}
1259 \func{wxString}{wxGetHostName}{\void}
1261 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
1263 Copies the current host machine's name into the supplied buffer. Please note
1264 that the returned name is {\it not} fully qualified, i.e. it does not include
1267 Under Windows or NT, this function first looks in the environment
1268 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
1269 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1271 The first variant of this function returns the hostname if successful or an
1272 empty string otherwise. The second (deprecated) function returns true
1273 if successful, false otherwise.
1275 \wxheading{See also}
1277 \helpref{wxGetFullHostName}{wxgetfullhostname}
1279 \wxheading{Include files}
1284 \membersection{::wxGetUserId}\label{wxgetuserid}
1286 \func{wxString}{wxGetUserId}{\void}
1288 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
1290 This function returns the "user id" also known as "login name" under Unix i.e.
1291 something like "jsmith". It uniquely identifies the current user (on this system).
1293 Under Windows or NT, this function first looks in the environment
1294 variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
1295 in the {\bf wxWidgets} section of the WIN.INI file is tried.
1297 The first variant of this function returns the login name if successful or an
1298 empty string otherwise. The second (deprecated) function returns true
1299 if successful, false otherwise.
1301 \wxheading{See also}
1303 \helpref{wxGetUserName}{wxgetusername}
1305 \wxheading{Include files}
1310 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
1312 \func{wxString}{wxGetOsDescription}{\void}
1314 Returns the string containing the description of the current platform in a
1315 user-readable form. For example, this function may return strings like
1316 {\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
1318 \wxheading{See also}
1320 \helpref{::wxGetOsVersion}{wxgetosversion}
1322 \wxheading{Include files}
1327 \membersection{::wxGetOsVersion}\label{wxgetosversion}
1329 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1331 Gets operating system version information.
1333 \begin{twocollist}\itemsep=0pt
1334 \twocolitemruled{Platform}{Return types}
1335 \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.
1337 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}. }
1338 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
1339 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1340 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1341 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1342 \twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
1343 \twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
1344 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
1345 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1346 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1349 \wxheading{See also}
1351 \helpref{::wxGetOsDescription}{wxgetosdescription}
1353 \wxheading{Include files}
1358 \membersection{::wxGetUserHome}\label{wxgetuserhome}
1360 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
1362 Returns the home directory for the given user. If the username is empty
1363 (default value), this function behaves like
1364 \helpref{wxGetHomeDir}{wxgethomedir}.
1366 \wxheading{Include files}
1371 \membersection{::wxGetUserName}\label{wxgetusername}
1373 \func{wxString}{wxGetUserName}{\void}
1375 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
1377 This function returns the full user name (something like "Mr. John Smith").
1379 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
1380 in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows
1381 is running, the entry {\bf Current} in the section {\bf User} of
1382 the PENWIN.INI file is used.
1384 The first variant of this function returns the user name if successful or an
1385 empty string otherwise. The second (deprecated) function returns {\tt true}
1386 if successful, {\tt false} otherwise.
1388 \wxheading{See also}
1390 \helpref{wxGetUserId}{wxgetuserid}
1392 \wxheading{Include files}
1398 \section{String functions}
1401 \membersection{::copystring}\label{copystring}
1403 \func{char *}{copystring}{\param{const char *}{s}}
1405 Makes a copy of the string {\it s} using the C++ new operator, so it can be
1406 deleted with the {\it delete} operator.
1408 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
1411 \membersection{::wxGetTranslation}\label{wxgettranslation}
1413 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
1415 \func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}}
1417 This function returns the translation of string {\it str} in the current
1418 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
1419 message catalogs (see \helpref{internationalization overview}{internationalization}), the
1420 original string is returned. In debug build, an error message is logged -- this
1421 should help to find the strings which were not yet translated. As this function
1422 is used very often, an alternative (and also common in Unix world) syntax is
1423 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
1424 as wxGetTranslation.
1426 The second form is used when retrieving translation of string that has
1427 different singular and plural form in English or different plural forms in some
1428 other language. It takes two extra arguments: \arg{str}
1429 parameter must contain the singular form of the string to be converted.
1430 It is also used as the key for the search in the catalog.
1431 The \arg{strPlural} parameter is the plural form (in English).
1432 The parameter \arg{n} is used to determine the plural form. If no
1433 message catalog is found \arg{str} is returned if `n == 1',
1434 otherwise \arg{strPlural}.
1435 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
1437 Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}.
1439 \membersection{::wxIsEmpty}\label{wxisempty}
1441 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}
1443 Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
1444 string, {\tt false} otherwise.
1447 \membersection{::wxStrcmp}\label{wxstrcmp}
1449 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1451 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1452 to or greater than {\it p2}. The comparison is case-sensitive.
1454 This function complements the standard C function {\it stricmp()} which performs
1455 case-insensitive comparison.
1458 \membersection{::wxStricmp}\label{wxstricmp}
1460 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
1462 Returns a negative value, 0, or positive value if {\it p1} is less than, equal
1463 to or greater than {\it p2}. The comparison is case-insensitive.
1465 This function complements the standard C function {\it strcmp()} which performs
1466 case-sensitive comparison.
1469 \membersection{::wxStringMatch}\label{wxstringmatch}
1471 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
1472 \param{bool}{ subString = true}, \param{bool}{ exact = false}}
1474 {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
1476 Returns {\tt true} if the substring {\it s1} is found within {\it s2},
1477 ignoring case if {\it exact} is false. If {\it subString} is {\tt false},
1478 no substring matching is done.
1481 \membersection{::wxStringEq}\label{wxstringeq}
1483 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
1485 {\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
1490 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
1494 \membersection{::wxStrlen}\label{wxstrlen}
1496 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
1498 This is a safe version of standard function {\it strlen()}: it does exactly the
1499 same thing (i.e. returns the length of the string) except that it returns 0 if
1500 {\it p} is the {\tt NULL} pointer.
1503 \membersection{::wxSnprintf}\label{wxsnprintf}
1505 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
1507 This function replaces the dangerous standard function {\tt sprintf()} and is
1508 like {\tt snprintf()} available on some platforms. The only difference with
1509 sprintf() is that an additional argument - buffer size - is taken and the
1510 buffer is never overflowed.
1512 Returns the number of characters copied to the buffer or -1 if there is not
1515 \wxheading{See also}
1517 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
1520 \membersection{wxT}\label{wxt}
1522 \func{wxChar}{wxT}{\param{char }{ch}}
1524 \func{const wxChar *}{wxT}{\param{const char *}{s}}
1526 wxT() is a macro which can be used with character and string literals (in other
1527 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
1528 Unicode build configuration. Please see the
1529 \helpref{Unicode overview}{unicode} for more information.
1531 This macro is simply returns the value passed to it without changes in ASCII
1532 build. In fact, its definition is:
1535 #define wxT(x) L ## x
1542 \membersection{wxTRANSLATE}\label{wxtranslate}
1544 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
1546 This macro doesn't do anything in the program code -- it simply expands to the
1547 value of its argument (except in Unicode build where it is equivalent to
1548 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
1549 with the same string which would be really unreadable).
1551 However it does have a purpose and it is to mark the literal strings for the
1552 extraction into the message catalog created by {\tt xgettext} program. Usually
1553 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
1554 the string for extraction but also expands into a
1555 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
1556 cannot be used in some situations, notably for static array
1559 Here is an example which should make it more clear: suppose that you have a
1560 static array of strings containing the weekday names and which have to be
1561 translated (note that it is a bad example, really, as
1562 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
1563 day names already). If you write
1566 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
1568 // use weekdays[n] as usual
1571 the code wouldn't compile because the function calls are forbidden in the array
1572 initializer. So instead you should do
1575 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
1577 // use wxGetTranslation(weekdays[n])
1582 Note that although the code {\bf would} compile if you simply omit
1583 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1584 no translations for the weekday names in the program message catalog and
1585 wxGetTranslation wouldn't find them.
1587 \membersection{::wxVsnprintf}\label{wxvsnprintf}
1589 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
1591 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
1592 argument instead of arbitrary number of parameters.
1594 \wxheading{See also}
1596 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
1600 \membersection{\_}\label{underscore}
1602 \func{const wxChar *}{\_}{\param{const char *}{s}}
1604 This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}
1605 function, so it marks the message for the extraction by {\tt xgettext} just as
1606 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
1607 the string for the current locale during execution.
1609 Don't confuse this macro with \helpref{\_T()}{underscoret}!
1612 \membersection{\_T}\label{underscoret}
1614 \func{wxChar}{\_T}{\param{char }{ch}}
1616 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
1618 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in
1619 wxWidgets simply because it may be more intuitive for Windows programmers as
1620 the standard Win32 headers also define it (as well as yet another name for the
1621 same macro which is {\tt \_TEXT()}).
1623 Don't confuse this macro with \helpref{\_()}{underscore}!
1627 \section{Dialog functions}\label{dialogfunctions}
1629 Below are a number of convenience functions for getting input from the
1630 user or displaying messages. Note that in these functions the last three
1631 parameters are optional. However, it is recommended to pass a parent frame
1632 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1633 the front when the dialog box is popped up.
1636 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
1638 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
1640 Changes the cursor to the given cursor for all windows in the application.
1641 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
1642 to its previous state. These two calls can be nested, and a counter
1643 ensures that only the outer calls take effect.
1645 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1647 \wxheading{Include files}
1652 \membersection{::wxBell}\label{wxbell}
1654 \func{void}{wxBell}{\void}
1656 Ring the system bell.
1658 \wxheading{Include files}
1663 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
1665 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
1666 \param{size\_t }{currentTip}}
1668 This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
1669 used with \helpref{wxShowTip}{wxshowtip}.
1671 \docparam{filename}{The name of the file containing the tips, one per line}
1672 \docparam{currentTip}{The index of the first tip to show - normally this index
1673 is remembered between the 2 program runs.}
1675 \wxheading{See also}
1677 \helpref{Tips overview}{tipsoverview}
1679 \wxheading{Include files}
1684 \membersection{::wxDirSelector}\label{wxdirselector}
1686 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
1687 \param{const wxString\& }{default\_path = ""},\\
1688 \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition},\\
1689 \param{wxWindow *}{parent = NULL}}
1691 Pops up a directory selector dialog. The arguments have the same meaning as
1692 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1693 and the default\_path, if specified, is set as the initial selection.
1695 The application must check for an empty return value (if the user pressed
1696 Cancel). For example:
1699 const wxString& dir = wxDirSelector("Choose a folder");
1706 \wxheading{Include files}
1711 \membersection{::wxFileSelector}\label{wxfileselector}
1713 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
1714 \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
1715 \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
1716 \param{int}{ x = -1}, \param{int}{ y = -1}}
1718 Pops up a file selector box. In Windows, this is the common file selector
1719 dialog. In X, this is a file selector box with the same functionality.
1720 The path and filename are distinct elements of a full file pathname.
1721 If path is empty, the current directory will be used. If filename is empty,
1722 no default filename will be supplied. The wildcard determines what files
1723 are displayed in the file selector, and file extension supplies a type
1724 extension for the required filename. Flags may be a combination of wxOPEN,
1725 wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
1727 Both the Unix and Windows versions implement a wildcard filter. Typing a
1728 filename containing wildcards (*, ?) in the filename text item, and
1729 clicking on Ok, will result in only those files matching the pattern being
1732 The wildcard may be a specification for multiple types of file
1733 with a description for each, such as:
1736 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1739 The application must check for an empty return value (the user pressed
1740 Cancel). For example:
1743 wxString filename = wxFileSelector("Choose a file to open");
1744 if ( !filename.empty() )
1746 // work with the file
1749 //else: cancelled by user
1752 \wxheading{Include files}
1757 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1759 \func{void}{wxEndBusyCursor}{\void}
1761 Changes the cursor back to the original cursor, for all windows in the application.
1762 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1764 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1766 \wxheading{Include files}
1771 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
1773 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
1775 Shows the colour selection dialog and returns the colour selected by user or
1776 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
1777 is valid) if the dialog was cancelled.
1779 \wxheading{Parameters}
1781 \docparam{parent}{The parent window for the colour selection dialog}
1783 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
1785 \wxheading{Include files}
1790 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
1792 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
1794 Shows the font selection dialog and returns the font selected by user or
1795 invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
1796 is valid) if the dialog was cancelled.
1798 \wxheading{Parameters}
1800 \docparam{parent}{The parent window for the font selection dialog}
1802 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
1804 \wxheading{Include files}
1810 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
1812 \func{size\_t}{wxGetMultipleChoices}{\\
1813 \param{wxArrayInt\& }{selections},\\
1814 \param{const wxString\& }{message},\\
1815 \param{const wxString\& }{caption},\\
1816 \param{const wxArrayString\& }{aChoices},\\
1817 \param{wxWindow *}{parent = NULL},\\
1818 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1819 \param{bool}{ centre = true},\\
1820 \param{int }{width=150}, \param{int }{height=200}}
1822 \func{size\_t}{wxGetMultipleChoices}{\\
1823 \param{wxArrayInt\& }{selections},\\
1824 \param{const wxString\& }{message},\\
1825 \param{const wxString\& }{caption},\\
1826 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1827 \param{wxWindow *}{parent = NULL},\\
1828 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1829 \param{bool}{ centre = true},\\
1830 \param{int }{width=150}, \param{int }{height=200}}
1832 Pops up a dialog box containing a message, OK/Cancel buttons and a
1833 multiple-selection listbox. The user may choose an arbitrary (including 0)
1834 number of items in the listbox whose indices will be returned in
1835 {\it selection} array. The initial contents of this array will be used to
1836 select the items when the dialog is shown.
1838 You may pass the list of strings to choose from either using {\it choices}
1839 which is an array of {\it n} strings for the listbox or by using a single
1840 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1842 If {\it centre} is true, the message text (which may include new line
1843 characters) is centred; if false, the message is left-justified.
1845 \wxheading{Include files}
1849 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1850 and {\tt choices}, and no {\tt selections} parameter; the function
1851 returns an array containing the user selections.}
1854 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
1856 \func{long}{wxGetNumberFromUser}{
1857 \param{const wxString\& }{message},
1858 \param{const wxString\& }{prompt},
1859 \param{const wxString\& }{caption},
1860 \param{long }{value},
1861 \param{long }{min = 0},
1862 \param{long }{max = 100},
1863 \param{wxWindow *}{parent = NULL},
1864 \param{const wxPoint\& }{pos = wxDefaultPosition}}
1866 Shows a dialog asking the user for numeric input. The dialogs title is set to
1867 {\it caption}, it contains a (possibly) multiline {\it message} above the
1868 single line {\it prompt} and the zone for entering the number.
1870 The number entered must be in the range {\it min}..{\it max} (both of which
1871 should be positive) and {\it value} is the initial value of it. If the user
1872 enters an invalid value or cancels the dialog, the function will return -1.
1874 Dialog is centered on its {\it parent} unless an explicit position is given in
1877 \wxheading{Include files}
1882 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
1884 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1885 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
1887 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
1888 in the dialog is not shown on screen but replaced with stars. This is intended
1889 to be used for entering passwords as the function name implies.
1891 \wxheading{Include files}
1896 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
1898 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1899 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
1900 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}}
1902 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
1903 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
1904 or press Cancel to return the empty string.
1906 If {\it centre} is true, the message text (which may include new line characters)
1907 is centred; if false, the message is left-justified.
1909 \wxheading{Include files}
1914 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
1916 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1917 \param{int }{nsel}, \param{int *}{selection},
1918 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1919 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1921 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
1922 listbox. The user may choose one or more item(s) and press OK or Cancel.
1924 The number of initially selected choices, and array of the selected indices,
1925 are passed in; this array will contain the user selections on exit, with
1926 the function returning the number of selections. {\it selection} must be
1927 as big as the number of choices, in case all are selected.
1929 If Cancel is pressed, -1 is returned.
1931 {\it choices} is an array of {\it n} strings for the listbox.
1933 If {\it centre} is true, the message text (which may include new line characters)
1934 is centred; if false, the message is left-justified.
1936 \wxheading{Include files}
1941 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
1943 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1944 \param{const wxString\& }{caption},\\
1945 \param{const wxArrayString\& }{aChoices},\\
1946 \param{wxWindow *}{parent = NULL},\\
1947 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1948 \param{bool}{ centre = true},\\
1949 \param{int }{width=150}, \param{int }{height=200}}
1951 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1952 \param{const wxString\& }{caption},\\
1953 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1954 \param{wxWindow *}{parent = NULL},\\
1955 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1956 \param{bool}{ centre = true},\\
1957 \param{int }{width=150}, \param{int }{height=200}}
1959 Pops up a dialog box containing a message, OK/Cancel buttons and a
1960 single-selection listbox. The user may choose an item and press OK to return a
1961 string or Cancel to return the empty string. Use
1962 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
1963 valid choice and if you want to be able to detect pressing Cancel reliably.
1965 You may pass the list of strings to choose from either using {\it choices}
1966 which is an array of {\it n} strings for the listbox or by using a single
1967 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1969 If {\it centre} is true, the message text (which may include new line
1970 characters) is centred; if false, the message is left-justified.
1972 \wxheading{Include files}
1976 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1980 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
1982 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1983 \param{const wxString\& }{caption},\\
1984 \param{const wxArrayString\& }{aChoices},\\
1985 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1986 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1988 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1989 \param{const wxString\& }{caption},\\
1990 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1991 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1992 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1994 As {\bf wxGetSingleChoice} but returns the index representing the selected
1995 string. If the user pressed cancel, -1 is returned.
1997 \wxheading{Include files}
2001 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2005 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
2007 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2008 \param{const wxString\& }{caption},\\
2009 \param{const wxArrayString\& }{aChoices},\\
2010 \param{const wxString\& }{client\_data[]},\\
2011 \param{wxWindow *}{parent = NULL},\\
2012 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2013 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2015 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
2016 \param{const wxString\& }{caption},\\
2017 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
2018 \param{const wxString\& }{client\_data[]},\\
2019 \param{wxWindow *}{parent = NULL},\\
2020 \param{int}{ x = -1}, \param{int}{ y = -1},\\
2021 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
2023 As {\bf wxGetSingleChoice} but takes an array of client data pointers
2024 corresponding to the strings, and returns one of these pointers or NULL if
2025 Cancel was pressed. The {\it client\_data} array must have the same number of
2026 elements as {\it choices} or {\it aChoices}!
2028 \wxheading{Include files}
2032 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
2033 and {\tt choices}, and the client data array must have the
2034 same length as the choices array.}
2037 \membersection{::wxIsBusy}\label{wxisbusy}
2039 \func{bool}{wxIsBusy}{\void}
2041 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
2042 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
2044 See also \helpref{wxBusyCursor}{wxbusycursor}.
2046 \wxheading{Include files}
2051 \membersection{::wxMessageBox}\label{wxmessagebox}
2053 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
2054 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
2056 General purpose message dialog. {\it style} may be a bit list of the
2057 following identifiers:
2059 \begin{twocollist}\itemsep=0pt
2060 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
2062 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
2064 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
2065 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
2066 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
2067 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
2068 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
2069 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
2072 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
2078 int answer = wxMessageBox("Quit program?", "Confirm",
2079 wxYES_NO | wxCANCEL, main_frame);
2080 if (answer == wxYES)
2081 main_frame->Close();
2085 {\it message} may contain newline characters, in which case the
2086 message will be split into separate lines, to cater for large messages.
2088 \wxheading{Include files}
2093 \membersection{::wxShowTip}\label{wxshowtip}
2095 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
2096 \param{wxTipProvider *}{tipProvider},
2097 \param{bool }{showAtStartup = true}}
2099 This function shows a "startup tip" to the user. The return value is the
2100 state of the ``Show tips at startup'' checkbox.
2102 \docparam{parent}{The parent window for the modal dialog}
2104 \docparam{tipProvider}{An object which is used to get the text of the tips.
2105 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
2107 \docparam{showAtStartup}{Should be true if startup tips are shown, false
2108 otherwise. This is used as the initial value for "Show tips at startup"
2109 checkbox which is shown in the tips dialog.}
2111 \wxheading{See also}
2113 \helpref{Tips overview}{tipsoverview}
2115 \wxheading{Include files}
2122 \section{Math functions}
2124 \wxheading{Include files}
2129 \membersection{wxFinite}\label{wxfinite}
2131 \func{int}{wxFinite}{\param{double }{x}}
2133 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
2134 returns 0 otherwise.
2137 \membersection{wxIsNaN}\label{wxisnan}
2139 \func{bool}{wxIsNaN}{\param{double }{x}}
2141 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
2147 \section{GDI functions}\label{gdifunctions}
2149 The following are relevant to the GDI (Graphics Device Interface).
2151 \wxheading{Include files}
2156 \membersection{wxBITMAP}\label{wxbitmapmacro}
2158 \func{}{wxBITMAP}{bitmapName}
2160 This macro loads a bitmap from either application resources (on the platforms
2161 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2162 avoid using {\tt \#ifdef}s when creating bitmaps.
2164 \wxheading{See also}
2166 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2167 \helpref{wxICON}{wxiconmacro}
2169 \wxheading{Include files}
2174 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
2176 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
2177 \param{int *}{width}, \param{int *}{height}}
2179 \func{wxRect}{wxGetClientDisplayRect}{\void}
2181 Returns the dimensions of the work area on the display. On Windows
2182 this means the area not covered by the taskbar, etc. Other platforms
2183 are currently defaulting to the whole display until a way is found to
2184 provide this info for all window managers, etc.
2187 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
2189 \func{bool}{wxColourDisplay}{\void}
2191 Returns true if the display is colour, false otherwise.
2194 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
2196 \func{int}{wxDisplayDepth}{\void}
2198 Returns the depth of the display (a value of 1 denotes a monochrome display).
2201 \membersection{::wxDisplaySize}\label{wxdisplaysize}
2203 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
2205 \func{wxSize}{wxGetDisplaySize}{\void}
2207 Returns the display size in pixels.
2210 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
2212 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
2214 \func{wxSize}{wxGetDisplaySizeMM}{\void}
2216 Returns the display size in millimeters.
2219 \membersection{::wxDROP\_ICON}\label{wxdropicon}
2221 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
2223 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
2224 name. Under MSW, the cursor is loaded from the resource file and the icon is
2225 loaded from XPM file under other platforms.
2227 This macro should be used with
2228 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
2230 \wxheading{Include files}
2235 \membersection{wxICON}\label{wxiconmacro}
2237 \func{}{wxICON}{iconName}
2239 This macro loads an icon from either application resources (on the platforms
2240 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2241 avoid using {\tt \#ifdef}s when creating icons.
2243 \wxheading{See also}
2245 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2246 \helpref{wxBITMAP}{wxbitmapmacro}
2248 \wxheading{Include files}
2253 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2255 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2256 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2258 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2259 makes it into a placeable metafile by prepending a header containing the given
2260 bounding box. The bounding box may be obtained from a device context after drawing
2261 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2263 In addition to adding the placeable metafile header, this function adds
2264 the equivalent of the following code to the start of the metafile data:
2267 SetMapMode(dc, MM_ANISOTROPIC);
2268 SetWindowOrg(dc, minX, minY);
2269 SetWindowExt(dc, maxX - minX, maxY - minY);
2272 This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes.
2274 Placeable metafiles may be imported by many Windows applications, and can be
2275 used in RTF (Rich Text Format) files.
2277 {\it scale} allows the specification of scale for the metafile.
2279 This function is only available under Windows.
2282 \membersection{::wxSetCursor}\label{wxsetcursor}
2284 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2286 Globally sets the cursor; only has an effect in Windows and GTK.
2287 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2291 \section{Printer settings}\label{printersettings}
2293 {\bf NB:} These routines are obsolete and should no longer be used!
2295 The following functions are used to control PostScript printing. Under
2296 Windows, PostScript output can only be sent to a file.
2298 \wxheading{Include files}
2303 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2305 \func{wxString}{wxGetPrinterCommand}{\void}
2307 Gets the printer command used to print a file. The default is {\tt lpr}.
2310 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2312 \func{wxString}{wxGetPrinterFile}{\void}
2314 Gets the PostScript output filename.
2317 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2319 \func{int}{wxGetPrinterMode}{\void}
2321 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2322 The default is PS\_PREVIEW.
2325 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2327 \func{wxString}{wxGetPrinterOptions}{\void}
2329 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2332 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2334 \func{int}{wxGetPrinterOrientation}{\void}
2336 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2339 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2341 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2343 Gets the command used to view a PostScript file. The default depends on the platform.
2346 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2348 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2350 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2353 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2355 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2357 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2360 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2362 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2364 Sets the printer command used to print a file. The default is {\tt lpr}.
2367 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2369 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2371 Sets the PostScript output filename.
2374 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2376 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2378 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2379 The default is PS\_PREVIEW.
2382 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2384 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2386 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2389 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2391 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2393 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2396 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2398 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2400 Sets the command used to view a PostScript file. The default depends on the platform.
2403 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2405 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2407 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2410 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2412 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2414 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2418 \section{Clipboard functions}\label{clipsboard}
2420 These clipboard functions are implemented for Windows only. The use of these functions
2421 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2424 \wxheading{Include files}
2429 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2431 \func{bool}{wxClipboardOpen}{\void}
2433 Returns true if this application has already opened the clipboard.
2436 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2438 \func{bool}{wxCloseClipboard}{\void}
2440 Closes the clipboard to allow other applications to use it.
2443 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2445 \func{bool}{wxEmptyClipboard}{\void}
2447 Empties the clipboard.
2450 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2452 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
2454 Enumerates the formats found in a list of available formats that belong
2455 to the clipboard. Each call to this function specifies a known
2456 available format; the function returns the format that appears next in
2459 {\it dataFormat} specifies a known format. If this parameter is zero,
2460 the function returns the first format in the list.
2462 The return value specifies the next known clipboard data format if the
2463 function is successful. It is zero if the {\it dataFormat} parameter specifies
2464 the last format in the list of available formats, or if the clipboard
2467 Before it enumerates the formats function, an application must open the clipboard by using the
2468 wxOpenClipboard function.
2471 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2473 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
2475 Gets data from the clipboard.
2477 {\it dataFormat} may be one of:
2479 \begin{itemize}\itemsep=0pt
2480 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2481 \item wxCF\_BITMAP: returns a new wxBitmap.
2484 The clipboard must have previously been opened for this call to succeed.
2487 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2489 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
2491 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2492 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2495 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2497 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
2499 Returns true if the given data format is available on the clipboard.
2502 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2504 \func{bool}{wxOpenClipboard}{\void}
2506 Opens the clipboard for passing data to it or getting data from it.
2509 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2511 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2513 Registers the clipboard data format name and returns an identifier.
2516 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2518 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
2520 Passes data to the clipboard.
2522 {\it dataFormat} may be one of:
2524 \begin{itemize}\itemsep=0pt
2525 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2526 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2527 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2528 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2531 The clipboard must have previously been opened for this call to succeed.
2536 \section{Miscellaneous functions}\label{miscellany}
2539 \membersection{wxCONCAT}\label{wxconcat}
2541 \func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
2543 This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
2546 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
2548 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
2550 When loading a function from a DLL you always have to cast the returned
2551 {\tt void *} pointer to the correct type and, even more annoyingly, you have to
2552 repeat this type twice if you want to declare and define a function pointer all
2555 This macro makes this slightly less painful by allowing you to specify the
2556 type only once, as the first parameter, and creating a variable of this type
2557 named after the function but with {\tt pfn} prefix and initialized with the
2558 function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}
2561 \wxheading{Parameters}
2563 \docparam{type}{the type of the function}
2565 \docparam{name}{the name of the function to load, not a string (without quotes,
2566 it is quoted automatically by the macro)}
2568 \docparam{dynlib}{the library to load the function from}
2572 \membersection{wxEXPLICIT}\label{wxexplicit}
2574 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2575 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2576 code which might have to be compiled with an old compiler without support for
2577 this language feature but still take advantage of it when it is available.
2580 \membersection{::wxGetKeyState}\label{wxgetkeystate}
2582 \func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
2584 Returns \true if the key parameter is currently pressed on the keyboard, or
2585 with modifier keys, (caps lock, etc) if the key is active (the led light is
2588 \wxheading{Include files}
2593 \membersection{wxLL}\label{wxll}
2595 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2597 This macro is defined for the platforms with a native 64 bit integer type and
2598 allows to define 64 bit compile time constants:
2602 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2606 \wxheading{Include files}
2610 \wxheading{See also}
2612 \helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
2615 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2617 This macro is defined to contain the {\tt printf()} format specifier using
2618 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2619 printed. Example of using it:
2623 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2624 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2628 \wxheading{See also}
2630 \helpref{wxLL}{wxll}
2632 \wxheading{Include files}
2637 \membersection{::wxNewId}\label{wxnewid}
2639 \func{long}{wxNewId}{\void}
2641 Generates an integer identifier unique to this run of the program.
2643 \wxheading{Include files}
2648 \membersection{::wxRegisterId}\label{wxregisterid}
2650 \func{void}{wxRegisterId}{\param{long}{ id}}
2652 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2655 \wxheading{Include files}
2660 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2662 \func{void}{wxDDECleanUp}{\void}
2664 Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be
2665 called by the application.
2667 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2669 \wxheading{Include files}
2674 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2676 \func{void}{wxDDEInitialize}{\void}
2678 Initializes the DDE system. May be called multiple times without harm.
2680 This no longer needs to be called by the application: it will be called
2681 by wxWidgets if necessary.
2683 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
2684 \helpref{wxDDECleanUp}{wxddecleanup}.
2686 \wxheading{Include files}
2691 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
2693 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
2695 This function enables or disables all top level windows. It is used by
2696 \helpref{::wxSafeYield}{wxsafeyield}.
2698 \wxheading{Include files}
2703 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
2705 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
2707 Find a menu item identifier associated with the given frame's menu bar.
2709 \wxheading{Include files}
2714 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
2716 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
2718 {\bf NB:} This function is obsolete, please use
2719 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
2721 Find a window by its label. Depending on the type of window, the label may be a window title
2722 or panel item label. If {\it parent} is NULL, the search will start from all top-level
2723 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2724 The search is recursive in both cases.
2726 \wxheading{Include files}
2731 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
2733 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
2735 {\bf NB:} This function is obsolete, please use
2736 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
2738 Find a window by its name (as given in a window constructor or {\bf Create} function call).
2739 If {\it parent} is NULL, the search will start from all top-level
2740 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2741 The search is recursive in both cases.
2743 If no such named window is found, {\bf wxFindWindowByLabel} is called.
2745 \wxheading{Include files}
2750 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
2752 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
2754 Find the deepest window at the given mouse position in screen coordinates,
2755 returning the window if found, or NULL if not.
2758 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
2760 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
2762 Find the deepest window at the mouse pointer position, returning the window
2763 and current pointer position in screen coordinates.
2766 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
2768 \func{wxWindow *}{wxGetActiveWindow}{\void}
2770 Gets the currently active window (Windows only).
2772 \wxheading{Include files}
2777 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
2779 \func{wxString}{wxGetDisplayName}{\void}
2781 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
2783 \wxheading{Include files}
2788 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
2790 \func{wxPoint}{wxGetMousePosition}{\void}
2792 Returns the mouse position in screen coordinates.
2794 \wxheading{Include files}
2799 \membersection{::wxGetResource}\label{wxgetresource}
2801 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2802 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
2804 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2805 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
2807 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2808 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
2810 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2811 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
2813 Gets a resource value from the resource database (for example, WIN.INI, or
2814 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2815 otherwise the specified file is used.
2817 Under X, if an application class (wxApp::GetClassName) has been defined,
2818 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
2819 an applications default file when merging all resource databases.
2821 The reason for passing the result in an argument is that it
2822 can be convenient to define a default value, which gets overridden
2823 if the value exists in the resource file. It saves a separate
2824 test for that resource's existence, and it also allows
2825 the overloading of the function for different types.
2827 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
2829 \wxheading{Include files}
2834 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
2836 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
2838 Returns the first top level parent of the given window, or in other words, the
2839 frame or dialog containing it, or {\tt NULL}.
2841 \wxheading{Include files}
2846 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
2848 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
2850 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
2851 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
2853 The resource must be defined in the {\tt .rc} file using the following syntax:
2856 myResource TEXT file.ext
2859 where {\tt file.ext} is a file that the resource compiler can find.
2861 This function is available under Windows only.
2863 \wxheading{Include files}
2868 \membersection{::wxPostDelete}\label{wxpostdelete}
2870 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
2872 Tells the system to delete the specified object when
2873 all other events have been processed. In some environments, it is
2874 necessary to use this instead of deleting a frame directly with the
2875 delete operator, because some GUIs will still send events to a deleted window.
2877 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
2879 \wxheading{Include files}
2884 \membersection{::wxPostEvent}\label{wxpostevent}
2886 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
2888 In a GUI application, this function posts {\it event} to the specified {\it dest}
2889 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2890 Otherwise, it dispatches {\it event} immediately using
2891 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
2892 See the respective documentation for details (and caveats).
2894 \wxheading{Include files}
2899 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
2901 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
2903 Under X only, sets the current display name. This is the X host and display name such
2904 as ``colonsay:0.0", and the function indicates which display should be used for creating
2905 windows from this point on. Setting the display within an application allows multiple
2906 displays to be used.
2908 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
2910 \wxheading{Include files}
2915 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
2917 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
2919 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
2921 {\bf NB:} This function is obsolete, please use
2922 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
2924 Strips any menu codes from {\it in} and places the result
2925 in {\it out} (or returns the new string, in the first form).
2927 Menu codes include \& (mark the next character with an underline
2928 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
2930 \wxheading{Include files}
2935 \membersection{wxULL}\label{wxull}
2937 \func{wxLongLong\_t}{wxULL}{\param{}{number}}
2939 This macro is defined for the platforms with a native 64 bit integer type and
2940 allows to define unsigned 64 bit compile time constants:
2944 unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
2948 \wxheading{Include files}
2952 \wxheading{See also}
2954 \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
2957 \membersection{::wxWriteResource}\label{wxwriteresource}
2959 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2960 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
2962 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2963 \param{float }{value}, \param{const wxString\& }{file = NULL}}
2965 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2966 \param{long }{value}, \param{const wxString\& }{file = NULL}}
2968 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2969 \param{int }{value}, \param{const wxString\& }{file = NULL}}
2971 Writes a resource value into the resource database (for example, WIN.INI, or
2972 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2973 otherwise the specified file is used.
2975 Under X, the resource databases are cached until the internal function
2976 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
2977 all updated resource databases are written to their files.
2979 Note that it is considered bad manners to write to the .Xdefaults
2980 file under Unix, although the WIN.INI file is fair game under Windows.
2982 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
2984 \wxheading{Include files}
2990 \section{Byte order macros}\label{byteordermacros}
2992 The endian-ness issues (that is the difference between big-endian and
2993 little-endian architectures) are important for the portable programs working
2994 with the external binary data (for example, data files or data coming from
2995 network) which is usually in some fixed, platform-independent format. The
2996 macros are helpful for transforming the data to the correct format.
2999 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
3001 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
3003 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
3005 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
3007 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
3009 These macros will swap the bytes of the {\it value} variable from little
3010 endian to big endian or vice versa unconditionally, i.e. independently of the
3014 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
3016 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
3018 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
3020 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
3022 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
3024 This macro will swap the bytes of the {\it value} variable from little
3025 endian to big endian or vice versa if the program is compiled on a
3026 big-endian architecture (such as Sun work stations). If the program has
3027 been compiled on a little-endian architecture, the value will be unchanged.
3029 Use these macros to read data from and write data to a file that stores
3030 data in little-endian (for example Intel i386) format.
3033 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
3035 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
3037 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
3039 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
3041 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
3043 This macro will swap the bytes of the {\it value} variable from little
3044 endian to big endian or vice versa if the program is compiled on a
3045 little-endian architecture (such as Intel PCs). If the program has
3046 been compiled on a big-endian architecture, the value will be unchanged.
3048 Use these macros to read data from and write data to a file that stores
3049 data in big-endian format.
3053 \section{RTTI functions}\label{rttimacros}
3055 wxWidgets uses its own RTTI ("run-time type identification") system which
3056 predates the current standard C++ RTTI and so is kept for backwards
3057 compatibility reasons but also because it allows some things which the
3058 standard RTTI doesn't directly support (such as creating a class from its
3061 The standard C++ RTTI can be used in the user code without any problems and in
3062 general you shouldn't need to use the functions and the macros in this section
3063 unless you are thinking of modifying or adding any wxWidgets classes.
3065 \wxheading{See also}
3067 \helpref{RTTI overview}{runtimeclassoverview}
3070 \membersection{CLASSINFO}\label{classinfo}
3072 \func{wxClassInfo *}{CLASSINFO}{className}
3074 Returns a pointer to the wxClassInfo object associated with this class.
3076 \wxheading{Include files}
3081 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
3083 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
3085 Used inside a class declaration to declare that the class should be
3086 made known to the class hierarchy, but objects of this class cannot be created
3087 dynamically. The same as DECLARE\_CLASS.
3092 class wxCommand: public wxObject
3094 DECLARE_ABSTRACT_CLASS(wxCommand)
3103 \wxheading{Include files}
3108 \membersection{DECLARE\_APP}\label{declareapp}
3110 \func{}{DECLARE\_APP}{className}
3112 This is used in headers to create a forward declaration of the
3113 \helpref{wxGetApp}{wxgetapp} function implemented by
3114 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
3115 {\tt className\& wxGetApp(void)}.
3123 \wxheading{Include files}
3128 \membersection{DECLARE\_CLASS}\label{declareclass}
3130 \func{}{DECLARE\_CLASS}{className}
3132 Used inside a class declaration to declare that the class should be
3133 made known to the class hierarchy, but objects of this class cannot be created
3134 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
3136 \wxheading{Include files}
3141 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
3143 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
3145 Used inside a class declaration to declare that the objects of this class should be dynamically
3146 creatable from run-time type information.
3151 class wxFrame: public wxWindow
3153 DECLARE_DYNAMIC_CLASS(wxFrame)
3156 const wxString& frameTitle;
3162 \wxheading{Include files}
3167 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
3169 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
3171 Used in a C++ implementation file to complete the declaration of
3172 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
3177 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
3179 wxCommand::wxCommand(void)
3185 \wxheading{Include files}
3190 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
3192 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
3194 Used in a C++ implementation file to complete the declaration of
3195 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
3197 \wxheading{Include files}
3202 \membersection{IMPLEMENT\_APP}\label{implementapp}
3204 \func{}{IMPLEMENT\_APP}{className}
3206 This is used in the application class implementation file to make the application class known to
3207 wxWidgets for dynamic construction. You use this instead of
3218 IMPLEMENT_APP(MyApp)
3221 See also \helpref{DECLARE\_APP}{declareapp}.
3223 \wxheading{Include files}
3228 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
3230 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
3232 Used in a C++ implementation file to complete the declaration of
3233 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
3235 \wxheading{Include files}
3240 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
3242 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
3244 Used in a C++ implementation file to complete the declaration of a
3245 class that has run-time type information and two base classes. The
3246 same as IMPLEMENT\_ABSTRACT\_CLASS2.
3248 \wxheading{Include files}
3253 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
3255 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
3257 Used in a C++ implementation file to complete the declaration of
3258 a class that has run-time type information, and whose instances
3259 can be created dynamically.
3264 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
3266 wxFrame::wxFrame(void)
3272 \wxheading{Include files}
3277 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
3279 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
3281 Used in a C++ implementation file to complete the declaration of
3282 a class that has run-time type information, and whose instances
3283 can be created dynamically. Use this for classes derived from two
3286 \wxheading{Include files}
3291 \membersection{wxConstCast}\label{wxconstcast}
3293 \func{classname *}{wxConstCast}{ptr, classname}
3295 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
3296 supports {\it const\_cast} or into an old, C-style cast, otherwise.
3298 \wxheading{See also}
3300 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3301 \helpref{wxDynamicCast}{wxdynamiccast}\\
3302 \helpref{wxStaticCast}{wxstaticcast}
3305 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
3307 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
3309 Creates and returns an object of the given class, if the class has been
3310 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
3313 \membersection{WXDEBUG\_NEW}\label{debugnew}
3315 \func{}{WXDEBUG\_NEW}{arg}
3317 This is defined in debug mode to be call the redefined new operator
3318 with filename and line number arguments. The definition is:
3321 #define WXDEBUG_NEW new(__FILE__,__LINE__)
3324 In non-debug mode, this is defined as the normal new operator.
3326 \wxheading{Include files}
3331 \membersection{wxDynamicCast}\label{wxdynamiccast}
3333 \func{classname *}{wxDynamicCast}{ptr, classname}
3335 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
3336 the pointer is of this type (the check is done during the run-time) or
3337 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
3338 wxObject::IsKindOf() function.
3340 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
3346 wxWindow *win = wxWindow::FindFocus();
3347 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
3350 // a text control has the focus...
3354 // no window has the focus or it is not a text control
3358 \wxheading{See also}
3360 \helpref{RTTI overview}{runtimeclassoverview}\\
3361 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
3362 \helpref{wxConstCast}{wxconstcast}\\
3363 \helpref{wxStatiicCast}{wxstaticcast}
3366 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
3368 \func{classname *}{wxDynamicCastThis}{classname}
3370 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
3371 latter provokes spurious compilation warnings from some compilers (because it
3372 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
3373 this macro should be used to avoid them.
3375 \wxheading{See also}
3377 \helpref{wxDynamicCast}{wxdynamiccast}
3380 \membersection{wxStaticCast}\label{wxstaticcast}
3382 \func{classname *}{wxStaticCast}{ptr, classname}
3384 This macro checks that the cast is valid in debug mode (an assert failure will
3385 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
3386 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
3388 \wxheading{See also}
3390 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3391 \helpref{wxDynamicCast}{wxdynamiccast}\\
3392 \helpref{wxConstCast}{wxconstcast}
3395 \membersection{wx\_const\_cast}\label{wxconstcastraw}
3397 \func{T}{wx\_const\_cast}{T, x}
3399 Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
3400 \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
3401 the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
3402 arguments is the same as for the standard cast.
3404 \wxheading{See also}
3406 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
3409 \membersection{wx\_static\_cast}\label{wxstaticcastraw}
3411 \func{T}{wx\_static\_cast}{T, x}
3413 Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
3414 \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
3415 there are no checks being done and the meaning of the macro arguments is exactly
3416 the same as for the standard static cast, i.e. \arg{T} is the full type name and
3417 star is not appended to it.
3419 \wxheading{See also}
3421 \helpref{wx\_const\_cast}{wxconstcastraw}\\
3425 \section{Log functions}\label{logfunctions}
3427 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
3428 further information. The functions use (implicitly) the currently active log
3429 target, so their descriptions here may not apply if the log target is not the
3430 standard one (installed by wxWidgets in the beginning of the program).
3432 \wxheading{Include files}
3437 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3439 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3441 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3442 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3444 Display a debugging message; under Windows, this will appear on the
3445 debugger command window, and under Unix, it will be written to standard
3448 The syntax is identical to {\bf printf}: pass a format string and a
3449 variable list of arguments.
3451 {\bf Tip:} under Windows, if your application crashes before the
3452 message appears in the debugging window, put a wxYield call after
3453 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3454 (at least for Watcom C++): preformat your messages and use OutputDebugString
3457 \wxheading{Include files}
3462 \membersection{::wxError}\label{wxerror}
3464 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}
3466 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3469 Displays {\it msg} and continues. This writes to standard error under
3470 Unix, and pops up a message box under Windows. Used for internal
3471 wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.
3473 \wxheading{Include files}
3478 \membersection{::wxFatalError}\label{wxfatalerror}
3480 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}
3482 {\bf NB:} This function is now obsolete, please use
3483 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3485 Displays {\it msg} and exits. This writes to standard error under Unix,
3486 and pops up a message box under Windows. Used for fatal internal
3487 wxWidgets errors. See also \helpref{wxError}{wxerror}.
3489 \wxheading{Include files}
3494 \membersection{::wxLogError}\label{wxlogerror}
3496 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
3498 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3500 The functions to use for error messages, i.e. the messages that must be shown
3501 to the user. The default processing is to pop up a message box to inform the
3505 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
3507 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
3509 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3511 Like \helpref{wxLogError}{wxlogerror}, but also
3512 terminates the program with the exit code 3. Using {\it abort()} standard
3513 function also terminates the program with this exit code.
3516 \membersection{::wxLogWarning}\label{wxlogwarning}
3518 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
3520 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3522 For warnings - they are also normally shown to the user, but don't interrupt
3526 \membersection{::wxLogMessage}\label{wxlogmessage}
3528 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
3530 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3532 For all normal, informational messages. They also appear in a message box by
3533 default (but it can be changed). Notice that the standard behaviour is to not
3534 show informational messages if there are any errors later - the logic being
3535 that the later error messages make the informational messages preceding them
3539 \membersection{::wxLogVerbose}\label{wxlogverbose}
3541 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
3543 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3545 For verbose output. Normally, it is suppressed, but
3546 might be activated if the user wishes to know more details about the program
3547 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
3550 \membersection{::wxLogStatus}\label{wxlogstatus}
3552 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
3554 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3556 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
3558 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3560 Messages logged by these functions will appear in the statusbar of the {\it
3561 frame} or of the top level application window by default (i.e. when using
3562 the second version of the functions).
3564 If the target frame doesn't have a statusbar, the message will be lost.
3567 \membersection{::wxLogSysError}\label{wxlogsyserror}
3569 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
3571 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3573 Mostly used by wxWidgets itself, but might be handy for logging errors after
3574 system call (API function) failure. It logs the specified message text as well
3575 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
3576 on the platform) and the corresponding error message. The second form
3577 of this function takes the error code explicitly as the first argument.
3579 \wxheading{See also}
3581 \helpref{wxSysErrorCode}{wxsyserrorcode},
3582 \helpref{wxSysErrorMsg}{wxsyserrormsg}
3585 \membersection{::wxLogDebug}\label{wxlogdebug}
3587 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
3589 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3591 The right functions for debug output. They only do something in debug
3592 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
3593 nothing in release mode (otherwise).
3596 \membersection{::wxLogTrace}\label{wxlogtrace}
3598 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
3600 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3602 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
3604 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3606 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
3608 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3610 As {\bf wxLogDebug}, trace functions only do something in debug build and
3611 expand to nothing in the release one. The reason for making
3612 it a separate function from it is that usually there are a lot of trace
3613 messages, so it might make sense to separate them from other debug messages.
3615 The trace messages also usually can be separated into different categories and
3616 the second and third versions of this function only log the message if the
3617 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
3618 allows to selectively trace only some operations and not others by changing
3619 the value of the trace mask (possible during the run-time).
3621 For the second function (taking a string mask), the message is logged only if
3622 the mask has been previously enabled by the call to
3623 \helpref{AddTraceMask}{wxlogaddtracemask} or by setting
3624 \helpref{{\tt WXTRACE} environment variable}{envvars}.
3625 The predefined string trace masks
3626 used by wxWidgets are:
3628 \begin{itemize}\itemsep=0pt
3629 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
3630 \item wxTRACE\_Messages: trace window messages/X callbacks
3631 \item wxTRACE\_ResAlloc: trace GDI resource allocation
3632 \item wxTRACE\_RefCount: trace various ref counting operations
3633 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
3636 The third version of the function only logs the message if all the bit
3637 corresponding to the {\it mask} are set in the wxLog trace mask which can be
3638 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
3639 flexible than the previous one because it doesn't allow defining the user
3640 trace masks easily - this is why it is deprecated in favour of using string
3643 \begin{itemize}\itemsep=0pt
3644 \item wxTraceMemAlloc: trace memory allocation (new/delete)
3645 \item wxTraceMessages: trace window messages/X callbacks
3646 \item wxTraceResAlloc: trace GDI resource allocation
3647 \item wxTraceRefCount: trace various ref counting operations
3648 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
3652 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
3654 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
3656 This function shows a message to the user in a safe way and should be safe to
3657 call even before the application has been initialized or if it is currently in
3658 some other strange state (for example, about to crash). Under Windows this
3659 function shows a message box using a native dialog instead of
3660 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
3661 it simply prints the message to the standard output using the title as prefix.
3663 \wxheading{Parameters}
3665 \docparam{title}{The title of the message box shown to the user or the prefix
3666 of the message string}
3668 \docparam{text}{The text to show to the user}
3670 \wxheading{See also}
3672 \helpref{wxLogFatalError}{wxlogfatalerror}
3674 \wxheading{Include files}
3679 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
3681 \func{unsigned long}{wxSysErrorCode}{\void}
3683 Returns the error code from the last system call. This function uses
3684 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
3686 \wxheading{See also}
3688 \helpref{wxSysErrorMsg}{wxsyserrormsg},
3689 \helpref{wxLogSysError}{wxlogsyserror}
3692 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
3694 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
3696 Returns the error message corresponding to the given system error code. If
3697 {\it errCode} is $0$ (default), the last error code (as returned by
3698 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
3700 \wxheading{See also}
3702 \helpref{wxSysErrorCode}{wxsyserrorcode},
3703 \helpref{wxLogSysError}{wxlogsyserror}
3706 \membersection{WXTRACE}\label{trace}
3708 \wxheading{Include files}
3712 \func{}{WXTRACE}{formatString, ...}
3714 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3716 Calls wxTrace with printf-style variable argument syntax. Output
3717 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3719 \wxheading{Include files}
3724 \membersection{WXTRACELEVEL}\label{tracelevel}
3726 \func{}{WXTRACELEVEL}{level, formatString, ...}
3728 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3730 Calls wxTraceLevel with printf-style variable argument syntax. Output
3731 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3732 The first argument should be the level at which this information is appropriate.
3733 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3736 \wxheading{Include files}
3741 \membersection{::wxTrace}\label{wxtrace}
3743 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
3745 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3747 Takes printf-style variable argument syntax. Output
3748 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3750 \wxheading{Include files}
3755 \membersection{::wxTraceLevel}\label{wxtracelevel}
3757 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
3759 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3761 Takes printf-style variable argument syntax. Output
3762 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3763 The first argument should be the level at which this information is appropriate.
3764 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3767 \wxheading{Include files}
3773 \section{Time functions}\label{timefunctions}
3775 The functions in this section deal with getting the current time and
3776 starting/stopping the global timers. Please note that the timer functions are
3777 deprecated because they work with one global timer only and
3778 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
3779 should be used instead. For retrieving the current time, you may also use
3780 \helpref{wxDateTime::Now}{wxdatetimenow} or
3781 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
3784 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
3786 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
3788 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
3790 If {\it resetTimer} is true (the default), the timer is reset to zero
3793 See also \helpref{wxTimer}{wxtimer}.
3795 \wxheading{Include files}
3800 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
3802 \func{long}{wxGetLocalTime}{\void}
3804 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
3806 \wxheading{See also}
3808 \helpref{wxDateTime::Now}{wxdatetimenow}
3810 \wxheading{Include files}
3815 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
3817 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
3819 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
3821 \wxheading{See also}
3823 \helpref{wxDateTime::Now}{wxdatetimenow},\\
3824 \helpref{wxLongLong}{wxlonglong}
3826 \wxheading{Include files}
3831 \membersection{::wxGetUTCTime}\label{wxgetutctime}
3833 \func{long}{wxGetUTCTime}{\void}
3835 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
3837 \wxheading{See also}
3839 \helpref{wxDateTime::Now}{wxdatetimenow}
3841 \wxheading{Include files}
3846 \membersection{::wxNow}\label{wxnow}
3848 \func{wxString}{wxNow}{\void}
3850 Returns a string representing the current date and time.
3852 \wxheading{Include files}
3857 \membersection{::wxSleep}\label{wxsleep}
3859 \func{void}{wxSleep}{\param{int}{ secs}}
3861 Sleeps for the specified number of seconds.
3863 \wxheading{Include files}
3868 \membersection{::wxStartTimer}\label{wxstarttimer}
3870 \func{void}{wxStartTimer}{\void}
3872 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
3874 See also \helpref{wxTimer}{wxtimer}.
3876 \wxheading{Include files}
3881 \membersection{::wxUsleep}\label{wxusleep}
3883 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
3885 Sleeps for the specified number of milliseconds. Notice that usage of this
3886 function is encouraged instead of calling usleep(3) directly because the
3887 standard usleep() function is not MT safe.
3889 \wxheading{Include files}
3895 \section{Debugging macros and functions}\label{debugmacros}
3897 Useful macros and functions for error checking and defensive programming.
3898 wxWidgets defines three families of the assert-like macros:
3899 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
3900 (in other words, in the debug build) but disappear completely in the release
3901 build. On the other hand, the wxCHECK macros stay event in release builds but a
3902 check failure doesn't generate any user-visible effects then. Finally, the
3903 compile time assertions don't happen during the run-time but result in the
3904 compilation error messages if the condition they check fail.
3906 \wxheading{Include files}
3911 \membersection{::wxOnAssert}\label{wxonassert}
3913 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
3915 This function is called whenever one of debugging macros fails (i.e. condition
3916 is false in an assertion). It is only defined in the debug mode, in release
3917 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
3919 To override the default behaviour in the debug builds which is to show the user
3920 a dialog asking whether he wants to abort the program, continue or continue
3921 ignoring any subsequent assert failures, you may override
3922 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
3923 the global application object exists.
3926 \membersection{wxASSERT}\label{wxassert}
3928 \func{}{wxASSERT}{\param{}{condition}}
3930 Assert macro. An error message will be generated if the condition is false in
3931 debug mode, but nothing will be done in the release build.
3933 Please note that the condition in wxASSERT() should have no side effects
3934 because it will not be executed in release mode at all.
3936 \wxheading{See also}
3938 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
3939 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3942 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
3944 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
3946 This macro results in a
3947 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
3948 of the given type {\it type} is less than {\it size} bits.
3950 You may use it like this, for example:
3953 // we rely on the int being able to hold values up to 2^32
3954 wxASSERT_MIN_BITSIZE(int, 32);
3956 // can't work with the platforms using UTF-8 for wchar_t
3957 wxASSERT_MIN_BITSIZE(wchar_t, 16);
3961 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
3963 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
3965 Assert macro with message. An error message will be generated if the condition is false.
3967 \wxheading{See also}
3969 \helpref{wxASSERT}{wxassert},\\
3970 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3973 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
3975 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
3977 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
3978 specified {\it condition} is false. The compiler error message should include
3979 the {\it msg} identifier - please note that it must be a valid C++ identifier
3980 and not a string unlike in the other cases.
3982 This macro is mostly useful for testing the expressions involving the
3983 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
3984 sometimes desirable to test them at the compile time.
3986 Note that this macro internally declares a struct whose name it tries to make
3987 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
3988 use it on the same line in two different source files. In this case you may
3989 either change the line in which either of them appears on or use the
3990 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
3992 Also note that Microsoft Visual C++ has a bug which results in compiler errors
3993 if you use this macro with ``Program Database For Edit And Continue''
3994 (\texttt{/ZI}) option, so you shouldn't use it (``Program Database''
3995 (\texttt{/Zi}) is ok though) for the code making use of this macro.
3997 \wxheading{See also}
3999 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
4000 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
4003 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
4005 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
4007 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
4008 except that it allows you to specify a unique {\it name} for the struct
4009 internally defined by this macro to avoid getting the compilation errors
4010 described \helpref{above}{wxcompiletimeassert}.
4013 \membersection{wxFAIL}\label{wxfail}
4015 \func{}{wxFAIL}{\void}
4017 Will always generate an assert error if this code is reached (in debug mode).
4019 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
4022 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
4024 \func{}{wxFAIL\_MSG}{\param{}{msg}}
4026 Will always generate an assert error with specified message if this code is reached (in debug mode).
4028 This macro is useful for marking unreachable" code areas, for example
4029 it may be used in the "default:" branch of a switch statement if all possible
4030 cases are processed above.
4032 \wxheading{See also}
4034 \helpref{wxFAIL}{wxfail}
4037 \membersection{wxCHECK}\label{wxcheck}
4039 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
4041 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4042 This check is done even in release mode.
4045 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
4047 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
4049 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
4050 This check is done even in release mode.
4052 This macro may be only used in non void functions, see also
4053 \helpref{wxCHECK\_RET}{wxcheckret}.
4056 \membersection{wxCHECK\_RET}\label{wxcheckret}
4058 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
4060 Checks that the condition is true, and returns if not (FAILs with given error
4061 message in debug mode). This check is done even in release mode.
4063 This macro should be used in void functions instead of
4064 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
4067 \membersection{wxCHECK2}\label{wxcheck2}
4069 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
4071 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
4072 {\it operation} if it is not. This is a generalisation of
4073 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
4074 returning from the function must be done when the {\it condition} is false.
4076 This check is done even in release mode.
4079 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
4081 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
4083 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
4084 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
4085 instead of wxFAIL() if the {\it condition} is false.
4088 \membersection{::wxTrap}\label{wxtrap}
4090 \func{void}{wxTrap}{\void}
4092 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
4093 debugger exception meaning that the control is passed to the debugger if one is
4094 attached to the process. Otherwise the program just terminates abnormally.
4096 In release mode this function does nothing.
4098 \wxheading{Include files}
4104 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
4106 \func{bool}{wxIsDebuggerRunning}{\void}
4108 Returns {\tt true} if the program is running under debugger, {\tt false}
4111 Please note that this function is currently only implemented for Mac builds
4112 using CodeWarrior and always returns {\tt false} elsewhere.
4117 \section{Environment access functions}\label{environfunctions}
4119 The functions in this section allow to access (get) or change value of
4120 environment variables in a portable way. They are currently implemented under
4121 Win32 and POSIX-like systems (Unix).
4123 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
4125 \wxheading{Include files}
4130 \membersection{wxGetenv}\label{wxgetenvmacro}
4132 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
4134 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
4137 Note that under Win32 it may not return correct value for the variables set
4138 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
4142 \membersection{wxGetEnv}\label{wxgetenv}
4144 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
4146 Returns the current value of the environment variable {\it var} in {\it value}.
4147 {\it value} may be {\tt NULL} if you just want to know if the variable exists
4148 and are not interested in its value.
4150 Returns {\tt true} if the variable exists, {\tt false} otherwise.
4153 \membersection{wxSetEnv}\label{wxsetenv}
4155 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
4157 Sets the value of the environment variable {\it var} (adding it if necessary)
4160 Returns {\tt true} on success.
4163 \membersection{wxUnsetEnv}\label{wxunsetenv}
4165 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
4167 Removes the variable {\it var} from the environment.
4168 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
4171 Returns {\tt true} on success.