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