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