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