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