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