Committed Jaako's renderer patch

[wxWidgets.git] / include / wx / utils.h

diff --git a/include/wx/utils.h b/include/wx/utils.h
index 27b84005546b046535c539995a5ff68b42ca3994..f5d087d38551108c80db19f2bb16f62276ff3bf9 100644 (file)
--- 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:
 // Purpose:     Miscellaneous utilities
 // Author:      Julian Smart
 // Modified by:


@@ -16,28 +16,23 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // 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"
 #include "wx/object.h"
 #include "wx/list.h"
 #include "wx/filefn.h"

+#if wxUSE_GUI
+    #include "wx/gdicmn.h"
+#endif

 
 class WXDLLIMPEXP_BASE wxArrayString;
 
 class WXDLLIMPEXP_BASE wxArrayString;

+class WXDLLIMPEXP_BASE wxArrayInt;

 
 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
 // wxLongLong
 #include "wx/longlong.h"
 
 
 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
 // wxLongLong
 #include "wx/longlong.h"
 

-#ifdef __X__
+#ifdef __WATCOMC__
+    #include <direct.h>
+#elif defined(__X__)

     #include <dirent.h>
     #include <unistd.h>
 #endif
     #include <dirent.h>
     #include <unistd.h>
 #endif


@@ -52,7 +47,6 @@ class WXDLLIMPEXP_CORE wxProcess;
 class WXDLLIMPEXP_CORE wxFrame;
 class WXDLLIMPEXP_CORE wxWindow;
 class WXDLLIMPEXP_CORE wxWindowList;
 class WXDLLIMPEXP_CORE wxFrame;
 class WXDLLIMPEXP_CORE wxWindow;
 class WXDLLIMPEXP_CORE wxWindowList;

-class WXDLLIMPEXP_CORE wxPoint;

 
 // ----------------------------------------------------------------------------
 // Macros
 
 // ----------------------------------------------------------------------------
 // Macros


@@ -61,16 +55,13 @@ class WXDLLIMPEXP_CORE wxPoint;
 #define wxMax(a,b)            (((a) > (b)) ? (a) : (b))
 #define wxMin(a,b)            (((a) < (b)) ? (a) : (b))
 
 #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
+// 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
 #else

-    // 64 bit UNIX has sizeof(long) = 64
-    // assume 32 bit platforms cannnot return more than 32bits of
-    #define wxMemorySize long
+    typedef long wxMemorySize;

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -90,7 +81,12 @@ wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) );
 // ----------------------------------------------------------------------------
 
 // Sound the bell
 // ----------------------------------------------------------------------------
 
 // Sound the bell

+#if !defined __EMX__ && \
+    (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
+WXDLLIMPEXP_CORE void wxBell();
+#else

 WXDLLIMPEXP_BASE void wxBell();
 WXDLLIMPEXP_BASE void wxBell();

+#endif

 
 // Get OS description as a user-readable string
 WXDLLIMPEXP_BASE wxString wxGetOsDescription();
 
 // Get OS description as a user-readable string
 WXDLLIMPEXP_BASE wxString wxGetOsDescription();


@@ -107,6 +103,85 @@ WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
 // Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
 WXDLLIMPEXP_BASE wxString wxGetDataDir();
 
 // Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
 WXDLLIMPEXP_BASE wxString wxGetDataDir();
 

+/*
+ * Class to make it easier to specify platform-dependent values
+ *
+ * Examples:
+ *  long val = wxPlatform::If(wxMac, 1).ElseIf(wxGTK, 2).ElseIf(stPDA, 5).Else(3);
+ *  wxString strVal = wxPlatform::If(wxMac, wxT("Mac")).ElseIf(wxMSW, wxT("MSW")).Else(wxT("Other"));
+ *
+ * A custom platform symbol:
+ *
+ *  #define stPDA 100
+ *  #ifdef __WXWINCE__
+ *      wxPlatform::AddPlatform(stPDA);
+ *  #endif
+ *
+ *  long windowStyle = wxCAPTION | (long) wxPlatform::IfNot(stPDA, wxRESIZE_BORDER);
+ *
+ */
+
+class WXDLLIMPEXP_BASE wxPlatform
+{
+public:
+    wxPlatform() { Init(); }
+    wxPlatform(const wxPlatform& platform) { Copy(platform); }
+    void operator = (const wxPlatform& platform) { Copy(platform); }
+    void Copy(const wxPlatform& platform);
+    void Init() { m_longValue = 0; m_doubleValue = 0.0; }
+
+    // Specify an optional default value
+    wxPlatform(long defValue) { m_longValue = defValue; m_doubleValue = 0.0; }
+    wxPlatform(const wxString& defValue) { m_stringValue = defValue; m_longValue = 0; m_doubleValue = 0.0; }
+    wxPlatform(double defValue) { m_longValue = 0; m_doubleValue = defValue; }
+
+    static wxPlatform If(int platform, long value);
+    static wxPlatform IfNot(int platform, long value);
+    wxPlatform& ElseIf(int platform, long value);
+    wxPlatform& ElseIfNot(int platform, long value);
+    wxPlatform& Else(long value);
+
+    static wxPlatform If(int platform, int value);
+    static wxPlatform IfNot(int platform, int value) { return IfNot(platform, (long)value); }
+    wxPlatform& ElseIf(int platform, int value) { return ElseIf(platform, (long) value); }
+    wxPlatform& ElseIfNot(int platform, int value) { return ElseIfNot(platform, (long) value); }
+    wxPlatform& Else(int value) { return Else((long) value); }
+
+    static wxPlatform If(int platform, double value);
+    static wxPlatform IfNot(int platform, double value);
+    wxPlatform& ElseIf(int platform, double value);
+    wxPlatform& ElseIfNot(int platform, double value);
+    wxPlatform& Else(double value);
+
+    static wxPlatform If(int platform, const wxString& value);
+    static wxPlatform IfNot(int platform, const wxString& value);
+    wxPlatform& ElseIf(int platform, const wxString& value);
+    wxPlatform& ElseIfNot(int platform, const wxString& value);
+    wxPlatform& Else(const wxString& value);
+
+    long GetInteger() const { return m_longValue; }
+    const wxString& GetString() const { return m_stringValue; }
+    double GetDouble() const { return m_doubleValue; }
+
+    operator int() const { return (int) GetInteger(); }
+    operator long() const { return GetInteger(); }
+    operator double() const { return GetDouble(); }
+    operator const wxString() const { return GetString(); }
+    operator const wxChar*() const { return (const wxChar*) GetString(); }
+
+    static void AddPlatform(int platform);
+    static bool Is(int platform);
+    static void ClearPlatforms();
+
+private:
+    long                m_longValue;
+    double              m_doubleValue;
+    wxString            m_stringValue;
+    static wxArrayInt*  sm_customPlatforms;
+};
+
+/// Function for testing current platform
+inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); }

 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 


