interface/wx/utils.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utils.h
   3 // Purpose:     interface of various utility classes and functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxWindowDisabler
  11
  12     This class disables all windows of the application (may be with the
  13     exception of one of them) in its constructor and enables them back in its
  14     destructor.
  15
  16     This is useful when you want to indicate to the user that the application
  17     is currently busy and cannot respond to user input.
  18
  19     @library{wxcore}
  20     @category{misc}
  21
  22     @see wxBusyCursor
  23 */
  24 class wxWindowDisabler
  25 {
  26 public:
  27     /**
  28         Disables all top level windows of the applications.
  29
  30         If @a disable is @c false nothing is done. This can be convenient if
  31         the windows should be disabled depending on some condition.
  32
  33         @since 2.9.0
  34     */
  35     wxWindowDisabler(bool disable = true);
  36
  37     /**
  38         Disables all top level windows of the applications with the exception
  39         of @a winToSkip if it is not @NULL.
  40     */
  41     wxWindowDisabler(wxWindow* winToSkip);
  42
  43     /**
  44         Reenables the windows disabled by the constructor.
  45     */
  46     ~wxWindowDisabler();
  47 };
  48
  49
  50
  51 /**
  52     @class wxBusyCursor
  53
  54     This class makes it easy to tell your user that the program is temporarily
  55     busy. Just create a wxBusyCursor object on the stack, and within the
  56     current scope, the hourglass will be shown.
  57
  58     For example:
  59
  60     @code
  61     wxBusyCursor wait;
  62
  63     for (int i = 0; i < 100000; i++)
  64         DoACalculation();
  65     @endcode
  66
  67     It works by calling wxBeginBusyCursor() in the constructor, and
  68     wxEndBusyCursor() in the destructor.
  69
  70     @library{wxcore}
  71     @category{misc}
  72
  73     @see wxBeginBusyCursor(), wxEndBusyCursor(), wxWindowDisabler
  74 */
  75 class wxBusyCursor
  76 {
  77 public:
  78     /**
  79         Constructs a busy cursor object, calling wxBeginBusyCursor().
  80     */
  81     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
  82
  83     /**
  84         Destroys the busy cursor object, calling wxEndBusyCursor().
  85     */
  86     ~wxBusyCursor();
  87 };
  88
  89
  90
  91 /**
  92     @class wxMouseState
  93
  94     Represents the mouse state.
  95
  96     The methods of this class generally mirror the corresponding methods of
  97     wxMouseEvent.
  98
  99     This class is implemented entirely in @<wx/utils.h@>, meaning no extra
 100     library needs to be linked to use this class.
 101
 102     @category{misc}
 103
 104     @see wxGetMouseState()
 105  */
 106 class wxMouseState
 107 {
 108 public:
 109     /**
 110         Default constructor.
 111     */
 112     wxMouseState();
 113
 114     /**
 115         Returns X coordinate of the physical mouse event position.
 116     */
 117     wxCoord GetX() const;
 118     /**
 119         Returns Y coordinate of the physical mouse event position.
 120     */
 121     wxCoord GetY() const;
 122     /**
 123         Returns the physical mouse position.
 124     */
 125     wxPoint GetPosition() const;
 126
 127     /**
 128         Returns @true if the left mouse button changed to down.
 129     */
 130     bool LeftDown() const;
 131     /**
 132         Returns @true if the middle mouse button changed to down.
 133     */
 134     bool MiddleDown() const;
 135     /**
 136         Returns @true if the right mouse button changed to down.
 137     */
 138     bool RightDown() const;
 139     /**
 140         Returns @true if the first extra button mouse button changed to down.
 141     */
 142     bool Aux1Down() const;
 143     /**
 144         Returns @true if the second extra button mouse button changed to down.
 145     */
 146     bool Aux2Down() const;
 147
 148     /**
 149         Returns @true if the control key is down.
 150     */
 151     bool ControlDown() const;
 152     /**
 153         Returns @true if the shift key is down.
 154     */
 155     bool ShiftDown() const;
 156     /**
 157         Returns @true if the alt key is down.
 158     */
 159     bool AltDown() const;
 160     /**
 161         Returns @true if the meta key is down.
 162     */
 163     bool MetaDown() const;
 164     /**
 165         Same as MetaDown() under Mac systems, ControlDown() for the others.
 166     */
 167     bool CmdDown() const;
 168 };
 169
 170
 171 // ============================================================================
 172 // Global functions/macros
 173 // ============================================================================
 174
 175
 176 /** @ingroup group_funcmacro_dialog */
 177 //@{
 178
 179 /**
 180     Changes the cursor to the given cursor for all windows in the application.
 181     Use wxEndBusyCursor() to revert the cursor back to its previous state.
 182     These two calls can be nested, and a counter ensures that only the outer
 183     calls take effect.
 184
 185     @see wxIsBusy(), wxBusyCursor
 186
 187     @header{wx/utils.h}
 188 */
 189 void wxBeginBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
 190
 191 /**
 192     Changes the cursor back to the original cursor, for all windows in the
 193     application. Use with wxBeginBusyCursor().
 194
 195     @see wxIsBusy(), wxBusyCursor
 196
 197     @header{wx/utils.h}
 198 */
 199 void wxEndBusyCursor();
 200
 201 /**
 202     Returns @true if between two wxBeginBusyCursor() and wxEndBusyCursor()
 203     calls.
 204
 205     @see wxBusyCursor.
 206
 207     @header{wx/utils.h}
 208 */
 209 bool wxIsBusy();
 210
 211 /**
 212     Ring the system bell.
 213
 214     @note This function is categorized as a GUI one and so is not thread-safe.
 215
 216     @header{wx/utils.h}
 217 */
 218 void wxBell();
 219
 220 /**
 221     Shows a message box with the information about the wxWidgets build used,
 222     including its version, most important build parameters and the version of
 223     the underlying GUI toolkit. This is mainly used for diagnostic purposes
 224     and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which
 225     doesn't otherwise handle this event.
 226
 227     @since 2.9.0
 228
 229     @header{wx/utils.h}
 230 */
 231 void wxInfoMessageBox(wxWindow parent = NULL);
 232
 233 //@}
 234
 235
 236
 237 /** @ingroup group_funcmacro_env */
 238 //@{
 239
 240 /**
 241     This is a macro defined as @c getenv() or its wide char version in Unicode
 242     mode.
 243
 244     Note that under Win32 it may not return correct value for the variables set
 245     with wxSetEnv(), use wxGetEnv() function instead.
 246
 247     @header{wx/utils.h}
 248 */
 249 wxChar* wxGetenv(const wxString& var);
 250
 251 /**
 252     Returns the current value of the environment variable @c var in @c value.
 253     @c value may be @NULL if you just want to know if the variable exists and
 254     are not interested in its value.
 255
 256     Returns @true if the variable exists, @false otherwise.
 257
 258     @header{wx/utils.h}
 259 */
 260 bool wxGetEnv(const wxString& var, wxString* value);
 261
 262 /**
 263     Sets the value of the environment variable @c var (adding it if necessary)
 264     to @c value.
 265
 266     Returns @true on success.
 267
 268     @see wxUnsetEnv()
 269
 270     @header{wx/utils.h}
 271 */
 272 bool wxSetEnv(const wxString& var, const wxString& value);
 273
 274 /**
 275     Removes the variable @c var from the environment. wxGetEnv() will return
 276     @NULL after the call to this function.
 277
 278     Returns @true on success.
 279
 280     @header{wx/utils.h}
 281 */
 282 bool wxUnsetEnv(const wxString& var);
 283
 284 //@}
 285
 286
 287
 288 /** @ingroup group_funcmacro_misc */
 289 //@{
 290
 291 /**
 292     Returns battery state as one of @c wxBATTERY_NORMAL_STATE,
 293     @c wxBATTERY_LOW_STATE, @c wxBATTERY_CRITICAL_STATE,
 294     @c wxBATTERY_SHUTDOWN_STATE or @c wxBATTERY_UNKNOWN_STATE.
 295     @c wxBATTERY_UNKNOWN_STATE is also the default on platforms where this
 296     feature is not implemented (currently everywhere but MS Windows).
 297
 298     @header{wx/utils.h}
 299 */
 300 wxBatteryState wxGetBatteryState();
 301
 302 /**
 303     Returns the type of power source as one of @c wxPOWER_SOCKET,
 304     @c wxPOWER_BATTERY or @c wxPOWER_UNKNOWN. @c wxPOWER_UNKNOWN is also the
 305     default on platforms where this feature is not implemented (currently
 306     everywhere but MS Windows).
 307
 308     @header{wx/utils.h}
 309 */
 310 wxPowerType wxGetPowerType();
 311
 312 /**
 313     Under X only, returns the current display name.
 314
 315     @see wxSetDisplayName()
 316
 317     @header{wx/utils.h}
 318 */
 319 wxString wxGetDisplayName();
 320
 321 /**
 322     For normal keys, returns @true if the specified key is currently down.
 323
 324     For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns @true if
 325     the key is toggled such that its LED indicator is lit. There is currently
 326     no way to test whether togglable keys are up or down.
 327
 328     Even though there are virtual key codes defined for mouse buttons, they
 329     cannot be used with this function currently.
 330
 331     @header{wx/utils.h}
 332 */
 333 bool wxGetKeyState(wxKeyCode key);
 334
 335 /**
 336     Returns the mouse position in screen coordinates.
 337
 338     @header{wx/utils.h}
 339 */
 340 wxPoint wxGetMousePosition();
 341
 342 /**
 343     Returns the current state of the mouse.  Returns a wxMouseState instance
 344     that contains the current position of the mouse pointer in screen
 345     coordinates, as well as boolean values indicating the up/down status of the
 346     mouse buttons and the modifier keys.
 347
 348     @header{wx/utils.h}
 349 */
 350 wxMouseState wxGetMouseState();
 351
 352 /**
 353     This function enables or disables all top level windows. It is used by
 354     wxSafeYield().
 355
 356     @header{wx/utils.h}
 357 */
 358 void wxEnableTopLevelWindows(bool enable = true);
 359
 360 /**
 361     Find the deepest window at the given mouse position in screen coordinates,
 362     returning the window if found, or @NULL if not.
 363
 364     @header{wx/utils.h}
 365 */
 366 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 367
 368 /**
 369     @deprecated Replaced by wxWindow::FindWindowByLabel().
 370
 371     Find a window by its label. Depending on the type of window, the label may
 372     be a window title or panel item label. If @a parent is @NULL, the search
 373     will start from all top-level frames and dialog boxes; if non-@NULL, the
 374     search will be limited to the given window hierarchy. The search is
 375     recursive in both cases.
 376
 377     @header{wx/utils.h}
 378 */
 379 wxWindow* wxFindWindowByLabel(const wxString& label,
 380                               wxWindow* parent = NULL);
 381
 382 /**
 383     @deprecated Replaced by wxWindow::FindWindowByName().
 384
 385     Find a window by its name (as given in a window constructor or @e Create
 386     function call). If @a parent is @NULL, the search will start from all
 387     top-level frames and dialog boxes; if non-@NULL, the search will be limited
 388     to the given window hierarchy. The search is recursive in both cases.
 389
 390     If no such named window is found, wxFindWindowByLabel() is called.
 391
 392     @header{wx/utils.h}
 393 */
 394 wxWindow* wxFindWindowByName(const wxString& name, wxWindow* parent = NULL);
 395
 396 /**
 397     Find a menu item identifier associated with the given frame's menu bar.
 398
 399     @header{wx/utils.h}
 400 */
 401 int wxFindMenuItemId(wxFrame* frame, const wxString& menuString,
 402                      const wxString& itemString);
 403
 404 /**
 405     @deprecated Ids generated by it can conflict with the Ids defined by the
 406                 user code, use @c wxID_ANY to assign ids which are guaranteed
 407                 to not conflict with the user-defined ids for the controls and
 408                 menu items you create instead of using this function.
 409
 410     Generates an integer identifier unique to this run of the program.
 411
 412     @header{wx/utils.h}
 413 */
 414 long wxNewId();
 415
 416 /**
 417     Ensures that Ids subsequently generated by wxNewId() do not clash with the
 418     given @a id.
 419
 420     @header{wx/utils.h}
 421 */
 422 void wxRegisterId(long id);
 423
 424 /**
 425     Opens the @a url in user's default browser. If the @a flags parameter
 426     contains @c wxBROWSER_NEW_WINDOW flag, a new window is opened for the URL
 427     (currently this is only supported under Windows). The @a url may also be a
 428     local file path (with or without the "file://" prefix), if it doesn't
 429     correspond to an existing file and the URL has no scheme "http://" is
 430     prepended to it by default.
 431
 432     Returns @true if the application was successfully launched.
 433
 434     @note For some configurations of the running user, the application which is
 435           launched to open the given URL may be URL-dependent (e.g. a browser
 436           may be used for local URLs while another one may be used for remote
 437           URLs).
 438
 439     @header{wx/utils.h}
 440 */
 441 bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);
 442
 443 /**
 444     Loads a user-defined Windows resource as a string. If the resource is
 445     found, the function creates a new character array and copies the data into
 446     it. A pointer to this data is returned. If unsuccessful, @NULL is returned.
 447
 448     The resource must be defined in the @c .rc file using the following syntax:
 449
 450     @code
 451     myResource TEXT file.ext
 452     @endcode
 453
 454     Where @c file.ext is a file that the resource compiler can find.
 455
 456     This function is available under Windows only.
 457
 458     @header{wx/utils.h}
 459 */
 460 wxString wxLoadUserResource(const wxString& resourceName,
 461                             const wxString& resourceType = "TEXT");
 462
 463 /**
 464     @deprecated Replaced by wxWindow::Close(). See the
 465                 @ref overview_windowdeletion "window deletion overview".
 466
 467     Tells the system to delete the specified object when all other events have
 468     been processed. In some environments, it is necessary to use this instead
 469     of deleting a frame directly with the delete operator, because some GUIs
 470     will still send events to a deleted window.
 471
 472     @header{wx/utils.h}
 473 */
 474 void wxPostDelete(wxObject* object);
 475
 476 /**
 477     Under X only, sets the current display name. This is the X host and display
 478     name such as "colonsay:0.0", and the function indicates which display
 479     should be used for creating windows from this point on. Setting the display
 480     within an application allows multiple displays to be used.
 481
 482     @see wxGetDisplayName()
 483
 484     @header{wx/utils.h}
 485 */
 486 void wxSetDisplayName(const wxString& displayName);
 487
 488 /**
 489     Strips any menu codes from @a str and returns the result.
 490
 491     By default, the functions strips both the mnemonics character (@c '&')
 492     which is used to indicate a keyboard shortkey, and the accelerators, which
 493     are used only in the menu items and are separated from the main text by the
 494     @c \t (TAB) character. By using @a flags of @c wxStrip_Mnemonics or
 495     @c wxStrip_Accel to strip only the former or the latter part, respectively.
 496
 497     Notice that in most cases wxMenuItem::GetLabelFromText() or
 498     wxControl::GetLabelText() can be used instead.
 499
 500     @header{wx/utils.h}
 501 */
 502 wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All);
 503
 504 //@}
 505
 506
 507
 508 /** @ingroup group_funcmacro_networkuseros */
 509 //@{
 510
 511 /**
 512     Copies the user's email address into the supplied buffer, by concatenating
 513     the values returned by wxGetFullHostName() and wxGetUserId().
 514
 515     @return @true if successful, @false otherwise.
 516
 517     @header{wx/utils.h}
 518 */
 519 wxString wxGetEmailAddress();
 520
 521 /**
 522     @deprecated Use wxGetEmailAddress() instead.
 523
 524     @param buf Buffer to store the email address in.
 525     @param sz  Size of the buffer.
 526
 527     @return @true if successful, @false otherwise.
 528
 529     @header{wx/utils.h}
 530 */
 531 bool wxGetEmailAddress(char* buf, int sz);
 532
 533 /**
 534     Returns the amount of free memory in bytes under environments which support
 535     it, and -1 if not supported or failed to perform measurement.
 536
 537     @header{wx/utils.h}
 538 */
 539 wxMemorySize wxGetFreeMemory();
 540
 541 /**
 542     Return the (current) user's home directory.
 543
 544     @see wxGetUserHome(), wxStandardPaths
 545
 546     @header{wx/utils.h}
 547 */
 548 wxString wxGetHomeDir();
 549
 550 /**
 551     Copies the current host machine's name into the supplied buffer. Please
 552     note that the returned name is @e not fully qualified, i.e. it does not
 553     include the domain name.
 554
 555     Under Windows or NT, this function first looks in the environment variable
 556     SYSTEM_NAME; if this is not found, the entry @b HostName in the wxWidgets
 557     section of the WIN.INI file is tried.
 558
 559     @return The hostname if successful or an empty string otherwise.
 560
 561     @see wxGetFullHostName()
 562
 563     @header{wx/utils.h}
 564 */
 565 wxString wxGetHostName();
 566
 567 /**
 568     @deprecated Use wxGetHostName() instead.
 569
 570     @param buf Buffer to store the host name in.
 571     @param sz  Size of the buffer.
 572
 573     @return @true if successful, @false otherwise.
 574
 575     @header{wx/utils.h}
 576 */
 577 bool wxGetHostName(char* buf, int sz);
 578
 579 /**
 580     Returns the FQDN (fully qualified domain host name) or an empty string on
 581     error.
 582
 583     @see wxGetHostName()
 584
 585     @header{wx/utils.h}
 586 */
 587 wxString wxGetFullHostName();
 588
 589 /**
 590     Returns the home directory for the given user. If the @a user is empty
 591     (default value), this function behaves like wxGetHomeDir() (i.e. returns
 592     the current user home directory).
 593
 594     If the home directory couldn't be determined, an empty string is returned.
 595
 596     @header{wx/utils.h}
 597 */
 598 wxString wxGetUserHome(const wxString& user = "");
 599
 600 /**
 601     This function returns the "user id" also known as "login name" under Unix
 602     (i.e. something like "jsmith"). It uniquely identifies the current user (on
 603     this system).  Under Windows or NT, this function first looks in the
 604     environment variables USER and LOGNAME; if neither of these is found, the
 605     entry @b UserId in the @b wxWidgets section of the WIN.INI file is tried.
 606
 607     @return The login name if successful or an empty string otherwise.
 608
 609     @see wxGetUserName()
 610
 611     @header{wx/utils.h}
 612 */
 613 wxString wxGetUserId();
 614
 615 /**
 616     @deprecated Use wxGetUserId() instead.
 617
 618     @param buf Buffer to store the login name in.
 619     @param sz  Size of the buffer.
 620
 621     @return @true if successful, @false otherwise.
 622
 623     @header{wx/utils.h}
 624 */
 625 bool wxGetUserId(char* buf, int sz);
 626
 627 /**
 628     This function returns the full user name (something like "Mr. John Smith").
 629
 630     Under Windows or NT, this function looks for the entry UserName in the
 631     wxWidgets section of the WIN.INI file. If PenWindows is running, the entry
 632     Current in the section User of the PENWIN.INI file is used.
 633
 634     @return The full user name if successful or an empty string otherwise.
 635
 636     @see wxGetUserId()
 637
 638     @header{wx/utils.h}
 639 */
 640 wxString wxGetUserName();
 641
 642 /**
 643     @deprecated Use wxGetUserName() instead.
 644
 645     @param buf Buffer to store the full user name in.
 646     @param sz  Size of the buffer.
 647
 648     @return @true if successful, @false otherwise.
 649
 650     @header{wx/utils.h}
 651 */
 652 bool wxGetUserName(char* buf, int sz);
 653
 654 /**
 655     Returns the string containing the description of the current platform in a
 656     user-readable form. For example, this function may return strings like
 657     "Windows NT Version 4.0" or "Linux 2.2.2 i386".
 658
 659     @see wxGetOsVersion()
 660
 661     @header{wx/utils.h}
 662 */
 663 wxString wxGetOsDescription();
 664
 665 /**
 666     Gets the version and the operating system ID for currently running OS. See
 667     wxPlatformInfo for more details about wxOperatingSystemId.
 668
 669     @see wxGetOsDescription(), wxPlatformInfo
 670
 671     @header{wx/utils.h}
 672 */
 673 wxOperatingSystemId wxGetOsVersion(int* major = NULL, int* minor = NULL);
 674
 675 /**
 676     Returns @true if the operating system the program is running under is 64
 677     bit. The check is performed at run-time and may differ from the value
 678     available at compile-time (at compile-time you can just check if
 679     <tt>sizeof(void*) == 8</tt>) since the program could be running in
 680     emulation mode or in a mixed 32/64 bit system (bi-architecture operating
 681     system).
 682
 683     @note This function is not 100% reliable on some systems given the fact
 684           that there isn't always a standard way to do a reliable check on the
 685           OS architecture.
 686
 687     @header{wx/utils.h}
 688 */
 689 bool wxIsPlatform64Bit();
 690
 691 /**
 692     Returns @true if the current platform is little endian (instead of big
 693     endian). The check is performed at run-time.
 694
 695     @see @ref group_funcmacro_byteorder "Byte Order Functions and Macros"
 696
 697     @header{wx/utils.h}
 698 */
 699 bool wxIsPlatformLittleEndian();
 700
 701 //@}
 702
 703
 704
 705 /** @ingroup group_funcmacro_procctrl */
 706 //@{
 707
 708 /**
 709     Executes another program in Unix or Windows.
 710
 711     In the overloaded versions of this function, if @a flags parameter contains
 712     @c wxEXEC_ASYNC flag (the default), flow of control immediately returns. If
 713     it contains @c wxEXEC_SYNC, the current application waits until the other
 714     program has terminated.
 715
 716     In the case of synchronous execution, the return value is the exit code of
 717     the process (which terminates by the moment the function returns) and will
 718     be -1 if the process couldn't be started and typically 0 if the process
 719     terminated successfully. Also, while waiting for the process to terminate,
 720     wxExecute() will call wxYield(). Because of this, by default this function
 721     disables all application windows to avoid unexpected reentrancies which
 722     could result from the users interaction with the program while the child
 723     process is running. If you are sure that it is safe to not disable the
 724     program windows, you may pass @c wxEXEC_NODISABLE flag to prevent this
 725     automatic disabling from happening.
 726
 727     For asynchronous execution, however, the return value is the process id and
 728     zero value indicates that the command could not be executed. As an added
 729     complication, the return value of -1 in this case indicates that we didn't
 730     launch a new process, but connected to the running one (this can only
 731     happen when using DDE under Windows for command execution). In particular,
 732     in this case only, the calling code will not get the notification about
 733     process termination.
 734
 735     If @a callback isn't @NULL and if execution is asynchronous,
 736     wxProcess::OnTerminate() will be called when the process finishes.
 737     Specifying this parameter also allows you to redirect the standard input
 738     and/or output of the process being launched by calling
 739     wxProcess::Redirect(). If the child process IO is redirected, under Windows
 740     the process window is not shown by default (this avoids having to flush an
 741     unnecessary console for the processes which don't create any windows
 742     anyhow) but a @c wxEXEC_NOHIDE flag can be used to prevent this from
 743     happening, i.e. with this flag the child process window will be shown
 744     normally.
 745
 746     Under Unix the flag @c wxEXEC_MAKE_GROUP_LEADER may be used to ensure that
 747     the new process is a group leader (this will create a new session if
 748     needed). Calling wxKill() passing wxKILL_CHILDREN will kill this process as
 749     well as all of its children (except those which have started their own
 750     session).
 751
 752     The @c wxEXEC_NOEVENTS flag prevents processing of any events from taking
 753     place while the child process is running. It should be only used for very
 754     short-lived processes as otherwise the application windows risk becoming
 755     unresponsive from the users point of view. As this flag only makes sense
 756     with @c wxEXEC_SYNC, @c wxEXEC_BLOCK equal to the sum of both of these
 757     flags is provided as a convenience.
 758
 759     @note Currently wxExecute() can only be used from the main thread, calling
 760           this function from another thread will result in an assert failure in
 761           debug build and won't work.
 762
 763     @param command
 764         The command to execute and any parameters to pass to it as a single
 765         string, i.e. "emacs file.txt".
 766     @param flags
 767         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
 768         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
 769         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
 770         their combination, in wxEXEC_SYNC case.
 771     @param callback
 772         An optional pointer to wxProcess.
 773
 774     @see wxShell(), wxProcess, @ref page_samples_exec
 775
 776     @header{wx/utils.h}
 777
 778     @beginWxPerlOnly
 779     This function is called @c Wx::ExecuteStdoutStderr and it only takes the
 780     @a command argument, and returns a 3-element list (@c status, @c output,
 781     @c errors), where @c output and @c errors are array references.
 782     @endWxPerlOnly
 783 */
 784 long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
 785                 wxProcess* callback = NULL);
 786
 787 //@}
 788
 789 /** @ingroup group_funcmacro_procctrl */
 790 //@{
 791 /**
 792     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
 793     please see its documentation for general information.
 794
 795     This version takes an array of values: a command, any number of arguments,
 796     terminated by @NULL.
 797
 798     @param argv
 799         The command to execute should be the first element of this array, any
 800         additional ones are the command parameters and the array must be
 801         terminated with a @NULL pointer.
 802     @param flags
 803         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
 804         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
 805         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
 806         their combination, in wxEXEC_SYNC case.
 807     @param callback
 808         An optional pointer to wxProcess.
 809
 810     @header{wx/utils.h}
 811 */
 812 long wxExecute(char** argv, int flags = wxEXEC_ASYNC,
 813                 wxProcess* callback = NULL);
 814 long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC,
 815                 wxProcess* callback = NULL);
 816 //@}
 817
 818 /** @ingroup group_funcmacro_procctrl */
 819 //@{
 820
 821 /**
 822     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
 823     please see its documentation for general information.
 824
 825     This version can be used to execute a process (always synchronously, the
 826     contents of @a flags is or'd with @c wxEXEC_SYNC) and capture its output in
 827     the array @e output.
 828
 829     @param command
 830         The command to execute and any parameters to pass to it as a single
 831         string.
 832     @param flags
 833         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
 834         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
 835         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
 836         their combination, in wxEXEC_SYNC case.
 837
 838     @header{wx/utils.h}
 839 */
 840 long wxExecute(const wxString& command, wxArrayString& output,
 841                 int flags = 0);
 842
 843 /**
 844     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
 845     please see its documentation for general information.
 846
 847     This version adds the possibility to additionally capture the messages from
 848     standard error output in the @a errors array.
 849
 850     @param command
 851         The command to execute and any parameters to pass to it as a single
 852         string.
 853     @param flags
 854         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
 855         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
 856         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
 857         their combination, in wxEXEC_SYNC case.
 858
 859     @header{wx/utils.h}
 860 */
 861 long wxExecute(const wxString& command, wxArrayString& output,
 862                 wxArrayString& errors, int flags = 0);
 863
 864 /**
 865     Returns the number uniquely identifying the current process in the system.
 866     If an error occurs, 0 is returned.
 867
 868     @header{wx/utils.h}
 869 */
 870 unsigned long wxGetProcessId();
 871
 872 /**
 873     Equivalent to the Unix kill function: send the given signal @a sig to the
 874     process with PID @a pid. The valid signal values are:
 875
 876     @code
 877     enum wxSignal
 878     {
 879         wxSIGNONE = 0, // verify if the process exists under Unix
 880         wxSIGHUP,
 881         wxSIGINT,
 882         wxSIGQUIT,
 883         wxSIGILL,
 884         wxSIGTRAP,
 885         wxSIGABRT,
 886         wxSIGEMT,
 887         wxSIGFPE,
 888         wxSIGKILL,     // forcefully kill, dangerous!
 889         wxSIGBUS,
 890         wxSIGSEGV,
 891         wxSIGSYS,
 892         wxSIGPIPE,
 893         wxSIGALRM,
 894         wxSIGTERM      // terminate the process gently
 895     };
 896     @endcode
 897
 898     @c wxSIGNONE, @c wxSIGKILL and @c wxSIGTERM have the same meaning under
 899     both Unix and Windows but all the other signals are equivalent to
 900     @c wxSIGTERM under Windows.
 901
 902     Returns 0 on success, -1 on failure. If the @a rc parameter is not @NULL,
 903     it will be filled with a value of the the @c wxKillError enum:
 904
 905     @code
 906     enum wxKillError
 907     {
 908         wxKILL_OK,            // no error
 909         wxKILL_BAD_SIGNAL,    // no such signal
 910         wxKILL_ACCESS_DENIED, // permission denied
 911         wxKILL_NO_PROCESS,    // no such process
 912         wxKILL_ERROR          // another, unspecified error
 913     };
 914     @endcode
 915
 916     The @a flags parameter can be wxKILL_NOCHILDREN (the default), or
 917     wxKILL_CHILDREN, in which case the child processes of this process will be
 918     killed too. Note that under Unix, for wxKILL_CHILDREN to work you should
 919     have created the process by passing wxEXEC_MAKE_GROUP_LEADER to
 920     wxExecute().
 921
 922     @see wxProcess::Kill(), wxProcess::Exists(), @ref page_samples_exec
 923
 924     @header{wx/utils.h}
 925 */
 926 int wxKill(long pid, int sig = wxSIGTERM,
 927             wxKillError rc = NULL, int flags = 0);
 928
 929 /**
 930     Executes a command in an interactive shell window. If no command is
 931     specified, then just the shell is spawned.
 932
 933     @see wxExecute(), @ref page_samples_exec
 934
 935     @header{wx/utils.h}
 936 */
 937 bool wxShell(const wxString& command = NULL);
 938
 939 /**
 940     This function shuts down or reboots the computer depending on the value of
 941     the @a flags.
 942
 943     @note Doing this requires the corresponding access rights (superuser under
 944           Unix, SE_SHUTDOWN privilege under Windows NT) and that this function
 945           is only implemented under Unix and Win32.
 946
 947     @param flags
 948         Either wxSHUTDOWN_POWEROFF or wxSHUTDOWN_REBOOT
 949
 950     @return @true on success, @false if an error occurred.
 951
 952     @header{wx/utils.h}
 953 */
 954 bool wxShutdown(wxShutdownFlags flags);
 955
 956 //@}
 957
 958
 959
 960 /** @ingroup group_funcmacro_time */
 961 //@{
 962
 963 /**
 964     Sleeps for the specified number of microseconds. The microsecond resolution
 965     may not, in fact, be available on all platforms (currently only Unix
 966     platforms with nanosleep(2) may provide it) in which case this is the same
 967     as calling wxMilliSleep() with the argument of @e microseconds/1000.
 968
 969     @header{wx/utils.h}
 970 */
 971 void wxMicroSleep(unsigned long microseconds);
 972
 973 /**
 974     Sleeps for the specified number of milliseconds. Notice that usage of this
 975     function is encouraged instead of calling usleep(3) directly because the
 976     standard @e usleep() function is not MT safe.
 977
 978     @header{wx/utils.h}
 979 */
 980 void wxMilliSleep(unsigned long milliseconds);
 981
 982 /**
 983     Returns a string representing the current date and time.
 984
 985     @header{wx/utils.h}
 986 */
 987 wxString wxNow();
 988
 989 /**
 990     Sleeps for the specified number of seconds.
 991
 992     @header{wx/utils.h}
 993 */
 994 void wxSleep(int secs);
 995
 996 /**
 997     @deprecated This function is deprecated because its name is misleading:
 998                 notice that the argument is in milliseconds, not microseconds.
 999                 Please use either wxMilliSleep() or wxMicroSleep() depending on
1000                 the resolution you need.
1001
1002     Sleeps for the specified number of milliseconds.
1003
1004     @header{wx/utils.h}
1005 */
1006 void wxUsleep(unsigned long milliseconds);
1007
1008 //@}
1009