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