]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/utils.h
changed wxGLContext::SetColour() argument from wxChar* to wxString
[wxWidgets.git] / include / wx / utils.h
... / ...
CommitLineData
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
26class WXDLLIMPEXP_BASE wxArrayString;
27class 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
49class WXDLLIMPEXP_CORE wxProcess;
50class WXDLLIMPEXP_CORE wxFrame;
51class WXDLLIMPEXP_CORE wxWindow;
52class 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// A shorter way of using strcmp
76#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
77
78// ----------------------------------------------------------------------------
79// Miscellaneous functions
80// ----------------------------------------------------------------------------
81
82// Sound the bell
83#if !defined __EMX__ && \
84 (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
85WXDLLIMPEXP_CORE void wxBell();
86#else
87WXDLLIMPEXP_BASE void wxBell();
88#endif
89
90// Get OS description as a user-readable string
91WXDLLIMPEXP_BASE wxString wxGetOsDescription();
92
93// Get OS version
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();
102
103// Return a string with the current date/time
104WXDLLIMPEXP_BASE wxString wxNow();
105
106// Return path where wxWidgets is installed (mostly useful in Unices)
107WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
108// Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
109WXDLLIMPEXP_BASE wxString wxGetDataDir();
110
111/*
112 * Class to make it easier to specify platform-dependent values
113 *
114 * Examples:
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"));
117 *
118 * A custom platform symbol:
119 *
120 * #define stPDA 100
121 * #ifdef __WXWINCE__
122 * wxPlatform::AddPlatform(stPDA);
123 * #endif
124 *
125 * long windowStyle = wxCAPTION | (long) wxPlatform::IfNot(stPDA, wxRESIZE_BORDER);
126 *
127 */
128
129class WXDLLIMPEXP_BASE wxPlatform
130{
131public:
132 wxPlatform() { Init(); }
133 wxPlatform(const wxPlatform& platform) { Copy(platform); }
134 void operator = (const wxPlatform& platform) { Copy(platform); }
135 void Copy(const wxPlatform& platform);
136
137 // Specify an optional default value
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; }
142
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
149 static wxPlatform If(int platform, int value) { return If(platform, (long)value); }
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);
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(); }
174 operator const wxString&() const { return GetString(); }
175
176 static void AddPlatform(int platform);
177 static bool Is(int platform);
178 static void ClearPlatforms();
179
180private:
181
182 void Init() { m_longValue = 0; m_doubleValue = 0.0; }
183
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
191inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); }
192
193#if wxUSE_GUI
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.
198WXDLLEXPORT bool wxGetKeyState(wxKeyCode key);
199
200
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.
204WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
205
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; }
225
226 bool ControlDown() { return m_controlDown; }
227 bool ShiftDown() { return m_shiftDown; }
228 bool AltDown() { return m_altDown; }
229 bool MetaDown() { return m_metaDown; }
230 bool CmdDown()
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; }
250
251private:
252 wxCoord m_x;
253 wxCoord m_y;
254
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;
263};
264
265
266// Returns the current state of the mouse position, buttons and modifers
267WXDLLEXPORT wxMouseState wxGetMouseState();
268
269#endif // wxUSE_GUI
270
271// ----------------------------------------------------------------------------
272// Window ID management
273// ----------------------------------------------------------------------------
274
275// Ensure subsequent IDs don't clash with this one
276WXDLLIMPEXP_BASE void wxRegisterId(long id);
277
278// Return the current ID
279WXDLLIMPEXP_BASE long wxGetCurrentId();
280
281// Generate a unique ID
282WXDLLIMPEXP_BASE long wxNewId();
283
284// ----------------------------------------------------------------------------
285// Various conversions
286// ----------------------------------------------------------------------------
287
288// Convert 2-digit hex number to decimal
289WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf);
290
291// Convert decimal integer to 2-character hex string
292WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf);
293WXDLLIMPEXP_BASE void wxDecToHex(int dec, char* ch1, char* ch2);
294WXDLLIMPEXP_BASE wxString wxDecToHex(int dec);
295
296// ----------------------------------------------------------------------------
297// Process management
298// ----------------------------------------------------------------------------
299
300// NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must*
301// be 0 and 1, don't change!
302
303enum
304{
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
315 // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill
316 // kills all children as well as pid
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
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
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.
338WXDLLIMPEXP_BASE long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC,
339 wxProcess *process = (wxProcess *) NULL);
340WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
341 wxProcess *process = (wxProcess *) NULL);
342
343// execute the command capturing its output into an array line by line, this is
344// always synchronous
345WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
346 wxArrayString& output,
347 int flags = 0);
348
349// also capture stderr (also synchronous)
350WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
351 wxArrayString& output,
352 wxArrayString& error,
353 int flags = 0);
354
355#if defined(__WXMSW__) && wxUSE_IPC
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);
360#endif // __WXMSW__ && wxUSE_IPC
361
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};
384
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
394enum wxKillFlags
395{
396 wxKILL_NOCHILDREN = 0, // don't kill children
397 wxKILL_CHILDREN = 1 // kill children
398};
399
400enum wxShutdownFlags
401{
402 wxSHUTDOWN_POWEROFF, // power off the computer
403 wxSHUTDOWN_REBOOT // shutdown and reboot
404};
405
406// Shutdown or reboot the PC
407WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags);
408
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
413WXDLLIMPEXP_BASE int wxKill(long pid,
414 wxSignal sig = wxSIGTERM,
415 wxKillError *rc = NULL,
416 int flags = wxKILL_NOCHILDREN);
417
418// Execute a command in an interactive shell window (always synchronously)
419// If no command then just the shell
420WXDLLIMPEXP_BASE bool wxShell(const wxString& command = wxEmptyString);
421
422// As wxShell(), but must give a (non interactive) command and its output will
423// be returned in output array
424WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output);
425
426// Sleep for nSecs seconds
427WXDLLIMPEXP_BASE void wxSleep(int nSecs);
428
429// Sleep for a given amount of milliseconds
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) );
437
438// Get the process id of the current process
439WXDLLIMPEXP_BASE unsigned long wxGetProcessId();
440
441// Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
442WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory();
443
444#if wxUSE_ON_FATAL_EXCEPTION
445
446// should wxApp::OnFatalException() be called?
447WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true);
448
449#endif // wxUSE_ON_FATAL_EXCEPTION
450
451// ----------------------------------------------------------------------------
452// Environment variables
453// ----------------------------------------------------------------------------
454
455// returns true if variable exists (value may be NULL if you just want to check
456// for this)
457WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value);
458
459// set the env var name to the given value, return true on success
460WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxChar *value);
461
462// remove the env var from environment
463inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); }
464
465// ----------------------------------------------------------------------------
466// Network and username functions.
467// ----------------------------------------------------------------------------
468
469// NB: "char *" functions are deprecated, use wxString ones!
470
471// Get eMail address
472WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize);
473WXDLLIMPEXP_BASE wxString wxGetEmailAddress();
474
475// Get hostname.
476WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize);
477WXDLLIMPEXP_BASE wxString wxGetHostName();
478
479// Get FQDN
480WXDLLIMPEXP_BASE wxString wxGetFullHostName();
481WXDLLIMPEXP_BASE bool wxGetFullHostName(wxChar *buf, int maxSize);
482
483// Get user ID e.g. jacs (this is known as login name under Unix)
484WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize);
485WXDLLIMPEXP_BASE wxString wxGetUserId();
486
487// Get user name e.g. Julian Smart
488WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize);
489WXDLLIMPEXP_BASE wxString wxGetUserName();
490
491// Get current Home dir and copy to dest (returns pstr->c_str())
492WXDLLIMPEXP_BASE wxString wxGetHomeDir();
493WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr);
494
495// Get the user's home dir (caller must copy --- volatile)
496// returns NULL is no HOME dir is known
497#if defined(__UNIX__) && wxUSE_UNICODE && !defined(__WINE__)
498WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
499#else
500WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
501#endif
502
503#if wxUSE_LONGLONG
504 typedef wxLongLong wxDiskspaceSize_t;
505#else
506 typedef long wxDiskspaceSize_t;
507#endif
508
509// get number of total/free bytes on the disk where path belongs
510WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path,
511 wxDiskspaceSize_t *pTotal = NULL,
512 wxDiskspaceSize_t *pFree = NULL);
513
514#if wxUSE_GUI // GUI only things from now on
515
516// ----------------------------------------------------------------------------
517// Launch default browser
518// ----------------------------------------------------------------------------
519
520// flags for wxLaunchDefaultBrowser
521enum
522{
523 wxBROWSER_NEW_WINDOW = 1
524};
525
526// Launch url in the user's default internet browser
527WXDLLIMPEXP_CORE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);
528
529// ----------------------------------------------------------------------------
530// Menu accelerators related things
531// ----------------------------------------------------------------------------
532
533// flags for wxStripMenuCodes
534enum
535{
536 // strip '&' characters
537 wxStrip_Mnemonics = 1,
538
539 // strip everything after '\t'
540 wxStrip_Accel = 2,
541
542 // strip everything (this is the default)
543 wxStrip_All = wxStrip_Mnemonics | wxStrip_Accel
544};
545
546// strip mnemonics and/or accelerators from the label
547WXDLLEXPORT wxString
548wxStripMenuCodes(const wxString& str, int flags = wxStrip_All);
549
550#if WXWIN_COMPATIBILITY_2_6
551// obsolete and deprecated version, do not use, use the above overload instead
552wxDEPRECATED(
553 WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = NULL)
554);
555
556#if wxUSE_ACCEL
557class WXDLLEXPORT wxAcceleratorEntry;
558
559// use wxAcceleratorEntry::Create() or FromString() methods instead
560wxDEPRECATED(
561 WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
562);
563#endif // wxUSE_ACCEL
564
565#endif // WXWIN_COMPATIBILITY_2_6
566
567// ----------------------------------------------------------------------------
568// Window search
569// ----------------------------------------------------------------------------
570
571// Returns menu item id or wxNOT_FOUND if none.
572WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
573
574// Find the wxWindow at the given point. wxGenericFindWindowAtPoint
575// is always present but may be less reliable than a native version.
576WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
577WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
578
579// NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead
580//
581// Find the window/widget with the given title or label.
582// Pass a parent to begin the search from, or NULL to look through
583// all windows.
584WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);
585
586// NB: this function is obsolete, use wxWindow::FindWindowByName() instead
587//
588// Find window by name, and if that fails, by label.
589WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
590
591// ----------------------------------------------------------------------------
592// Message/event queue helpers
593// ----------------------------------------------------------------------------
594
595// Yield to other apps/messages and disable user input
596WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false);
597
598// Enable or disable input to all top level windows
599WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true);
600
601// Check whether this window wants to process messages, e.g. Stop button
602// in long calculations.
603WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
604
605// Consume all events until no more left
606WXDLLEXPORT void wxFlushEvents();
607
608// a class which disables all windows (except, may be, thegiven one) in its
609// ctor and enables them back in its dtor
610class WXDLLEXPORT wxWindowDisabler
611{
612public:
613 wxWindowDisabler(wxWindow *winToSkip = (wxWindow *)NULL);
614 ~wxWindowDisabler();
615
616private:
617 wxWindowList *m_winDisabled;
618
619 DECLARE_NO_COPY_CLASS(wxWindowDisabler)
620};
621
622// ----------------------------------------------------------------------------
623// Cursors
624// ----------------------------------------------------------------------------
625
626// Set the cursor to the busy cursor for all windows
627WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR);
628
629// Restore cursor to normal
630WXDLLEXPORT void wxEndBusyCursor();
631
632// true if we're between the above two calls
633WXDLLEXPORT bool wxIsBusy();
634
635// Convenience class so we can just create a wxBusyCursor object on the stack
636class WXDLLEXPORT wxBusyCursor
637{
638public:
639 wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR)
640 { wxBeginBusyCursor(cursor); }
641 ~wxBusyCursor()
642 { wxEndBusyCursor(); }
643
644 // FIXME: These two methods are currently only implemented (and needed?)
645 // in wxGTK. BusyCursor handling should probably be moved to
646 // common code since the wxGTK and wxMSW implementations are very
647 // similar except for wxMSW using HCURSOR directly instead of
648 // wxCursor.. -- RL.
649 static const wxCursor &GetStoredCursor();
650 static const wxCursor GetBusyCursor();
651};
652
653void WXDLLEXPORT wxGetMousePosition( int* x, int* y );
654
655// MSW only: get user-defined resource from the .res file.
656// Returns NULL or newly-allocated memory, so use delete[] to clean up.
657#ifdef __WXMSW__
658 extern WXDLLEXPORT const wxChar* wxUserResourceStr;
659 WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
660#endif // MSW
661
662// ----------------------------------------------------------------------------
663// X11 Display access
664// ----------------------------------------------------------------------------
665
666#if defined(__X__) || defined(__WXGTK__)
667
668#ifdef __WXGTK__
669 void *wxGetDisplay();
670#endif
671
672#ifdef __X__
673 WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay();
674 WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name);
675 WXDLLIMPEXP_CORE wxString wxGetDisplayName();
676#endif // X or GTK+
677
678// use this function instead of the functions above in implementation code
679inline struct _XDisplay *wxGetX11Display()
680{
681 return (_XDisplay *)wxGetDisplay();
682}
683
684#endif // X11 || wxGTK
685
686#endif // wxUSE_GUI
687
688// ----------------------------------------------------------------------------
689// wxYield(): these functions are obsolete, please use wxApp methods instead!
690// ----------------------------------------------------------------------------
691
692// Yield to other apps/messages
693WXDLLIMPEXP_BASE bool wxYield();
694
695// Like wxYield, but fails silently if the yield is recursive.
696WXDLLIMPEXP_BASE bool wxYieldIfNeeded();
697
698// ----------------------------------------------------------------------------
699// Error message functions used by wxWidgets (deprecated, use wxLog)
700// ----------------------------------------------------------------------------
701
702#endif
703 // _WX_UTILSH__