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