@@ -121,6 +196,70 @@ WXDLLEXPORT bool wxGetKeyState(wxKeyCode key);
 // in wxMSW.
 WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
 
 // 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------


@@ -143,8 +282,8 @@ WXDLLEXPORT long wxGetCurrentId();
 // these functions are deprecated, use wxString methods instead!
 #if WXWIN_COMPATIBILITY_2_4
 
 // 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;

 
 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 StringToFloat(const wxChar *s, float *number) );
 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr) );


@@ -215,6 +354,13 @@ WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
                                 wxArrayString& error,
                                 int flags = 0);
 
                                 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
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix
 enum wxSignal
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix


@@ -262,6 +408,26 @@ enum wxShutdownFlags
 // Shutdown or reboot the PC
 WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags);
 
 // 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
 //
 // 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
 //


@@ -304,6 +470,15 @@ WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true);
 
 #endif // wxUSE_ON_FATAL_EXCEPTION
 
 
 #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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Environment variables
 // ----------------------------------------------------------------------------


@@ -356,10 +531,16 @@ WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptySt
 WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
 #endif
 
 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,
 // 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
 
 
 #if wxUSE_GUI // GUI only things from now on
 


@@ -435,9 +616,7 @@ private:
 // ----------------------------------------------------------------------------
 
 // Set the cursor to the busy cursor for all windows
 // ----------------------------------------------------------------------------
 
 // Set the cursor to the busy cursor for all windows

-class WXDLLEXPORT wxCursor;
-WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
-WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
+WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR);

 
 // Restore cursor to normal
 WXDLLEXPORT void wxEndBusyCursor();
 
 // Restore cursor to normal
 WXDLLEXPORT void wxEndBusyCursor();


@@ -449,7 +628,7 @@ WXDLLEXPORT bool wxIsBusy();
 class WXDLLEXPORT wxBusyCursor
 {
 public:
 class WXDLLEXPORT wxBusyCursor
 {
 public:

-    wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
+    wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR)

         { wxBeginBusyCursor(cursor); }
     ~wxBusyCursor()
         { wxEndBusyCursor(); }
         { wxBeginBusyCursor(cursor); }
     ~wxBusyCursor()
         { wxEndBusyCursor(); }


@@ -485,7 +664,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__
 // 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
 
     WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
 #endif // MSW
 


@@ -498,9 +677,9 @@ void WXDLLEXPORT wxGetMousePosition( int* x, int* y );
 #endif
 
 #ifdef __X__
 #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__
 #endif // X or GTK+
 
 #ifdef __X__


@@ -532,21 +711,5 @@ WXDLLIMPEXP_BASE bool wxYieldIfNeeded();
 // Error message functions used by wxWidgets (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)
-wxDEPRECATED( WXDLLIMPEXP_BASE void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1 );
-
-// Non-fatal error (continues)
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxInternalErrorStr;
-wxDEPRECATED( WXDLLIMPEXP_BASE void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr) );
-
-// Fatal error (exits)
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFatalErrorStr;
-wxDEPRECATED( WXDLLIMPEXP_BASE void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr) );
-
-#endif // WXWIN_COMPATIBILITY_2_2
-

 #endif
     // _WX_UTILSH__
 #endif
     // _WX_UTILSH__