]>
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 | ||
162e998c PC |
12 | #ifndef _WX_UTILS_H_ |
13 | #define _WX_UTILS_H_ | |
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 | 25 | |
b5dbe15d VS |
26 | class WXDLLIMPEXP_FWD_BASE wxArrayString; |
27 | class WXDLLIMPEXP_FWD_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 | ||
4f7d425f | 49 | class WXDLLIMPEXP_FWD_BASE wxProcess; |
b5dbe15d VS |
50 | class WXDLLIMPEXP_FWD_CORE wxFrame; |
51 | class WXDLLIMPEXP_FWD_CORE wxWindow; | |
52 | class WXDLLIMPEXP_FWD_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 | ||
d6b9496a | 75 | // A shorter way of using strcmp |
9d2f3c71 | 76 | #define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0)) |
d6b9496a VZ |
77 | |
78 | // ---------------------------------------------------------------------------- | |
79 | // Miscellaneous functions | |
80 | // ---------------------------------------------------------------------------- | |
81 | ||
82 | // Sound the bell | |
968eb2ef MW |
83 | #if !defined __EMX__ && \ |
84 | (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__) | |
85 | WXDLLIMPEXP_CORE void wxBell(); | |
86 | #else | |
bddd7a8d | 87 | WXDLLIMPEXP_BASE void wxBell(); |
968eb2ef | 88 | #endif |
d6b9496a | 89 | |
8cf304f8 VZ |
90 | #if wxUSE_MSGDLG |
91 | // Show wxWidgets information | |
92 | WXDLLIMPEXP_CORE void wxInfoMessageBox(wxWindow* parent); | |
93 | #endif // wxUSE_MSGDLG | |
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); } | |
162e998c | 139 | void operator = (const wxPlatform& platform) { if (&platform != this) Copy(platform); } |
4bfec179 | 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(); } | |
f8087c0d | 179 | operator const wxString&() const { return GetString(); } |
230c9077 JS |
180 | |
181 | static void AddPlatform(int platform); | |
4bfec179 | 182 | static bool Is(int platform); |
230c9077 JS |
183 | static void ClearPlatforms(); |
184 | ||
185 | private: | |
25a9f291 WS |
186 | |
187 | void Init() { m_longValue = 0; m_doubleValue = 0.0; } | |
188 | ||
230c9077 JS |
189 | long m_longValue; |
190 | double m_doubleValue; | |
191 | wxString m_stringValue; | |
192 | static wxArrayInt* sm_customPlatforms; | |
193 | }; | |
194 | ||
195 | /// Function for testing current platform | |
4bfec179 | 196 | inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); } |
134677bd | 197 | |
e90c1d2a | 198 | #if wxUSE_GUI |
97698dc4 RD |
199 | |
200 | // Get the state of a key (true if pressed, false if not) | |
201 | // This is generally most useful getting the state of | |
202 | // the modifier or toggle keys. | |
1751226c | 203 | WXDLLEXPORT bool wxGetKeyState(wxKeyCode key); |
97698dc4 | 204 | |
14dfb3d2 | 205 | |
63cc5d9d RR |
206 | // Don't synthesize KeyUp events holding down a key and producing |
207 | // KeyDown events with autorepeat. On by default and always on | |
208 | // in wxMSW. | |
f0492f7d RR |
209 | WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag ); |
210 | ||
7dd40b6f RD |
211 | |
212 | // wxMouseState is used to hold information about button and modifier state | |
213 | // and is what is returned from wxGetMouseState. | |
214 | class WXDLLEXPORT wxMouseState | |
215 | { | |
216 | public: | |
217 | wxMouseState() | |
218 | : m_x(0), m_y(0), | |
219 | m_leftDown(false), m_middleDown(false), m_rightDown(false), | |
01101e2d | 220 | m_aux1Down(false), m_aux2Down(false), |
7dd40b6f RD |
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; } | |
01101e2d VZ |
231 | bool Aux1Down() { return m_aux1Down; } |
232 | bool Aux2Down() { return m_aux2Down; } | |
25a9f291 | 233 | |
7dd40b6f RD |
234 | bool ControlDown() { return m_controlDown; } |
235 | bool ShiftDown() { return m_shiftDown; } | |
236 | bool AltDown() { return m_altDown; } | |
237 | bool MetaDown() { return m_metaDown; } | |
25a9f291 | 238 | bool CmdDown() |
7dd40b6f RD |
239 | { |
240 | #if defined(__WXMAC__) || defined(__WXCOCOA__) | |
241 | return MetaDown(); | |
242 | #else | |
243 | return ControlDown(); | |
244 | #endif | |
245 | } | |
246 | ||
247 | void SetX(wxCoord x) { m_x = x; } | |
248 | void SetY(wxCoord y) { m_y = y; } | |
249 | ||
250 | void SetLeftDown(bool down) { m_leftDown = down; } | |
251 | void SetMiddleDown(bool down) { m_middleDown = down; } | |
252 | void SetRightDown(bool down) { m_rightDown = down; } | |
01101e2d VZ |
253 | void SetAux1Down(bool down) { m_aux1Down = down; } |
254 | void SetAux2Down(bool down) { m_aux2Down = down; } | |
7dd40b6f RD |
255 | |
256 | void SetControlDown(bool down) { m_controlDown = down; } | |
257 | void SetShiftDown(bool down) { m_shiftDown = down; } | |
258 | void SetAltDown(bool down) { m_altDown = down; } | |
259 | void SetMetaDown(bool down) { m_metaDown = down; } | |
25a9f291 | 260 | |
7dd40b6f RD |
261 | private: |
262 | wxCoord m_x; | |
263 | wxCoord m_y; | |
264 | ||
ddf60574 MW |
265 | bool m_leftDown : 1; |
266 | bool m_middleDown : 1; | |
267 | bool m_rightDown : 1; | |
01101e2d VZ |
268 | bool m_aux1Down : 1; |
269 | bool m_aux2Down : 1; | |
ddf60574 MW |
270 | |
271 | bool m_controlDown : 1; | |
272 | bool m_shiftDown : 1; | |
273 | bool m_altDown : 1; | |
274 | bool m_metaDown : 1; | |
7dd40b6f RD |
275 | }; |
276 | ||
277 | ||
278 | // Returns the current state of the mouse position, buttons and modifers | |
279 | WXDLLEXPORT wxMouseState wxGetMouseState(); | |
280 | ||
c2ca375c | 281 | #endif // wxUSE_GUI |
7dd40b6f | 282 | |
d6b9496a VZ |
283 | // ---------------------------------------------------------------------------- |
284 | // Window ID management | |
285 | // ---------------------------------------------------------------------------- | |
286 | ||
c801d85f | 287 | // Ensure subsequent IDs don't clash with this one |
c2ca375c | 288 | WXDLLIMPEXP_BASE void wxRegisterId(long id); |
c801d85f KB |
289 | |
290 | // Return the current ID | |
c2ca375c | 291 | WXDLLIMPEXP_BASE long wxGetCurrentId(); |
c801d85f | 292 | |
c2ca375c VZ |
293 | // Generate a unique ID |
294 | WXDLLIMPEXP_BASE long wxNewId(); | |
e90c1d2a | 295 | |
d6b9496a VZ |
296 | // ---------------------------------------------------------------------------- |
297 | // Various conversions | |
298 | // ---------------------------------------------------------------------------- | |
c801d85f | 299 | |
c801d85f | 300 | // Convert 2-digit hex number to decimal |
bddd7a8d | 301 | WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf); |
c801d85f KB |
302 | |
303 | // Convert decimal integer to 2-character hex string | |
bddd7a8d | 304 | WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf); |
f728025e | 305 | WXDLLIMPEXP_BASE void wxDecToHex(int dec, char* ch1, char* ch2); |
bddd7a8d | 306 | WXDLLIMPEXP_BASE wxString wxDecToHex(int dec); |
c801d85f | 307 | |
d6b9496a VZ |
308 | // ---------------------------------------------------------------------------- |
309 | // Process management | |
310 | // ---------------------------------------------------------------------------- | |
311 | ||
e0f6b731 | 312 | // NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must* |
fbf456aa VZ |
313 | // be 0 and 1, don't change! |
314 | ||
315 | enum | |
316 | { | |
e1082c9f VZ |
317 | // execute the process asynchronously |
318 | wxEXEC_ASYNC = 0, | |
319 | ||
320 | // execute it synchronously, i.e. wait until it finishes | |
321 | wxEXEC_SYNC = 1, | |
322 | ||
323 | // under Windows, don't hide the child even if it's IO is redirected (this | |
324 | // is done by default) | |
325 | wxEXEC_NOHIDE = 2, | |
326 | ||
e0f6b731 JS |
327 | // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill |
328 | // kills all children as well as pid | |
f38f6899 VZ |
329 | wxEXEC_MAKE_GROUP_LEADER = 4, |
330 | ||
331 | // by default synchronous execution disables all program windows to avoid | |
332 | // that the user interacts with the program while the child process is | |
333 | // running, you can use this flag to prevent this from happening | |
bc855d09 VZ |
334 | wxEXEC_NODISABLE = 8, |
335 | ||
336 | // by default, the event loop is run while waiting for synchronous execution | |
337 | // to complete and this flag can be used to simply block the main process | |
338 | // until the child process finishes | |
339 | wxEXEC_NOEVENTS = 16, | |
340 | ||
341 | // convenient synonym for flags given system()-like behaviour | |
342 | wxEXEC_BLOCK = wxEXEC_SYNC | wxEXEC_NOEVENTS | |
fbf456aa VZ |
343 | }; |
344 | ||
345 | // Execute another program. | |
346 | // | |
347 | // If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the | |
348 | // process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on | |
349 | // failure and the PID of the launched process if ok. | |
d7ef641d | 350 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, |
05718a98 VZ |
351 | int flags = wxEXEC_ASYNC, |
352 | wxProcess *process = NULL); | |
353 | WXDLLIMPEXP_BASE long wxExecute(char **argv, | |
354 | int flags = wxEXEC_ASYNC, | |
355 | wxProcess *process = NULL); | |
d7ef641d VZ |
356 | #if wxUSE_UNICODE |
357 | WXDLLIMPEXP_BASE long wxExecute(wchar_t **argv, | |
05718a98 VZ |
358 | int flags = wxEXEC_ASYNC, |
359 | wxProcess *process = NULL); | |
d7ef641d | 360 | #endif // wxUSE_UNICODE |
c801d85f | 361 | |
fbf456aa VZ |
362 | // execute the command capturing its output into an array line by line, this is |
363 | // always synchronous | |
bddd7a8d | 364 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, |
4d172154 VZ |
365 | wxArrayString& output, |
366 | int flags = 0); | |
f6bcfd97 | 367 | |
fbf456aa | 368 | // also capture stderr (also synchronous) |
bddd7a8d | 369 | WXDLLIMPEXP_BASE long wxExecute(const wxString& command, |
4d172154 VZ |
370 | wxArrayString& output, |
371 | wxArrayString& error, | |
372 | int flags = 0); | |
cd6ce4a9 | 373 | |
5ccb95f6 | 374 | #if defined(__WXMSW__) && wxUSE_IPC |
42d0df00 VZ |
375 | // ask a DDE server to execute the DDE request with given parameters |
376 | WXDLLIMPEXP_BASE bool wxExecuteDDE(const wxString& ddeServer, | |
377 | const wxString& ddeTopic, | |
378 | const wxString& ddeCommand); | |
5ccb95f6 | 379 | #endif // __WXMSW__ && wxUSE_IPC |
42d0df00 | 380 | |
d6b9496a VZ |
381 | enum wxSignal |
382 | { | |
383 | wxSIGNONE = 0, // verify if the process exists under Unix | |
384 | wxSIGHUP, | |
385 | wxSIGINT, | |
386 | wxSIGQUIT, | |
387 | wxSIGILL, | |
388 | wxSIGTRAP, | |
389 | wxSIGABRT, | |
390 | wxSIGIOT = wxSIGABRT, // another name | |
391 | wxSIGEMT, | |
392 | wxSIGFPE, | |
393 | wxSIGKILL, | |
394 | wxSIGBUS, | |
395 | wxSIGSEGV, | |
396 | wxSIGSYS, | |
397 | wxSIGPIPE, | |
398 | wxSIGALRM, | |
399 | wxSIGTERM | |
400 | ||
401 | // further signals are different in meaning between different Unix systems | |
402 | }; | |
c801d85f | 403 | |
50567b69 VZ |
404 | enum wxKillError |
405 | { | |
406 | wxKILL_OK, // no error | |
407 | wxKILL_BAD_SIGNAL, // no such signal | |
408 | wxKILL_ACCESS_DENIED, // permission denied | |
409 | wxKILL_NO_PROCESS, // no such process | |
410 | wxKILL_ERROR // another, unspecified error | |
411 | }; | |
412 | ||
e0f6b731 JS |
413 | enum wxKillFlags |
414 | { | |
415 | wxKILL_NOCHILDREN = 0, // don't kill children | |
416 | wxKILL_CHILDREN = 1 // kill children | |
417 | }; | |
418 | ||
f6ba47d9 VZ |
419 | enum wxShutdownFlags |
420 | { | |
421 | wxSHUTDOWN_POWEROFF, // power off the computer | |
422 | wxSHUTDOWN_REBOOT // shutdown and reboot | |
423 | }; | |
424 | ||
c1cb4153 | 425 | // Shutdown or reboot the PC |
bddd7a8d | 426 | WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags); |
f6ba47d9 | 427 | |
50567b69 VZ |
428 | // send the given signal to the process (only NONE and KILL are supported under |
429 | // Windows, all others mean TERM), return 0 if ok and -1 on error | |
430 | // | |
431 | // return detailed error in rc if not NULL | |
bddd7a8d | 432 | WXDLLIMPEXP_BASE int wxKill(long pid, |
50567b69 | 433 | wxSignal sig = wxSIGTERM, |
e0f6b731 JS |
434 | wxKillError *rc = NULL, |
435 | int flags = wxKILL_NOCHILDREN); | |
c801d85f | 436 | |
2c8e4738 | 437 | // Execute a command in an interactive shell window (always synchronously) |
c801d85f | 438 | // If no command then just the shell |
bddd7a8d | 439 | WXDLLIMPEXP_BASE bool wxShell(const wxString& command = wxEmptyString); |
c801d85f | 440 | |
2c8e4738 VZ |
441 | // As wxShell(), but must give a (non interactive) command and its output will |
442 | // be returned in output array | |
bddd7a8d | 443 | WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output); |
2c8e4738 | 444 | |
b568d04f | 445 | // Sleep for nSecs seconds |
bddd7a8d | 446 | WXDLLIMPEXP_BASE void wxSleep(int nSecs); |
c801d85f | 447 | |
afb74891 | 448 | // Sleep for a given amount of milliseconds |
08873d36 VZ |
449 | WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds); |
450 | ||
451 | // Sleep for a given amount of microseconds | |
452 | WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds); | |
453 | ||
454 | // Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep | |
455 | wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) ); | |
afb74891 | 456 | |
c1cb4153 | 457 | // Get the process id of the current process |
bddd7a8d | 458 | WXDLLIMPEXP_BASE unsigned long wxGetProcessId(); |
c1cb4153 | 459 | |
c801d85f | 460 | // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) |
9d8aca48 | 461 | WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory(); |
c801d85f | 462 | |
a76d8a29 VZ |
463 | #if wxUSE_ON_FATAL_EXCEPTION |
464 | ||
a37a5a73 | 465 | // should wxApp::OnFatalException() be called? |
cb719f2e | 466 | WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true); |
a37a5a73 | 467 | |
a76d8a29 VZ |
468 | #endif // wxUSE_ON_FATAL_EXCEPTION |
469 | ||
8fd0d89b VZ |
470 | // ---------------------------------------------------------------------------- |
471 | // Environment variables | |
472 | // ---------------------------------------------------------------------------- | |
473 | ||
cb719f2e | 474 | // returns true if variable exists (value may be NULL if you just want to check |
308978f6 | 475 | // for this) |
bddd7a8d | 476 | WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value); |
8fd0d89b | 477 | |
cb719f2e | 478 | // set the env var name to the given value, return true on success |
90a77e64 | 479 | WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxString& value); |
8fd0d89b VZ |
480 | |
481 | // remove the env var from environment | |
90a77e64 VS |
482 | WXDLLIMPEXP_BASE bool wxUnsetEnv(const wxString& var); |
483 | ||
484 | #if WXWIN_COMPATIBILITY_2_8 | |
485 | inline bool wxSetEnv(const wxString& var, const char *value) | |
486 | { return wxSetEnv(var, wxString(value)); } | |
487 | inline bool wxSetEnv(const wxString& var, const wchar_t *value) | |
488 | { return wxSetEnv(var, wxString(value)); } | |
489 | template<typename T> | |
490 | inline bool wxSetEnv(const wxString& var, const wxCharTypeBuffer<T>& value) | |
491 | { return wxSetEnv(var, wxString(value)); } | |
492 | inline bool wxSetEnv(const wxString& var, const wxCStrData& value) | |
493 | { return wxSetEnv(var, wxString(value)); } | |
494 | ||
495 | // this one is for passing NULL directly - don't use it, use wxUnsetEnv instead | |
496 | wxDEPRECATED( inline bool wxSetEnv(const wxString& var, int value) ); | |
497 | inline bool wxSetEnv(const wxString& var, int value) | |
498 | { | |
499 | wxASSERT_MSG( value == 0, "using non-NULL integer as string?" ); | |
a43bd048 VZ |
500 | |
501 | wxUnusedVar(value); // fix unused parameter warning in release build | |
502 | ||
90a77e64 VS |
503 | return wxUnsetEnv(var); |
504 | } | |
505 | #endif // WXWIN_COMPATIBILITY_2_8 | |
8fd0d89b | 506 | |
d6b9496a VZ |
507 | // ---------------------------------------------------------------------------- |
508 | // Network and username functions. | |
509 | // ---------------------------------------------------------------------------- | |
c801d85f | 510 | |
d6b9496a | 511 | // NB: "char *" functions are deprecated, use wxString ones! |
c801d85f KB |
512 | |
513 | // Get eMail address | |
bddd7a8d VZ |
514 | WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize); |
515 | WXDLLIMPEXP_BASE wxString wxGetEmailAddress(); | |
c801d85f KB |
516 | |
517 | // Get hostname. | |
bddd7a8d VZ |
518 | WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize); |
519 | WXDLLIMPEXP_BASE wxString wxGetHostName(); | |
d6b9496a VZ |
520 | |
521 | // Get FQDN | |
bddd7a8d VZ |
522 | WXDLLIMPEXP_BASE wxString wxGetFullHostName(); |
523 | WXDLLIMPEXP_BASE bool wxGetFullHostName(wxChar *buf, int maxSize); | |
c801d85f | 524 | |
d6b9496a | 525 | // Get user ID e.g. jacs (this is known as login name under Unix) |
bddd7a8d VZ |
526 | WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize); |
527 | WXDLLIMPEXP_BASE wxString wxGetUserId(); | |
c801d85f KB |
528 | |
529 | // Get user name e.g. Julian Smart | |
bddd7a8d VZ |
530 | WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize); |
531 | WXDLLIMPEXP_BASE wxString wxGetUserName(); | |
d6b9496a VZ |
532 | |
533 | // Get current Home dir and copy to dest (returns pstr->c_str()) | |
bddd7a8d VZ |
534 | WXDLLIMPEXP_BASE wxString wxGetHomeDir(); |
535 | WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr); | |
d6b9496a | 536 | |
14d63513 VZ |
537 | // Get the user's (by default use the current user name) home dir, |
538 | // return empty string on error | |
539 | WXDLLIMPEXP_BASE wxString wxGetUserHome(const wxString& user = wxEmptyString); | |
540 | ||
d6b9496a | 541 | |
7ba7c4e6 VZ |
542 | #if wxUSE_LONGLONG |
543 | typedef wxLongLong wxDiskspaceSize_t; | |
544 | #else | |
545 | typedef long wxDiskspaceSize_t; | |
546 | #endif | |
547 | ||
eadd7bd2 | 548 | // get number of total/free bytes on the disk where path belongs |
bddd7a8d | 549 | WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path, |
7ba7c4e6 VZ |
550 | wxDiskspaceSize_t *pTotal = NULL, |
551 | wxDiskspaceSize_t *pFree = NULL); | |
eadd7bd2 | 552 | |
fe5f448f RR |
553 | |
554 | ||
555 | extern "C" | |
556 | { | |
557 | typedef int (wxCMPFUNC_CONV *CMPFUNCDATA)(const void* pItem1, const void* pItem2, const void* user_data); | |
558 | } | |
559 | ||
560 | ||
561 | WXDLLIMPEXP_BASE void wxQsort(void *const pbase, size_t total_elems, | |
14d63513 | 562 | size_t size, CMPFUNCDATA cmp, const void* user_data); |
fe5f448f RR |
563 | |
564 | ||
e90c1d2a VZ |
565 | #if wxUSE_GUI // GUI only things from now on |
566 | ||
d6b9496a | 567 | // ---------------------------------------------------------------------------- |
c5f0d1f9 DE |
568 | // Launch default browser |
569 | // ---------------------------------------------------------------------------- | |
570 | ||
571 | // flags for wxLaunchDefaultBrowser | |
572 | enum | |
573 | { | |
574 | wxBROWSER_NEW_WINDOW = 1 | |
575 | }; | |
576 | ||
577 | // Launch url in the user's default internet browser | |
578 | WXDLLIMPEXP_CORE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); | |
579 | ||
580 | // ---------------------------------------------------------------------------- | |
974e8d94 | 581 | // Menu accelerators related things |
d6b9496a | 582 | // ---------------------------------------------------------------------------- |
c801d85f | 583 | |
74639764 VZ |
584 | // flags for wxStripMenuCodes |
585 | enum | |
586 | { | |
587 | // strip '&' characters | |
588 | wxStrip_Mnemonics = 1, | |
589 | ||
590 | // strip everything after '\t' | |
591 | wxStrip_Accel = 2, | |
592 | ||
593 | // strip everything (this is the default) | |
594 | wxStrip_All = wxStrip_Mnemonics | wxStrip_Accel | |
595 | }; | |
596 | ||
597 | // strip mnemonics and/or accelerators from the label | |
598 | WXDLLEXPORT wxString | |
599 | wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); | |
600 | ||
74639764 | 601 | #if WXWIN_COMPATIBILITY_2_6 |
90527a50 | 602 | // obsolete and deprecated version, do not use, use the above overload instead |
74639764 VZ |
603 | wxDEPRECATED( |
604 | WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL) | |
605 | ); | |
c801d85f | 606 | |
974e8d94 | 607 | #if wxUSE_ACCEL |
b5dbe15d | 608 | class WXDLLIMPEXP_FWD_CORE wxAcceleratorEntry; |
90527a50 VZ |
609 | |
610 | // use wxAcceleratorEntry::Create() or FromString() methods instead | |
ee0a94cf RR |
611 | wxDEPRECATED( |
612 | WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label) | |
613 | ); | |
974e8d94 VZ |
614 | #endif // wxUSE_ACCEL |
615 | ||
90527a50 VZ |
616 | #endif // WXWIN_COMPATIBILITY_2_6 |
617 | ||
d6b9496a VZ |
618 | // ---------------------------------------------------------------------------- |
619 | // Window search | |
620 | // ---------------------------------------------------------------------------- | |
621 | ||
cb719f2e | 622 | // Returns menu item id or wxNOT_FOUND if none. |
184b5d99 | 623 | WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); |
c801d85f | 624 | |
57591e0e JS |
625 | // Find the wxWindow at the given point. wxGenericFindWindowAtPoint |
626 | // is always present but may be less reliable than a native version. | |
627 | WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); | |
59a12e90 JS |
628 | WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt); |
629 | ||
146ba0fe VZ |
630 | // NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead |
631 | // | |
632 | // Find the window/widget with the given title or label. | |
633 | // Pass a parent to begin the search from, or NULL to look through | |
634 | // all windows. | |
635 | WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL); | |
636 | ||
637 | // NB: this function is obsolete, use wxWindow::FindWindowByName() instead | |
638 | // | |
639 | // Find window by name, and if that fails, by label. | |
640 | WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL); | |
641 | ||
d6b9496a VZ |
642 | // ---------------------------------------------------------------------------- |
643 | // Message/event queue helpers | |
644 | // ---------------------------------------------------------------------------- | |
c801d85f | 645 | |
ead7ce10 | 646 | // Yield to other apps/messages and disable user input |
cb719f2e | 647 | WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false); |
ead7ce10 | 648 | |
95dee651 | 649 | // Enable or disable input to all top level windows |
cb719f2e | 650 | WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true); |
95dee651 | 651 | |
d6b9496a VZ |
652 | // Check whether this window wants to process messages, e.g. Stop button |
653 | // in long calculations. | |
654 | WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd); | |
655 | ||
656 | // Consume all events until no more left | |
657 | WXDLLEXPORT void wxFlushEvents(); | |
658 | ||
2ecd1756 | 659 | // a class which disables all windows (except, may be, the given one) in its |
cd6ce4a9 VZ |
660 | // ctor and enables them back in its dtor |
661 | class WXDLLEXPORT wxWindowDisabler | |
662 | { | |
663 | public: | |
2ecd1756 VZ |
664 | // this ctor conditionally disables all windows: if the argument is false, |
665 | // it doesn't do anything | |
666 | wxWindowDisabler(bool disable = true); | |
667 | ||
668 | // ctor disables all windows except winToSkip | |
669 | wxWindowDisabler(wxWindow *winToSkip); | |
670 | ||
671 | // dtor enables back all windows disabled by the ctor | |
cd6ce4a9 VZ |
672 | ~wxWindowDisabler(); |
673 | ||
674 | private: | |
2ecd1756 VZ |
675 | // disable all windows except the given one (used by both ctors) |
676 | void DoDisable(wxWindow *winToSkip = NULL); | |
677 | ||
678 | ||
cd6ce4a9 | 679 | wxWindowList *m_winDisabled; |
2ecd1756 | 680 | bool m_disabled; |
c1cb4153 VZ |
681 | |
682 | DECLARE_NO_COPY_CLASS(wxWindowDisabler) | |
cd6ce4a9 VZ |
683 | }; |
684 | ||
d6b9496a VZ |
685 | // ---------------------------------------------------------------------------- |
686 | // Cursors | |
687 | // ---------------------------------------------------------------------------- | |
c801d85f KB |
688 | |
689 | // Set the cursor to the busy cursor for all windows | |
f516d986 | 690 | WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR); |
e2a6f233 | 691 | |
c801d85f | 692 | // Restore cursor to normal |
afb74891 | 693 | WXDLLEXPORT void wxEndBusyCursor(); |
d6b9496a | 694 | |
cb719f2e | 695 | // true if we're between the above two calls |
afb74891 | 696 | WXDLLEXPORT bool wxIsBusy(); |
c801d85f | 697 | |
e2a6f233 JS |
698 | // Convenience class so we can just create a wxBusyCursor object on the stack |
699 | class WXDLLEXPORT wxBusyCursor | |
700 | { | |
afb74891 | 701 | public: |
f516d986 | 702 | wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR) |
afb74891 | 703 | { wxBeginBusyCursor(cursor); } |
f6bcfd97 | 704 | ~wxBusyCursor() |
afb74891 | 705 | { wxEndBusyCursor(); } |
e2a6f233 | 706 | |
f6bcfd97 BP |
707 | // FIXME: These two methods are currently only implemented (and needed?) |
708 | // in wxGTK. BusyCursor handling should probably be moved to | |
709 | // common code since the wxGTK and wxMSW implementations are very | |
710 | // similar except for wxMSW using HCURSOR directly instead of | |
711 | // wxCursor.. -- RL. | |
712 | static const wxCursor &GetStoredCursor(); | |
713 | static const wxCursor GetBusyCursor(); | |
714 | }; | |
c801d85f | 715 | |
c801d85f KB |
716 | void WXDLLEXPORT wxGetMousePosition( int* x, int* y ); |
717 | ||
718 | // MSW only: get user-defined resource from the .res file. | |
719 | // Returns NULL or newly-allocated memory, so use delete[] to clean up. | |
2049ba38 | 720 | #ifdef __WXMSW__ |
16cba29d | 721 | extern WXDLLEXPORT const wxChar* wxUserResourceStr; |
373658eb | 722 | WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); |
d6b9496a VZ |
723 | #endif // MSW |
724 | ||
725 | // ---------------------------------------------------------------------------- | |
dc281933 | 726 | // X11 Display access |
d6b9496a | 727 | // ---------------------------------------------------------------------------- |
c801d85f | 728 | |
dc281933 VZ |
729 | #if defined(__X__) || defined(__WXGTK__) |
730 | ||
d111a89a | 731 | #ifdef __WXGTK__ |
033bf67c | 732 | WXDLLIMPEXP_CORE void *wxGetDisplay(); |
d111a89a VZ |
733 | #endif |
734 | ||
c801d85f | 735 | #ifdef __X__ |
968eb2ef MW |
736 | WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay(); |
737 | WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name); | |
738 | WXDLLIMPEXP_CORE wxString wxGetDisplayName(); | |
d111a89a | 739 | #endif // X or GTK+ |
c801d85f | 740 | |
e4e83f38 VZ |
741 | // use this function instead of the functions above in implementation code |
742 | inline struct _XDisplay *wxGetX11Display() | |
743 | { | |
744 | return (_XDisplay *)wxGetDisplay(); | |
745 | } | |
c801d85f | 746 | |
dc281933 VZ |
747 | #endif // X11 || wxGTK |
748 | ||
e90c1d2a VZ |
749 | #endif // wxUSE_GUI |
750 | ||
886dd7d2 VZ |
751 | // ---------------------------------------------------------------------------- |
752 | // wxYield(): these functions are obsolete, please use wxApp methods instead! | |
753 | // ---------------------------------------------------------------------------- | |
754 | ||
a131b460 VZ |
755 | // avoid redeclaring this function here if it had been already declated by |
756 | // wx/app.h, this results in warnings from g++ with -Wredundant-decls | |
757 | #ifndef wx_YIELD_DECLARED | |
758 | #define wx_YIELD_DECLARED | |
759 | ||
886dd7d2 | 760 | // Yield to other apps/messages |
bddd7a8d | 761 | WXDLLIMPEXP_BASE bool wxYield(); |
886dd7d2 | 762 | |
a131b460 VZ |
763 | #endif // wx_YIELD_DECLARED |
764 | ||
886dd7d2 | 765 | // Like wxYield, but fails silently if the yield is recursive. |
bddd7a8d | 766 | WXDLLIMPEXP_BASE bool wxYieldIfNeeded(); |
886dd7d2 | 767 | |
f6bcfd97 | 768 | // ---------------------------------------------------------------------------- |
77ffb593 | 769 | // Error message functions used by wxWidgets (deprecated, use wxLog) |
f6bcfd97 BP |
770 | // ---------------------------------------------------------------------------- |
771 | ||
c801d85f | 772 | #endif |
34138703 | 773 | // _WX_UTILSH__ |