1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions and macros defined in wxWindows 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{WXDEBUG
\_NEW}{debugnew
}\\
25 \helpref{WXTRACELEVEL
}{tracelevel
}\\
26 \helpref{WXTRACE
}{trace
}\\
27 \helpref{wxASSERT
\_MIN\_BITSIZE}{wxassertminbitsize
}\\
28 \helpref{wxASSERT
\_MSG}{wxassertmsg
}\\
29 \helpref{wxASSERT
}{wxassert
}\\
30 \helpref{wxBITMAP
}{wxbitmapmacro
}\\
31 \helpref{wxBeginBusyCursor
}{wxbeginbusycursor
}\\
32 \helpref{wxBell
}{wxbell
}\\
33 \helpref{wxCHECK
}{wxcheck
}\\
34 \helpref{wxCHECK2
\_MSG}{wxcheck2msg
}\\
35 \helpref{wxCHECK2
}{wxcheck2
}\\
36 \helpref{wxCHECK
\_GCC\_VERSION}{wxcheckgccversion
}\\
37 \helpref{wxCHECK
\_MSG}{wxcheckmsg
}\\
38 \helpref{wxCHECK
\_RET}{wxcheckret
}\\
39 \helpref{wxCHECK
\_VERSION}{wxcheckversion
}\\
40 \helpref{wxCHECK
\_W32API\_VERSION}{wxcheckw32apiversion
}\\
41 \helpref{wxClientDisplayRect
}{wxclientdisplayrect
}\\
42 \helpref{wxClipboardOpen
}{functionwxclipboardopen
}\\
43 \helpref{wxCloseClipboard
}{wxcloseclipboard
}\\
44 \helpref{wxColourDisplay
}{wxcolourdisplay
}\\
45 \helpref{wxCOMPILE
\_TIME\_ASSERT}{wxcompiletimeassert
}\\
46 \helpref{wxCOMPILE
\_TIME\_ASSERT2}{wxcompiletimeassert2
}\\
47 \helpref{wxConcatFiles
}{wxconcatfiles
}\\
48 \helpref{wxConstCast
}{wxconstcast
}\\
49 \helpref{wxCopyFile
}{wxcopyfile
}\\
50 \helpref{wxCreateDynamicObject
}{wxcreatedynamicobject
}\\
51 \helpref{wxCreateFileTipProvider
}{wxcreatefiletipprovider
}\\
52 \helpref{wxDDECleanUp
}{wxddecleanup
}\\
53 \helpref{wxDDEInitialize
}{wxddeinitialize
}\\
54 \helpref{wxDROP
\_ICON}{wxdropicon
}\\
55 \helpref{wxDebugMsg
}{wxdebugmsg
}\\
56 \helpref{wxDirExists
}{functionwxdirexists
}\\
57 \helpref{wxDirSelector
}{wxdirselector
}\\
58 \helpref{wxDisplayDepth
}{wxdisplaydepth
}\\
59 \helpref{wxDisplaySize
}{wxdisplaysize
}\\
60 \helpref{wxDisplaySizeMM
}{wxdisplaysizemm
}\\
61 \helpref{wxDos2UnixFilename
}{wxdos2unixfilename
}\\
62 \helpref{wxDynamicCastThis
}{wxdynamiccastthis
}\\
63 \helpref{wxDynamicCast
}{wxdynamiccast
}\\
64 \helpref{wxEmptyClipboard
}{wxemptyclipboard
}\\
65 \helpref{wxEnableTopLevelWindows
}{wxenabletoplevelwindows
}\\
66 \helpref{wxEndBusyCursor
}{wxendbusycursor
}\\
67 \helpref{wxEntry
}{wxentry
}\\
68 \helpref{wxEnumClipboardFormats
}{wxenumclipboardformats
}\\
69 \helpref{wxError
}{wxerror
}\\
70 \helpref{wxExecute
}{wxexecute
}\\
71 \helpref{wxExit
}{wxexit
}\\
72 \helpref{wxEXPLICIT
}{wxexplicit
}\\
73 \helpref{wxFAIL
\_MSG}{wxfailmsg
}\\
74 \helpref{wxFAIL
}{wxfail
}\\
75 \helpref{wxFatalError
}{wxfatalerror
}\\
76 \helpref{wxFileExists
}{functionwxfileexists
}\\
77 \helpref{wxFileModificationTime
}{wxfilemodificationtime
}\\
78 \helpref{wxFileNameFromPath
}{wxfilenamefrompath
}\\
79 \helpref{wxFileSelector
}{wxfileselector
}\\
80 \helpref{wxFindFirstFile
}{wxfindfirstfile
}\\
81 \helpref{wxFindMenuItemId
}{wxfindmenuitemid
}\\
82 \helpref{wxFindNextFile
}{wxfindnextfile
}\\
83 \helpref{wxFindWindowAtPointer
}{wxfindwindowatpointer
}\\
84 \helpref{wxFindWindowAtPoint
}{wxfindwindowatpoint
}\\
85 \helpref{wxFindWindowByLabel
}{wxfindwindowbylabel
}\\
86 \helpref{wxFindWindowByName
}{wxfindwindowbyname
}\\
87 \helpref{wxFinite
}{wxfinite
}\\
88 \helpref{wxGetActiveWindow
}{wxgetactivewindow
}\\
89 \helpref{wxGetApp
}{wxgetapp
}\\
90 \helpref{wxGetClipboardData
}{wxgetclipboarddata
}\\
91 \helpref{wxGetClipboardFormatName
}{wxgetclipboardformatname
}\\
92 \helpref{wxGetColourFromUser
}{wxgetcolourfromuser
}\\
93 \helpref{wxGetCwd
}{wxgetcwd
}\\
94 \helpref{wxGetDiskSpace
}{wxgetdiskspace
}\\
95 \helpref{wxGetDisplayName
}{wxgetdisplayname
}\\
96 \helpref{wxGetElapsedTime
}{wxgetelapsedtime
}\\
97 \helpref{wxGetEmailAddress
}{wxgetemailaddress
}\\
98 \helpref{wxGetEnv
}{wxgetenv
}\\
99 \helpref{wxGetFontFromUser
}{wxgetfontfromuser
}\\
100 \helpref{wxGetFreeMemory
}{wxgetfreememory
}\\
101 \helpref{wxGetFullHostName
}{wxgetfullhostname
}\\
102 \helpref{wxGetHomeDir
}{wxgethomedir
}\\
103 \helpref{wxGetHostName
}{wxgethostname
}\\
104 \helpref{wxGetLocalTimeMillis
}{wxgetlocaltimemillis
}\\
105 \helpref{wxGetLocalTime
}{wxgetlocaltime
}\\
106 \helpref{wxGetMousePosition
}{wxgetmouseposition
}\\
107 \helpref{wxGetMultipleChoices
}{wxgetmultiplechoices
}\\
108 \helpref{wxGetMultipleChoice
}{wxgetmultiplechoice
}\\
109 \helpref{wxGetNumberFromUser
}{wxgetnumberfromuser
}\\
110 \helpref{wxGetOSDirectory
}{wxgetosdirectory
}\\
111 \helpref{wxGetOsDescription
}{wxgetosdescription
}\\
112 \helpref{wxGetOsVersion
}{wxgetosversion
}\\
113 \helpref{wxGetPasswordFromUser
}{wxgetpasswordfromuser
}\\
114 \helpref{wxGetPrinterCommand
}{wxgetprintercommand
}\\
115 \helpref{wxGetPrinterFile
}{wxgetprinterfile
}\\
116 \helpref{wxGetPrinterMode
}{wxgetprintermode
}\\
117 \helpref{wxGetPrinterOptions
}{wxgetprinteroptions
}\\
118 \helpref{wxGetPrinterOrientation
}{wxgetprinterorientation
}\\
119 \helpref{wxGetPrinterPreviewCommand
}{wxgetprinterpreviewcommand
}\\
120 \helpref{wxGetPrinterScaling
}{wxgetprinterscaling
}\\
121 \helpref{wxGetPrinterTranslation
}{wxgetprintertranslation
}\\
122 \helpref{wxGetProcessId
}{wxgetprocessid
}\\
123 \helpref{wxGetResource
}{wxgetresource
}\\
124 \helpref{wxGetSingleChoiceData
}{wxgetsinglechoicedata
}\\
125 \helpref{wxGetSingleChoiceIndex
}{wxgetsinglechoiceindex
}\\
126 \helpref{wxGetSingleChoice
}{wxgetsinglechoice
}\\
127 \helpref{wxGetTempFileName
}{wxgettempfilename
}\\
128 \helpref{wxGetTextFromUser
}{wxgettextfromuser
}\\
129 \helpref{wxGetTopLevelParent
}{wxgettoplevelparent
}\\
130 \helpref{wxGetTranslation
}{wxgettranslation
}\\
131 \helpref{wxGetUTCTime
}{wxgetutctime
}\\
132 \helpref{wxGetUserHome
}{wxgetuserhome
}\\
133 \helpref{wxGetUserId
}{wxgetuserid
}\\
134 \helpref{wxGetUserName
}{wxgetusername
}\\
135 \helpref{wxGetWorkingDirectory
}{wxgetworkingdirectory
}\\
136 \helpref{wxGetenv
}{wxgetenvmacro
}\\
137 \helpref{wxHandleFatalExceptions
}{wxhandlefatalexceptions
}\\
138 \helpref{wxICON
}{wxiconmacro
}\\
139 \helpref{wxINTXX
\_SWAP\_ALWAYS}{intswapalways
}\\
140 \helpref{wxINTXX
\_SWAP\_ON\_BE}{intswaponbe
}\\
141 \helpref{wxINTXX
\_SWAP\_ON\_LE}{intswaponle
}\\
142 \helpref{wxInitAllImageHandlers
}{wxinitallimagehandlers
}\\
143 \helpref{wxInitialize
}{wxinitialize
}\\
144 \helpref{wxIsAbsolutePath
}{wxisabsolutepath
}\\
145 \helpref{wxIsBusy
}{wxisbusy
}\\
146 \helpref{wxIsClipboardFormatAvailable
}{wxisclipboardformatavailable
}\\
147 \helpref{wxIsEmpty
}{wxisempty
}\\
148 \helpref{wxIsNaN
}{wxisnan
}\\
149 \helpref{wxIsWild
}{wxiswild
}\\
150 \helpref{wxKill
}{wxkill
}\\
151 \helpref{wxLoadUserResource
}{wxloaduserresource
}\\
152 \helpref{wxLogDebug
}{wxlogdebug
}\\
153 \helpref{wxLogError
}{wxlogerror
}\\
154 \helpref{wxLogFatalError
}{wxlogfatalerror
}\\
155 \helpref{wxLogMessage
}{wxlogmessage
}\\
156 \helpref{wxLogStatus
}{wxlogstatus
}\\
157 \helpref{wxLogSysError
}{wxlogsyserror
}\\
158 \helpref{wxLogTrace
}{wxlogtrace
}\\
159 \helpref{wxLogVerbose
}{wxlogverbose
}\\
160 \helpref{wxLogWarning
}{wxlogwarning
}\\
161 \helpref{wxLL
}{wxll
}\\
162 \helpref{wxLongLongFmtSpec
}{wxlonglongfmtspec
}\\
163 \helpref{wxMakeMetafilePlaceable
}{wxmakemetafileplaceable
}\\
164 \helpref{wxMatchWild
}{wxmatchwild
}\\
165 \helpref{wxMessageBox
}{wxmessagebox
}\\
166 \helpref{wxMkdir
}{wxmkdir
}\\
167 \helpref{wxMutexGuiEnter
}{wxmutexguienter
}\\
168 \helpref{wxMutexGuiLeave
}{wxmutexguileave
}\\
169 \helpref{wxNewId
}{wxnewid
}\\
170 \helpref{wxNow
}{wxnow
}\\
171 \helpref{wxOnAssert
}{wxonassert
}\\
172 \helpref{wxOpenClipboard
}{wxopenclipboard
}\\
173 \helpref{wxPathOnly
}{wxpathonly
}\\
174 \helpref{wxPostDelete
}{wxpostdelete
}\\
175 \helpref{wxPostEvent
}{wxpostevent
}\\
176 \helpref{wxRegisterClipboardFormat
}{wxregisterclipboardformat
}\\
177 \helpref{wxRegisterId
}{wxregisterid
}\\
178 \helpref{wxRemoveFile
}{wxremovefile
}\\
179 \helpref{wxRenameFile
}{wxrenamefile
}\\
180 \helpref{wxRmdir
}{wxrmdir
}\\
181 \helpref{wxSafeShowMessage
}{wxsafeshowmessage
}\\
182 \helpref{wxSafeYield
}{wxsafeyield
}\\
183 \helpref{wxSetClipboardData
}{wxsetclipboarddata
}\\
184 \helpref{wxSetCursor
}{wxsetcursor
}\\
185 \helpref{wxSetDisplayName
}{wxsetdisplayname
}\\
186 \helpref{wxSetEnv
}{wxsetenv
}\\
187 \helpref{wxSetPrinterCommand
}{wxsetprintercommand
}\\
188 \helpref{wxSetPrinterFile
}{wxsetprinterfile
}\\
189 \helpref{wxSetPrinterMode
}{wxsetprintermode
}\\
190 \helpref{wxSetPrinterOptions
}{wxsetprinteroptions
}\\
191 \helpref{wxSetPrinterOrientation
}{wxsetprinterorientation
}\\
192 \helpref{wxSetPrinterPreviewCommand
}{wxsetprinterpreviewcommand
}\\
193 \helpref{wxSetPrinterScaling
}{wxsetprinterscaling
}\\
194 \helpref{wxSetPrinterTranslation
}{wxsetprintertranslation
}\\
195 \helpref{wxSetWorkingDirectory
}{wxsetworkingdirectory
}\\
196 \helpref{wxShell
}{wxshell
}\\
197 \helpref{wxShowTip
}{wxshowtip
}\\
198 \helpref{wxShutdown
}{wxshutdown
}\\
199 \helpref{wxSleep
}{wxsleep
}\\
200 \helpref{wxSnprintf
}{wxsnprintf
}\\
201 \helpref{wxSplitPath
}{wxsplitfunction
}\\
202 \helpref{wxStartTimer
}{wxstarttimer
}\\
203 \helpref{wxStaticCast
}{wxstaticcast
}\\
204 \helpref{wxStrcmp
}{wxstrcmp
}\\
205 \helpref{wxStricmp
}{wxstricmp
}\\
206 \helpref{wxStringEq
}{wxstringeq
}\\
207 \helpref{wxStringMatch
}{wxstringmatch
}\\
208 \helpref{wxStripMenuCodes
}{wxstripmenucodes
}\\
209 \helpref{wxStrlen
}{wxstrlen
}\\
210 \helpref{wxSysErrorCode
}{wxsyserrorcode
}\\
211 \helpref{wxSysErrorMsg
}{wxsyserrormsg
}\\
213 \helpref{wxToLower
}{wxtolower
}\\
214 \helpref{wxToUpper
}{wxtoupper
}\\
215 \helpref{wxTraceLevel
}{wxtracelevel
}\\
216 \helpref{wxTrace
}{wxtrace
}\\
217 \helpref{wxTransferFileToStream
}{wxtransferfiletostream
}\\
218 \helpref{wxTransferStreamToFile
}{wxtransferstreamtofile
}\\
219 \helpref{wxTrap
}{wxtrap
}\\
220 \helpref{wxUninitialize
}{wxuninitialize
}\\
221 \helpref{wxUnix2DosFilename
}{wxunix2dosfilename
}\\
222 \helpref{wxUnsetEnv
}{wxunsetenv
}\\
223 \helpref{wxUsleep
}{wxusleep
}\\
224 \helpref{wxVsnprintf
}{wxvsnprintf
}\\
225 \helpref{wxWakeUpIdle
}{wxwakeupidle
}\\
226 \helpref{wxWriteResource
}{wxwriteresource
}\\
227 \helpref{wxYield
}{wxyield
}\\
228 \helpref{\_}{underscore
}\\
229 \helpref{\_T}{underscoret
}
231 \section{Version macros
}\label{versionfunctions
}
233 The following constants are defined in wxWindows:
235 \begin{itemize
}\itemsep=
0pt
236 \item {\tt wxMAJOR
\_VERSION} is the major version of wxWindows
237 \item {\tt wxMINOR
\_VERSION} is the minor version of wxWindows
238 \item {\tt wxRELEASE
\_NUMBER} is the release number
241 For example, the values or these constants for wxWindows
2.1.15 are
2,
1 and
244 Additionally,
{\tt wxVERSION
\_STRING} is a user-readable string containing
245 the full wxWindows version and
{\tt wxVERSION
\_NUMBER} is a combination of the
246 three version numbers above: for
2.1.15, it is
2115 and it is
2200 for
249 \wxheading{Include files
}
251 <wx/version.h> or <wx/defs.h>
253 \membersection{wxCHECK
\_VERSION}\label{wxcheckversion
}
255 \func{bool
}{wxCHECK
\_VERSION}{\param{}{major, minor, release
}}
257 This is a macro which evaluates to true if the current wxWindows version is at
258 least major.minor.release.
260 For example, to test if the program is compiled with wxWindows
2.2 or higher,
261 the following can be done:
265 #if wxCHECK_VERSION(
2,
2,
0)
266 if ( s.StartsWith("foo") )
267 #else // replacement code for old version
268 if ( strncmp(s, "foo",
3) ==
0 )
275 \membersection{wxCHECK
\_GCC\_VERSION}\label{wxcheckgccversion
}
277 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
279 Returns $
1$ if the compiler being used to compile the code is GNU C++
280 compiler (g++) version major.minor.release or greater. Otherwise, and also if
281 the compiler is not GNU C++ at all, returns $
0$.
283 \membersection{wxCHECK
\_W32API\_VERSION}\label{wxcheckw32apiversion
}
285 \func{bool
}{wxCHECK
\_GCC\_VERSION}{\param{}{major, minor, release
}}
287 Returns $
1$ if the version of w32api headers used is major.minor.release or
288 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
289 Win32 at all, returns $
0$.
291 \section{Application initialization and termination
}\label{appinifunctions
}
293 The functions in this section are used on application startup/shutdown and also
294 to control the behaviour of the main event loop of the GUI programs.
296 \membersection{::wxEntry
}\label{wxentry
}
298 This initializes wxWindows in a platform-dependent way. Use this if you
299 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
300 you can initialize wxWindows from an Microsoft Foundation Classes application using
303 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
304 \param{const wxString\&
}{commandLine
},
\param{int
}{ cmdShow
},
\param{bool
}{ enterLoop = true
}}
306 wxWindows initialization under Windows (non-DLL). If
{\it enterLoop
} is false, the
307 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
308 message loop will be entered.
310 \func{void
}{wxEntry
}{\param{HANDLE
}{ hInstance
},
\param{HANDLE
}{ hPrevInstance
},
311 \param{WORD
}{ wDataSegment
},
\param{WORD
}{ wHeapSize
},
\param{const wxString\&
}{ commandLine
}}
313 wxWindows initialization under Windows (for applications constructed as a DLL).
315 \func{int
}{wxEntry
}{\param{int
}{ argc
},
\param{const wxString\& *
}{argv
}}
317 wxWindows initialization under Unix.
321 To clean up wxWindows, call wxApp::OnExit followed by the static function
322 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
325 int CTheApp::ExitInstance()
327 // OnExit isn't called by CleanUp so must be called explicitly.
331 return CWinApp::ExitInstance();
335 \wxheading{Include files
}
340 \membersection{::wxGetApp
}\label{wxgetapp
}
342 \func{wxAppDerivedClass\&
}{wxGetApp
}{\void}
344 This function doesn't exist in wxWindows but it is created by using
345 the
\helpref{IMPLEMENT
\_APP}{implementapp
} macro. Thus, before using it
346 anywhere but in the same module where this macro is used, you must make it
347 available using
\helpref{DECLARE
\_APP}{declareapp
}.
349 The advantage of using this function compared to directly using the global
350 wxTheApp pointer is that the latter is of type
{\tt wxApp *
} and so wouldn't
351 allow you to access the functions specific to your application class but not
352 present in wxApp while wxGetApp() returns the object of the right type.
354 \membersection{::wxHandleFatalExceptions
}\label{wxhandlefatalexceptions
}
356 \func{bool
}{wxHandleFatalExceptions
}{\param{bool
}{ doIt = true
}}
358 If
{\it doIt
} is true, the fatal exceptions (also known as general protection
359 faults under Windows or segmentation violations in the Unix world) will be
360 caught and passed to
\helpref{wxApp::OnFatalException
}{wxapponfatalexception
}.
361 By default, i.e. before this function is called, they will be handled in the
362 normal way which usually just means that the application will be terminated.
363 Calling wxHandleFatalExceptions() with
{\it doIt
} equal to false will restore
364 this default behaviour.
366 \membersection{::wxInitAllImageHandlers
}\label{wxinitallimagehandlers
}
368 \func{void
}{wxInitAllImageHandlers
}{\void}
370 Initializes all available image handlers. For a list of available handlers,
371 see
\helpref{wxImage
}{wximage
}.
375 \helpref{wxImage
}{wximage
},
\helpref{wxImageHandler
}{wximagehandler
}
377 \wxheading{Include files
}
381 \membersection{::wxInitialize
}\label{wxinitialize
}
383 \func{bool
}{wxInitialize
}{\void}
385 This function is used in wxBase only and only if you don't create
386 \helpref{wxApp
}{wxapp
} object at all. In this case you must call it from your
387 {\tt main()
} function before calling any other wxWindows functions.
389 If the function returns
{\tt false
} the initialization could not be performed,
390 in this case the library cannot be used and
391 \helpref{wxUninitialize
}{wxuninitialize
} shouldn't be called neither.
393 This function may be called several times but
394 \helpref{wxUninitialize
}{wxuninitialize
} must be called for each successful
395 call to this function.
397 \wxheading{Include files
}
401 \membersection{::wxSafeYield
}\label{wxsafeyield
}
403 \func{bool
}{wxSafeYield
}{\param{wxWindow*
}{ win = NULL
},
\param{bool
}{
404 onlyIfNeeded = false
}}
406 This function is similar to wxYield, except that it disables the user input to
407 all program windows before calling wxYield and re-enables it again
408 afterwards. If
{\it win
} is not NULL, this window will remain enabled,
409 allowing the implementation of some limited user interaction.
411 Returns the result of the call to
\helpref{::wxYield
}{wxyield
}.
413 \wxheading{Include files
}
417 \membersection{::wxUninitialize
}\label{wxuninitialize
}
419 \func{void
}{wxUninitialize
}{\void}
421 This function is for use in console (wxBase) programs only. It must be called
422 once for each previous successful call to
\helpref{wxInitialize
}{wxinitialize
}.
424 \wxheading{Include files
}
428 \membersection{::wxYield
}\label{wxyield
}
430 \func{bool
}{wxYield
}{\void}
432 Calls
\helpref{wxApp::Yield
}{wxappyield
}.
434 This function is kept only for backwards compatibility. Please use
435 the
\helpref{wxApp::Yield
}{wxappyield
} method instead in any new code.
437 \wxheading{Include files
}
439 <wx/app.h> or <wx/utils.h>
441 \membersection{::wxWakeUpIdle
}\label{wxwakeupidle
}
443 \func{void
}{wxWakeUpIdle
}{\void}
445 This functions wakes up the (internal and platform dependent) idle system, i.e. it
446 will force the system to send an idle event even if the system currently
{\it is
}
447 idle and thus would not send any idle event until after some other event would get
448 sent. This is also useful for sending events between two threads and is used by
449 the corresponding functions
\helpref{::wxPostEvent
}{wxpostevent
} and
450 \helpref{wxEvtHandler::AddPendingEvent
}{wxevthandleraddpendingevent
}.
452 \wxheading{Include files
}
456 \section{Process control functions
}\label{processfunctions
}
458 The functions in this section are used to launch or terminate the other
461 \membersection{::wxExecute
}\label{wxexecute
}
463 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{int
}{sync = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
465 \func{long
}{wxExecute
}{\param{char **
}{argv
},
\param{int
}{flags = wxEXEC
\_ASYNC},
\param{wxProcess *
}{callback = NULL
}}
467 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
}}
469 \perlnote{In wxPerl this function only takes the
{\tt command
} argument,
470 and returns a
2-element list
{\tt ( status, output )
}, where
{\tt output
} is
473 \func{long
}{wxExecute
}{\param{const wxString\&
}{command
},
\param{wxArrayString\&
}{output
},
\param{wxArrayString\&
}{errors
}}
475 \perlnote{In wxPerl this function only takes the
{\tt command
} argument,
476 and returns a
3-element list
{\tt ( status, output, errors )
}, where
477 {\tt output
} and
{\tt errors
} are array references.
}
479 Executes another program in Unix or Windows.
481 The first form takes a command string, such as
{\tt "emacs file.txt"
}.
483 The second form takes an array of values: a command, any number of
484 arguments, terminated by NULL.
486 The semantics of the third and fourth versions is different from the first two
487 and is described in more details below.
489 If
{\it flags
} parameter contains
{\tt wxEXEC
\_ASYNC} flag (the default), flow
490 of control immediately returns. If it contains
{\tt wxEXEC
\_SYNC}, the current
491 application waits until the other program has terminated.
493 In the case of synchronous execution, the return value is the exit code of
494 the process (which terminates by the moment the function returns) and will be
495 $-
1$ if the process couldn't be started and typically
0 if the process
496 terminated successfully. Also, while waiting for the process to
497 terminate, wxExecute will call
\helpref{wxYield
}{wxyield
}. The caller
498 should ensure that this can cause no recursion, in the simplest case by
499 calling
\helpref{wxEnableTopLevelWindows(false)
}{wxenabletoplevelwindows
}.
501 For asynchronous execution, however, the return value is the process id and
502 zero value indicates that the command could not be executed. As an added
503 complication, the return value of $-
1$ in this case indicates that we didn't
504 launch a new process, but connected to the running one (this can only happen in
505 case of using DDE under Windows for command execution). In particular, in this,
506 and only this, case the calling code will not get the notification about
509 If callback isn't NULL and if execution is asynchronous,
510 \helpref{wxProcess::OnTerminate
}{wxprocessonterminate
} will be called when
511 the process finishes. Specifying this parameter also allows you to redirect the
512 standard input and/or output of the process being launched by calling
513 \helpref{Redirect
}{wxprocessredirect
}. If the child process IO is redirected,
514 under Windows the process window is not shown by default (this avoids having to
515 flush an unnecessary console for the processes which don't create any windows
516 anyhow) but a
{\tt wxEXEC
\_NOHIDE} flag can be used to prevent this from
517 happening, i.e. with this flag the child process window will be shown normally.
519 Under Unix the flag
{\tt wxEXEC
\_MAKE\_GROUP\_LEADER} may be used to ensure
520 that the new process is a group leader (this will create a new session if
521 needed). Calling
\helpref{wxKill
}{wxkill
} with the argument of -pid where pid
522 is the process ID of the new process will kill this process as well as all of
523 its children (except those which have started their own session).
525 Finally, you may use the third overloaded version of this function to execute
526 a process (always synchronously) and capture its output in the array
527 {\it output
}. The fourth version adds the possibility to additionally capture
528 the messages from standard error output in the
{\it errors
} array.
530 {\bf NB:
} Currently wxExecute() can only be used from the main thread, calling
531 this function from another thread will result in an assert failure in debug
532 build and won't work.
536 \helpref{wxShell
}{wxshell
},
\helpref{wxProcess
}{wxprocess
},
\helpref{Exec sample
}{sampleexec
}.
538 \wxheading{Parameters
}
540 \docparam{command
}{The command to execute and any parameters to pass to it as a
543 \docparam{argv
}{The command to execute should be the first element of this
544 array, any additional ones are the command parameters and the array must be
545 terminated with a NULL pointer.
}
547 \docparam{flags
}{Combination of bit masks
{\tt wxEXEC
\_ASYNC},
548 {\tt wxEXEC
\_SYNC} and
{\tt wxEXEC
\_NOHIDE}}
550 \docparam{callback
}{An optional pointer to
\helpref{wxProcess
}{wxprocess
}}
552 \wxheading{Include files
}
556 \membersection{::wxExit
}\label{wxexit
}
558 \func{void
}{wxExit
}{\void}
560 Exits application after calling
\helpref{wxApp::OnExit
}{wxapponexit
}.
561 Should only be used in an emergency: normally the top-level frame
562 should be deleted (after deleting all other frames) to terminate the
563 application. See
\helpref{wxCloseEvent
}{wxcloseevent
} and
\helpref{wxApp
}{wxapp
}.
565 \wxheading{Include files
}
569 \membersection{::wxKill
}\label{wxkill
}
571 \func{int
}{wxKill
}{\param{long
}{ pid
},
\param{int
}{ sig = wxSIGTERM
},
\param{wxKillError
}{*rc = NULL
}}
573 Equivalent to the Unix kill function: send the given signal
{\it sig
} to the
574 process with PID
{\it pid
}. The valid signal values are
579 wxSIGNONE =
0, // verify if the process exists under Unix
588 wxSIGKILL, // forcefully kill, dangerous!
594 wxSIGTERM // terminate the process gently
598 {\tt wxSIGNONE
},
{\tt wxSIGKILL
} and
{\tt wxSIGTERM
} have the same meaning
599 under both Unix and Windows but all the other signals are equivalent to
600 {\tt wxSIGTERM
} under Windows.
602 Returns
0 on success, -
1 on failure. If
{\it rc
} parameter is not NULL, it will
603 be filled with an element of
{\tt wxKillError
} enum:
608 wxKILL_OK, // no error
609 wxKILL_BAD_SIGNAL, // no such signal
610 wxKILL_ACCESS_DENIED, // permission denied
611 wxKILL_NO_PROCESS, // no such process
612 wxKILL_ERROR // another, unspecified error
618 \helpref{wxProcess::Kill
}{wxprocesskill
},
\rtfsp
619 \helpref{wxProcess::Exists
}{wxprocessexists
},
\rtfsp
620 \helpref{Exec sample
}{sampleexec
}
622 \wxheading{Include files
}
626 \membersection{::wxGetProcessId
}\label{wxgetprocessid
}
628 \func{unsigned long
}{wxGetProcessId
}{\void}
630 Returns the number uniquely identifying the current process in the system.
632 If an error occurs, $
0$ is returned.
634 \wxheading{Include files
}
638 \membersection{::wxShell
}\label{wxshell
}
640 \func{bool
}{wxShell
}{\param{const wxString\&
}{command = NULL
}}
642 Executes a command in an interactive shell window. If no command is
643 specified, then just the shell is spawned.
645 See also
\helpref{wxExecute
}{wxexecute
},
\helpref{Exec sample
}{sampleexec
}.
647 \wxheading{Include files
}
651 \membersection{::wxShutdown
}\label{wxshutdown
}
653 \func{bool
}{wxShutdown
}{\param{wxShutdownFlags
}{flags
}}
655 This function shuts down or reboots the computer depending on the value of the
656 {\it flags
}. Please notice that doing this requires the corresponding access
657 rights (superuser under Unix,
{\tt SE
\_SHUTDOWN} privelege under Windows NT)
658 and that this function is only implemented under Unix and Win32.
660 \wxheading{Parameters
}
662 \docparam{flags
}{Either
{\tt wxSHUTDOWN
\_POWEROFF} or
{\tt wxSHUTDOWN
\_REBOOT}}
666 {\tt true
} on success,
{\tt false
} if an error occured.
668 \wxheading{Include files
}
672 \section{Thread functions
}\label{threadfunctions
}
674 \wxheading{Include files
}
680 \helpref{wxThread
}{wxthread
},
\helpref{wxMutex
}{wxmutex
},
\helpref{Multithreading overview
}{wxthreadoverview
}
682 \membersection{::wxMutexGuiEnter
}\label{wxmutexguienter
}
684 \func{void
}{wxMutexGuiEnter
}{\void}
686 This function must be called when any thread other than the main GUI thread
687 wants to get access to the GUI library. This function will block the execution
688 of the calling thread until the main thread (or any other thread holding the
689 main GUI lock) leaves the GUI library and no other thread will enter the GUI
690 library until the calling thread calls
\helpref{::wxMutexGuiLeave()
}{wxmutexguileave
}.
692 Typically, these functions are used like this:
695 void MyThread::Foo(void)
697 // before doing any GUI calls we must ensure that this thread is the only
703 my_window->DrawSomething();
709 Note that under GTK, no creation of top-level windows is allowed in any
710 thread but the main one.
712 This function is only defined on platforms which support preemptive
715 \membersection{::wxMutexGuiLeave
}\label{wxmutexguileave
}
717 \func{void
}{wxMutexGuiLeave
}{\void}
719 See
\helpref{::wxMutexGuiEnter()
}{wxmutexguienter
}.
721 This function is only defined on platforms which support preemptive
724 \section{File functions
}\label{filefunctions
}
726 \wxheading{Include files
}
732 \helpref{wxPathList
}{wxpathlist
}\\
733 \helpref{wxDir
}{wxdir
}\\
734 \helpref{wxFile
}{wxfile
}\\
735 \helpref{wxFileName
}{wxfilename
}
737 \membersection{::wxDirExists
}\label{functionwxdirexists
}
739 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
741 Returns true if the directory exists.
743 \membersection{::wxDos2UnixFilename
}\label{wxdos2unixfilename
}
745 \func{void
}{wxDos2UnixFilename
}{\param{wxChar *
}{s
}}
747 Converts a DOS to a Unix filename by replacing backslashes with forward
750 \membersection{::wxFileExists
}\label{functionwxfileexists
}
752 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
754 Returns true if the file exists. It also returns true if the file is
757 \membersection{::wxFileModificationTime
}\label{wxfilemodificationtime
}
759 \func{time
\_t}{wxFileModificationTime
}{\param{const wxString\&
}{filename
}}
761 Returns time of last modification of given file.
763 \membersection{::wxFileNameFromPath
}\label{wxfilenamefrompath
}
765 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
767 \func{char *
}{wxFileNameFromPath
}{\param{char *
}{path
}}
769 {\bf NB:
} This function is obsolete, please use
770 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
772 Returns the filename for a full path. The second form returns a pointer to
773 temporary storage that should not be deallocated.
775 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
777 \func{wxString
}{wxFindFirstFile
}{\param{const char *
}{spec
},
\param{int
}{ flags =
0}}
779 This function does directory searching; returns the first file
780 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
781 get the next matching file. Neither will
report the current directory "." or the
782 parent directory "..".
784 {\it spec
} may contain wildcards.
786 {\it flags
} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
791 wxString f = wxFindFirstFile("/home/project/*.*");
792 while ( !f.IsEmpty() )
795 f = wxFindNextFile();
799 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
801 \func{wxString
}{wxFindNextFile
}{\void}
803 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
805 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
807 \membersection{::wxGetDiskSpace
}\label{wxgetdiskspace
}
809 \func{bool
}{wxGetDiskSpace
}{\param{const wxString\&
}{path
},
\param{wxLongLong
}{*total = NULL
},
\param{wxLongLong
}{*free = NULL
}}
811 This function returns the total number of bytes and number of free bytes on
812 the disk containing the directory
{\it path
} (it should exist). Both
813 {\it total
} and
{\it free
} parameters may be
{\tt NULL
} if the corresponding
814 information is not needed.
818 {\tt true
} on success,
{\tt false
} if an error occured (for example, the
819 directory doesn't exist).
821 \wxheading{Portability
}
823 This function is implemented for Win16 (only for drives less than
2Gb), Win32,
824 Mac OS and generic Unix provided the system has
{\tt statfs()
} function.
826 This function first appeared in wxWindows
2.3.2.
828 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
830 \func{wxString
}{wxGetOSDirectory
}{\void}
832 Returns the Windows directory under Windows; on other platforms returns the empty string.
834 \membersection{::wxIsAbsolutePath
}\label{wxisabsolutepath
}
836 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
838 Returns true if the argument is an absolute filename, i.e. with a slash
839 or drive name at the beginning.
841 \membersection{::wxPathOnly
}\label{wxpathonly
}
843 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
845 Returns the directory part of the filename.
847 \membersection{::wxUnix2DosFilename
}\label{wxunix2dosfilename
}
849 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
851 Converts a Unix to a DOS filename by replacing forward
852 slashes with backslashes.
854 \membersection{::wxConcatFiles
}\label{wxconcatfiles
}
856 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
857 \param{const wxString\&
}{file3
}}
859 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
862 \membersection{::wxCopyFile
}\label{wxcopyfile
}
864 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
\param{bool
}{overwrite = true
}}
866 Copies
{\it file1
} to
{\it file2
}, returning true if successful. If
867 {\it overwrite
} parameter is true (default), the destination file is overwritten
868 if it exists, but if
{\it overwrite
} is false, the functions fails in this
871 \membersection{::wxGetCwd
}\label{wxgetcwd
}
873 \func{wxString
}{wxGetCwd
}{\void}
875 Returns a string containing the current (or working) directory.
877 \membersection{::wxGetWorkingDirectory
}\label{wxgetworkingdirectory
}
879 \func{wxString
}{wxGetWorkingDirectory
}{\param{char *
}{buf=NULL
},
\param{int
}{sz=
1000}}
881 {\bf NB:
} This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
883 Copies the current working directory into the buffer if supplied, or
884 copies the working directory into new storage (which you must delete yourself)
885 if the buffer is NULL.
887 {\it sz
} is the size of the buffer if supplied.
889 \membersection{::wxGetTempFileName
}\label{wxgettempfilename
}
891 \func{char *
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char *
}{buf=NULL
}}
893 \func{bool
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{wxString\&
}{buf
}}
895 %% Makes a temporary filename based on {\it prefix}, opens and closes the file,
896 %% and places the name in {\it buf}. If {\it buf} is NULL, new store
897 %% is allocated for the temporary filename using {\it new}.
899 %% Under Windows, the filename will include the drive and name of the
900 %% directory allocated for temporary files (usually the contents of the
901 %% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
903 %% It is the application's responsibility to create and delete the file.
905 {\bf NB:
} These functions are obsolete, please use
\rtfsp
906 \helpref{wxFileName::CreateTempFileName
}{wxfilenamecreatetempfilename
}\rtfsp
909 \membersection{::wxIsWild
}\label{wxiswild
}
911 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
913 Returns true if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
915 \membersection{::wxMatchWild
}\label{wxmatchwild
}
917 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
919 Returns true if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
920 dot
\_special}\/ is true, filenames beginning with a dot are not matched
921 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
923 \membersection{::wxMkdir
}\label{wxmkdir
}
925 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
927 Makes the directory
{\it dir
}, returning true if successful.
929 {\it perm
} is the access mask for the directory for the systems on which it is
930 supported (Unix) and doesn't have effect for the other ones.
932 \membersection{::wxRemoveFile
}\label{wxremovefile
}
934 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
936 Removes
{\it file
}, returning true if successful.
938 \membersection{::wxRenameFile
}\label{wxrenamefile
}
940 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
942 Renames
{\it file1
} to
{\it file2
}, returning true if successful.
944 \membersection{::wxRmdir
}\label{wxrmdir
}
946 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
948 Removes the directory
{\it dir
}, returning true if successful. Does not work under VMS.
950 The
{\it flags
} parameter is reserved for future use.
952 \membersection{::wxSetWorkingDirectory
}\label{wxsetworkingdirectory
}
954 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
956 Sets the current working directory, returning true if the operation succeeded.
957 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
959 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
961 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{wxString *
}{ path
},
\param{wxString *
}{ name
},
\param{wxString *
}{ ext
}}
963 {\bf NB:
} This function is obsolete, please use
964 \helpref{wxFileName::SplitPath
}{wxfilenamesplitpath
} instead.
966 This function splits a full file name into components: the path (including possible disk/drive
967 specification under Windows), the base name and the extension. Any of the output parameters
968 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
969 a particular component.
971 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
972 Windows, however it will not consider backslashes as path separators under Unix (where backslash
973 is a valid character in a filename).
975 On entry,
{\it fullname
} should be non-NULL (it may be empty though).
977 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
978 contains the file name and
{\it ext
} contains the file extension without leading dot. All
979 three of them may be empty if the corresponding component is. The old contents of the
980 strings pointed to by these parameters will be overwritten in any case (if the pointers
983 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
985 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
987 Copies the given file to
{\it stream
}. Useful when converting an old application to
988 use streams (within the
document/view framework, for example).
990 \wxheading{Include files
}
994 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
996 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
998 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
999 use streams (within the
document/view framework, for example).
1001 \wxheading{Include files
}
1005 \section{Network, user and OS functions
}\label{networkfunctions
}
1007 The functions in this section are used to retrieve information about the
1008 current computer and/or user characteristics.
1010 \membersection{::wxGetFreeMemory
}\label{wxgetfreememory
}
1012 \func{long
}{wxGetFreeMemory
}{\void}
1014 Returns the amount of free memory in bytes under environments which
1015 support it, and -
1 if not supported. Currently, it is supported only
1016 under Windows, Linux and Solaris.
1018 \wxheading{Include files
}
1022 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
1024 \func{wxString
}{wxGetFullHostName
}{\void}
1026 Returns the FQDN (fully qualified domain host name) or an empty string on
1029 \wxheading{See also
}
1031 \helpref{wxGetHostName
}{wxgethostname
}
1033 \wxheading{Include files
}
1037 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
1039 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
1041 Copies the user's email address into the supplied buffer, by
1042 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
1043 and
\helpref{wxGetUserId
}{wxgetuserid
}.
1045 Returns true if successful, false otherwise.
1047 \wxheading{Include files
}
1051 \membersection{::wxGetHomeDir
}\label{wxgethomedir
}
1053 \func{wxString
}{wxGetHomeDir
}{\void}
1055 Return the (current) user's home directory.
1057 \wxheading{See also
}
1059 \helpref{wxGetUserHome
}{wxgetuserhome
}
1061 \wxheading{Include files
}
1065 \membersection{::wxGetHostName
}\label{wxgethostname
}
1067 \func{wxString
}{wxGetHostName
}{\void}
1069 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1071 Copies the current host machine's name into the supplied buffer. Please note
1072 that the returned name is
{\it not
} fully qualified, i.e. it does not include
1075 Under Windows or NT, this function first looks in the environment
1076 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
1077 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
1079 The first variant of this function returns the hostname if successful or an
1080 empty string otherwise. The second (deprecated) function returns true
1081 if successful, false otherwise.
1083 \wxheading{See also
}
1085 \helpref{wxGetFullHostName
}{wxgetfullhostname
}
1087 \wxheading{Include files
}
1091 \membersection{::wxGetUserId
}\label{wxgetuserid
}
1093 \func{wxString
}{wxGetUserId
}{\void}
1095 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1097 This function returns the "user id" also known as "login name" under Unix i.e.
1098 something like "jsmith". It uniquely identifies the current user (on this system).
1100 Under Windows or NT, this function first looks in the environment
1101 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
1102 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
1104 The first variant of this function returns the login name if successful or an
1105 empty string otherwise. The second (deprecated) function returns true
1106 if successful, false otherwise.
1108 \wxheading{See also
}
1110 \helpref{wxGetUserName
}{wxgetusername
}
1112 \wxheading{Include files
}
1116 \membersection{::wxGetOsDescription
}\label{wxgetosdescription
}
1118 \func{wxString
}{wxGetOsDescription
}{\void}
1120 Returns the string containing the description of the current platform in a
1121 user-readable form. For example, this function may return strings like
1122 {\tt Windows NT Version
4.0} or
{\tt Linux
2.2.2 i386
}.
1124 \wxheading{See also
}
1126 \helpref{::wxGetOsVersion
}{wxgetosversion
}
1128 \wxheading{Include files
}
1132 \membersection{::wxGetOsVersion
}\label{wxgetosversion
}
1134 \func{int
}{wxGetOsVersion
}{\param{int *
}{major = NULL
},
\param{int *
}{minor = NULL
}}
1136 Gets operating system version information.
1138 \begin{twocollist
}\itemsep=
0pt
1139 \twocolitemruled{Platform
}{Return types
}
1140 \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.
1142 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
}.
}
1143 \twocolitem{GTK
}{Return value is wxGTK, For GTK
1.0,
{\it major
} is
1,
{\it minor
} is
0.
}
1144 \twocolitem{Motif
}{Return value is wxMOTIF
\_X,
{\it major
} is X version,
{\it minor
} is X revision.
}
1145 \twocolitem{OS/
2}{Return value is wxOS2
\_PM.
}
1146 \twocolitem{Windows
3.1}{Return value is wxWINDOWS,
{\it major
} is
3,
{\it minor
} is
1.
}
1147 \twocolitem{Windows NT/
2000}{Return value is wxWINDOWS
\_NT, version is returned in
{\it major
} and
{\it minor
}}
1148 \twocolitem{Windows
98}{Return value is wxWIN95,
{\it major
} is
4,
{\it minor
} is
1 or greater.
}
1149 \twocolitem{Windows
95}{Return value is wxWIN95,
{\it major
} is
4,
{\it minor
} is
0.
}
1150 \twocolitem{Win32s (Windows
3.1)
}{Return value is wxWIN32S,
{\it major
} is
3,
{\it minor
} is
1.
}
1151 \twocolitem{Watcom C++
386 supervisor mode (Windows
3.1)
}{Return value is wxWIN386,
{\it major
} is
3,
{\it minor
} is
1.
}
1154 \wxheading{See also
}
1156 \helpref{::wxGetOsDescription
}{wxgetosdescription
}
1158 \wxheading{Include files
}
1162 \membersection{::wxGetUserHome
}\label{wxgetuserhome
}
1164 \func{const wxChar *
}{wxGetUserHome
}{\param{const wxString\&
}{user = ""
}}
1166 Returns the home directory for the given user. If the username is empty
1167 (default value), this function behaves like
1168 \helpref{wxGetHomeDir
}{wxgethomedir
}.
1170 \wxheading{Include files
}
1174 \membersection{::wxGetUserName
}\label{wxgetusername
}
1176 \func{wxString
}{wxGetUserName
}{\void}
1178 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
1180 This function returns the full user name (something like "Mr. John Smith").
1182 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
1183 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
1184 is running, the entry
{\bf Current
} in the section
{\bf User
} of
1185 the PENWIN.INI file is used.
1187 The first variant of this function returns the user name if successful or an
1188 empty string otherwise. The second (deprecated) function returns
{\tt true
}
1189 if successful,
{\tt false
} otherwise.
1191 \wxheading{See also
}
1193 \helpref{wxGetUserId
}{wxgetuserid
}
1195 \wxheading{Include files
}
1199 \section{String functions
}
1201 \membersection{::copystring
}\label{copystring
}
1203 \func{char *
}{copystring
}{\param{const char *
}{s
}}
1205 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
1206 deleted with the
{\it delete
} operator.
1208 This function is deprecated, use
\helpref{wxString
}{wxstring
} class instead.
1210 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
1212 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
1214 This function returns the translation of string
{\it str
} in the current
1215 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
1216 message catalogs (see
\helpref{internationalization overview
}{internationalization
}), the
1217 original string is returned. In debug build, an error message is logged -- this
1218 should help to find the strings which were not yet translated. As this function
1219 is used very often, an alternative (and also common in Unix world) syntax is
1220 provided: the
\helpref{\_()
}{underscore
} macro is defined to do the same thing
1221 as wxGetTranslation.
1223 \membersection{::wxIsEmpty
}\label{wxisempty
}
1225 \func{bool
}{wxIsEmpty
}{\param{const char *
}{ p
}}
1227 Returns
{\tt true
} if the pointer is either
{\tt NULL
} or points to an empty
1228 string,
{\tt false
} otherwise.
1230 \membersection{::wxStrcmp
}\label{wxstrcmp
}
1232 \func{int
}{wxStrcmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1234 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1235 to or greater than
{\it p2
}. The comparison is case-sensitive.
1237 This function complements the standard C function
{\it stricmp()
} which performs
1238 case-insensitive comparison.
1240 \membersection{::wxStricmp
}\label{wxstricmp
}
1242 \func{int
}{wxStricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
1244 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
1245 to or greater than
{\it p2
}. The comparison is case-insensitive.
1247 This function complements the standard C function
{\it strcmp()
} which performs
1248 case-sensitive comparison.
1250 \membersection{::wxStringMatch
}\label{wxstringmatch
}
1252 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
1253 \param{bool
}{ subString = true
},
\param{bool
}{ exact = false
}}
1255 {\bf NB:
} This function is obsolete, use
\helpref{wxString::Find
}{wxstringfind
} instead.
1257 Returns
{\tt true
} if the substring
{\it s1
} is found within
{\it s2
},
1258 ignoring case if
{\it exact
} is false. If
{\it subString
} is
{\tt false
},
1259 no substring matching is done.
1261 \membersection{::wxStringEq
}\label{wxstringeq
}
1263 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
1265 {\bf NB:
} This function is obsolete, use
\helpref{wxString
}{wxstring
} instead.
1270 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
1273 \membersection{::wxStrlen
}\label{wxstrlen
}
1275 \func{size
\_t}{wxStrlen
}{\param{const char *
}{ p
}}
1277 This is a safe version of standard function
{\it strlen()
}: it does exactly the
1278 same thing (i.e. returns the length of the string) except that it returns
0 if
1279 {\it p
} is the
{\tt NULL
} pointer.
1281 \membersection{::wxSnprintf
}\label{wxsnprintf
}
1283 \func{int
}{wxSnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{}{...
}}
1285 This function replaces the dangerous standard function
{\tt sprintf()
} and is
1286 like
{\tt snprintf()
} available on some platforms. The only difference with
1287 sprintf() is that an additional argument - buffer size - is taken and the
1288 buffer is never overflowed.
1290 Returns the number of characters copied to the buffer or -
1 if there is not
1293 \wxheading{See also
}
1295 \helpref{wxVsnprintf
}{wxvsnprintf
},
\helpref{wxString::Printf
}{wxstringprintf
}
1297 \membersection{wxT
}\label{wxt
}
1299 \func{wxChar
}{wxT
}{\param{char
}{ch
}}
1301 \func{const wxChar *
}{wxT
}{\param{const char *
}{s
}}
1303 wxT() is a macro which can be used with character and string literals (in other
1304 words,
{\tt 'x'
} or
{\tt "foo"
}) to automatically convert them to Unicode in
1305 Unicode build configuration. Please see the
1306 \helpref{Unicode overview
}{unicode
} for more information.
1308 This macro is simply returns the value passed to it without changes in ASCII
1309 build. In fact, its definition is:
1312 #define wxT(x) L ## x
1318 \membersection{wxTRANSLATE
}\label{wxtranslate
}
1320 \func{const wxChar *
}{wxTRANSLATE
}{\param{const char *
}{s
}}
1322 This macro doesn't do anything in the program code -- it simply expands to the
1323 value of its argument (expand in Unicode build where it is equivalent to
1324 \helpref{wxT
}{wxt
} which makes it unnecessary to use both wxTRANSLATE and wxT
1325 with the same string which would be really unreadable).
1327 However it does have a purpose and it is to mark the literal strings for the
1328 extraction into the message catalog created by
{\tt xgettext
} program. Usually
1329 this is achieved using
\helpref{\_()
}{underscore
} but that macro not only marks
1330 the string for extraction but also expands into
1331 \helpref{wxGetTranslation
}{wxgettranslation
} function call which means that it
1332 cannot be used in some situations, notably for the static arrays
1335 Here is an example which should make it more clear: suppose that you have a
1336 static array of strings containing the weekday names and which have to be
1337 translated (note that it is a bad example, really, as
1338 \helpref{wxDateTime
}{wxdatetime
} already can be used to get the localized week
1339 day names already). If you write
1341 static const wxChar * const weekdays
[] =
{ _("Mon"), ..., _("Sun")
};
1343 // use weekdays
[n
] as usual
1345 the code wouldn't compile because the function calls are forbidden in the array
1346 initializer. So instead you should do
1348 static const wxChar * const weekdays
[] =
{ wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun")
};
1350 // use wxGetTranslation(weekdays
[n
])
1354 Note that although the code
{\bf would
} compile if you simply omit
1355 wxTRANSLATE() in the above, it wouldn't work as expected because there would be
1356 no translations for the weekday names in the program message catalog and
1357 wxGetTranslation wouldn't find them.
1360 \membersection{::wxToLower
}\label{wxtolower
}
1362 \func{char
}{wxToLower
}{\param{char
}{ch
}}
1364 Converts the character to lower case. This is implemented as a macro for efficiency.
1366 \wxheading{Include files
}
1370 \membersection{::wxToUpper
}\label{wxtoupper
}
1372 \func{char
}{wxToUpper
}{\param{char
}{ch
}}
1374 Converts the character to upper case. This is implemented as a macro for efficiency.
1376 \wxheading{Include files
}
1380 \membersection{::wxVsnprintf
}\label{wxvsnprintf
}
1382 \func{int
}{wxVsnprintf
}{\param{wxChar *
}{buf
},
\param{size
\_t }{len
},
\param{const wxChar *
}{format
},
\param{va
\_list }{argPtr
}}
1384 The same as
\helpref{wxSnprintf
}{wxsnprintf
} but takes a
{\tt va
\_list }
1385 argument instead of arbitrary number of parameters.
1387 \wxheading{See also
}
1389 \helpref{wxSnprintf
}{wxsnprintf
},
\helpref{wxString::PrintfV
}{wxstringprintfv
}
1392 \membersection{\_}\label{underscore
}
1394 \func{const wxChar *
}{\_}{\param{const char *
}{s
}}
1396 This macro expands into a call to
\helpref{wxGetTranslation
}{wxgettranslation
}
1397 function, so it marks the message for the extraction by
{\tt xgettext
} just as
1398 \helpref{wxTRANSLATE
}{wxtranslate
} does, but also returns the translation of
1399 the string for the current locale during execution.
1401 Don't confuse this macro with
\helpref{\_T()
}{underscoret
}!
1404 \membersection{\_T}\label{underscoret
}
1406 \func{wxChar
}{\_T}{\param{char
}{ch
}}
1408 \func{const wxChar *
}{\_T}{\param{const wxChar
}{ch
}}
1410 This macro is exactly the same as
\helpref{wxT
}{wxt
} and is defined in
1411 wxWindows simply because it may be more intuitive for Windows programmers as
1412 the standard Win32 headers also define it (as well as yet another name for the
1413 same macro which is
{\tt \_TEXT()
}).
1415 Don't confuse this macro with
\helpref{\_()
}{underscore
}!
1417 \membersection{\_}\label{underscore
}
1419 \section{Dialog functions
}\label{dialogfunctions
}
1421 Below are a number of convenience functions for getting input from the
1422 user or displaying messages. Note that in these functions the last three
1423 parameters are optional. However, it is recommended to pass a parent frame
1424 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
1425 the front when the dialog box is popped up.
1427 \membersection{::wxBeginBusyCursor
}\label{wxbeginbusycursor
}
1429 \func{void
}{wxBeginBusyCursor
}{\param{wxCursor *
}{cursor = wxHOURGLASS
\_CURSOR}}
1431 Changes the cursor to the given cursor for all windows in the application.
1432 Use
\helpref{wxEndBusyCursor
}{wxendbusycursor
} to revert the cursor back
1433 to its previous state. These two calls can be nested, and a counter
1434 ensures that only the outer calls take effect.
1436 See also
\helpref{wxIsBusy
}{wxisbusy
},
\helpref{wxBusyCursor
}{wxbusycursor
}.
1438 \wxheading{Include files
}
1442 \membersection{::wxBell
}\label{wxbell
}
1444 \func{void
}{wxBell
}{\void}
1446 Ring the system bell.
1448 \wxheading{Include files
}
1452 \membersection{::wxCreateFileTipProvider
}\label{wxcreatefiletipprovider
}
1454 \func{wxTipProvider *
}{wxCreateFileTipProvider
}{\param{const wxString\&
}{filename
},
1455 \param{size
\_t }{currentTip
}}
1457 This function creates a
\helpref{wxTipProvider
}{wxtipprovider
} which may be
1458 used with
\helpref{wxShowTip
}{wxshowtip
}.
1460 \docparam{filename
}{The name of the file containing the tips, one per line
}
1461 \docparam{currentTip
}{The index of the first tip to show - normally this index
1462 is remembered between the
2 program runs.
}
1464 \wxheading{See also
}
1466 \helpref{Tips overview
}{tipsoverview
}
1468 \wxheading{Include files
}
1472 \membersection{::wxDirSelector
}\label{wxdirselector
}
1474 \func{wxString
}{wxDirSelector
}{\param{const wxString\&
}{message = wxDirSelectorPromptStr
},\\
1475 \param{const wxString\&
}{default
\_path = ""
},\\
1476 \param{long
}{style =
0},
\param{const wxPoint\&
}{pos = wxDefaultPosition
},\\
1477 \param{wxWindow *
}{parent = NULL
}}
1479 Pops up a directory selector dialog. The arguments have the same meaning as
1480 those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
1481 and the default
\_path, if specified, is set as the initial selection.
1483 The application must check for an empty return value (if the user pressed
1484 Cancel). For example:
1487 const wxString& dir = wxDirSelector("Choose a folder");
1494 \wxheading{Include files
}
1498 \membersection{::wxFileSelector
}\label{wxfileselector
}
1500 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
1501 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
1502 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
1503 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
1505 Pops up a file selector box. In Windows, this is the common file selector
1506 dialog. In X, this is a file selector box with the same functionality.
1507 The path and filename are distinct elements of a full file pathname.
1508 If path is empty, the current directory will be used. If filename is empty,
1509 no default filename will be supplied. The wildcard determines what files
1510 are displayed in the file selector, and file extension supplies a type
1511 extension for the required filename. Flags may be a combination of wxOPEN,
1512 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, wxFILE
\_MUST\_EXIST, wxMULTIPLE or
0.
1514 Both the Unix and Windows versions implement a wildcard filter. Typing a
1515 filename containing wildcards
(*, ?) in the filename text item, and
1516 clicking on Ok, will result in only those files matching the pattern being
1519 The wildcard may be a specification for multiple types of file
1520 with a description for each, such as:
1523 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
1526 The application must check for an empty return value (the user pressed
1527 Cancel). For example:
1530 wxString filename = wxFileSelector("Choose a file to open");
1531 if ( !filename.empty() )
1533 // work with the file
1536 //else: cancelled by user
1539 \wxheading{Include files}
1543 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1545 \func{void}{wxEndBusyCursor}{\void}
1547 Changes the cursor back to the original cursor, for all windows in the application.
1548 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1550 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1552 \wxheading{Include files}
1556 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
1558 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
1560 Shows the colour selection dialog and returns the colour selected by user or
1561 invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
1562 is valid) if the dialog was cancelled.
1564 \wxheading{Parameters}
1566 \docparam{parent}{The parent window for the colour selection dialog}
1568 \docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
1570 \wxheading{Include files}
1574 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
1576 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
1578 Shows the font selection dialog and returns the font selected by user or
1579 invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
1580 is valid) if the dialog was cancelled.
1582 \wxheading{Parameters}
1584 \docparam{parent}{The parent window for the font selection dialog}
1586 \docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
1588 \wxheading{Include files}
1593 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
1595 \func{size\_t}{wxGetMultipleChoices}{\\
1596 \param{wxArrayInt\& }{selections},\\
1597 \param{const wxString\& }{message},\\
1598 \param{const wxString\& }{caption},\\
1599 \param{const wxArrayString\& }{aChoices},\\
1600 \param{wxWindow *}{parent = NULL},\\
1601 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1602 \param{bool}{ centre = true},\\
1603 \param{int }{width=150}, \param{int }{height=200}}
1605 \func{size\_t}{wxGetMultipleChoices}{\\
1606 \param{wxArrayInt\& }{selections},\\
1607 \param{const wxString\& }{message},\\
1608 \param{const wxString\& }{caption},\\
1609 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1610 \param{wxWindow *}{parent = NULL},\\
1611 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1612 \param{bool}{ centre = true},\\
1613 \param{int }{width=150}, \param{int }{height=200}}
1615 Pops up a dialog box containing a message, OK/Cancel buttons and a
1616 multiple-selection listbox. The user may choose an arbitrary (including 0)
1617 number of items in the listbox whose indices will be returned in
1618 {\it selection} array. The initial contents of this array will be used to
1619 select the items when the dialog is shown.
1621 You may pass the list of strings to choose from either using {\it choices}
1622 which is an array of {\it n} strings for the listbox or by using a single
1623 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1625 If {\it centre} is true, the message text (which may include new line
1626 characters) is centred; if false, the message is left-justified.
1628 \wxheading{Include files}
1632 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1633 and {\tt choices}, and no {\tt selections} parameter; the function
1634 returns an array containing the user selections.}
1636 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
1638 \func{long}{wxGetNumberFromUser}{
1639 \param{const wxString\& }{message},
1640 \param{const wxString\& }{prompt},
1641 \param{const wxString\& }{caption},
1642 \param{long }{value},
1643 \param{long }{min = 0},
1644 \param{long }{max = 100},
1645 \param{wxWindow *}{parent = NULL},
1646 \param{const wxPoint\& }{pos = wxDefaultPosition}}
1648 Shows a dialog asking the user for numeric input. The dialogs title is set to
1649 {\it caption}, it contains a (possibly) multiline {\it message} above the
1650 single line {\it prompt} and the zone for entering the number.
1652 The number entered must be in the range {\it min}..{\it max} (both of which
1653 should be positive) and {\it value} is the initial value of it. If the user
1654 enters an invalid value or cancels the dialog, the function will return -1.
1656 Dialog is centered on its {\it parent} unless an explicit position is given in
1659 \wxheading{Include files}
1663 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
1665 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1666 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
1668 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
1669 in the dialog is not shown on screen but replaced with stars. This is intended
1670 to be used for entering passwords as the function name implies.
1672 \wxheading{Include files}
1676 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
1678 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
1679 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
1680 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}}
1682 Pop up a dialog box with title set to {\it caption}, {\it message}, and a
1683 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
1684 or press Cancel to return the empty string.
1686 If {\it centre} is true, the message text (which may include new line characters)
1687 is centred; if false, the message is left-justified.
1689 \wxheading{Include files}
1693 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
1695 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1696 \param{int }{nsel}, \param{int *}{selection},
1697 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1698 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1700 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
1701 listbox. The user may choose one or more item(s) and press OK or Cancel.
1703 The number of initially selected choices, and array of the selected indices,
1704 are passed in; this array will contain the user selections on exit, with
1705 the function returning the number of selections. {\it selection} must be
1706 as big as the number of choices, in case all are selected.
1708 If Cancel is pressed, -1 is returned.
1710 {\it choices} is an array of {\it n} strings for the listbox.
1712 If {\it centre} is true, the message text (which may include new line characters)
1713 is centred; if false, the message is left-justified.
1715 \wxheading{Include files}
1719 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
1721 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1722 \param{const wxString\& }{caption},\\
1723 \param{const wxArrayString\& }{aChoices},\\
1724 \param{wxWindow *}{parent = NULL},\\
1725 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1726 \param{bool}{ centre = true},\\
1727 \param{int }{width=150}, \param{int }{height=200}}
1729 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
1730 \param{const wxString\& }{caption},\\
1731 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1732 \param{wxWindow *}{parent = NULL},\\
1733 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1734 \param{bool}{ centre = true},\\
1735 \param{int }{width=150}, \param{int }{height=200}}
1737 Pops up a dialog box containing a message, OK/Cancel buttons and a
1738 single-selection listbox. The user may choose an item and press OK to return a
1739 string or Cancel to return the empty string. Use
1740 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
1741 valid choice and if you want to be able to detect pressing Cancel reliably.
1743 You may pass the list of strings to choose from either using {\it choices}
1744 which is an array of {\it n} strings for the listbox or by using a single
1745 {\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
1747 If {\it centre} is true, the message text (which may include new line
1748 characters) is centred; if false, the message is left-justified.
1750 \wxheading{Include files}
1754 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1757 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
1759 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1760 \param{const wxString\& }{caption},\\
1761 \param{const wxArrayString\& }{aChoices},\\
1762 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1763 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1765 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
1766 \param{const wxString\& }{caption},\\
1767 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1768 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
1769 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1771 As {\bf wxGetSingleChoice} but returns the index representing the selected
1772 string. If the user pressed cancel, -1 is returned.
1774 \wxheading{Include files}
1778 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1781 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
1783 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
1784 \param{const wxString\& }{caption},\\
1785 \param{const wxArrayString\& }{aChoices},\\
1786 \param{const wxString\& }{client\_data[]},\\
1787 \param{wxWindow *}{parent = NULL},\\
1788 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1789 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1791 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
1792 \param{const wxString\& }{caption},\\
1793 \param{int}{ n}, \param{const wxString\& }{choices[]},\\
1794 \param{const wxString\& }{client\_data[]},\\
1795 \param{wxWindow *}{parent = NULL},\\
1796 \param{int}{ x = -1}, \param{int}{ y = -1},\\
1797 \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
1799 As {\bf wxGetSingleChoice} but takes an array of client data pointers
1800 corresponding to the strings, and returns one of these pointers or NULL if
1801 Cancel was pressed. The {\it client\_data} array must have the same number of
1802 elements as {\it choices} or {\it aChoices}!
1804 \wxheading{Include files}
1808 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
1809 and {\tt choices}, and the client data array must have the
1810 same length as the choices array.}
1812 \membersection{::wxIsBusy}\label{wxisbusy}
1814 \func{bool}{wxIsBusy}{\void}
1816 Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1817 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1819 See also \helpref{wxBusyCursor}{wxbusycursor}.
1821 \wxheading{Include files}
1825 \membersection{::wxMessageBox}\label{wxmessagebox}
1827 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
1828 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
1830 General purpose message dialog. {\it style} may be a bit list of the
1831 following identifiers:
1833 \begin{twocollist}\itemsep=0pt
1834 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
1836 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
1838 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
1839 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
1840 \twocolitem{wxICON\_HAND}{Displays an error symbol.}
1841 \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}
1842 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
1843 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
1846 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
1852 int answer = wxMessageBox("Quit program?", "Confirm",
1853 wxYES_NO | wxCANCEL, main_frame);
1854 if (answer == wxYES)
1859 {\it message} may contain newline characters, in which case the
1860 message will be split into separate lines, to cater for large messages.
1862 \wxheading{Include files}
1866 \membersection{::wxShowTip}\label{wxshowtip}
1868 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
1869 \param{wxTipProvider *}{tipProvider},
1870 \param{bool }{showAtStartup = true}}
1872 This function shows a "startup tip" to the user. The return value is the
1873 state of the ``Show tips at startup'' checkbox.
1875 \docparam{parent}{The parent window for the modal dialog}
1877 \docparam{tipProvider}{An object which is used to get the text of the tips.
1878 It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
1880 \docparam{showAtStartup}{Should be true if startup tips are shown, false
1881 otherwise. This is used as the initial value for "Show tips at startup"
1882 checkbox which is shown in the tips dialog.}
1884 \wxheading{See also}
1886 \helpref{Tips overview}{tipsoverview}
1888 \wxheading{Include files}
1893 \section{Math functions}
1895 \wxheading{Include files}
1899 \membersection{wxFinite}\label{wxfinite}
1901 \func{int}{wxFinite}{\param{double }{x}}
1903 Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),
1904 returns 0 otherwise.
1906 \membersection{wxIsNaN}\label{wxisnan}
1908 \func{bool}{wxIsNaN}{\param{double }{x}}
1910 Returns a non-zero value if {\it x} is NaN (not a number), returns 0
1914 \section{GDI functions}\label{gdifunctions}
1916 The following are relevant to the GDI (Graphics Device Interface).
1918 \wxheading{Include files}
1922 \membersection{wxBITMAP}\label{wxbitmapmacro}
1924 \func{}{wxBITMAP}{bitmapName}
1926 This macro loads a bitmap from either application resources (on the platforms
1927 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
1928 avoid using {\tt \#ifdef}s when creating bitmaps.
1930 \wxheading{See also}
1932 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
1933 \helpref{wxICON}{wxiconmacro}
1935 \wxheading{Include files}
1939 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
1941 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
1942 \param{int *}{width}, \param{int *}{height}}
1944 \func{wxRect}{wxGetClientDisplayRect}{\void}
1946 Returns the dimensions of the work area on the display. On Windows
1947 this means the area not covered by the taskbar, etc. Other platforms
1948 are currently defaulting to the whole display until a way is found to
1949 provide this info for all window managers, etc.
1951 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
1953 \func{bool}{wxColourDisplay}{\void}
1955 Returns true if the display is colour, false otherwise.
1957 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
1959 \func{int}{wxDisplayDepth}{\void}
1961 Returns the depth of the display (a value of 1 denotes a monochrome display).
1963 \membersection{::wxDisplaySize}\label{wxdisplaysize}
1965 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
1967 \func{wxSize}{wxGetDisplaySize}{\void}
1969 Returns the display size in pixels.
1971 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
1973 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
1975 \func{wxSize}{wxGetDisplaySizeMM}{\void}
1977 Returns the display size in millimeters.
1979 \membersection{::wxDROP\_ICON}\label{wxdropicon}
1981 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
1983 This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
1984 name. Under MSW, the cursor is loaded from the resource file and the icon is
1985 loaded from XPM file under other platforms.
1987 This macro should be used with
1988 \helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
1990 \wxheading{Include files}
1994 \membersection{wxICON}\label{wxiconmacro}
1996 \func{}{wxICON}{iconName}
1998 This macro loads an icon from either application resources (on the platforms
1999 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
2000 avoid using {\tt \#ifdef}s when creating icons.
2002 \wxheading{See also}
2004 \helpref{Bitmaps and icons overview}{wxbitmapoverview},
2005 \helpref{wxBITMAP}{wxbitmapmacro}
2007 \wxheading{Include files}
2011 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
2013 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
2014 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
2016 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
2017 makes it into a placeable metafile by prepending a header containing the given
2018 bounding box. The bounding box may be obtained from a device context after drawing
2019 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
2021 In addition to adding the placeable metafile header, this function adds
2022 the equivalent of the following code to the start of the metafile data:
2025 SetMapMode(dc, MM_ANISOTROPIC);
2026 SetWindowOrg(dc, minX, minY);
2027 SetWindowExt(dc, maxX - minX, maxY - minY);
2030 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
2032 Placeable metafiles may be imported by many Windows applications, and can be
2033 used in RTF (Rich Text Format) files.
2035 {\it scale} allows the specification of scale for the metafile.
2037 This function is only available under Windows.
2039 \membersection{::wxSetCursor}\label{wxsetcursor}
2041 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
2043 Globally sets the cursor; only has an effect in Windows and GTK.
2044 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
2046 \section{Printer settings}\label{printersettings}
2048 {\bf NB:} These routines are obsolete and should no longer be used!
2050 The following functions are used to control PostScript printing. Under
2051 Windows, PostScript output can only be sent to a file.
2053 \wxheading{Include files}
2057 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
2059 \func{wxString}{wxGetPrinterCommand}{\void}
2061 Gets the printer command used to print a file. The default is {\tt lpr}.
2063 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
2065 \func{wxString}{wxGetPrinterFile}{\void}
2067 Gets the PostScript output filename.
2069 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
2071 \func{int}{wxGetPrinterMode}{\void}
2073 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2074 The default is PS\_PREVIEW.
2076 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
2078 \func{wxString}{wxGetPrinterOptions}{\void}
2080 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
2082 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
2084 \func{int}{wxGetPrinterOrientation}{\void}
2086 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2088 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
2090 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
2092 Gets the command used to view a PostScript file. The default depends on the platform.
2094 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
2096 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
2098 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
2100 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
2102 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
2104 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2106 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
2108 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
2110 Sets the printer command used to print a file. The default is {\tt lpr}.
2112 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
2114 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
2116 Sets the PostScript output filename.
2118 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
2120 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
2122 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
2123 The default is PS\_PREVIEW.
2125 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
2127 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
2129 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
2131 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
2133 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
2135 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
2137 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
2139 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
2141 Sets the command used to view a PostScript file. The default depends on the platform.
2143 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
2145 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
2147 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
2149 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
2151 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
2153 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
2155 \section{Clipboard functions}\label{clipsboard}
2157 These clipboard functions are implemented for Windows only. The use of these functions
2158 is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
2161 \wxheading{Include files}
2165 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
2167 \func{bool}{wxClipboardOpen}{\void}
2169 Returns true if this application has already opened the clipboard.
2171 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
2173 \func{bool}{wxCloseClipboard}{\void}
2175 Closes the clipboard to allow other applications to use it.
2177 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
2179 \func{bool}{wxEmptyClipboard}{\void}
2181 Empties the clipboard.
2183 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
2185 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
2187 Enumerates the formats found in a list of available formats that belong
2188 to the clipboard. Each call to this function specifies a known
2189 available format; the function returns the format that appears next in
2192 {\it dataFormat} specifies a known format. If this parameter is zero,
2193 the function returns the first format in the list.
2195 The return value specifies the next known clipboard data format if the
2196 function is successful. It is zero if the {\it dataFormat} parameter specifies
2197 the last format in the list of available formats, or if the clipboard
2200 Before it enumerates the formats function, an application must open the clipboard by using the
2201 wxOpenClipboard function.
2203 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
2205 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
2207 Gets data from the clipboard.
2209 {\it dataFormat} may be one of:
2211 \begin{itemize}\itemsep=0pt
2212 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
2213 \item wxCF\_BITMAP: returns a new wxBitmap.
2216 The clipboard must have previously been opened for this call to succeed.
2218 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
2220 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
2222 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
2223 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
2225 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
2227 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
2229 Returns true if the given data format is available on the clipboard.
2231 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
2233 \func{bool}{wxOpenClipboard}{\void}
2235 Opens the clipboard for passing data to it or getting data from it.
2237 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
2239 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
2241 Registers the clipboard data format name and returns an identifier.
2243 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
2245 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
2247 Passes data to the clipboard.
2249 {\it dataFormat} may be one of:
2251 \begin{itemize}\itemsep=0pt
2252 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
2253 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
2254 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
2255 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
2258 The clipboard must have previously been opened for this call to succeed.
2260 \section{Miscellaneous functions}\label{miscellany}
2262 \membersection{wxEXPLICIT}\label{wxexplicit}
2264 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
2265 the compiler supports it or nothing otherwise. Thus, it can be used even in the
2266 code which might have to be compiled with an old compiler without support for
2267 this language feature but still take advantage of it when it is available.
2269 \membersection{wxLL}\label{wxll}
2271 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
2273 This macro is defined for the platforms with a native 64 bit integer type and
2274 allows to define 64 bit compile time constants:
2278 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2282 \wxheading{Include files}
2286 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
2288 This macro is defined to contain the {\tt printf()} format specifier using
2289 which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
2290 printed. Example of using it:
2294 wxLongLong_t ll = wxLL(0x1234567890abcdef);
2295 printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
2299 \wxheading{See also}
2301 \helpref{wxLL}{wxll}
2303 \wxheading{Include files}
2307 \membersection{::wxNewId}\label{wxnewid}
2309 \func{long}{wxNewId}{\void}
2311 Generates an integer identifier unique to this run of the program.
2313 \wxheading{Include files}
2317 \membersection{::wxRegisterId}\label{wxregisterid}
2319 \func{void}{wxRegisterId}{\param{long}{ id}}
2321 Ensures that ids subsequently generated by {\bf NewId} do not clash with
2324 \wxheading{Include files}
2328 \membersection{::wxDDECleanUp}\label{wxddecleanup}
2330 \func{void}{wxDDECleanUp}{\void}
2332 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
2333 called by the application.
2335 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
2337 \wxheading{Include files}
2341 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
2343 \func{void}{wxDDEInitialize}{\void}
2345 Initializes the DDE system. May be called multiple times without harm.
2347 This no longer needs to be called by the application: it will be called
2348 by wxWindows if necessary.
2350 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
2351 \helpref{wxDDECleanUp}{wxddecleanup}.
2353 \wxheading{Include files}
2357 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
2359 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
2361 This function enables or disables all top level windows. It is used by
2362 \helpref{::wxSafeYield}{wxsafeyield}.
2364 \wxheading{Include files}
2368 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
2370 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
2372 Find a menu item identifier associated with the given frame's menu bar.
2374 \wxheading{Include files}
2378 \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
2380 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
2382 {\bf NB:} This function is obsolete, please use
2383 \helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
2385 Find a window by its label. Depending on the type of window, the label may be a window title
2386 or panel item label. If {\it parent} is NULL, the search will start from all top-level
2387 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2388 The search is recursive in both cases.
2390 \wxheading{Include files}
2394 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
2396 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
2398 {\bf NB:} This function is obsolete, please use
2399 \helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
2401 Find a window by its name (as given in a window constructor or {\bf Create} function call).
2402 If {\it parent} is NULL, the search will start from all top-level
2403 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
2404 The search is recursive in both cases.
2406 If no such named window is found, {\bf wxFindWindowByLabel} is called.
2408 \wxheading{Include files}
2412 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
2414 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
2416 Find the deepest window at the given mouse position in screen coordinates,
2417 returning the window if found, or NULL if not.
2419 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
2421 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
2423 Find the deepest window at the mouse pointer position, returning the window
2424 and current pointer position in screen coordinates.
2426 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
2428 \func{wxWindow *}{wxGetActiveWindow}{\void}
2430 Gets the currently active window (Windows only).
2432 \wxheading{Include files}
2436 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
2438 \func{wxString}{wxGetDisplayName}{\void}
2440 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
2442 \wxheading{Include files}
2446 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
2448 \func{wxPoint}{wxGetMousePosition}{\void}
2450 Returns the mouse position in screen coordinates.
2452 \wxheading{Include files}
2456 \membersection{::wxGetResource}\label{wxgetresource}
2458 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2459 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
2461 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2462 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
2464 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2465 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
2467 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2468 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
2470 Gets a resource value from the resource database (for example, WIN.INI, or
2471 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2472 otherwise the specified file is used.
2474 Under X, if an application class (wxApp::GetClassName) has been defined,
2475 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
2476 an applications default file when merging all resource databases.
2478 The reason for passing the result in an argument is that it
2479 can be convenient to define a default value, which gets overridden
2480 if the value exists in the resource file. It saves a separate
2481 test for that resource's existence, and it also allows
2482 the overloading of the function for different types.
2484 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
2486 \wxheading{Include files}
2490 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
2492 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
2494 Returns the first top level parent of the given window, or in other words, the
2495 frame or dialog containing it, or {\tt NULL}.
2497 \wxheading{Include files}
2501 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
2503 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
2505 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
2506 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
2508 The resource must be defined in the {\tt .rc} file using the following syntax:
2511 myResource TEXT file.ext
2514 where {\tt file.ext} is a file that the resource compiler can find.
2516 This function is available under Windows only.
2518 \wxheading{Include files}
2522 \membersection{::wxPostDelete}\label{wxpostdelete}
2524 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
2526 Tells the system to delete the specified object when
2527 all other events have been processed. In some environments, it is
2528 necessary to use this instead of deleting a frame directly with the
2529 delete operator, because some GUIs will still send events to a deleted window.
2531 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
2533 \wxheading{Include files}
2537 \membersection{::wxPostEvent}\label{wxpostevent}
2539 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
2541 In a GUI application, this function posts {\it event} to the specified {\it dest}
2542 object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
2543 Otherwise, it dispatches {\it event} immediately using
2544 \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
2545 See the respective documentation for details (and caveats).
2547 \wxheading{Include files}
2551 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
2553 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
2555 Under X only, sets the current display name. This is the X host and display name such
2556 as ``colonsay:0.0", and the function indicates which display should be used for creating
2557 windows from this point on. Setting the display within an application allows multiple
2558 displays to be used.
2560 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
2562 \wxheading{Include files}
2566 \membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
2568 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
2570 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
2572 {\bf NB:} This function is obsolete, please use
2573 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
2575 Strips any menu codes from {\it in} and places the result
2576 in {\it out} (or returns the new string, in the first form).
2578 Menu codes include \& (mark the next character with an underline
2579 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
2581 \wxheading{Include files}
2585 \membersection{::wxWriteResource}\label{wxwriteresource}
2587 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2588 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
2590 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2591 \param{float }{value}, \param{const wxString\& }{file = NULL}}
2593 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2594 \param{long }{value}, \param{const wxString\& }{file = NULL}}
2596 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
2597 \param{int }{value}, \param{const wxString\& }{file = NULL}}
2599 Writes a resource value into the resource database (for example, WIN.INI, or
2600 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
2601 otherwise the specified file is used.
2603 Under X, the resource databases are cached until the internal function
2604 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
2605 all updated resource databases are written to their files.
2607 Note that it is considered bad manners to write to the .Xdefaults
2608 file under Unix, although the WIN.INI file is fair game under Windows.
2610 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
2612 \wxheading{Include files}
2616 \section{Byte order macros}\label{byteordermacros}
2618 The endian-ness issues (that is the difference between big-endian and
2619 little-endian architectures) are important for the portable programs working
2620 with the external binary data (for example, data files or data coming from
2621 network) which is usually in some fixed, platform-independent format. The
2622 macros are helpful for transforming the data to the correct format.
2624 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
2626 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
2628 \func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
2630 \func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
2632 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
2634 These macros will swap the bytes of the {\it value} variable from little
2635 endian to big endian or vice versa unconditionally, i.e. independently of the
2638 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
2640 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
2642 \func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
2644 \func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
2646 \func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
2648 This macro will swap the bytes of the {\it value} variable from little
2649 endian to big endian or vice versa if the program is compiled on a
2650 big-endian architecture (such as Sun work stations). If the program has
2651 been compiled on a little-endian architecture, the value will be unchanged.
2653 Use these macros to read data from and write data to a file that stores
2654 data in little-endian (for example Intel i386) format.
2656 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
2658 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
2660 \func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
2662 \func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
2664 \func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
2666 This macro will swap the bytes of the {\it value} variable from little
2667 endian to big endian or vice versa if the program is compiled on a
2668 little-endian architecture (such as Intel PCs). If the program has
2669 been compiled on a big-endian architecture, the value will be unchanged.
2671 Use these macros to read data from and write data to a file that stores
2672 data in big-endian format.
2674 \section{RTTI functions}\label{rttimacros}
2676 wxWindows uses its own RTTI ("run-time type identification") system which
2677 predates the current standard C++ RTTI and so is kept for backwards
2678 compatibility reasons but also because it allows some things which the
2679 standard RTTI doesn't directly support (such as creating a class from its
2682 The standard C++ RTTI can be used in the user code without any problems and in
2683 general you shouldn't need to use the functions and the macros in this section
2684 unless you are thinking of modifying or adding any wxWindows classes.
2686 \wxheading{See also}
2688 \helpref{RTTI overview}{runtimeclassoverview}
2690 \membersection{CLASSINFO}\label{classinfo}
2692 \func{wxClassInfo *}{CLASSINFO}{className}
2694 Returns a pointer to the wxClassInfo object associated with this class.
2696 \wxheading{Include files}
2700 \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
2702 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
2704 Used inside a class declaration to declare that the class should be
2705 made known to the class hierarchy, but objects of this class cannot be created
2706 dynamically. The same as DECLARE\_CLASS.
2711 class wxCommand: public wxObject
2713 DECLARE_ABSTRACT_CLASS(wxCommand)
2722 \wxheading{Include files}
2726 \membersection{DECLARE\_APP}\label{declareapp}
2728 \func{}{DECLARE\_APP}{className}
2730 This is used in headers to create a forward declaration of the
2731 \helpref{wxGetApp}{wxgetapp} function implemented by
2732 \helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
2733 {\tt className\& wxGetApp(void)}.
2741 \wxheading{Include files}
2745 \membersection{DECLARE\_CLASS}\label{declareclass}
2747 \func{}{DECLARE\_CLASS}{className}
2749 Used inside a class declaration to declare that the class should be
2750 made known to the class hierarchy, but objects of this class cannot be created
2751 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
2753 \wxheading{Include files}
2757 \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
2759 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
2761 Used inside a class declaration to declare that the objects of this class should be dynamically
2762 creatable from run-time type information.
2767 class wxFrame: public wxWindow
2769 DECLARE_DYNAMIC_CLASS(wxFrame)
2772 const wxString& frameTitle;
2778 \wxheading{Include files}
2782 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
2784 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
2786 Used in a C++ implementation file to complete the declaration of
2787 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
2792 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
2794 wxCommand::wxCommand(void)
2800 \wxheading{Include files}
2804 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
2806 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
2808 Used in a C++ implementation file to complete the declaration of
2809 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
2811 \wxheading{Include files}
2815 \membersection{IMPLEMENT\_APP}\label{implementapp}
2817 \func{}{IMPLEMENT\_APP}{className}
2819 This is used in the application class implementation file to make the application class known to
2820 wxWindows for dynamic construction. You use this instead of
2831 IMPLEMENT_APP(MyApp)
2834 See also \helpref{DECLARE\_APP}{declareapp}.
2836 \wxheading{Include files}
2840 \membersection{IMPLEMENT\_CLASS}\label{implementclass}
2842 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
2844 Used in a C++ implementation file to complete the declaration of
2845 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
2847 \wxheading{Include files}
2851 \membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
2853 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
2855 Used in a C++ implementation file to complete the declaration of a
2856 class that has run-time type information and two base classes. The
2857 same as IMPLEMENT\_ABSTRACT\_CLASS2.
2859 \wxheading{Include files}
2863 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
2865 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
2867 Used in a C++ implementation file to complete the declaration of
2868 a class that has run-time type information, and whose instances
2869 can be created dynamically.
2874 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
2876 wxFrame::wxFrame(void)
2882 \wxheading{Include files}
2886 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
2888 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
2890 Used in a C++ implementation file to complete the declaration of
2891 a class that has run-time type information, and whose instances
2892 can be created dynamically. Use this for classes derived from two
2895 \wxheading{Include files}
2899 \membersection{wxConstCast}\label{wxconstcast}
2901 \func{classname *}{wxConstCast}{ptr, classname}
2903 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
2904 supports {\it const\_cast} or into an old, C-style cast, otherwise.
2906 \wxheading{See also}
2908 \helpref{wxDynamicCast}{wxdynamiccast}\\
2909 \helpref{wxStaticCast}{wxstaticcast}
2911 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
2913 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
2915 Creates and returns an object of the given class, if the class has been
2916 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
2918 \membersection{WXDEBUG\_NEW}\label{debugnew}
2920 \func{}{WXDEBUG\_NEW}{arg}
2922 This is defined in debug mode to be call the redefined new operator
2923 with filename and line number arguments. The definition is:
2926 #define WXDEBUG_NEW new(__FILE__,__LINE__)
2929 In non-debug mode, this is defined as the normal new operator.
2931 \wxheading{Include files}
2935 \membersection{wxDynamicCast}\label{wxdynamiccast}
2937 \func{classname *}{wxDynamicCast}{ptr, classname}
2939 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
2940 the pointer is of this type (the check is done during the run-time) or
2941 {\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
2942 wxObject::IsKindOf() function.
2944 The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
2950 wxWindow *win = wxWindow::FindFocus();
2951 wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
2954 // a text control has the focus...
2958 // no window has the focus or it is not a text control
2962 \wxheading{See also}
2964 \helpref{RTTI overview}{runtimeclassoverview}\\
2965 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
2966 \helpref{wxConstCast}{wxconstcast}\\
2967 \helpref{wxStatiicCast}{wxstaticcast}
2969 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
2971 \func{classname *}{wxDynamicCastThis}{classname}
2973 This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
2974 latter provokes spurious compilation warnings from some compilers (because it
2975 tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
2976 this macro should be used to avoid them.
2978 \wxheading{See also}
2980 \helpref{wxDynamicCast}{wxdynamiccast}
2982 \membersection{wxStaticCast}\label{wxstaticcast}
2984 \func{classname *}{wxStaticCast}{ptr, classname}
2986 This macro checks that the cast is valid in debug mode (an assert failure will
2987 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
2988 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
2990 \helpref{wxDynamicCast}{wxdynamiccast}\\
2991 \helpref{wxConstCast}{wxconstcast}
2993 \section{Log functions}\label{logfunctions}
2995 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2996 further information. The functions use (implicitly) the currently active log
2997 target, so their descriptions here may not apply if the log target is not the
2998 standard one (installed by wxWindows in the beginning of the program).
3000 \wxheading{Include files}
3004 \membersection{::wxDebugMsg}\label{wxdebugmsg}
3006 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
3008 {\bf NB:} This function is now obsolete, replaced by \helpref{Log
3009 functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
3011 Display a debugging message; under Windows, this will appear on the
3012 debugger command window, and under Unix, it will be written to standard
3015 The syntax is identical to {\bf printf}: pass a format string and a
3016 variable list of arguments.
3018 {\bf Tip:} under Windows, if your application crashes before the
3019 message appears in the debugging window, put a wxYield call after
3020 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
3021 (at least for Watcom C++): preformat your messages and use OutputDebugString
3024 \wxheading{Include files}
3028 \membersection{::wxError}\label{wxerror}
3030 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
3032 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
3035 Displays {\it msg} and continues. This writes to standard error under
3036 Unix, and pops up a message box under Windows. Used for internal
3037 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
3039 \wxheading{Include files}
3043 \membersection{::wxFatalError}\label{wxfatalerror}
3045 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
3047 {\bf NB:} This function is now obsolete, please use
3048 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
3050 Displays {\it msg} and exits. This writes to standard error under Unix,
3051 and pops up a message box under Windows. Used for fatal internal
3052 wxWindows errors. See also \helpref{wxError}{wxerror}.
3054 \wxheading{Include files}
3058 \membersection{::wxLogError}\label{wxlogerror}
3060 \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
3062 \func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3064 The functions to use for error messages, i.e. the messages that must be shown
3065 to the user. The default processing is to pop up a message box to inform the
3068 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
3070 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
3072 \func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3074 Like \helpref{wxLogError}{wxlogerror}, but also
3075 terminates the program with the exit code 3. Using {\it abort()} standard
3076 function also terminates the program with this exit code.
3078 \membersection{::wxLogWarning}\label{wxlogwarning}
3080 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
3082 \func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3084 For warnings - they are also normally shown to the user, but don't interrupt
3087 \membersection{::wxLogMessage}\label{wxlogmessage}
3089 \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
3091 \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3093 For all normal, informational messages. They also appear in a message box by
3094 default (but it can be changed). Notice that the standard behaviour is to not
3095 show informational messages if there are any errors later - the logic being
3096 that the later error messages make the informational messages preceding them
3099 \membersection{::wxLogVerbose}\label{wxlogverbose}
3101 \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
3103 \func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3105 For verbose output. Normally, it is suppressed, but
3106 might be activated if the user wishes to know more details about the program
3107 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
3109 \membersection{::wxLogStatus}\label{wxlogstatus}
3111 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
3113 \func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3115 \func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
3117 \func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3119 Messages logged by these functions will appear in the statusbar of the {\it
3120 frame} or of the top level application window by default (i.e. when using
3121 the second version of the functions).
3123 If the target frame doesn't have a statusbar, the message will be lost.
3125 \membersection{::wxLogSysError}\label{wxlogsyserror}
3127 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
3129 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3131 Mostly used by wxWindows itself, but might be handy for logging errors after
3132 system call (API function) failure. It logs the specified message text as well
3133 as the last system error code ({\it errno} or {\it ::GetLastError()} depending
3134 on the platform) and the corresponding error message. The second form
3135 of this function takes the error code explicitly as the first argument.
3137 \wxheading{See also}
3139 \helpref{wxSysErrorCode}{wxsyserrorcode},
3140 \helpref{wxSysErrorMsg}{wxsyserrormsg}
3142 \membersection{::wxLogDebug}\label{wxlogdebug}
3144 \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
3146 \func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3148 The right functions for debug output. They only do something in debug
3149 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
3150 nothing in release mode (otherwise).
3152 \membersection{::wxLogTrace}\label{wxlogtrace}
3154 \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
3156 \func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
3158 \func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
3160 \func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3162 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
3164 \func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
3166 As {\bf wxLogDebug}, trace functions only do something in debug build and
3167 expand to nothing in the release one. The reason for making
3168 it a separate function from it is that usually there are a lot of trace
3169 messages, so it might make sense to separate them from other debug messages.
3171 The trace messages also usually can be separated into different categories and
3172 the second and third versions of this function only log the message if the
3173 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
3174 allows to selectively trace only some operations and not others by changing
3175 the value of the trace mask (possible during the run-time).
3177 For the second function (taking a string mask), the message is logged only if
3178 the mask has been previously enabled by the call to
3179 \helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
3180 used by wxWindows are:
3182 \begin{itemize}\itemsep=0pt
3183 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
3184 \item wxTRACE\_Messages: trace window messages/X callbacks
3185 \item wxTRACE\_ResAlloc: trace GDI resource allocation
3186 \item wxTRACE\_RefCount: trace various ref counting operations
3187 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
3190 The third version of the function only logs the message if all the bit
3191 corresponding to the {\it mask} are set in the wxLog trace mask which can be
3192 set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
3193 flexible than the previous one because it doesn't allow defining the user
3194 trace masks easily - this is why it is deprecated in favour of using string
3197 \begin{itemize}\itemsep=0pt
3198 \item wxTraceMemAlloc: trace memory allocation (new/delete)
3199 \item wxTraceMessages: trace window messages/X callbacks
3200 \item wxTraceResAlloc: trace GDI resource allocation
3201 \item wxTraceRefCount: trace various ref counting operations
3202 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
3205 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
3207 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
3209 This function shows a message to the user in a safe way and should be safe to
3210 call even before the application has been initialized or if it is currently in
3211 some other strange state (for example, about to crash). Under Windows this
3212 function shows a message box using a native dialog instead of
3213 \helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
3214 it simply prints the message to the standard output using the title as prefix.
3216 \wxheading{Parameters}
3218 \docparam{title}{The title of the message box shown to the user or the prefix
3219 of the message string}
3221 \docparam{text}{The text to show to the user}
3223 \wxheading{See also}
3225 \helpref{wxLogFatalError}{wxlogfatalerror}
3227 \wxheading{Include files}
3231 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
3233 \func{unsigned long}{wxSysErrorCode}{\void}
3235 Returns the error code from the last system call. This function uses
3236 {\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
3238 \wxheading{See also}
3240 \helpref{wxSysErrorMsg}{wxsyserrormsg},
3241 \helpref{wxLogSysError}{wxlogsyserror}
3243 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
3245 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
3247 Returns the error message corresponding to the given system error code. If
3248 {\it errCode} is $0$ (default), the last error code (as returned by
3249 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
3251 \wxheading{See also}
3253 \helpref{wxSysErrorCode}{wxsyserrorcode},
3254 \helpref{wxLogSysError}{wxlogsyserror}
3256 \membersection{WXTRACE}\label{trace}
3258 \wxheading{Include files}
3262 \func{}{WXTRACE}{formatString, ...}
3264 {\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3266 Calls wxTrace with printf-style variable argument syntax. Output
3267 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3269 \wxheading{Include files}
3273 \membersection{WXTRACELEVEL}\label{tracelevel}
3275 \func{}{WXTRACELEVEL}{level, formatString, ...}
3277 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3279 Calls wxTraceLevel with printf-style variable argument syntax. Output
3280 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3281 The first argument should be the level at which this information is appropriate.
3282 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3285 \wxheading{Include files}
3289 \membersection{::wxTrace}\label{wxtrace}
3291 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
3293 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3295 Takes printf-style variable argument syntax. Output
3296 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3298 \wxheading{Include files}
3302 \membersection{::wxTraceLevel}\label{wxtracelevel}
3304 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
3306 {\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
3308 Takes printf-style variable argument syntax. Output
3309 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
3310 The first argument should be the level at which this information is appropriate.
3311 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
3314 \wxheading{Include files}
3318 \section{Time functions}\label{timefunctions}
3320 The functions in this section deal with getting the current time and
3321 starting/stopping the global timers. Please note that the timer functions are
3322 deprecated because they work with one global timer only and
3323 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
3324 should be used instead. For retrieving the current time, you may also use
3325 \helpref{wxDateTime::Now}{wxdatetimenow} or
3326 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
3328 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
3330 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
3332 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
3334 If {\it resetTimer} is true (the default), the timer is reset to zero
3337 See also \helpref{wxTimer}{wxtimer}.
3339 \wxheading{Include files}
3343 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
3345 \func{long}{wxGetLocalTime}{\void}
3347 Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
3349 \wxheading{See also}
3351 \helpref{wxDateTime::Now}{wxdatetimenow}
3353 \wxheading{Include files}
3357 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
3359 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
3361 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
3363 \wxheading{See also}
3365 \helpref{wxDateTime::Now}{wxdatetimenow},\\
3366 \helpref{wxLongLong}{wxlonglong}
3368 \wxheading{Include files}
3372 \membersection{::wxGetUTCTime}\label{wxgetutctime}
3374 \func{long}{wxGetUTCTime}{\void}
3376 Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
3378 \wxheading{See also}
3380 \helpref{wxDateTime::Now}{wxdatetimenow}
3382 \wxheading{Include files}
3386 \membersection{::wxNow}\label{wxnow}
3388 \func{wxString}{wxNow}{\void}
3390 Returns a string representing the current date and time.
3392 \wxheading{Include files}
3396 \membersection{::wxSleep}\label{wxsleep}
3398 \func{void}{wxSleep}{\param{int}{ secs}}
3400 Sleeps for the specified number of seconds.
3402 \wxheading{Include files}
3406 \membersection{::wxStartTimer}\label{wxstarttimer}
3408 \func{void}{wxStartTimer}{\void}
3410 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
3412 See also \helpref{wxTimer}{wxtimer}.
3414 \wxheading{Include files}
3418 \membersection{::wxUsleep}\label{wxusleep}
3420 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
3422 Sleeps for the specified number of milliseconds. Notice that usage of this
3423 function is encouraged instead of calling usleep(3) directly because the
3424 standard usleep() function is not MT safe.
3426 \wxheading{Include files}
3430 \section{Debugging macros and functions}\label{debugmacros}
3432 Useful macros and functions for error checking and defensive programming.
3433 wxWindows defines three families of the assert-like macros:
3434 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
3435 (in other words, in the debug build) but disappear completely in the release
3436 build. On the other hand, the wxCHECK macros stay event in release builds but a
3437 check failure doesn't generate any user-visible effects then. Finally, the
3438 compile time assertions don't happen during the run-time but result in the
3439 compilation error messages if the condition they check fail.
3441 \wxheading{Include files}
3445 \membersection{::wxOnAssert}\label{wxonassert}
3447 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
3449 This function is called whenever one of debugging macros fails (i.e. condition
3450 is false in an assertion). It is only defined in the debug mode, in release
3451 builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
3453 To override the default behaviour in the debug builds which is to show the user
3454 a dialog asking whether he wants to abort the program, continue or continue
3455 ignoring any subsequent assert failures, you may override
3456 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
3457 the global application object exists.
3459 \membersection{wxASSERT}\label{wxassert}
3461 \func{}{wxASSERT}{\param{}{condition}}
3463 Assert macro. An error message will be generated if the condition is false in
3464 debug mode, but nothing will be done in the release build.
3466 Please note that the condition in wxASSERT() should have no side effects
3467 because it will not be executed in release mode at all.
3469 \wxheading{See also}
3471 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
3472 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3474 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
3476 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
3478 This macro results in a
3479 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
3480 of the given type {\it type} is less than {\it size} bits.
3482 You may use it like this, for example:
3485 // we rely on the int being able to hold values up to 2^32
3486 wxASSERT_MIN_BITSIZE(int, 32);
3488 // can't work with the platforms using UTF-8 for wchar_t
3489 wxASSERT_MIN_BITSIZE(wchar_t, 16);
3492 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
3494 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
3496 Assert macro with message. An error message will be generated if the condition is false.
3498 \wxheading{See also}
3500 \helpref{wxASSERT}{wxassert},\\
3501 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
3503 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
3505 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
3507 Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
3508 specified {\it condition} is false. The compiler error message should include
3509 the {\it msg} identifier - please note that it must be a valid C++ identifier
3510 and not a string unlike in the other cases.
3512 This macro is mostly useful for testing the expressions involving the
3513 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
3514 sometimes desirable to test them at the compile time.
3516 Note that this macro internally declares a struct whose name it tries to make
3517 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
3518 use it on the same line in two different source files. In this case you may
3519 either change the line in which either of them appears on or use the
3520 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
3522 \wxheading{See also}
3524 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
3525 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
3527 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
3529 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
3531 This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
3532 except that it allows you to specify a unique {\it name} for the struct
3533 internally defined by this macro to avoid getting the compilation errors
3534 described \helpref{above}{wxcompiletimeassert}.
3536 \membersection{wxFAIL}\label{wxfail}
3538 \func{}{wxFAIL}{\void}
3540 Will always generate an assert error if this code is reached (in debug mode).
3542 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
3544 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
3546 \func{}{wxFAIL\_MSG}{\param{}{msg}}
3548 Will always generate an assert error with specified message if this code is reached (in debug mode).
3550 This macro is useful for marking unreachable" code areas, for example
3551 it may be used in the "default:" branch of a switch statement if all possible
3552 cases are processed above.
3554 \wxheading{See also}
3556 \helpref{wxFAIL}{wxfail}
3558 \membersection{wxCHECK}\label{wxcheck}
3560 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
3562 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
3563 This check is done even in release mode.
3565 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
3567 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
3569 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
3570 This check is done even in release mode.
3572 This macro may be only used in non void functions, see also
3573 \helpref{wxCHECK\_RET}{wxcheckret}.
3575 \membersection{wxCHECK\_RET}\label{wxcheckret}
3577 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
3579 Checks that the condition is true, and returns if not (FAILs with given error
3580 message in debug mode). This check is done even in release mode.
3582 This macro should be used in void functions instead of
3583 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
3585 \membersection{wxCHECK2}\label{wxcheck2}
3587 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
3589 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
3590 {\it operation} if it is not. This is a generalisation of
3591 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
3592 returning from the function must be done when the {\it condition} is false.
3594 This check is done even in release mode.
3596 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
3598 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
3600 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
3601 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
3602 instead of wxFAIL() if the {\it condition} is false.
3604 \membersection{::wxTrap}\label{wxtrap}
3606 \func{void}{wxTrap}{\void}
3608 In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a
3609 debugger exception meaning that the control is passed to the debugger if one is
3610 attached to the process. Otherwise the program just terminates abnormally.
3612 In release mode this function does nothing.
3614 \wxheading{Include files}
3618 \section{Environment access functions}\label{environfunctions}
3620 The functions in this section allow to access (get) or change value of
3621 environment variables in a portable way. They are currently implemented under
3622 Win32 and POSIX-like systems (Unix).
3624 % TODO add some stuff about env var inheriting but not propagating upwards (VZ)
3626 \wxheading{Include files}
3630 \membersection{wxGetenv}\label{wxgetenvmacro}
3632 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
3634 This is a macro defined as {\tt getenv()} or its wide char version in Unicode
3637 Note that under Win32 it may not return correct value for the variables set
3638 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
3641 \membersection{wxGetEnv}\label{wxgetenv}
3643 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
3645 Returns the current value of the environment variable {\it var} in {\it value}.
3646 {\it value} may be {\tt NULL} if you just want to know if the variable exists
3647 and are not interested in its value.
3649 Returns {\tt true} if the variable exists, {\tt false} otherwise.
3651 \membersection{wxSetEnv}\label{wxsetenv}
3653 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
3655 Sets the value of the environment variable {\it var} (adding it if necessary)
3658 Returns {\tt true} on success.
3660 \membersection{wxUnsetEnv}\label{wxunsetenv}
3662 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
3664 Removes the variable {\it var} from the environment.
3665 \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
3668 Returns {\tt true} on success.