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