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