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