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