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