X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/df5168c427b51f1ab2b3200a5c8f7626b3d24aae..5851053a968330aea0a4bd6918b330eb0bfa0007:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 988754c1b6..e599e210cb 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: utils.h +// Name: wx/utils.h // Purpose: Miscellaneous utilities // Author: Julian Smart // Modified by: @@ -16,20 +16,19 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(__APPLE__) - #pragma interface "utils.h" -#endif - #include "wx/object.h" #include "wx/list.h" #include "wx/filefn.h" -#include "wx/arrstr.h" + +class WXDLLIMPEXP_BASE wxArrayString; // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare // wxLongLong #include "wx/longlong.h" -#ifdef __X__ +#ifdef __WATCOMC__ + #include +#elif defined(__X__) #include #include #endif @@ -40,11 +39,11 @@ // Forward declaration // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_BASE wxProcess; -class WXDLLIMPEXP_BASE wxFrame; -class WXDLLIMPEXP_BASE wxWindow; -class WXDLLIMPEXP_BASE wxWindowList; -class WXDLLIMPEXP_BASE wxPoint; +class WXDLLIMPEXP_CORE wxProcess; +class WXDLLIMPEXP_CORE wxFrame; +class WXDLLIMPEXP_CORE wxWindow; +class WXDLLIMPEXP_CORE wxWindowList; +class WXDLLIMPEXP_CORE wxPoint; // ---------------------------------------------------------------------------- // Macros @@ -53,18 +52,22 @@ class WXDLLIMPEXP_BASE wxPoint; #define wxMax(a,b) (((a) > (b)) ? (a) : (b)) #define wxMin(a,b) (((a) < (b)) ? (a) : (b)) +// wxGetFreeMemory can return huge amount of memory on 32-bit platforms as well +// so to always use long long for its result type on all platforms which +// support it +#if wxUSE_LONGLONG + typedef wxLongLong wxMemorySize; +#else + typedef long wxMemorySize; +#endif + // ---------------------------------------------------------------------------- // String functions (deprecated, use wxString) // ---------------------------------------------------------------------------- // Make a copy of this string using 'new' #if WXWIN_COMPATIBILITY_2_4 -WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s); -#endif - -#if WXWIN_COMPATIBILITY_2 -// Matches string one within string two regardless of case -WXDLLIMPEXP_BASE bool StringMatch(const wxChar *one, const wxChar *two, bool subString = TRUE, bool exact = FALSE); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) ); #endif // A shorter way of using strcmp @@ -75,7 +78,12 @@ WXDLLIMPEXP_BASE bool StringMatch(const wxChar *one, const wxChar *two, bool sub // ---------------------------------------------------------------------------- // Sound the bell +#if !defined __EMX__ && \ + (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__) +WXDLLIMPEXP_CORE void wxBell(); +#else WXDLLIMPEXP_BASE void wxBell(); +#endif // Get OS description as a user-readable string WXDLLIMPEXP_BASE wxString wxGetOsDescription(); @@ -87,33 +95,98 @@ WXDLLIMPEXP_BASE int wxGetOsVersion(int *majorVsn = (int *) NULL, // Return a string with the current date/time WXDLLIMPEXP_BASE wxString wxNow(); -// Return path where wxWindows is installed (mostly useful in Unices) +// Return path where wxWidgets is installed (mostly useful in Unices) WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix(); // Return path to wxWin data (/usr/share/wx/%{version}) (Unices) WXDLLIMPEXP_BASE wxString wxGetDataDir(); #if wxUSE_GUI + +// Get the state of a key (true if pressed, false if not) +// This is generally most useful getting the state of +// the modifier or toggle keys. +WXDLLEXPORT bool wxGetKeyState(wxKeyCode key); + + // Don't synthesize KeyUp events holding down a key and producing // KeyDown events with autorepeat. On by default and always on // in wxMSW. WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag ); + +// wxMouseState is used to hold information about button and modifier state +// and is what is returned from wxGetMouseState. +class WXDLLEXPORT wxMouseState +{ +public: + wxMouseState() + : m_x(0), m_y(0), + m_leftDown(false), m_middleDown(false), m_rightDown(false), + m_controlDown(false), m_shiftDown(false), m_altDown(false), + m_metaDown(false) + {} + + wxCoord GetX() { return m_x; } + wxCoord GetY() { return m_y; } + + bool LeftDown() { return m_leftDown; } + bool MiddleDown() { return m_middleDown; } + bool RightDown() { return m_rightDown; } + + bool ControlDown() { return m_controlDown; } + bool ShiftDown() { return m_shiftDown; } + bool AltDown() { return m_altDown; } + bool MetaDown() { return m_metaDown; } + bool CmdDown() + { +#if defined(__WXMAC__) || defined(__WXCOCOA__) + return MetaDown(); +#else + return ControlDown(); +#endif + } + + void SetX(wxCoord x) { m_x = x; } + void SetY(wxCoord y) { m_y = y; } + + void SetLeftDown(bool down) { m_leftDown = down; } + void SetMiddleDown(bool down) { m_middleDown = down; } + void SetRightDown(bool down) { m_rightDown = down; } + + void SetControlDown(bool down) { m_controlDown = down; } + void SetShiftDown(bool down) { m_shiftDown = down; } + void SetAltDown(bool down) { m_altDown = down; } + void SetMetaDown(bool down) { m_metaDown = down; } + +private: + wxCoord m_x; + wxCoord m_y; + + bool m_leftDown; + bool m_middleDown; + bool m_rightDown; + + bool m_controlDown; + bool m_shiftDown; + bool m_altDown; + bool m_metaDown; +}; + + +// Returns the current state of the mouse position, buttons and modifers +WXDLLEXPORT wxMouseState wxGetMouseState(); + + // ---------------------------------------------------------------------------- // Window ID management // ---------------------------------------------------------------------------- // Generate a unique ID WXDLLEXPORT long wxNewId(); -#if !defined(NewId) && defined(WXWIN_COMPATIBILITY) - #define NewId wxNewId -#endif // Ensure subsequent IDs don't clash with this one WXDLLEXPORT void wxRegisterId(long id); -#if !defined(RegisterId) && defined(WXWIN_COMPATIBILITY) - #define RegisterId wxRegisterId -#endif // Return the current ID WXDLLEXPORT long wxGetCurrentId(); @@ -127,17 +200,17 @@ WXDLLEXPORT long wxGetCurrentId(); // these functions are deprecated, use wxString methods instead! #if WXWIN_COMPATIBILITY_2_4 -WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFloatToStringStr; -WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxDoubleToStringStr; +extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxFloatToStringStr; +extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDoubleToStringStr; -WXDLLIMPEXP_BASE void StringToFloat(const wxChar *s, float *number); -WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr); -WXDLLIMPEXP_BASE void StringToDouble(const wxChar *s, double *number); -WXDLLIMPEXP_BASE wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr); -WXDLLIMPEXP_BASE void StringToInt(const wxChar *s, int *number); -WXDLLIMPEXP_BASE void StringToLong(const wxChar *s, long *number); -WXDLLIMPEXP_BASE wxChar* IntToString(int number); -WXDLLIMPEXP_BASE wxChar* LongToString(long number); +wxDEPRECATED( WXDLLIMPEXP_BASE void StringToFloat(const wxChar *s, float *number) ); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr) ); +wxDEPRECATED( WXDLLIMPEXP_BASE void StringToDouble(const wxChar *s, double *number) ); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr) ); +wxDEPRECATED( WXDLLIMPEXP_BASE void StringToInt(const wxChar *s, int *number) ); +wxDEPRECATED( WXDLLIMPEXP_BASE void StringToLong(const wxChar *s, long *number) ); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* IntToString(int number) ); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* LongToString(long number) ); #endif // WXWIN_COMPATIBILITY_2_4 @@ -152,7 +225,7 @@ WXDLLIMPEXP_BASE wxString wxDecToHex(int dec); // Process management // ---------------------------------------------------------------------------- -// NB: for backwars compatibility reasons the values of wxEXEC_[A]SYNC *must* +// NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must* // be 0 and 1, don't change! enum @@ -167,9 +240,14 @@ enum // is done by default) wxEXEC_NOHIDE = 2, - // under Unix, if the process is the group leader then killing -pid kills - // all children as well as pid - wxEXEC_MAKE_GROUP_LEADER = 4 + // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill + // kills all children as well as pid + wxEXEC_MAKE_GROUP_LEADER = 4, + + // by default synchronous execution disables all program windows to avoid + // that the user interacts with the program while the child process is + // running, you can use this flag to prevent this from happening + wxEXEC_NODISABLE = 8 }; // Execute another program. @@ -185,12 +263,21 @@ WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYN // execute the command capturing its output into an array line by line, this is // always synchronous WXDLLIMPEXP_BASE long wxExecute(const wxString& command, - wxArrayString& output); + wxArrayString& output, + int flags = 0); // also capture stderr (also synchronous) WXDLLIMPEXP_BASE long wxExecute(const wxString& command, - wxArrayString& output, - wxArrayString& error); + wxArrayString& output, + wxArrayString& error, + int flags = 0); + +#if defined(__WXMSW__) && wxUSE_IPC +// ask a DDE server to execute the DDE request with given parameters +WXDLLIMPEXP_BASE bool wxExecuteDDE(const wxString& ddeServer, + const wxString& ddeTopic, + const wxString& ddeCommand); +#endif // __WXMSW__ && wxUSE_IPC enum wxSignal { @@ -224,6 +311,12 @@ enum wxKillError wxKILL_ERROR // another, unspecified error }; +enum wxKillFlags +{ + wxKILL_NOCHILDREN = 0, // don't kill children + wxKILL_CHILDREN = 1 // kill children +}; + enum wxShutdownFlags { wxSHUTDOWN_POWEROFF, // power off the computer @@ -233,13 +326,34 @@ enum wxShutdownFlags // Shutdown or reboot the PC WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags); +enum wxPowerType +{ + wxPOWER_SOCKET, + wxPOWER_BATTERY, + wxPOWER_UNKNOWN +}; + +WXDLLIMPEXP_BASE wxPowerType wxGetPowerType(); + +enum wxBatteryState +{ + wxBATTERY_NORMAL_STATE, // system is fully usable + wxBATTERY_LOW_STATE, // start to worry + wxBATTERY_CRITICAL_STATE, // save quickly + wxBATTERY_SHUTDOWN_STATE, // too late + wxBATTERY_UNKNOWN_STATE +}; + +WXDLLIMPEXP_BASE wxBatteryState wxGetBatteryState(); + // 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 WXDLLIMPEXP_BASE int wxKill(long pid, wxSignal sig = wxSIGTERM, - wxKillError *rc = NULL); + wxKillError *rc = NULL, + int flags = wxKILL_NOCHILDREN); // Execute a command in an interactive shell window (always synchronously) // If no command then just the shell @@ -253,26 +367,45 @@ WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output); WXDLLIMPEXP_BASE void wxSleep(int nSecs); // Sleep for a given amount of milliseconds -WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds); +WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds); + +// Sleep for a given amount of microseconds +WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds); + +// Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep +wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) ); // Get the process id of the current process WXDLLIMPEXP_BASE unsigned long wxGetProcessId(); // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) -WXDLLIMPEXP_BASE long wxGetFreeMemory(); +WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory(); + +#if wxUSE_ON_FATAL_EXCEPTION // should wxApp::OnFatalException() be called? -WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = TRUE); +WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true); + +#endif // wxUSE_ON_FATAL_EXCEPTION + +// flags for wxLaunchDefaultBrowser +enum +{ + wxBROWSER_NEW_WINDOW = 1 +}; + +// Launch url in the user's default internet browser +WXDLLIMPEXP_BASE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); // ---------------------------------------------------------------------------- // Environment variables // ---------------------------------------------------------------------------- -// returns TRUE if variable exists (value may be NULL if you just want to check +// returns true if variable exists (value may be NULL if you just want to check // for this) WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value); -// set the env var name to the given value, return TRUE on success +// set the env var name to the given value, return true on success WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxChar *value); // remove the env var from environment @@ -316,10 +449,16 @@ WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptySt WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString); #endif +#if wxUSE_LONGLONG + typedef wxLongLong wxDiskspaceSize_t; +#else + typedef long wxDiskspaceSize_t; +#endif + // get number of total/free bytes on the disk where path belongs WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path, - wxLongLong *pTotal = NULL, - wxLongLong *pFree = NULL); + wxDiskspaceSize_t *pTotal = NULL, + wxDiskspaceSize_t *pFree = NULL); #if wxUSE_GUI // GUI only things from now on @@ -339,7 +478,7 @@ WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label); // Window search // ---------------------------------------------------------------------------- -// Returns menu item id or -1 if none. +// Returns menu item id or wxNOT_FOUND if none. WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); // Find the wxWindow at the given point. wxGenericFindWindowAtPoint @@ -364,10 +503,10 @@ WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent // ---------------------------------------------------------------------------- // Yield to other apps/messages and disable user input -WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = FALSE); +WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false); // Enable or disable input to all top level windows -WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE); +WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true); // Check whether this window wants to process messages, e.g. Stop button // in long calculations. @@ -396,13 +535,13 @@ private: // Set the cursor to the busy cursor for all windows class WXDLLEXPORT wxCursor; -WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR; +extern WXDLLEXPORT_DATA(wxCursor*) wxHOURGLASS_CURSOR; WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR); // Restore cursor to normal WXDLLEXPORT void wxEndBusyCursor(); -// TRUE if we're between the above two calls +// true if we're between the above two calls WXDLLEXPORT bool wxIsBusy(); // Convenience class so we can just create a wxBusyCursor object on the stack @@ -445,7 +584,7 @@ void WXDLLEXPORT wxGetMousePosition( int* x, int* y ); // MSW only: get user-defined resource from the .res file. // Returns NULL or newly-allocated memory, so use delete[] to clean up. #ifdef __WXMSW__ - WXDLLEXPORT extern const wxChar* wxUserResourceStr; + extern WXDLLEXPORT const wxChar* wxUserResourceStr; WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); #endif // MSW @@ -458,9 +597,9 @@ void WXDLLEXPORT wxGetMousePosition( int* x, int* y ); #endif #ifdef __X__ - WXDisplay *wxGetDisplay(); - bool wxSetDisplay(const wxString& display_name); - wxString wxGetDisplayName(); + WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay(); + WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name); + WXDLLIMPEXP_CORE wxString wxGetDisplayName(); #endif // X or GTK+ #ifdef __X__ @@ -489,24 +628,8 @@ WXDLLIMPEXP_BASE bool wxYield(); WXDLLIMPEXP_BASE bool wxYieldIfNeeded(); // ---------------------------------------------------------------------------- -// Error message functions used by wxWindows (deprecated, use wxLog) +// Error message functions used by wxWidgets (deprecated, use wxLog) // ---------------------------------------------------------------------------- -#if WXWIN_COMPATIBILITY_2_2 - -// Format a message on the standard error (UNIX) or the debugging -// stream (Windows) -WXDLLIMPEXP_BASE void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1; - -// Non-fatal error (continues) -WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxInternalErrorStr; -WXDLLIMPEXP_BASE void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); - -// Fatal error (exits) -WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFatalErrorStr; -WXDLLIMPEXP_BASE void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr); - -#endif // WXWIN_COMPATIBILITY_2_2 - #endif // _WX_UTILSH__