]>
Commit | Line | Data |
---|---|---|
c801d85f | 1 | ///////////////////////////////////////////////////////////////////////////// |
55034339 | 2 | // Name: wx/utils.h |
c801d85f KB |
3 | // Purpose: Miscellaneous utilities |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 29/01/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998 Julian Smart | |
65571936 | 9 | // Licence: wxWindows licence |
c801d85f KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_UTILSH__ |
13 | #define _WX_UTILSH__ | |
c801d85f | 14 | |
d6b9496a VZ |
15 | // ---------------------------------------------------------------------------- |
16 | // headers | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
c801d85f KB |
19 | #include "wx/object.h" |
20 | #include "wx/list.h" | |
c801d85f | 21 | #include "wx/filefn.h" |
f516d986 VZ |
22 | #if wxUSE_GUI |
23 | #include "wx/gdicmn.h" | |
24 | #endif | |
2da2f941 MB |
25 | |
26 | class WXDLLIMPEXP_BASE wxArrayString; | |
230c9077 | 27 | class WXDLLIMPEXP_BASE wxArrayInt; |
c801d85f | 28 | |
eadd7bd2 VZ |
29 | // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare |
30 | // wxLongLong | |
31 | #include "wx/longlong.h" | |
32 | ||
8bb6b2c0 VZ |
33 | // need for wxOperatingSystemId |
34 | #include "wx/platinfo.h" | |
35 | ||
55034339 WS |
36 | #ifdef __WATCOMC__ |
37 | #include <direct.h> | |
38 | #elif defined(__X__) | |
d6b9496a VZ |
39 | #include <dirent.h> |
40 | #include <unistd.h> | |
c801d85f KB |
41 | #endif |
42 | ||
43 | #include <stdio.h> | |
44 | ||
d6b9496a VZ |
45 | // ---------------------------------------------------------------------------- |
46 | // Forward declaration | |
47 | // ---------------------------------------------------------------------------- | |
48 | ||
62a9d04c VS |
49 | class WXDLLIMPEXP_CORE wxProcess; |
50 | class WXDLLIMPEXP_CORE wxFrame; | |
51 | class WXDLLIMPEXP_CORE wxWindow; | |
52 | class WXDLLIMPEXP_CORE wxWindowList; | |
d6b9496a | 53 | |
d6b9496a VZ |
54 | // ---------------------------------------------------------------------------- |
55 | // Macros | |
56 | // ---------------------------------------------------------------------------- | |
c801d85f | 57 | |
d6b9496a VZ |
58 | #define wxMax(a,b) (((a) > (b)) ? (a) : (b)) |
59 | #define wxMin(a,b) (((a) < (b)) ? (a) : (b)) | |
e8ee8f27 | 60 | #define wxClip(a,b,c) (((a) < (b)) ? (b) : (((a) > (c)) ? (c) : (a))) |
c801d85f | 61 | |
9ad34f61 VZ |
62 | // wxGetFreeMemory can return huge amount of memory on 32-bit platforms as well |
63 | // so to always use long long for its result type on all platforms which | |
64 | // support it | |
65 | #if wxUSE_LONGLONG | |
66 | typedef wxLongLong wxMemorySize; | |
9d8aca48 | 67 | #else |
9ad34f61 | 68 | typedef long wxMemorySize; |
9d8aca48 WS |
69 | #endif |
70 | ||
d6b9496a VZ |
71 | // ---------------------------------------------------------------------------- |
72 | // String functions (deprecated, use wxString) | |
73 | // ---------------------------------------------------------------------------- | |
74 | ||
c801d85f | 75 | // Make a copy of this string using 'new' |
f526f752 | 76 | #if WXWIN_COMPATIBILITY_2_4 |
eecb33b0 | 77 | wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) ); |
f526f752 | 78 | #endif |
c801d85f | 79 | |
d6b9496a | 80 | // A shorter way of using strcmp |
9d2f3c71 | 81 | #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0)) |
d6b9496a VZ |
82 | |
83 | // ---------------------------------------------------------------------------- | |
84 | // Miscellaneous functions | |
85 | // ---------------------------------------------------------------------------- | |
86 | ||
87 | // Sound the bell | |
968eb2ef MW |
88 | #if !defined __EMX__ && \ |
89 | (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__) | |
90 | WXDLLIMPEXP_CORE void wxBell(); | |
91 | #else | |
bddd7a8d | 92 | WXDLLIMPEXP_BASE void wxBell(); |
968eb2ef | 93 | #endif |
d6b9496a | 94 | |
bdc72a22 | 95 | // Get OS description as a user-readable string |
bddd7a8d | 96 | WXDLLIMPEXP_BASE wxString wxGetOsDescription(); |
bdc72a22 | 97 | |
d6b9496a | 98 | // Get OS version |
8bb6b2c0 VZ |
99 | WXDLLIMPEXP_BASE wxOperatingSystemId wxGetOsVersion(int *majorVsn = (int *) NULL, |
100 | int *minorVsn = (int *) NULL); | |
101 | ||
102 | // Get platform endianness | |
103 | WXDLLIMPEXP_BASE bool wxIsPlatformLittleEndian(); | |
104 | ||
105 | // Get platform architecture | |
106 | WXDLLIMPEXP_BASE bool wxIsPlatform64Bit(); | |
d6b9496a VZ |
107 | |
108 | // Return a string with the current date/time | |
bddd7a8d | 109 | WXDLLIMPEXP_BASE wxString wxNow(); |
d6b9496a | 110 | |
77ffb593 | 111 | // Return path where wxWidgets is installed (mostly useful in Unices) |
bddd7a8d | 112 | WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix(); |
2c18f21d | 113 | // Return path to wxWin data (/usr/share/wx/%{version}) (Unices) |
bddd7a8d | 114 | WXDLLIMPEXP_BASE wxString wxGetDataDir(); |
134677bd | 115 | |
230c9077 JS |
116 | /* |
117 | * Class to make it easier to specify platform-dependent values | |
118 | * | |
119 | * Examples: | |
4bfec179 JS |
120 | * long val = wxPlatform::If(wxMac, 1).ElseIf(wxGTK, 2).ElseIf(stPDA, 5).Else(3); |
121 | * wxString strVal = wxPlatform::If(wxMac, wxT("Mac")).ElseIf(wxMSW, wxT("MSW")).Else(wxT("Other")); | |
230c9077 JS |
122 | * |
123 | * A custom platform symbol: | |
124 | * | |
125 | * #define stPDA 100 | |
126 | * #ifdef __WXWINCE__ | |
127 | * wxPlatform::AddPlatform(stPDA); | |
128 | * #endif | |
129 | * | |
4bfec179 | 130 | * long windowStyle = wxCAPTION | (long) wxPlatform::IfNot(stPDA, wxRESIZE_BORDER); |
230c9077 JS |
131 | * |
132 | */ | |
133 | ||
134 | class WXDLLIMPEXP_BASE wxPlatform | |
135 | { | |
136 | public: | |
4bfec179 JS |
137 | wxPlatform() { Init(); } |
138 | wxPlatform(const wxPlatform& platform) { Copy(platform); } | |
139 | void operator = (const wxPlatform& platform) { Copy(platform); } | |
140 | void Copy(const wxPlatform& platform); | |
230c9077 JS |
141 | |
142 | // Specify an optional default value | |
25a9f291 WS |
143 | wxPlatform(int defValue) { Init(); m_longValue = (long)defValue; } |
144 | wxPlatform(long defValue) { Init(); m_longValue = defValue; } | |
145 | wxPlatform(const wxString& defValue) { Init(); m_stringValue = defValue; } | |
146 | wxPlatform(double defValue) { Init(); m_doubleValue = defValue; } | |
230c9077 | 147 | |
4bfec179 JS |
148 | static wxPlatform If(int platform, long value); |
149 | static wxPlatform IfNot(int platform, long value); | |
150 | wxPlatform& ElseIf(int platform, long value); | |
151 | wxPlatform& ElseIfNot(int platform, long value); | |
152 | wxPlatform& Else(long value); | |
153 | ||
25a9f291 | 154 | static wxPlatform If(int platform, int value) { return If(platform, (long)value); } |
4bfec179 JS |
155 | static wxPlatform IfNot(int platform, int value) { return IfNot(platform, (long)value); } |
156 | wxPlatform& ElseIf(int platform, int value) { return ElseIf(platform, (long) value); } | |
157 | wxPlatform& ElseIfNot(int platform, int value) { return ElseIfNot(platform, (long) value); } | |
158 | wxPlatform& Else(int value) { return Else((long) value); } | |
159 | ||
160 | static wxPlatform If(int platform, double value); | |
161 | static wxPlatform IfNot(int platform, double value); | |
162 | wxPlatform& ElseIf(int platform, double value); | |
163 | wxPlatform& ElseIfNot(int platform, double value); | |
164 | wxPlatform& Else(double value); | |
165 | ||
166 | static wxPlatform If(int platform, const wxString& value); | |
167 | static wxPlatform IfNot(int platform, const wxString& value); | |
168 | wxPlatform& ElseIf(int platform, const wxString& value); | |
169 | wxPlatform& ElseIfNot(int platform, const wxString& value); | |
170 | wxPlatform& Else(const wxString& value); | |
230c9077 JS |
171 | |
172 | long GetInteger() const { return m_longValue; } | |
173 | const wxString& GetString() const { return m_stringValue; } | |
174 | double GetDouble() const { return m_doubleValue; } | |
175 | ||
176 | operator int() const { return (int) GetInteger(); } | |
177 | operator long() const { return GetInteger(); } | |
178 | operator double() const { return GetDouble(); } | |
179 | operator const wxString() const { return GetString(); } | |
180 | operator const wxChar*() const { return (const wxChar*) GetString(); } | |
181 | ||
182 | static void AddPlatform(int platform); | |
4bfec179 | 183 | static bool Is(int platform); |
230c9077 JS |
184 | static void ClearPlatforms(); |
185 | ||
186 | private: | |
25a9f291 WS |
187 | |
188 | void Init() { m_longValue = 0; m_doubleValue = 0.0; } | |
189 | ||
230c9077 JS |
190 | long m_longValue; |
191 | double m_doubleValue; | |
192 | wxString m_stringValue; | |
193 | static wxArrayInt* sm_customPlatforms; | |
194 | }; | |
195 | ||
196 | /// Function for testing current platform | |
4bfec179 | 197 | inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); } |
134677bd | 198 | |
e90c1d2a | 199 | #if wxUSE_GUI |
97698dc4 RD |
200 | |
201 | // Get the state of a key (true if pressed, false if not) | |
202 | // This is generally most useful getting the state of | |
203 | // the modifier or toggle keys. | |
1751226c | 204 | WXDLLEXPORT bool wxGetKeyState(wxKeyCode key); |
97698dc4 | 205 | |
14dfb3d2 | 206 | |
63cc5d9d RR |
207 | // Don't synthesize KeyUp events holding down a key and producing |
208 | // KeyDown events with autorepeat. On by default and always on | |
209 | // in wxMSW. | |
f0492f7d RR |
210 | WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag ); |
211 | ||
7dd40b6f RD |
212 | |
213 | // wxMouseState is used to hold information about button and modifier state | |
214 | // and is what is returned from wxGetMouseState. | |
215 | class WXDLLEXPORT wxMouseState | |
216 | { | |
217 | public: | |
218 | wxMouseState() | |
219 | : m_x(0), m_y(0), | |
220 | m_leftDown(false), m_middleDown(false), m_rightDown(false), | |
221 | m_controlDown(false), m_shiftDown(false), m_altDown(false), | |
222 | m_metaDown(false) | |
223 | {} | |
224 | ||
225 | wxCoord GetX() { return m_x; } | |
226 | wxCoord GetY() { return m_y; } | |
227 | ||
228 | bool LeftDown() { return m_leftDown; } | |
229 | bool MiddleDown() { return m_middleDown; } | |
230 | bool RightDown() { return m_rightDown; } | |
25a9f291 | 231 | |
7dd40b6f RD |
232 | bool ControlDown() { return m_controlDown; } |
233 | bool ShiftDown() { return m_shiftDown; } | |
234 | bool AltDown() { return m_altDown; } | |
235 | bool MetaDown() { return m_metaDown; } | |
25a9f291 | 236 | bool CmdDown() |
7dd40b6f RD |
237 | { |
238 | #if defined(__WXMAC__) || defined(__WXCOCOA__) | |
239 | return MetaDown(); | |
240 | #else | |
241 | return ControlDown(); | |
242 | #endif | |
243 | } | |
244 | ||
245 | void SetX(wxCoord x) { m_x = x; } | |
246 | void SetY(wxCoord y) { m_y = y; } | |
247 | ||
248 | void SetLeftDown(bool down) { m_leftDown = down; } | |
249 | void SetMiddleDown(bool down) { m_middleDown = down; } | |
250 | void SetRightDown(bool down) { m_rightDown = down; } | |
251 | ||
252 | void SetControlDown(bool down) { m_controlDown = down; } | |
253 | void SetShiftDown(bool down) { m_shiftDown = down; } | |
254 | void SetAltDown(bool down) { m_altDown = down; } | |
255 | void SetMetaDown(bool down) { m_metaDown = down; } | |
25a9f291 | 256 | |
7dd40b6f RD |
257 | private: |
258 | wxCoord m_x; | |
259 | wxCoord m_y; | |
260 | ||
ddf60574 MW |
261 | bool m_leftDown : 1; |
262 | bool m_middleDown : 1; | |
263 | bool m_rightDown : 1; | |
264 | ||
265 | bool m_controlDown : 1; | |
266 | bool m_shiftDown : 1; | |
267 | bool m_altDown : 1; | |
268 | bool m_metaDown : 1; | |
7dd40b6f RD |
269 | }; |
270 | ||
271 | ||
272 | // Returns the current state of the mouse position, buttons and modifers | |
273 | WXDLLEXPORT wxMouseState wxGetMouseState(); | |
274 | ||
275 | ||
d6b9496a VZ |
276 | // ---------------------------------------------------------------------------- |
277 | // Window ID management | |
278 | // ---------------------------------------------------------------------------- | |
279 | ||
c801d85f | 280 | // Generate a unique ID |
afb74891 | 281 | WXDLLEXPORT long wxNewId(); |
c801d85f KB |
282 | |
283 | // Ensure subsequent IDs don't clash with this one | |
184b5d99 | 284 | WXDLLEXPORT void wxRegisterId(long id); |
c801d85f KB |
285 | |
286 | // Return the current ID | |
afb74891 | 287 | WXDLLEXPORT long wxGetCurrentId(); |
c801d85f | 288 | |
e90c1d2a VZ |
289 | #endif // wxUSE_GUI |
290 | ||
d6b9496a VZ |
291 | // ---------------------------------------------------------------------------- |
292 | // Various conversions | |
293 | // ---------------------------------------------------------------------------- | |
c801d85f | 294 | |
e12c92c2 VZ |
295 | // these functions are deprecated, use wxString methods instead! |
296 | #if WXWIN_COMPATIBILITY_2_4 | |
297 | ||
16cba29d WS |
298 | extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxFloatToStringStr; |
299 | extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDoubleToStringStr; | |
c801d85f | 300 | |
eecb33b0 WS |
301 | wxDEPRECATED( WXDLLIMPEXP_BASE void StringToFloat(const wxChar *s, float *number) ); |
302 | wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr) ); | |
303 | wxDEPRECATED( WXDLLIMPEXP_BASE void StringToDouble(const wxChar *s, double *number) ); | |
304 | wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr) ); | |
305 | wxDEPRECATED( WXDLLIMPEXP_BASE void StringToInt(const wxChar *s, int *number) ); | |
306 | wxDEPRECATED( WXDLLIMPEXP_BASE void StringToLong(const wxChar *s, long *number) ); | |
307 | wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* IntToString(int number) ); | |
308 | wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* LongToString(long number) ); | |
c801d85f | 309 | |
e12c92c2 VZ |
310 | #endif // WXWIN_COMPATIBILITY_2_4 |
311 | ||
c801d85f | 312 | // Convert 2-digit hex number to decimal |
bddd7a8d | 313 | WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf); |
c801d85f KB |
314 | |
315 | // Convert decimal integer to 2-character hex string | |
bddd7a8d VZ |
316 | WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf); |
317 | WXDLLIMPEXP_BASE wxString wxDecToHex(int dec); | |
c801d85f | 318 | |
d6b9496a VZ |
319 | // ---------------------------------------------------------------------------- |
320 | // Process management | |
321 | // ---------------------------------------------------------------------------- | |
322 | ||
e0f6b731 | 323 | // NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must* |
fbf456aa VZ |
324 | // be 0 and 1, don't change! |
325 | ||
326 | enum | |
327 | { | |
e1082c9f VZ |
328 | // execute the process asynchronously |
329 | wxEXEC_ASYNC = 0, | |
330 | ||
331 | // execute it synchronously, i.e. wait until it finishes | |
332 | wxEXEC_SYNC = 1, | |
333 | ||
334 | // under Windows, don't hide the child even if it's IO is redirected (this | |
335 | // is done by default) | |
336 | wxEXEC_NOHIDE = 2, | |
337 | ||
e0f6b731 JS |
338 | // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill |
339 | // kills all children as well as pid | |
f38f6899 VZ |
340 | wxEXEC_MAKE_GROUP_LEADER = 4, |
341 | ||
342 | // by default synchronous execution disables all program windows to avoid | |
343 | // that the user interacts with the program while the child process is | |
344 | // running, you can use this flag to prevent this from happening | |
345 | wxEXEC_NODISABLE = 8 | |
fbf456aa VZ |
346 | }; |
347 | ||
348 | // Execute another program. | |
349 | // | |
350 | // If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the | |
351 | // process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on | |
352 | // failure and the PID of the launched process if ok. | |
bddd7a8d | 353 | WXDLLIMPEXP_BASE long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC, |
c67daf87 | 354 | wxProcess *process = (wxProcess *) NULL); |
bddd7a8d | 355 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, |
c67daf87 | 356 | wxProcess *process = (wxProcess *) NULL); |
c801d85f | 357 | |
fbf456aa VZ |
358 | // execute the command capturing its output into an array line by line, this is |
359 | // always synchronous | |
bddd7a8d | 360 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, |
4d172154 VZ |
361 | wxArrayString& output, |
362 | int flags = 0); | |
f6bcfd97 | 363 | |
fbf456aa | 364 | // also capture stderr (also synchronous) |
bddd7a8d | 365 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, |
4d172154 VZ |
366 | wxArrayString& output, |
367 | wxArrayString& error, | |
368 | int flags = 0); | |
cd6ce4a9 | 369 | |
5ccb95f6 | 370 | #if defined(__WXMSW__) && wxUSE_IPC |
42d0df00 VZ |
371 | // ask a DDE server to execute the DDE request with given parameters |
372 | WXDLLIMPEXP_BASE bool wxExecuteDDE(const wxString& ddeServer, | |
373 | const wxString& ddeTopic, | |
374 | const wxString& ddeCommand); | |
5ccb95f6 | 375 | #endif // __WXMSW__ && wxUSE_IPC |
42d0df00 | 376 | |
d6b9496a VZ |
377 | enum wxSignal |
378 | { | |
379 | wxSIGNONE = 0, // verify if the process exists under Unix | |
380 | wxSIGHUP, | |
381 | wxSIGINT, | |
382 | wxSIGQUIT, | |
383 | wxSIGILL, | |
384 | wxSIGTRAP, | |
385 | wxSIGABRT, | |
386 | wxSIGIOT = wxSIGABRT, // another name | |
387 | wxSIGEMT, | |
388 | wxSIGFPE, | |
389 | wxSIGKILL, | |
390 | wxSIGBUS, | |
391 | wxSIGSEGV, | |
392 | wxSIGSYS, | |
393 | wxSIGPIPE, | |
394 | wxSIGALRM, | |
395 | wxSIGTERM | |
396 | ||
397 | // further signals are different in meaning between different Unix systems | |
398 | }; | |
c801d85f | 399 | |
50567b69 VZ |
400 | enum wxKillError |
401 | { | |
402 | wxKILL_OK, // no error | |
403 | wxKILL_BAD_SIGNAL, // no such signal | |
404 | wxKILL_ACCESS_DENIED, // permission denied | |
405 | wxKILL_NO_PROCESS, // no such process | |
406 | wxKILL_ERROR // another, unspecified error | |
407 | }; | |
408 | ||
e0f6b731 JS |
409 | enum wxKillFlags |
410 | { | |
411 | wxKILL_NOCHILDREN = 0, // don't kill children | |
412 | wxKILL_CHILDREN = 1 // kill children | |
413 | }; | |
414 | ||
f6ba47d9 VZ |
415 | enum wxShutdownFlags |
416 | { | |
417 | wxSHUTDOWN_POWEROFF, // power off the computer | |
418 | wxSHUTDOWN_REBOOT // shutdown and reboot | |
419 | }; | |
420 | ||
c1cb4153 | 421 | // Shutdown or reboot the PC |
bddd7a8d | 422 | WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags); |
f6ba47d9 | 423 | |
50567b69 VZ |
424 | // send the given signal to the process (only NONE and KILL are supported under |
425 | // Windows, all others mean TERM), return 0 if ok and -1 on error | |
426 | // | |
427 | // return detailed error in rc if not NULL | |
bddd7a8d | 428 | WXDLLIMPEXP_BASE int wxKill(long pid, |
50567b69 | 429 | wxSignal sig = wxSIGTERM, |
e0f6b731 JS |
430 | wxKillError *rc = NULL, |
431 | int flags = wxKILL_NOCHILDREN); | |
c801d85f | 432 | |
2c8e4738 | 433 | // Execute a command in an interactive shell window (always synchronously) |
c801d85f | 434 | // If no command then just the shell |
bddd7a8d | 435 | WXDLLIMPEXP_BASE bool wxShell(const wxString& command = wxEmptyString); |
c801d85f | 436 | |
2c8e4738 VZ |
437 | // As wxShell(), but must give a (non interactive) command and its output will |
438 | // be returned in output array | |
bddd7a8d | 439 | WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output); |
2c8e4738 | 440 | |
b568d04f | 441 | // Sleep for nSecs seconds |
bddd7a8d | 442 | WXDLLIMPEXP_BASE void wxSleep(int nSecs); |
c801d85f | 443 | |
afb74891 | 444 | // Sleep for a given amount of milliseconds |
08873d36 VZ |
445 | WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds); |
446 | ||
447 | // Sleep for a given amount of microseconds | |
448 | WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds); | |
449 | ||
450 | // Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep | |
451 | wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) ); | |
afb74891 | 452 | |
c1cb4153 | 453 | // Get the process id of the current process |
bddd7a8d | 454 | WXDLLIMPEXP_BASE unsigned long wxGetProcessId(); |
c1cb4153 | 455 | |
c801d85f | 456 | // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) |
9d8aca48 | 457 | WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory(); |
c801d85f | 458 | |
a76d8a29 VZ |
459 | #if wxUSE_ON_FATAL_EXCEPTION |
460 | ||
a37a5a73 | 461 | // should wxApp::OnFatalException() be called? |
cb719f2e | 462 | WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true); |
a37a5a73 | 463 | |
a76d8a29 VZ |
464 | #endif // wxUSE_ON_FATAL_EXCEPTION |
465 | ||
42d0df00 VZ |
466 | // flags for wxLaunchDefaultBrowser |
467 | enum | |
468 | { | |
469 | wxBROWSER_NEW_WINDOW = 1 | |
470 | }; | |
471 | ||
498a1eeb | 472 | // Launch url in the user's default internet browser |
42d0df00 | 473 | WXDLLIMPEXP_BASE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); |
498a1eeb | 474 | |
8fd0d89b VZ |
475 | // ---------------------------------------------------------------------------- |
476 | // Environment variables | |
477 | // ---------------------------------------------------------------------------- | |
478 | ||
cb719f2e | 479 | // returns true if variable exists (value may be NULL if you just want to check |
308978f6 | 480 | // for this) |
bddd7a8d | 481 | WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value); |
8fd0d89b | 482 | |
cb719f2e | 483 | // set the env var name to the given value, return true on success |
bddd7a8d | 484 | WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxChar *value); |
8fd0d89b VZ |
485 | |
486 | // remove the env var from environment | |
487 | inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); } | |
488 | ||
d6b9496a VZ |
489 | // ---------------------------------------------------------------------------- |
490 | // Network and username functions. | |
491 | // ---------------------------------------------------------------------------- | |
c801d85f | 492 | |
d6b9496a | 493 | // NB: "char *" functions are deprecated, use wxString ones! |
c801d85f KB |
494 | |
495 | // Get eMail address | |
bddd7a8d VZ |
496 | WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize); |
497 | WXDLLIMPEXP_BASE wxString wxGetEmailAddress(); | |
c801d85f KB |
498 | |
499 | // Get hostname. | |
bddd7a8d VZ |
500 | WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize); |
501 | WXDLLIMPEXP_BASE wxString wxGetHostName(); | |
d6b9496a VZ |
502 | |
503 | // Get FQDN | |
bddd7a8d VZ |
504 | WXDLLIMPEXP_BASE wxString wxGetFullHostName(); |
505 | WXDLLIMPEXP_BASE bool wxGetFullHostName(wxChar *buf, int maxSize); | |
c801d85f | 506 | |
d6b9496a | 507 | // Get user ID e.g. jacs (this is known as login name under Unix) |
bddd7a8d VZ |
508 | WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize); |
509 | WXDLLIMPEXP_BASE wxString wxGetUserId(); | |
c801d85f KB |
510 | |
511 | // Get user name e.g. Julian Smart | |
bddd7a8d VZ |
512 | WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize); |
513 | WXDLLIMPEXP_BASE wxString wxGetUserName(); | |
d6b9496a VZ |
514 | |
515 | // Get current Home dir and copy to dest (returns pstr->c_str()) | |
bddd7a8d VZ |
516 | WXDLLIMPEXP_BASE wxString wxGetHomeDir(); |
517 | WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr); | |
d6b9496a VZ |
518 | |
519 | // Get the user's home dir (caller must copy --- volatile) | |
520 | // returns NULL is no HOME dir is known | |
61ef57fc | 521 | #if defined(__UNIX__) && wxUSE_UNICODE |
bddd7a8d | 522 | WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString); |
61ef57fc | 523 | #else |
bddd7a8d | 524 | WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString); |
61ef57fc | 525 | #endif |
d6b9496a | 526 | |
7ba7c4e6 VZ |
527 | #if wxUSE_LONGLONG |
528 | typedef wxLongLong wxDiskspaceSize_t; | |
529 | #else | |
530 | typedef long wxDiskspaceSize_t; | |
531 | #endif | |
532 | ||
eadd7bd2 | 533 | // get number of total/free bytes on the disk where path belongs |
bddd7a8d | 534 | WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path, |
7ba7c4e6 VZ |
535 | wxDiskspaceSize_t *pTotal = NULL, |
536 | wxDiskspaceSize_t *pFree = NULL); | |
eadd7bd2 | 537 | |
e90c1d2a VZ |
538 | #if wxUSE_GUI // GUI only things from now on |
539 | ||
d6b9496a | 540 | // ---------------------------------------------------------------------------- |
974e8d94 | 541 | // Menu accelerators related things |
d6b9496a | 542 | // ---------------------------------------------------------------------------- |
c801d85f | 543 | |
74639764 VZ |
544 | // flags for wxStripMenuCodes |
545 | enum | |
546 | { | |
547 | // strip '&' characters | |
548 | wxStrip_Mnemonics = 1, | |
549 | ||
550 | // strip everything after '\t' | |
551 | wxStrip_Accel = 2, | |
552 | ||
553 | // strip everything (this is the default) | |
554 | wxStrip_All = wxStrip_Mnemonics | wxStrip_Accel | |
555 | }; | |
556 | ||
557 | // strip mnemonics and/or accelerators from the label | |
558 | WXDLLEXPORT wxString | |
559 | wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); | |
560 | ||
561 | // obsolete and deprecated version, do not use | |
562 | #if WXWIN_COMPATIBILITY_2_6 | |
563 | wxDEPRECATED( | |
564 | WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL) | |
565 | ); | |
566 | #endif | |
c801d85f | 567 | |
974e8d94 VZ |
568 | #if wxUSE_ACCEL |
569 | class WXDLLEXPORT wxAcceleratorEntry; | |
570 | WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label); | |
571 | #endif // wxUSE_ACCEL | |
572 | ||
d6b9496a VZ |
573 | // ---------------------------------------------------------------------------- |
574 | // Window search | |
575 | // ---------------------------------------------------------------------------- | |
576 | ||
cb719f2e | 577 | // Returns menu item id or wxNOT_FOUND if none. |
184b5d99 | 578 | WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); |
c801d85f | 579 | |
57591e0e JS |
580 | // Find the wxWindow at the given point. wxGenericFindWindowAtPoint |
581 | // is always present but may be less reliable than a native version. | |
582 | WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); | |
59a12e90 JS |
583 | WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt); |
584 | ||
146ba0fe VZ |
585 | // NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead |
586 | // | |
587 | // Find the window/widget with the given title or label. | |
588 | // Pass a parent to begin the search from, or NULL to look through | |
589 | // all windows. | |
590 | WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL); | |
591 | ||
592 | // NB: this function is obsolete, use wxWindow::FindWindowByName() instead | |
593 | // | |
594 | // Find window by name, and if that fails, by label. | |
595 | WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL); | |
596 | ||
d6b9496a VZ |
597 | // ---------------------------------------------------------------------------- |
598 | // Message/event queue helpers | |
599 | // ---------------------------------------------------------------------------- | |
c801d85f | 600 | |
ead7ce10 | 601 | // Yield to other apps/messages and disable user input |
cb719f2e | 602 | WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false); |
ead7ce10 | 603 | |
95dee651 | 604 | // Enable or disable input to all top level windows |
cb719f2e | 605 | WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true); |
95dee651 | 606 | |
d6b9496a VZ |
607 | // Check whether this window wants to process messages, e.g. Stop button |
608 | // in long calculations. | |
609 | WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd); | |
610 | ||
611 | // Consume all events until no more left | |
612 | WXDLLEXPORT void wxFlushEvents(); | |
613 | ||
cd6ce4a9 VZ |
614 | // a class which disables all windows (except, may be, thegiven one) in its |
615 | // ctor and enables them back in its dtor | |
616 | class WXDLLEXPORT wxWindowDisabler | |
617 | { | |
618 | public: | |
619 | wxWindowDisabler(wxWindow *winToSkip = (wxWindow *)NULL); | |
620 | ~wxWindowDisabler(); | |
621 | ||
622 | private: | |
623 | wxWindowList *m_winDisabled; | |
c1cb4153 VZ |
624 | |
625 | DECLARE_NO_COPY_CLASS(wxWindowDisabler) | |
cd6ce4a9 VZ |
626 | }; |
627 | ||
d6b9496a VZ |
628 | // ---------------------------------------------------------------------------- |
629 | // Cursors | |
630 | // ---------------------------------------------------------------------------- | |
c801d85f KB |
631 | |
632 | // Set the cursor to the busy cursor for all windows | |
f516d986 | 633 | WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR); |
e2a6f233 | 634 | |
c801d85f | 635 | // Restore cursor to normal |
afb74891 | 636 | WXDLLEXPORT void wxEndBusyCursor(); |
d6b9496a | 637 | |
cb719f2e | 638 | // true if we're between the above two calls |
afb74891 | 639 | WXDLLEXPORT bool wxIsBusy(); |
c801d85f | 640 | |
e2a6f233 JS |
641 | // Convenience class so we can just create a wxBusyCursor object on the stack |
642 | class WXDLLEXPORT wxBusyCursor | |
643 | { | |
afb74891 | 644 | public: |
f516d986 | 645 | wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR) |
afb74891 | 646 | { wxBeginBusyCursor(cursor); } |
f6bcfd97 | 647 | ~wxBusyCursor() |
afb74891 | 648 | { wxEndBusyCursor(); } |
e2a6f233 | 649 | |
f6bcfd97 BP |
650 | // FIXME: These two methods are currently only implemented (and needed?) |
651 | // in wxGTK. BusyCursor handling should probably be moved to | |
652 | // common code since the wxGTK and wxMSW implementations are very | |
653 | // similar except for wxMSW using HCURSOR directly instead of | |
654 | // wxCursor.. -- RL. | |
655 | static const wxCursor &GetStoredCursor(); | |
656 | static const wxCursor GetBusyCursor(); | |
657 | }; | |
c801d85f | 658 | |
c801d85f | 659 | |
d6b9496a | 660 | // ---------------------------------------------------------------------------- |
c801d85f | 661 | // Reading and writing resources (eg WIN.INI, .Xdefaults) |
d6b9496a VZ |
662 | // ---------------------------------------------------------------------------- |
663 | ||
47d67540 | 664 | #if wxUSE_RESOURCES |
62448488 JS |
665 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = wxEmptyString); |
666 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = wxEmptyString); | |
667 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = wxEmptyString); | |
668 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = wxEmptyString); | |
669 | ||
9d2f3c71 | 670 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, wxChar **value, const wxString& file = wxEmptyString); |
62448488 JS |
671 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = wxEmptyString); |
672 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = wxEmptyString); | |
673 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = wxEmptyString); | |
47d67540 | 674 | #endif // wxUSE_RESOURCES |
c801d85f | 675 | |
c801d85f KB |
676 | void WXDLLEXPORT wxGetMousePosition( int* x, int* y ); |
677 | ||
678 | // MSW only: get user-defined resource from the .res file. | |
679 | // Returns NULL or newly-allocated memory, so use delete[] to clean up. | |
2049ba38 | 680 | #ifdef __WXMSW__ |
16cba29d | 681 | extern WXDLLEXPORT const wxChar* wxUserResourceStr; |
373658eb | 682 | WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); |
d6b9496a VZ |
683 | #endif // MSW |
684 | ||
685 | // ---------------------------------------------------------------------------- | |
686 | // Display and colorss (X only) | |
687 | // ---------------------------------------------------------------------------- | |
c801d85f | 688 | |
d111a89a VZ |
689 | #ifdef __WXGTK__ |
690 | void *wxGetDisplay(); | |
691 | #endif | |
692 | ||
c801d85f | 693 | #ifdef __X__ |
968eb2ef MW |
694 | WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay(); |
695 | WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name); | |
696 | WXDLLIMPEXP_CORE wxString wxGetDisplayName(); | |
d111a89a | 697 | #endif // X or GTK+ |
c801d85f KB |
698 | |
699 | #ifdef __X__ | |
700 | ||
338dd992 JJ |
701 | #ifdef __VMS__ // Xlib.h for VMS is not (yet) compatible with C++ |
702 | // The resulting warnings are switched off here | |
703 | #pragma message disable nosimpint | |
704 | #endif | |
7266b672 | 705 | // #include <X11/Xlib.h> |
338dd992 JJ |
706 | #ifdef __VMS__ |
707 | #pragma message enable nosimpint | |
708 | #endif | |
c801d85f | 709 | |
c801d85f KB |
710 | #endif //__X__ |
711 | ||
e90c1d2a VZ |
712 | #endif // wxUSE_GUI |
713 | ||
886dd7d2 VZ |
714 | // ---------------------------------------------------------------------------- |
715 | // wxYield(): these functions are obsolete, please use wxApp methods instead! | |
716 | // ---------------------------------------------------------------------------- | |
717 | ||
718 | // Yield to other apps/messages | |
bddd7a8d | 719 | WXDLLIMPEXP_BASE bool wxYield(); |
886dd7d2 VZ |
720 | |
721 | // Like wxYield, but fails silently if the yield is recursive. | |
bddd7a8d | 722 | WXDLLIMPEXP_BASE bool wxYieldIfNeeded(); |
886dd7d2 | 723 | |
f6bcfd97 | 724 | // ---------------------------------------------------------------------------- |
77ffb593 | 725 | // Error message functions used by wxWidgets (deprecated, use wxLog) |
f6bcfd97 BP |
726 | // ---------------------------------------------------------------------------- |
727 | ||
c801d85f | 728 | #endif |
34138703 | 729 | // _WX_UTILSH__ |