| 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 licence |
| 7 | ///////////////////////////////////////////////////////////////////////////// |
| 8 | |
| 9 | /** |
| 10 | Signal constants used by wxProcess. |
| 11 | */ |
| 12 | enum wxSignal |
| 13 | { |
| 14 | wxSIGNONE = 0, //!< verify if the process exists under Unix |
| 15 | wxSIGHUP, |
| 16 | wxSIGINT, |
| 17 | wxSIGQUIT, |
| 18 | wxSIGILL, |
| 19 | wxSIGTRAP, |
| 20 | wxSIGABRT, |
| 21 | wxSIGEMT, |
| 22 | wxSIGFPE, |
| 23 | wxSIGKILL, //!< forcefully kill, dangerous! |
| 24 | wxSIGBUS, |
| 25 | wxSIGSEGV, |
| 26 | wxSIGSYS, |
| 27 | wxSIGPIPE, |
| 28 | wxSIGALRM, |
| 29 | wxSIGTERM //!< terminate the process gently |
| 30 | }; |
| 31 | |
| 32 | /** |
| 33 | Return values for wxProcess::Kill. |
| 34 | */ |
| 35 | enum wxKillError |
| 36 | { |
| 37 | wxKILL_OK, //!< no error |
| 38 | wxKILL_BAD_SIGNAL, //!< no such signal |
| 39 | wxKILL_ACCESS_DENIED, //!< permission denied |
| 40 | wxKILL_NO_PROCESS, //!< no such process |
| 41 | wxKILL_ERROR //!< another, unspecified error |
| 42 | }; |
| 43 | |
| 44 | enum wxKillFlags |
| 45 | { |
| 46 | wxKILL_NOCHILDREN = 0, //!< don't kill children |
| 47 | wxKILL_CHILDREN = 1 //!< kill children |
| 48 | }; |
| 49 | |
| 50 | enum wxShutdownFlags |
| 51 | { |
| 52 | wxSHUTDOWN_FORCE = 1, //!< can be combined with other flags (MSW-only) |
| 53 | wxSHUTDOWN_POWEROFF = 2, //!< power off the computer |
| 54 | wxSHUTDOWN_REBOOT = 4, //!< shutdown and reboot |
| 55 | wxSHUTDOWN_LOGOFF = 8 //!< close session (currently MSW-only) |
| 56 | }; |
| 57 | |
| 58 | |
| 59 | /** |
| 60 | @class wxWindowDisabler |
| 61 | |
| 62 | This class disables all windows of the application (may be with the |
| 63 | exception of one of them) in its constructor and enables them back in its |
| 64 | destructor. |
| 65 | |
| 66 | This is useful when you want to indicate to the user that the application |
| 67 | is currently busy and cannot respond to user input. |
| 68 | |
| 69 | @library{wxcore} |
| 70 | @category{misc} |
| 71 | |
| 72 | @see wxBusyCursor |
| 73 | */ |
| 74 | class wxWindowDisabler |
| 75 | { |
| 76 | public: |
| 77 | /** |
| 78 | Disables all top level windows of the applications. |
| 79 | |
| 80 | If @a disable is @c false nothing is done. This can be convenient if |
| 81 | the windows should be disabled depending on some condition. |
| 82 | |
| 83 | @since 2.9.0 |
| 84 | */ |
| 85 | wxWindowDisabler(bool disable = true); |
| 86 | |
| 87 | /** |
| 88 | Disables all top level windows of the applications with the exception |
| 89 | of @a winToSkip if it is not @NULL. |
| 90 | |
| 91 | Notice that under MSW if @a winToSkip appears in the taskbar, the user |
| 92 | will be able to close the entire application (even though its main |
| 93 | window is disabled) by right clicking on the taskbar icon and selecting |
| 94 | the appropriate "Close" command from the context menu. To prevent this |
| 95 | from happening you may want to use wxFRAME_TOOL_WINDOW, if applicable, |
| 96 | or wxFRAME_NO_TASKBAR style when creating the window that will remain |
| 97 | enabled. |
| 98 | */ |
| 99 | wxWindowDisabler(wxWindow* winToSkip); |
| 100 | |
| 101 | /** |
| 102 | Reenables the windows disabled by the constructor. |
| 103 | */ |
| 104 | ~wxWindowDisabler(); |
| 105 | }; |
| 106 | |
| 107 | |
| 108 | |
| 109 | /** |
| 110 | @class wxBusyCursor |
| 111 | |
| 112 | This class makes it easy to tell your user that the program is temporarily |
| 113 | busy. Just create a wxBusyCursor object on the stack, and within the |
| 114 | current scope, the hourglass will be shown. |
| 115 | |
| 116 | For example: |
| 117 | |
| 118 | @code |
| 119 | wxBusyCursor wait; |
| 120 | |
| 121 | for (int i = 0; i < 100000; i++) |
| 122 | DoACalculation(); |
| 123 | @endcode |
| 124 | |
| 125 | It works by calling wxBeginBusyCursor() in the constructor, and |
| 126 | wxEndBusyCursor() in the destructor. |
| 127 | |
| 128 | @library{wxcore} |
| 129 | @category{misc} |
| 130 | |
| 131 | @see wxBeginBusyCursor(), wxEndBusyCursor(), wxWindowDisabler |
| 132 | */ |
| 133 | class wxBusyCursor |
| 134 | { |
| 135 | public: |
| 136 | /** |
| 137 | Constructs a busy cursor object, calling wxBeginBusyCursor(). |
| 138 | */ |
| 139 | wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR); |
| 140 | |
| 141 | /** |
| 142 | Destroys the busy cursor object, calling wxEndBusyCursor(). |
| 143 | */ |
| 144 | ~wxBusyCursor(); |
| 145 | }; |
| 146 | |
| 147 | |
| 148 | |
| 149 | // ============================================================================ |
| 150 | // Global functions/macros |
| 151 | // ============================================================================ |
| 152 | |
| 153 | |
| 154 | /** @addtogroup group_funcmacro_dialog */ |
| 155 | //@{ |
| 156 | |
| 157 | /** |
| 158 | Changes the cursor to the given cursor for all windows in the application. |
| 159 | Use wxEndBusyCursor() to revert the cursor back to its previous state. |
| 160 | These two calls can be nested, and a counter ensures that only the outer |
| 161 | calls take effect. |
| 162 | |
| 163 | @see wxIsBusy(), wxBusyCursor |
| 164 | |
| 165 | @header{wx/utils.h} |
| 166 | */ |
| 167 | void wxBeginBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR); |
| 168 | |
| 169 | /** |
| 170 | Changes the cursor back to the original cursor, for all windows in the |
| 171 | application. Use with wxBeginBusyCursor(). |
| 172 | |
| 173 | @see wxIsBusy(), wxBusyCursor |
| 174 | |
| 175 | @header{wx/utils.h} |
| 176 | */ |
| 177 | void wxEndBusyCursor(); |
| 178 | |
| 179 | /** |
| 180 | Returns @true if between two wxBeginBusyCursor() and wxEndBusyCursor() |
| 181 | calls. |
| 182 | |
| 183 | @see wxBusyCursor. |
| 184 | |
| 185 | @header{wx/utils.h} |
| 186 | */ |
| 187 | bool wxIsBusy(); |
| 188 | |
| 189 | /** |
| 190 | Ring the system bell. |
| 191 | |
| 192 | @note This function is categorized as a GUI one and so is not thread-safe. |
| 193 | |
| 194 | @header{wx/utils.h} |
| 195 | */ |
| 196 | void wxBell(); |
| 197 | |
| 198 | /** |
| 199 | Shows a message box with the information about the wxWidgets build used, |
| 200 | including its version, most important build parameters and the version of |
| 201 | the underlying GUI toolkit. This is mainly used for diagnostic purposes |
| 202 | and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which |
| 203 | doesn't otherwise handle this event. |
| 204 | |
| 205 | @since 2.9.0 |
| 206 | @see wxGetLibraryVersionInfo() |
| 207 | @header{wx/utils.h} |
| 208 | */ |
| 209 | void wxInfoMessageBox(wxWindow* parent); |
| 210 | |
| 211 | //@} |
| 212 | |
| 213 | /** @addtogroup group_funcmacro_version */ |
| 214 | //@{ |
| 215 | |
| 216 | /** |
| 217 | Get wxWidgets version information. |
| 218 | |
| 219 | @since 2.9.2 |
| 220 | @see wxVersionInfo |
| 221 | @header{wx/utils.h} |
| 222 | @library{wxcore} |
| 223 | */ |
| 224 | wxVersionInfo wxGetLibraryVersionInfo(); |
| 225 | |
| 226 | //@} |
| 227 | |
| 228 | |
| 229 | |
| 230 | /** @addtogroup group_funcmacro_env */ |
| 231 | //@{ |
| 232 | |
| 233 | /** |
| 234 | A map type containing environment variables names and values. |
| 235 | |
| 236 | This type is used with wxGetEnvMap() function and wxExecuteEnv structure |
| 237 | optionally passed to wxExecute(). |
| 238 | |
| 239 | @since 2.9.2 |
| 240 | |
| 241 | @header{wx/utils.h} |
| 242 | */ |
| 243 | typedef wxStringToStringHashMap wxEnvVariableHashMap; |
| 244 | |
| 245 | /** |
| 246 | This is a macro defined as @c getenv() or its wide char version in Unicode |
| 247 | mode. |
| 248 | |
| 249 | Note that under Win32 it may not return correct value for the variables set |
| 250 | with wxSetEnv(), use wxGetEnv() function instead. |
| 251 | |
| 252 | @header{wx/utils.h} |
| 253 | */ |
| 254 | wxChar* wxGetenv(const wxString& var); |
| 255 | |
| 256 | /** |
| 257 | Returns the current value of the environment variable @a var in @a value. |
| 258 | |
| 259 | @a value may be @NULL if you just want to know if the variable exists and |
| 260 | are not interested in its value. |
| 261 | |
| 262 | Returns @true if the variable exists, @false otherwise. |
| 263 | |
| 264 | @header{wx/utils.h} |
| 265 | */ |
| 266 | bool wxGetEnv(const wxString& var, wxString* value); |
| 267 | |
| 268 | /** |
| 269 | Sets the value of the environment variable @a var (adding it if necessary) |
| 270 | to @a value. |
| 271 | |
| 272 | Notice that under Windows platforms the program may have two different |
| 273 | environment blocks: the first one is that of a Windows process and is |
| 274 | always present, but the CRT may maintain its own independent copy of the |
| 275 | environment. wxSetEnv() will always update the first copy, which means that |
| 276 | wxGetEnv(), which uses it directly, will always return the expected value |
| 277 | after this call. But wxSetEnv() only updates the second copy for some |
| 278 | compilers/CRT implementations (currently only MSVC and MinGW which uses the |
| 279 | same MSVC CRT) and so using wxGetenv() (notice the difference in case) may |
| 280 | not return the updated value. |
| 281 | |
| 282 | @param var |
| 283 | The environment variable to be set, must not contain @c '=' character. |
| 284 | @param value |
| 285 | New value of the variable. |
| 286 | @return |
| 287 | @true on success or @false if changing the value failed. |
| 288 | |
| 289 | @see wxUnsetEnv() |
| 290 | |
| 291 | @header{wx/utils.h} |
| 292 | */ |
| 293 | bool wxSetEnv(const wxString& var, const wxString& value); |
| 294 | |
| 295 | /** |
| 296 | Removes the variable @a var from the environment. |
| 297 | |
| 298 | wxGetEnv() will return @NULL after the call to this function. |
| 299 | |
| 300 | Returns @true on success. |
| 301 | |
| 302 | @header{wx/utils.h} |
| 303 | */ |
| 304 | bool wxUnsetEnv(const wxString& var); |
| 305 | |
| 306 | /** |
| 307 | Fill a map with the complete content of current environment. |
| 308 | |
| 309 | The map will contain the environment variable names as keys and their |
| 310 | values as values. |
| 311 | |
| 312 | @param map |
| 313 | The environment map to fill, must be non-@NULL. |
| 314 | @return |
| 315 | @true if environment was successfully retrieved or @false otherwise. |
| 316 | |
| 317 | @header{wx/utils.h} |
| 318 | |
| 319 | @since 2.9.2 |
| 320 | */ |
| 321 | bool wxGetEnvMap(wxEnvVariableHashMap *map); |
| 322 | //@} |
| 323 | |
| 324 | |
| 325 | |
| 326 | /** @addtogroup group_funcmacro_misc */ |
| 327 | //@{ |
| 328 | |
| 329 | /** |
| 330 | Returns battery state as one of @c wxBATTERY_NORMAL_STATE, |
| 331 | @c wxBATTERY_LOW_STATE, @c wxBATTERY_CRITICAL_STATE, |
| 332 | @c wxBATTERY_SHUTDOWN_STATE or @c wxBATTERY_UNKNOWN_STATE. |
| 333 | @c wxBATTERY_UNKNOWN_STATE is also the default on platforms where this |
| 334 | feature is not implemented (currently everywhere but MS Windows). |
| 335 | |
| 336 | @header{wx/utils.h} |
| 337 | */ |
| 338 | wxBatteryState wxGetBatteryState(); |
| 339 | |
| 340 | /** |
| 341 | Returns the type of power source as one of @c wxPOWER_SOCKET, |
| 342 | @c wxPOWER_BATTERY or @c wxPOWER_UNKNOWN. @c wxPOWER_UNKNOWN is also the |
| 343 | default on platforms where this feature is not implemented (currently |
| 344 | everywhere but MS Windows). |
| 345 | |
| 346 | @header{wx/utils.h} |
| 347 | */ |
| 348 | wxPowerType wxGetPowerType(); |
| 349 | |
| 350 | /** |
| 351 | Under X only, returns the current display name. |
| 352 | |
| 353 | @see wxSetDisplayName() |
| 354 | |
| 355 | @header{wx/utils.h} |
| 356 | */ |
| 357 | wxString wxGetDisplayName(); |
| 358 | |
| 359 | /** |
| 360 | For normal keys, returns @true if the specified key is currently down. |
| 361 | |
| 362 | For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns @true if |
| 363 | the key is toggled such that its LED indicator is lit. There is currently |
| 364 | no way to test whether togglable keys are up or down. |
| 365 | |
| 366 | Even though there are virtual key codes defined for mouse buttons, they |
| 367 | cannot be used with this function currently. |
| 368 | |
| 369 | @header{wx/utils.h} |
| 370 | */ |
| 371 | bool wxGetKeyState(wxKeyCode key); |
| 372 | |
| 373 | /** |
| 374 | Returns the mouse position in screen coordinates. |
| 375 | |
| 376 | @header{wx/utils.h} |
| 377 | */ |
| 378 | wxPoint wxGetMousePosition(); |
| 379 | |
| 380 | /** |
| 381 | Returns the current state of the mouse. Returns a wxMouseState instance |
| 382 | that contains the current position of the mouse pointer in screen |
| 383 | coordinates, as well as boolean values indicating the up/down status of the |
| 384 | mouse buttons and the modifier keys. |
| 385 | |
| 386 | @header{wx/utils.h} |
| 387 | */ |
| 388 | wxMouseState wxGetMouseState(); |
| 389 | |
| 390 | /** |
| 391 | This function enables or disables all top level windows. It is used by |
| 392 | wxSafeYield(). |
| 393 | |
| 394 | @header{wx/utils.h} |
| 395 | */ |
| 396 | void wxEnableTopLevelWindows(bool enable = true); |
| 397 | |
| 398 | /** |
| 399 | Find the deepest window at the given mouse position in screen coordinates, |
| 400 | returning the window if found, or @NULL if not. |
| 401 | |
| 402 | @header{wx/utils.h} |
| 403 | */ |
| 404 | wxWindow* wxFindWindowAtPoint(const wxPoint& pt); |
| 405 | |
| 406 | /** |
| 407 | @deprecated Replaced by wxWindow::FindWindowByLabel(). |
| 408 | |
| 409 | Find a window by its label. Depending on the type of window, the label may |
| 410 | be a window title or panel item label. If @a parent is @NULL, the search |
| 411 | will start from all top-level frames and dialog boxes; if non-@NULL, the |
| 412 | search will be limited to the given window hierarchy. The search is |
| 413 | recursive in both cases. |
| 414 | |
| 415 | @header{wx/utils.h} |
| 416 | */ |
| 417 | wxWindow* wxFindWindowByLabel(const wxString& label, |
| 418 | wxWindow* parent = NULL); |
| 419 | |
| 420 | /** |
| 421 | @deprecated Replaced by wxWindow::FindWindowByName(). |
| 422 | |
| 423 | Find a window by its name (as given in a window constructor or @e Create |
| 424 | function call). If @a parent is @NULL, the search will start from all |
| 425 | top-level frames and dialog boxes; if non-@NULL, the search will be limited |
| 426 | to the given window hierarchy. The search is recursive in both cases. |
| 427 | |
| 428 | If no such named window is found, wxFindWindowByLabel() is called. |
| 429 | |
| 430 | @header{wx/utils.h} |
| 431 | */ |
| 432 | wxWindow* wxFindWindowByName(const wxString& name, wxWindow* parent = NULL); |
| 433 | |
| 434 | /** |
| 435 | Find a menu item identifier associated with the given frame's menu bar. |
| 436 | |
| 437 | @header{wx/utils.h} |
| 438 | */ |
| 439 | int wxFindMenuItemId(wxFrame* frame, const wxString& menuString, |
| 440 | const wxString& itemString); |
| 441 | |
| 442 | /** |
| 443 | @deprecated Ids generated by it can conflict with the Ids defined by the |
| 444 | user code, use @c wxID_ANY to assign ids which are guaranteed |
| 445 | to not conflict with the user-defined ids for the controls and |
| 446 | menu items you create instead of using this function. |
| 447 | |
| 448 | Generates an integer identifier unique to this run of the program. |
| 449 | |
| 450 | @header{wx/utils.h} |
| 451 | */ |
| 452 | long wxNewId(); |
| 453 | |
| 454 | /** |
| 455 | Ensures that Ids subsequently generated by wxNewId() do not clash with the |
| 456 | given @a id. |
| 457 | |
| 458 | @header{wx/utils.h} |
| 459 | */ |
| 460 | void wxRegisterId(long id); |
| 461 | |
| 462 | /** |
| 463 | Opens the @a document in the application associated with the files of this |
| 464 | type. |
| 465 | |
| 466 | The @a flags parameter is currently not used |
| 467 | |
| 468 | Returns @true if the application was successfully launched. |
| 469 | |
| 470 | @see wxLaunchDefaultBrowser(), wxExecute() |
| 471 | |
| 472 | @header{wx/utils.h} |
| 473 | */ |
| 474 | bool wxLaunchDefaultApplication(const wxString& document, int flags = 0); |
| 475 | |
| 476 | /** |
| 477 | Opens the @a url in user's default browser. |
| 478 | |
| 479 | If the @a flags parameter contains @c wxBROWSER_NEW_WINDOW flag, a new |
| 480 | window is opened for the URL (currently this is only supported under |
| 481 | Windows). |
| 482 | |
| 483 | And unless the @a flags parameter contains @c wxBROWSER_NOBUSYCURSOR flag, |
| 484 | a busy cursor is shown while the browser is being launched (using |
| 485 | wxBusyCursor). |
| 486 | |
| 487 | The parameter @a url is interpreted as follows: |
| 488 | - if it has a valid scheme (e.g. @c "file:", @c "http:" or @c "mailto:") |
| 489 | it is passed to the appropriate browser configured in the user system. |
| 490 | - if it has no valid scheme (e.g. it's a local file path without the @c "file:" |
| 491 | prefix), then ::wxFileExists and ::wxDirExists are used to test if it's a |
| 492 | local file/directory; if it is, then the browser is called with the |
| 493 | @a url parameter eventually prefixed by @c "file:". |
| 494 | - if it has no valid scheme and it's not a local file/directory, then @c "http:" |
| 495 | is prepended and the browser is called. |
| 496 | |
| 497 | Returns @true if the application was successfully launched. |
| 498 | |
| 499 | @note For some configurations of the running user, the application which is |
| 500 | launched to open the given URL may be URL-dependent (e.g. a browser |
| 501 | may be used for local URLs while another one may be used for remote |
| 502 | URLs). |
| 503 | |
| 504 | @see wxLaunchDefaultApplication(), wxExecute() |
| 505 | |
| 506 | @header{wx/utils.h} |
| 507 | */ |
| 508 | bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); |
| 509 | |
| 510 | /** |
| 511 | Loads a user-defined Windows resource as a string. If the resource is |
| 512 | found, the function creates a new character array and copies the data into |
| 513 | it. A pointer to this data is returned. If unsuccessful, @NULL is returned. |
| 514 | |
| 515 | The resource must be defined in the @c .rc file using the following syntax: |
| 516 | |
| 517 | @code |
| 518 | myResource TEXT file.ext |
| 519 | @endcode |
| 520 | |
| 521 | Where @c file.ext is a file that the resource compiler can find. |
| 522 | |
| 523 | This function is available under Windows only. |
| 524 | |
| 525 | @header{wx/utils.h} |
| 526 | */ |
| 527 | wxString wxLoadUserResource(const wxString& resourceName, |
| 528 | const wxString& resourceType = "TEXT"); |
| 529 | |
| 530 | /** |
| 531 | @deprecated Replaced by wxWindow::Close(). See the |
| 532 | @ref overview_windowdeletion "window deletion overview". |
| 533 | |
| 534 | Tells the system to delete the specified object when all other events have |
| 535 | been processed. In some environments, it is necessary to use this instead |
| 536 | of deleting a frame directly with the delete operator, because some GUIs |
| 537 | will still send events to a deleted window. |
| 538 | |
| 539 | @header{wx/utils.h} |
| 540 | */ |
| 541 | void wxPostDelete(wxObject* object); |
| 542 | |
| 543 | |
| 544 | /** |
| 545 | Compare function type for use with wxQsort() |
| 546 | |
| 547 | @header{wx/utils.h} |
| 548 | */ |
| 549 | typedef int (*wxSortCallback)(const void* pItem1, const void* pItem2, const void* user_data); |
| 550 | |
| 551 | /** |
| 552 | Function implementing quick sort algorithm. |
| 553 | |
| 554 | This function sorts @a total_elems objects of size @a size located at @a |
| 555 | pbase. It uses @a cmp function for comparing them and passes @a user_data |
| 556 | pointer to the comparison function each time it's called. |
| 557 | |
| 558 | @header{wx/utils.h} |
| 559 | */ |
| 560 | void wxQsort(void* pbase, size_t total_elems, |
| 561 | size_t size, wxSortCallback cmp, const void* user_data); |
| 562 | |
| 563 | |
| 564 | /** |
| 565 | Under X only, sets the current display name. This is the X host and display |
| 566 | name such as "colonsay:0.0", and the function indicates which display |
| 567 | should be used for creating windows from this point on. Setting the display |
| 568 | within an application allows multiple displays to be used. |
| 569 | |
| 570 | @see wxGetDisplayName() |
| 571 | |
| 572 | @header{wx/utils.h} |
| 573 | */ |
| 574 | void wxSetDisplayName(const wxString& displayName); |
| 575 | |
| 576 | |
| 577 | /** |
| 578 | flags for wxStripMenuCodes |
| 579 | */ |
| 580 | enum |
| 581 | { |
| 582 | // strip '&' characters |
| 583 | wxStrip_Mnemonics = 1, |
| 584 | |
| 585 | // strip everything after '\t' |
| 586 | wxStrip_Accel = 2, |
| 587 | |
| 588 | // strip everything (this is the default) |
| 589 | wxStrip_All = wxStrip_Mnemonics | wxStrip_Accel |
| 590 | }; |
| 591 | |
| 592 | /** |
| 593 | Strips any menu codes from @a str and returns the result. |
| 594 | |
| 595 | By default, the functions strips both the mnemonics character (@c '&') |
| 596 | which is used to indicate a keyboard shortkey, and the accelerators, which |
| 597 | are used only in the menu items and are separated from the main text by the |
| 598 | @c \\t (TAB) character. By using @a flags of @c wxStrip_Mnemonics or |
| 599 | @c wxStrip_Accel to strip only the former or the latter part, respectively. |
| 600 | |
| 601 | Notice that in most cases wxMenuItem::GetLabelFromText() or |
| 602 | wxControl::GetLabelText() can be used instead. |
| 603 | |
| 604 | @header{wx/utils.h} |
| 605 | */ |
| 606 | wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); |
| 607 | |
| 608 | //@} |
| 609 | |
| 610 | |
| 611 | |
| 612 | /** @addtogroup group_funcmacro_networkuseros */ |
| 613 | //@{ |
| 614 | |
| 615 | /** |
| 616 | Copies the user's email address into the supplied buffer, by concatenating |
| 617 | the values returned by wxGetFullHostName() and wxGetUserId(). |
| 618 | |
| 619 | @return @true if successful, @false otherwise. |
| 620 | |
| 621 | @header{wx/utils.h} |
| 622 | */ |
| 623 | wxString wxGetEmailAddress(); |
| 624 | |
| 625 | /** |
| 626 | @deprecated Use wxGetEmailAddress() instead. |
| 627 | |
| 628 | @param buf Buffer to store the email address in. |
| 629 | @param sz Size of the buffer. |
| 630 | |
| 631 | @return @true if successful, @false otherwise. |
| 632 | |
| 633 | @header{wx/utils.h} |
| 634 | */ |
| 635 | bool wxGetEmailAddress(char* buf, int sz); |
| 636 | |
| 637 | /** |
| 638 | Returns the amount of free memory in bytes under environments which support |
| 639 | it, and -1 if not supported or failed to perform measurement. |
| 640 | |
| 641 | @header{wx/utils.h} |
| 642 | */ |
| 643 | wxMemorySize wxGetFreeMemory(); |
| 644 | |
| 645 | /** |
| 646 | Return the (current) user's home directory. |
| 647 | |
| 648 | @see wxGetUserHome(), wxStandardPaths |
| 649 | |
| 650 | @header{wx/utils.h} |
| 651 | */ |
| 652 | wxString wxGetHomeDir(); |
| 653 | |
| 654 | /** |
| 655 | Copies the current host machine's name into the supplied buffer. Please |
| 656 | note that the returned name is @e not fully qualified, i.e. it does not |
| 657 | include the domain name. |
| 658 | |
| 659 | Under Windows or NT, this function first looks in the environment variable |
| 660 | SYSTEM_NAME; if this is not found, the entry @b HostName in the wxWidgets |
| 661 | section of the WIN.INI file is tried. |
| 662 | |
| 663 | @return The hostname if successful or an empty string otherwise. |
| 664 | |
| 665 | @see wxGetFullHostName() |
| 666 | |
| 667 | @header{wx/utils.h} |
| 668 | */ |
| 669 | wxString wxGetHostName(); |
| 670 | |
| 671 | /** |
| 672 | @deprecated Use wxGetHostName() instead. |
| 673 | |
| 674 | @param buf Buffer to store the host name in. |
| 675 | @param sz Size of the buffer. |
| 676 | |
| 677 | @return @true if successful, @false otherwise. |
| 678 | |
| 679 | @header{wx/utils.h} |
| 680 | */ |
| 681 | bool wxGetHostName(char* buf, int sz); |
| 682 | |
| 683 | /** |
| 684 | Returns the FQDN (fully qualified domain host name) or an empty string on |
| 685 | error. |
| 686 | |
| 687 | @see wxGetHostName() |
| 688 | |
| 689 | @header{wx/utils.h} |
| 690 | */ |
| 691 | wxString wxGetFullHostName(); |
| 692 | |
| 693 | /** |
| 694 | Returns the home directory for the given user. If the @a user is empty |
| 695 | (default value), this function behaves like wxGetHomeDir() (i.e. returns |
| 696 | the current user home directory). |
| 697 | |
| 698 | If the home directory couldn't be determined, an empty string is returned. |
| 699 | |
| 700 | @header{wx/utils.h} |
| 701 | */ |
| 702 | wxString wxGetUserHome(const wxString& user = wxEmptyString); |
| 703 | |
| 704 | /** |
| 705 | This function returns the "user id" also known as "login name" under Unix |
| 706 | (i.e. something like "jsmith"). It uniquely identifies the current user (on |
| 707 | this system). Under Windows or NT, this function first looks in the |
| 708 | environment variables USER and LOGNAME; if neither of these is found, the |
| 709 | entry @b UserId in the @b wxWidgets section of the WIN.INI file is tried. |
| 710 | |
| 711 | @return The login name if successful or an empty string otherwise. |
| 712 | |
| 713 | @see wxGetUserName() |
| 714 | |
| 715 | @header{wx/utils.h} |
| 716 | */ |
| 717 | wxString wxGetUserId(); |
| 718 | |
| 719 | /** |
| 720 | @deprecated Use wxGetUserId() instead. |
| 721 | |
| 722 | @param buf Buffer to store the login name in. |
| 723 | @param sz Size of the buffer. |
| 724 | |
| 725 | @return @true if successful, @false otherwise. |
| 726 | |
| 727 | @header{wx/utils.h} |
| 728 | */ |
| 729 | bool wxGetUserId(char* buf, int sz); |
| 730 | |
| 731 | /** |
| 732 | This function returns the full user name (something like "Mr. John Smith"). |
| 733 | |
| 734 | Under Windows or NT, this function looks for the entry UserName in the |
| 735 | wxWidgets section of the WIN.INI file. If PenWindows is running, the entry |
| 736 | Current in the section User of the PENWIN.INI file is used. |
| 737 | |
| 738 | @return The full user name if successful or an empty string otherwise. |
| 739 | |
| 740 | @see wxGetUserId() |
| 741 | |
| 742 | @header{wx/utils.h} |
| 743 | */ |
| 744 | wxString wxGetUserName(); |
| 745 | |
| 746 | /** |
| 747 | @deprecated Use wxGetUserName() instead. |
| 748 | |
| 749 | @param buf Buffer to store the full user name in. |
| 750 | @param sz Size of the buffer. |
| 751 | |
| 752 | @return @true if successful, @false otherwise. |
| 753 | |
| 754 | @header{wx/utils.h} |
| 755 | */ |
| 756 | bool wxGetUserName(char* buf, int sz); |
| 757 | |
| 758 | /** |
| 759 | Returns the string containing the description of the current platform in a |
| 760 | user-readable form. For example, this function may return strings like |
| 761 | "Windows NT Version 4.0" or "Linux 2.2.2 i386". |
| 762 | |
| 763 | @see wxGetOsVersion() |
| 764 | |
| 765 | @header{wx/utils.h} |
| 766 | */ |
| 767 | wxString wxGetOsDescription(); |
| 768 | |
| 769 | /** |
| 770 | Gets the version and the operating system ID for currently running OS. |
| 771 | The returned wxOperatingSystemId value can be used for a basic categorization |
| 772 | of the OS family; the major and minor version numbers allows to detect a specific |
| 773 | system. |
| 774 | |
| 775 | For Unix-like systems (@c wxOS_UNIX) the major and minor version integers will |
| 776 | contain the kernel major and minor version numbers (as returned by the |
| 777 | 'uname -r' command); e.g. "2" and "6" if the machine is using kernel 2.6.19. |
| 778 | |
| 779 | For Mac OS X systems (@c wxOS_MAC) the major and minor version integers are the |
| 780 | natural version numbers associated with the OS; e.g. "10" and "6" if the machine |
| 781 | is using Mac OS X Snow Leopard. |
| 782 | |
| 783 | For Windows-like systems (@c wxOS_WINDOWS) the major and minor version integers will |
| 784 | contain the following values: |
| 785 | @beginTable |
| 786 | @row3col{<b>Windows OS name</b>, <b>Major version</b>, <b>Minor version</b>} |
| 787 | @row3col{Windows 7, 6, 1} |
| 788 | @row3col{Windows Server 2008 R2, 6, 1} |
| 789 | @row3col{Windows Server 2008, 6, 0} |
| 790 | @row3col{Windows Vista, 6, 0} |
| 791 | @row3col{Windows Server 2003 R2, 5, 2} |
| 792 | @row3col{Windows Server 2003, 5, 2} |
| 793 | @row3col{Windows XP, 5, 1} |
| 794 | @row3col{Windows 2000, 5, 0} |
| 795 | @endDefList |
| 796 | See the <a href="http://msdn.microsoft.com/en-us/library/ms724832(VS.85).aspx">MSDN</a> |
| 797 | for more info about the values above. |
| 798 | |
| 799 | @see wxGetOsDescription(), wxPlatformInfo |
| 800 | |
| 801 | @header{wx/utils.h} |
| 802 | */ |
| 803 | wxOperatingSystemId wxGetOsVersion(int* major = NULL, int* minor = NULL); |
| 804 | |
| 805 | /** |
| 806 | Returns @true if the operating system the program is running under is 64 |
| 807 | bit. The check is performed at run-time and may differ from the value |
| 808 | available at compile-time (at compile-time you can just check if |
| 809 | <tt>sizeof(void*) == 8</tt>) since the program could be running in |
| 810 | emulation mode or in a mixed 32/64 bit system (bi-architecture operating |
| 811 | system). |
| 812 | |
| 813 | @note This function is not 100% reliable on some systems given the fact |
| 814 | that there isn't always a standard way to do a reliable check on the |
| 815 | OS architecture. |
| 816 | |
| 817 | @header{wx/utils.h} |
| 818 | */ |
| 819 | bool wxIsPlatform64Bit(); |
| 820 | |
| 821 | /** |
| 822 | Returns @true if the current platform is little endian (instead of big |
| 823 | endian). The check is performed at run-time. |
| 824 | |
| 825 | @see @ref group_funcmacro_byteorder "Byte Order Functions and Macros" |
| 826 | |
| 827 | @header{wx/utils.h} |
| 828 | */ |
| 829 | bool wxIsPlatformLittleEndian(); |
| 830 | |
| 831 | /** |
| 832 | Returns a structure containing informations about the currently running |
| 833 | Linux distribution. |
| 834 | |
| 835 | This function uses the @c lsb_release utility which is part of the |
| 836 | <tt>Linux Standard Base Core</tt> specification |
| 837 | (see http://refspecs.linux-foundation.org/lsb.shtml) since the very first LSB |
| 838 | release 1.0 (released in 2001). |
| 839 | The @c lsb_release utility is very common on modern Linux distributions but in |
| 840 | case it's not available, then this function will return a ::wxLinuxDistributionInfo |
| 841 | structure containing empty strings. |
| 842 | |
| 843 | This function is Linux-specific and is only available when the @c __LINUX__ |
| 844 | symbol is defined. |
| 845 | */ |
| 846 | wxLinuxDistributionInfo wxGetLinuxDistributionInfo(); |
| 847 | |
| 848 | //@} |
| 849 | |
| 850 | |
| 851 | |
| 852 | /** @addtogroup group_funcmacro_procctrl */ |
| 853 | //@{ |
| 854 | |
| 855 | /** |
| 856 | @struct wxExecuteEnv |
| 857 | |
| 858 | This structure can optionally be passed to wxExecute() to specify |
| 859 | additional options to use for the child process. |
| 860 | |
| 861 | @since 2.9.2 |
| 862 | |
| 863 | @header{wx/utils.h} |
| 864 | */ |
| 865 | struct wxExecuteEnv |
| 866 | { |
| 867 | /** |
| 868 | The initial working directory for the new process. |
| 869 | |
| 870 | If this field is empty, the current working directory of this process |
| 871 | is used. |
| 872 | */ |
| 873 | wxString cwd; |
| 874 | |
| 875 | /** |
| 876 | The environment variable map. |
| 877 | |
| 878 | If the map is empty, the environment variables of the current process |
| 879 | are also used for the child one, otherwise only the variables defined |
| 880 | in this map are used. |
| 881 | */ |
| 882 | wxEnvVariableHashMap env; |
| 883 | }; |
| 884 | |
| 885 | /** |
| 886 | Bit flags that can be used with wxExecute(). |
| 887 | */ |
| 888 | enum |
| 889 | { |
| 890 | /** |
| 891 | Execute the process asynchronously. |
| 892 | |
| 893 | Notice that, due to its value, this is the default. |
| 894 | */ |
| 895 | wxEXEC_ASYNC = 0, |
| 896 | |
| 897 | /** |
| 898 | Execute the process synchronously. |
| 899 | */ |
| 900 | wxEXEC_SYNC = 1, |
| 901 | |
| 902 | /** |
| 903 | Always show the child process console under MSW. |
| 904 | |
| 905 | The child console is hidden by default if the child IO is redirected, |
| 906 | this flag allows to change this and show it nevertheless. |
| 907 | |
| 908 | This flag is ignored under the other platforms. |
| 909 | */ |
| 910 | wxEXEC_SHOW_CONSOLE = 2, |
| 911 | |
| 912 | /** |
| 913 | Make the new process a group leader. |
| 914 | |
| 915 | Under Unix, if the process is the group leader then passing |
| 916 | wxKILL_CHILDREN to wxKill() kills all children as well as pid. |
| 917 | |
| 918 | Under MSW, applies only to console applications and is only supported |
| 919 | under NT family (i.e. not under Windows 9x). It corresponds to the |
| 920 | native @c CREATE_NEW_PROCESS_GROUP and, in particular, ensures that |
| 921 | Ctrl-Break signals will be sent to all children of this process as well |
| 922 | to the process itself. Support for this flag under MSW was added in |
| 923 | version 2.9.4 of wxWidgets. |
| 924 | */ |
| 925 | wxEXEC_MAKE_GROUP_LEADER = 4, |
| 926 | |
| 927 | /** |
| 928 | Don't disable the program UI while running the child synchronously. |
| 929 | |
| 930 | By default synchronous execution disables all program windows to avoid |
| 931 | that the user interacts with the program while the child process is |
| 932 | running, you can use this flag to prevent this from happening. |
| 933 | |
| 934 | This flag can only be used with ::wxEXEC_SYNC. |
| 935 | */ |
| 936 | wxEXEC_NODISABLE = 8, |
| 937 | |
| 938 | /** |
| 939 | Don't dispatch events while the child process is executed. |
| 940 | |
| 941 | By default, the event loop is run while waiting for synchronous |
| 942 | execution to complete and this flag can be used to simply block the |
| 943 | main process until the child process finishes |
| 944 | |
| 945 | This flag can only be used with ::wxEXEC_SYNC. |
| 946 | */ |
| 947 | wxEXEC_NOEVENTS = 16, |
| 948 | |
| 949 | /** |
| 950 | Hide child process console under MSW. |
| 951 | |
| 952 | Under MSW, hide the console of the child process if it has one, |
| 953 | even if its IO is not redirected. |
| 954 | |
| 955 | This flag is ignored under the other platforms. |
| 956 | */ |
| 957 | wxEXEC_HIDE_CONSOLE = 32, |
| 958 | |
| 959 | /** |
| 960 | Convenient synonym for flags given system()-like behaviour. |
| 961 | */ |
| 962 | wxEXEC_BLOCK = wxEXEC_SYNC | wxEXEC_NOEVENTS |
| 963 | }; |
| 964 | /** |
| 965 | Executes another program in Unix or Windows. |
| 966 | |
| 967 | In the overloaded versions of this function, if @a flags parameter contains |
| 968 | @c wxEXEC_ASYNC flag (the default), flow of control immediately returns. If |
| 969 | it contains @c wxEXEC_SYNC, the current application waits until the other |
| 970 | program has terminated. |
| 971 | |
| 972 | In the case of synchronous execution, the return value is the exit code of |
| 973 | the process (which terminates by the moment the function returns) and will |
| 974 | be -1 if the process couldn't be started and typically 0 if the process |
| 975 | terminated successfully. Also, while waiting for the process to terminate, |
| 976 | wxExecute() will call wxYield(). Because of this, by default this function |
| 977 | disables all application windows to avoid unexpected reentrancies which |
| 978 | could result from the users interaction with the program while the child |
| 979 | process is running. If you are sure that it is safe to not disable the |
| 980 | program windows, you may pass @c wxEXEC_NODISABLE flag to prevent this |
| 981 | automatic disabling from happening. |
| 982 | |
| 983 | For asynchronous execution, however, the return value is the process id and |
| 984 | zero value indicates that the command could not be executed. As an added |
| 985 | complication, the return value of -1 in this case indicates that we didn't |
| 986 | launch a new process, but connected to the running one (this can only |
| 987 | happen when using DDE under Windows for command execution). In particular, |
| 988 | in this case only, the calling code will not get the notification about |
| 989 | process termination. |
| 990 | |
| 991 | If @a callback isn't @NULL and if execution is asynchronous, |
| 992 | wxProcess::OnTerminate() will be called when the process finishes. |
| 993 | Specifying this parameter also allows you to redirect the standard input |
| 994 | and/or output of the process being launched by calling |
| 995 | wxProcess::Redirect(). |
| 996 | |
| 997 | Under Windows, when launching a console process its console is shown by |
| 998 | default but hidden if its IO is redirected. Both of these default |
| 999 | behaviours may be overridden: if ::wxEXEC_HIDE_CONSOLE is specified, the |
| 1000 | console will never be shown. If ::wxEXEC_SHOW_CONSOLE is used, the console |
| 1001 | will be shown even if the child process IO is redirected. Neither of these |
| 1002 | flags affect non-console Windows applications or does anything under the |
| 1003 | other systems. |
| 1004 | |
| 1005 | Under Unix the flag @c wxEXEC_MAKE_GROUP_LEADER may be used to ensure that |
| 1006 | the new process is a group leader (this will create a new session if |
| 1007 | needed). Calling wxKill() passing wxKILL_CHILDREN will kill this process as |
| 1008 | well as all of its children (except those which have started their own |
| 1009 | session). Under MSW, this flag can be used with console processes only and |
| 1010 | corresponds to the native @c CREATE_NEW_PROCESS_GROUP flag. |
| 1011 | |
| 1012 | The @c wxEXEC_NOEVENTS flag prevents processing of any events from taking |
| 1013 | place while the child process is running. It should be only used for very |
| 1014 | short-lived processes as otherwise the application windows risk becoming |
| 1015 | unresponsive from the users point of view. As this flag only makes sense |
| 1016 | with @c wxEXEC_SYNC, @c wxEXEC_BLOCK equal to the sum of both of these |
| 1017 | flags is provided as a convenience. |
| 1018 | |
| 1019 | @note Currently wxExecute() can only be used from the main thread, calling |
| 1020 | this function from another thread will result in an assert failure in |
| 1021 | debug build and won't work. |
| 1022 | |
| 1023 | @param command |
| 1024 | The command to execute and any parameters to pass to it as a single |
| 1025 | string, i.e. "emacs file.txt". |
| 1026 | @param flags |
| 1027 | Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include |
| 1028 | wxEXEC_SHOW_CONSOLE, wxEXEC_HIDE_CONSOLE, wxEXEC_MAKE_GROUP_LEADER (in |
| 1029 | either case) or wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, |
| 1030 | which is equal to their combination, in wxEXEC_SYNC case. |
| 1031 | @param callback |
| 1032 | An optional pointer to wxProcess. |
| 1033 | @param env |
| 1034 | An optional pointer to additional parameters for the child process, |
| 1035 | such as its initial working directory and environment variables. This |
| 1036 | parameter is available in wxWidgets 2.9.2 and later only. |
| 1037 | |
| 1038 | @see wxShell(), wxProcess, @ref page_samples_exec, |
| 1039 | wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() |
| 1040 | |
| 1041 | @header{wx/utils.h} |
| 1042 | |
| 1043 | @beginWxPerlOnly |
| 1044 | In wxPerl this function is called @c Wx::ExecuteCommand. |
| 1045 | @endWxPerlOnly |
| 1046 | */ |
| 1047 | long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, |
| 1048 | wxProcess* callback = NULL, |
| 1049 | const wxExecuteEnv* env = NULL); |
| 1050 | //@} |
| 1051 | |
| 1052 | /** @addtogroup group_funcmacro_procctrl */ |
| 1053 | //@{ |
| 1054 | /** |
| 1055 | This is an overloaded version of wxExecute(const wxString&,int,wxProcess*), |
| 1056 | please see its documentation for general information. |
| 1057 | |
| 1058 | This version takes an array of values: a command, any number of arguments, |
| 1059 | terminated by @NULL. |
| 1060 | |
| 1061 | @param argv |
| 1062 | The command to execute should be the first element of this array, any |
| 1063 | additional ones are the command parameters and the array must be |
| 1064 | terminated with a @NULL pointer. |
| 1065 | @param flags |
| 1066 | Same as for wxExecute(const wxString&,int,wxProcess*) overload. |
| 1067 | @param callback |
| 1068 | An optional pointer to wxProcess. |
| 1069 | @param env |
| 1070 | An optional pointer to additional parameters for the child process, |
| 1071 | such as its initial working directory and environment variables. This |
| 1072 | parameter is available in wxWidgets 2.9.2 and later only. |
| 1073 | |
| 1074 | @see wxShell(), wxProcess, @ref page_samples_exec, |
| 1075 | wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() |
| 1076 | |
| 1077 | @header{wx/utils.h} |
| 1078 | |
| 1079 | @beginWxPerlOnly |
| 1080 | In wxPerl this function is called @c Wx::ExecuteArgs. |
| 1081 | @endWxPerlOnly |
| 1082 | */ |
| 1083 | long wxExecute(char** argv, int flags = wxEXEC_ASYNC, |
| 1084 | wxProcess* callback = NULL, |
| 1085 | const wxExecuteEnv *env = NULL); |
| 1086 | long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC, |
| 1087 | wxProcess* callback = NULL, |
| 1088 | const wxExecuteEnv *env = NULL); |
| 1089 | //@} |
| 1090 | |
| 1091 | /** @addtogroup group_funcmacro_procctrl */ |
| 1092 | //@{ |
| 1093 | |
| 1094 | /** |
| 1095 | This is an overloaded version of wxExecute(const wxString&,int,wxProcess*), |
| 1096 | please see its documentation for general information. |
| 1097 | |
| 1098 | This version can be used to execute a process (always synchronously, the |
| 1099 | contents of @a flags is or'd with @c wxEXEC_SYNC) and capture its output in |
| 1100 | the array @e output. |
| 1101 | |
| 1102 | @param command |
| 1103 | The command to execute and any parameters to pass to it as a single |
| 1104 | string. |
| 1105 | @param output |
| 1106 | The string array where the stdout of the executed process is saved. |
| 1107 | @param flags |
| 1108 | Combination of flags to which ::wxEXEC_SYNC is always implicitly added. |
| 1109 | @param env |
| 1110 | An optional pointer to additional parameters for the child process, |
| 1111 | such as its initial working directory and environment variables. This |
| 1112 | parameter is available in wxWidgets 2.9.2 and later only. |
| 1113 | |
| 1114 | @see wxShell(), wxProcess, @ref page_samples_exec, |
| 1115 | wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() |
| 1116 | |
| 1117 | @header{wx/utils.h} |
| 1118 | |
| 1119 | @beginWxPerlOnly |
| 1120 | This function is called @c Wx::ExecuteStdout: it only takes the |
| 1121 | @a command argument, and returns a 2-element list (@c status, @c output), |
| 1122 | where @c output in an array reference. |
| 1123 | @endWxPerlOnly |
| 1124 | */ |
| 1125 | long wxExecute(const wxString& command, wxArrayString& output, int flags = 0, |
| 1126 | const wxExecuteEnv *env = NULL); |
| 1127 | |
| 1128 | /** |
| 1129 | This is an overloaded version of wxExecute(const wxString&,int,wxProcess*), |
| 1130 | please see its documentation for general information. |
| 1131 | |
| 1132 | This version adds the possibility to additionally capture the messages from |
| 1133 | standard error output in the @a errors array. As with the above overload |
| 1134 | capturing standard output only, execution is always synchronous. |
| 1135 | |
| 1136 | @param command |
| 1137 | The command to execute and any parameters to pass to it as a single |
| 1138 | string. |
| 1139 | @param output |
| 1140 | The string array where the stdout of the executed process is saved. |
| 1141 | @param errors |
| 1142 | The string array where the stderr of the executed process is saved. |
| 1143 | @param flags |
| 1144 | Combination of flags to which ::wxEXEC_SYNC is always implicitly added. |
| 1145 | @param env |
| 1146 | An optional pointer to additional parameters for the child process, |
| 1147 | such as its initial working directory and environment variables. This |
| 1148 | parameter is available in wxWidgets 2.9.2 and later only. |
| 1149 | |
| 1150 | @see wxShell(), wxProcess, @ref page_samples_exec, |
| 1151 | wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() |
| 1152 | |
| 1153 | @header{wx/utils.h} |
| 1154 | |
| 1155 | @beginWxPerlOnly |
| 1156 | This function is called @c Wx::ExecuteStdoutStderr: it only takes the |
| 1157 | @a command argument, and returns a 3-element list (@c status, @c output, |
| 1158 | @c errors), where @c output and @c errors are array references. |
| 1159 | @endWxPerlOnly |
| 1160 | */ |
| 1161 | long wxExecute(const wxString& command, wxArrayString& output, |
| 1162 | wxArrayString& errors, int flags = 0, |
| 1163 | const wxExecuteEnv *env = NULL); |
| 1164 | |
| 1165 | /** |
| 1166 | Returns the number uniquely identifying the current process in the system. |
| 1167 | If an error occurs, 0 is returned. |
| 1168 | |
| 1169 | @header{wx/utils.h} |
| 1170 | */ |
| 1171 | unsigned long wxGetProcessId(); |
| 1172 | |
| 1173 | /** |
| 1174 | Equivalent to the Unix kill function: send the given signal @a sig to the |
| 1175 | process with PID @a pid. |
| 1176 | |
| 1177 | The valid signal values are: |
| 1178 | |
| 1179 | @code |
| 1180 | enum wxSignal |
| 1181 | { |
| 1182 | wxSIGNONE = 0, // verify if the process exists under Unix |
| 1183 | wxSIGHUP, |
| 1184 | wxSIGINT, |
| 1185 | wxSIGQUIT, |
| 1186 | wxSIGILL, |
| 1187 | wxSIGTRAP, |
| 1188 | wxSIGABRT, |
| 1189 | wxSIGEMT, |
| 1190 | wxSIGFPE, |
| 1191 | wxSIGKILL, // forcefully kill, dangerous! |
| 1192 | wxSIGBUS, |
| 1193 | wxSIGSEGV, |
| 1194 | wxSIGSYS, |
| 1195 | wxSIGPIPE, |
| 1196 | wxSIGALRM, |
| 1197 | wxSIGTERM // terminate the process gently |
| 1198 | }; |
| 1199 | @endcode |
| 1200 | |
| 1201 | @c wxSIGNONE, @c wxSIGKILL and @c wxSIGTERM have the same meaning under |
| 1202 | both Unix and Windows but all the other signals are equivalent to |
| 1203 | @c wxSIGTERM under Windows. |
| 1204 | |
| 1205 | Returns 0 on success, -1 on failure. If the @a rc parameter is not @NULL, |
| 1206 | it will be filled with a value from the @c wxKillError enum: |
| 1207 | |
| 1208 | @code |
| 1209 | enum wxKillError |
| 1210 | { |
| 1211 | wxKILL_OK, // no error |
| 1212 | wxKILL_BAD_SIGNAL, // no such signal |
| 1213 | wxKILL_ACCESS_DENIED, // permission denied |
| 1214 | wxKILL_NO_PROCESS, // no such process |
| 1215 | wxKILL_ERROR // another, unspecified error |
| 1216 | }; |
| 1217 | @endcode |
| 1218 | |
| 1219 | The @a flags parameter can be wxKILL_NOCHILDREN (the default), or |
| 1220 | wxKILL_CHILDREN, in which case the child processes of this process will be |
| 1221 | killed too. Note that under Unix, for wxKILL_CHILDREN to work you should |
| 1222 | have created the process by passing wxEXEC_MAKE_GROUP_LEADER to |
| 1223 | wxExecute(). |
| 1224 | |
| 1225 | @see wxProcess::Kill(), wxProcess::Exists(), @ref page_samples_exec |
| 1226 | |
| 1227 | @header{wx/utils.h} |
| 1228 | */ |
| 1229 | int wxKill(long pid, wxSignal sig = wxSIGTERM, |
| 1230 | wxKillError* rc = NULL, int flags = wxKILL_NOCHILDREN); |
| 1231 | |
| 1232 | /** |
| 1233 | Executes a command in an interactive shell window. If no command is |
| 1234 | specified, then just the shell is spawned. |
| 1235 | |
| 1236 | @see wxExecute(), @ref page_samples_exec |
| 1237 | |
| 1238 | @header{wx/utils.h} |
| 1239 | */ |
| 1240 | bool wxShell(const wxString& command = wxEmptyString); |
| 1241 | |
| 1242 | /** |
| 1243 | This function shuts down or reboots the computer depending on the value of |
| 1244 | the @a flags. |
| 1245 | |
| 1246 | @note Note that performing the shutdown requires the corresponding access |
| 1247 | rights (superuser under Unix, SE_SHUTDOWN privilege under Windows NT) |
| 1248 | and that this function is only implemented under Unix and MSW. |
| 1249 | |
| 1250 | @param flags |
| 1251 | One of @c wxSHUTDOWN_POWEROFF, @c wxSHUTDOWN_REBOOT or |
| 1252 | @c wxSHUTDOWN_LOGOFF (currently implemented only for MSW) possibly |
| 1253 | combined with @c wxSHUTDOWN_FORCE which forces shutdown under MSW by |
| 1254 | forcefully terminating all the applications. As doing this can result |
| 1255 | in a data loss, this flag shouldn't be used unless really necessary. |
| 1256 | |
| 1257 | @return @true on success, @false if an error occurred. |
| 1258 | |
| 1259 | @header{wx/utils.h} |
| 1260 | */ |
| 1261 | bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF); |
| 1262 | |
| 1263 | //@} |
| 1264 | |
| 1265 | |
| 1266 | |
| 1267 | /** @addtogroup group_funcmacro_time */ |
| 1268 | //@{ |
| 1269 | |
| 1270 | /** |
| 1271 | Sleeps for the specified number of microseconds. The microsecond resolution |
| 1272 | may not, in fact, be available on all platforms (currently only Unix |
| 1273 | platforms with nanosleep(2) may provide it) in which case this is the same |
| 1274 | as calling wxMilliSleep() with the argument of @e microseconds/1000. |
| 1275 | |
| 1276 | @header{wx/utils.h} |
| 1277 | */ |
| 1278 | void wxMicroSleep(unsigned long microseconds); |
| 1279 | |
| 1280 | /** |
| 1281 | Sleeps for the specified number of milliseconds. Notice that usage of this |
| 1282 | function is encouraged instead of calling usleep(3) directly because the |
| 1283 | standard @e usleep() function is not MT safe. |
| 1284 | |
| 1285 | @header{wx/utils.h} |
| 1286 | */ |
| 1287 | void wxMilliSleep(unsigned long milliseconds); |
| 1288 | |
| 1289 | /** |
| 1290 | Returns a string representing the current date and time. |
| 1291 | |
| 1292 | @header{wx/utils.h} |
| 1293 | */ |
| 1294 | wxString wxNow(); |
| 1295 | |
| 1296 | /** |
| 1297 | Sleeps for the specified number of seconds. |
| 1298 | |
| 1299 | @header{wx/utils.h} |
| 1300 | */ |
| 1301 | void wxSleep(int secs); |
| 1302 | |
| 1303 | /** |
| 1304 | @deprecated This function is deprecated because its name is misleading: |
| 1305 | notice that the argument is in milliseconds, not microseconds. |
| 1306 | Please use either wxMilliSleep() or wxMicroSleep() depending on |
| 1307 | the resolution you need. |
| 1308 | |
| 1309 | Sleeps for the specified number of milliseconds. |
| 1310 | |
| 1311 | @header{wx/utils.h} |
| 1312 | */ |
| 1313 | void wxUsleep(unsigned long milliseconds); |
| 1314 | |
| 1315 | //@} |
| 1316 | |