X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cd6ce4a90c11b54cc00799d0e4611d858739a749..594f0f5bf1355fb8d58f403d3ebacc1c1767c429:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 8be9b245f3..a737731cac 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -25,6 +25,10 @@ #include "wx/list.h" #include "wx/filefn.h" +// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare +// wxLongLong +#include "wx/longlong.h" + #ifdef __X__ #include #include @@ -40,12 +44,7 @@ class WXDLLEXPORT wxProcess; class WXDLLEXPORT wxFrame; class WXDLLEXPORT wxWindow; class WXDLLEXPORT wxWindowList; - -// FIXME should use wxStricmp() instead -#if defined(__GNUWIN32__) - #define stricmp strcasecmp - #define strnicmp strncasecmp -#endif +class WXDLLEXPORT wxPoint; // ---------------------------------------------------------------------------- // Macros @@ -58,7 +57,7 @@ class WXDLLEXPORT wxWindowList; // String functions (deprecated, use wxString) // ---------------------------------------------------------------------------- -// Useful buffer (FIXME VZ: yeah, that is. To be removed!) +// Useful buffer (FIXME VZ: To be removed!!!) WXDLLEXPORT_DATA(extern wxChar*) wxBuffer; // Make a copy of this string using 'new' @@ -87,6 +86,10 @@ WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL, // Return a string with the current date/time WXDLLEXPORT wxString wxNow(); +// Return path where wxWindows is installed (mostly useful in Unices) +WXDLLEXPORT const wxChar *wxGetInstallPrefix(); + + #if wxUSE_GUI // Don't synthesize KeyUp events holding down a key and producing // KeyDown events with autorepeat. On by default and always on @@ -148,7 +151,13 @@ WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE, wxProcess *process = (wxProcess *) NULL); // execute the command capturing its output into an array line by line -WXDLLEXPORT long wxExecute(const wxString& command, wxArrayString& output); +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output); + +// also capture stderr +WXDLLEXPORT long wxExecute(const wxString& command, + wxArrayString& output, + wxArrayString& error); enum wxSignal { @@ -173,13 +182,31 @@ enum wxSignal // further signals are different in meaning between different Unix systems }; -// the argument is ignored under Windows - the process is always killed -WXDLLEXPORT int wxKill(long pid, wxSignal sig = wxSIGTERM); +enum wxKillError +{ + wxKILL_OK, // no error + wxKILL_BAD_SIGNAL, // no such signal + wxKILL_ACCESS_DENIED, // permission denied + wxKILL_NO_PROCESS, // no such process + wxKILL_ERROR // another, unspecified error +}; + +// send the given signal to the process (only NONE and KILL are supported under +// Windows, all others mean TERM), return 0 if ok and -1 on error +// +// return detailed error in rc if not NULL +WXDLLEXPORT int wxKill(long pid, + wxSignal sig = wxSIGTERM, + wxKillError *rc = NULL); -// Execute a command in an interactive shell window +// Execute a command in an interactive shell window (always synchronously) // If no command then just the shell WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString); +// As wxShell(), but must give a (non interactive) command and its output will +// be returned in output array +WXDLLEXPORT bool wxShell(const wxString& command, wxArrayString& output); + // Sleep for nSecs seconds WXDLLEXPORT void wxSleep(int nSecs); @@ -189,6 +216,23 @@ WXDLLEXPORT void wxUsleep(unsigned long milliseconds); // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) WXDLLEXPORT long wxGetFreeMemory(); +// should wxApp::OnFatalException() be called? +WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE); + +// ---------------------------------------------------------------------------- +// Environment variables +// ---------------------------------------------------------------------------- + +// returns TRUE if variable exists (value may be NULL if you just want to check +// for this) +WXDLLEXPORT bool wxGetEnv(const wxString& var, wxString *value); + +// set the env var name to the given value, return TRUE on success +WXDLLEXPORT bool wxSetEnv(const wxString& var, const wxChar *value); + +// remove the env var from environment +inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); } + // ---------------------------------------------------------------------------- // Network and username functions. // ---------------------------------------------------------------------------- @@ -227,6 +271,17 @@ WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString) WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString); #endif +#ifdef __WXMAC__ +WXDLLEXPORT wxString wxMacFindFolder(short vRefNum, + OSType folderType, + Boolean createFolder); +#endif + +// get number of total/free bytes on the disk where path belongs +WXDLLEXPORT bool wxGetDiskSpace(const wxString& path, + wxLongLong *pTotal = NULL, + wxLongLong *pFree = NULL); + #if wxUSE_GUI // GUI only things from now on // ---------------------------------------------------------------------------- @@ -256,6 +311,11 @@ WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent // Returns menu item id or -1 if none. WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); +// Find the wxWindow at the given point. wxGenericFindWindowAtPoint +// is always present but may be less reliable than a native version. +WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt); +WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt); + // ---------------------------------------------------------------------------- // Message/event queue helpers // ---------------------------------------------------------------------------- @@ -263,6 +323,9 @@ WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, con // Yield to other apps/messages WXDLLEXPORT bool wxYield(); +// Like wxYield, but fails silently if the yield is recursive. +WXDLLEXPORT bool wxYieldIfNeeded(); + // Yield to other apps/messages and disable user input WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL); @@ -309,25 +372,18 @@ class WXDLLEXPORT wxBusyCursor public: wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR) { wxBeginBusyCursor(cursor); } - ~wxBusyCursor() + ~wxBusyCursor() { wxEndBusyCursor(); } -}; -// ---------------------------------------------------------------------------- -// Error message functions used by wxWindows (deprecated, use wxLog) -// ---------------------------------------------------------------------------- - -// Format a message on the standard error (UNIX) or the debugging -// stream (Windows) -WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...); - -// Non-fatal error (continues) -WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr; -WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); + // FIXME: These two methods are currently only implemented (and needed?) + // in wxGTK. BusyCursor handling should probably be moved to + // common code since the wxGTK and wxMSW implementations are very + // similar except for wxMSW using HCURSOR directly instead of + // wxCursor.. -- RL. + static const wxCursor &GetStoredCursor(); + static const wxCursor GetBusyCursor(); +}; -// Fatal error (exits) -WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr; -WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr); // ---------------------------------------------------------------------------- // Reading and writing resources (eg WIN.INI, .Xdefaults) @@ -407,5 +463,22 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor); #endif // wxUSE_GUI +// ---------------------------------------------------------------------------- +// Error message functions used by wxWindows (deprecated, use wxLog) +// ---------------------------------------------------------------------------- + +// Format a message on the standard error (UNIX) or the debugging +// stream (Windows) +WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...); + +// Non-fatal error (continues) +WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr; +WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); + +// Fatal error (exits) +WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr; +WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr); + + #endif // _WX_UTILSH__