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