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