X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f38f68999028a8ff8d3cd0b1cf4a0fc94af805b0..fbf618dff87a9e4a88d5be458cecc50309b30af3:/include/wx/utils.h diff --git a/include/wx/utils.h b/include/wx/utils.h index 2450c08a9b..234f130670 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,17 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__) -// Some older compilers (such as EMX) cannot handle -// #pragma interface/implementation correctly, iff -// #pragma implementation is used in _two_ translation -// units (as created by e.g. event.cpp compiled for -// libwx_base and event.cpp compiled for libwx_gui_core). -// So we must not use those pragmas for those compilers in -// such files. - #pragma interface "utils.h" -#endif - #include "wx/object.h" #include "wx/list.h" #include "wx/filefn.h" @@ -37,7 +26,9 @@ class WXDLLIMPEXP_BASE wxArrayString; // wxLongLong #include "wx/longlong.h" -#ifdef __X__ +#ifdef __WATCOMC__ + #include +#elif defined(__X__) #include #include #endif @@ -61,13 +52,25 @@ class WXDLLIMPEXP_CORE 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 64-bit platforms +// define wxMemorySize according to the type which best fits your platform +#if wxUSE_LONGLONG && defined(__WIN64__) + // 64 bit Windowses have sizeof(long) only 32 bit long + // we need to use wxLongLong to express memory sizes + #define wxMemorySize wxLongLong +#else + // 64 bit UNIX has sizeof(long) = 64 + // assume 32 bit platforms cannnot return more than 32bits of + #define wxMemorySize long +#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); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) ); #endif // A shorter way of using strcmp @@ -78,7 +81,12 @@ WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s); // ---------------------------------------------------------------------------- // 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(); @@ -131,17 +139,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 @@ -194,12 +202,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); + +#ifdef __WXMSW__ +// 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__ enum wxSignal { @@ -248,6 +265,26 @@ 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 // @@ -281,11 +318,24 @@ wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) ); 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); +#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 // ---------------------------------------------------------------------------- @@ -418,7 +468,7 @@ 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 @@ -467,7 +517,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 @@ -480,9 +530,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__ @@ -514,21 +564,5 @@ WXDLLIMPEXP_BASE bool wxYieldIfNeeded(); // 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__