correct access for virtuals, other minor corrections

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

diff --git a/include/wx/utils.h b/include/wx/utils.h
index 517385f7b7dd210c5b525495f1a77a5e6332f80f..40305e40445f84272d4abb1e00edd7299c0f8473 100644 (file)
--- a/include/wx/utils.h
+++ b/include/wx/utils.h
@@ -19,8 +19,12 @@
 #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 wxArrayInt;
 
 // need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
 // wxLongLong
@@ -43,7 +47,6 @@ class WXDLLIMPEXP_CORE wxProcess;
 class WXDLLIMPEXP_CORE wxFrame;
 class WXDLLIMPEXP_CORE wxWindow;
 class WXDLLIMPEXP_CORE wxWindowList;
-class WXDLLIMPEXP_CORE wxPoint;
 
 // ----------------------------------------------------------------------------
 // Macros
@@ -51,6 +54,7 @@ class WXDLLIMPEXP_CORE wxPoint;
 
 #define wxMax(a,b)            (((a) > (b)) ? (a) : (b))
 #define wxMin(a,b)            (((a) < (b)) ? (a) : (b))
+#define wxClip(a,b,c)         (((a) < (b)) ? (b) : (((a) > (c)) ? (c) : (a)))
 
 // 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
@@ -100,6 +104,88 @@ WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
 // 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);
+
+    // Specify an optional default value
+    wxPlatform(int defValue) { Init(); m_longValue = (long)defValue; }
+    wxPlatform(long defValue) { Init(); m_longValue = defValue; }
+    wxPlatform(const wxString& defValue) { Init(); m_stringValue = defValue; }
+    wxPlatform(double defValue) { Init(); 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) { return If(platform, (long)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:
+
+    void Init() { m_longValue = 0; m_doubleValue = 0.0; }
+
+    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
 
@@ -133,12 +219,12 @@ public:
     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() 
+    bool        CmdDown()
     {
 #if defined(__WXMAC__) || defined(__WXCOCOA__)
         return MetaDown();
@@ -158,7 +244,7 @@ public:
     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;
@@ -449,10 +535,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
 
@@ -528,9 +620,7 @@ private:
 // ----------------------------------------------------------------------------
 
 // Set the cursor to the busy cursor for all windows
-class WXDLLEXPORT wxCursor;
-extern WXDLLEXPORT_DATA(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();
@@ -542,7 +632,7 @@ WXDLLEXPORT bool wxIsBusy();
 class WXDLLEXPORT wxBusyCursor
 {
 public:
-    wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
+    wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }
     ~wxBusyCursor()
         { wxEndBusyCursor(); }