Add RunScript and implement on all backends. Document and add a very simple unit...

[wxWidgets.git] / include / wx / propgrid / propgridpagestate.h

diff --git a/include/wx/propgrid/propgridpagestate.h b/include/wx/propgrid/propgridpagestate.h
index 3ebebcf9ce7afe622f773087a6f9031f9f4023a5..c25b9e5bac2019f37166022af3584f2295d4b1b1 100644 (file)
--- a/include/wx/propgrid/propgridpagestate.h
+++ b/include/wx/propgrid/propgridpagestate.h
@@ -6,12 +6,14 @@
 // Created:     2008-08-24
 // RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROPGRID_PROPGRIDPAGESTATE_H_
 #define _WX_PROPGRID_PROPGRIDPAGESTATE_H_
 
+#include "wx/defs.h"
+
 #if wxUSE_PROPGRID
 
 #include "wx/propgrid/property.h"
@@ -23,25 +25,59 @@
     A return value from wxPropertyGrid::HitTest(),
     contains all you need to know about an arbitrary location on the grid.
 */
-struct WXDLLIMPEXP_PROPGRID wxPropertyGridHitTestResult
+class WXDLLIMPEXP_PROPGRID wxPropertyGridHitTestResult
 {
     friend class wxPropertyGridPageState;
 public:
+    wxPropertyGridHitTestResult()
+    {
+        m_property = NULL;
+        m_column = -1;
+        m_splitter = -1;
+        m_splitterHitOffset = 0;
+    }
 
-    wxPGProperty* GetProperty() const { return property; }
+    ~wxPropertyGridHitTestResult()
+    {
+    }
 
-    /** Column. -1 for margin. */
-    int             column;
+    /**
+        Returns column hit. -1 for margin.
+    */
+    int GetColumn() const { return m_column; }
 
-    /** Index of splitter hit, -1 for none. */
-    int             splitter;
+    /**
+        Returns property hit. NULL if empty space below
+        properties was hit instead.
+    */
+    wxPGProperty* GetProperty() const
+    {
+        return m_property;
+    }
 
-    /** If splitter hit, offset to that */
-    int             splitterHitOffset;
+    /**
+        Returns index of splitter hit, -1 for none.
+    */
+    int GetSplitter() const { return m_splitter; }
+
+    /**
+        If splitter hit, then this member function
+        returns offset to the exact splitter position.
+    */
+    int GetSplitterHitOffset() const { return m_splitterHitOffset; }
 
 private:
     /** Property. NULL if empty space below properties was hit */
-    wxPGProperty*   property;
+    wxPGProperty*   m_property;
+
+    /** Column. -1 for margin. */
+    int             m_column;
+
+    /** Index of splitter hit, -1 for none. */
+    int             m_splitter;
+
+    /** If splitter hit, offset to that */
+    int             m_splitterHitOffset;
 };
 
 // -----------------------------------------------------------------------
@@ -345,7 +381,6 @@ public:
         m_pIt = it.m_pIt;
         m_pIt->IncRef();
     }
-#ifndef SWIG
     const wxPGVIterator& operator=( const wxPGVIterator& it )
     {
         if (this != &it)
@@ -356,7 +391,6 @@ public:
         }
         return *this;
     }
-#endif
     void Next() { m_pIt->Next(); }
     bool AtEnd() const { return m_pIt->m_it.AtEnd(); }
     wxPGProperty* GetProperty() const { return m_pIt->m_it.GetProperty(); }
@@ -366,9 +400,6 @@ protected:
 
 // -----------------------------------------------------------------------
 
-#ifndef SWIG
-// We won't need this class from wxPython
-
 /** @class wxPropertyGridPageState
 
     Contains low-level property page information (properties, column widths,
@@ -406,7 +437,7 @@ public:
     void CheckColumnWidths( int widthChange = 0 );
 
     /**
-        Override this member function to add custom behavior on property
+        Override this member function to add custom behaviour on property
         deletion.
     */
     virtual void DoDelete( wxPGProperty* item, bool doDelete = true );
@@ -416,7 +447,7 @@ public:
     wxPGProperty* DoGetItemAtY( int y ) const;
 
     /**
-        Override this member function to add custom behavior on property
+        Override this member function to add custom behaviour on property
         insertion.
     */
     virtual wxPGProperty* DoInsert( wxPGProperty* parent,
@@ -429,8 +460,7 @@ public:
     */
     virtual void DoSetSplitterPosition( int pos,
                                         int splitterColumn = 0,
-                                        bool allPages = false,
-                                        bool fromAutoCenter = false );
+                                        int flags = 0 );
 
     bool EnableCategories( bool enable );
 
@@ -445,9 +475,6 @@ public:
         }
     }
 
-    /** Enables or disables given property and its subproperties. */
-    bool DoEnableProperty( wxPGProperty* p, bool enable );
-
     /** Returns (precalculated) height of contained visible properties.
     */
     unsigned int GetVirtualHeight() const
@@ -519,6 +546,15 @@ public:
 
     void DoRemoveFromSelection( wxPGProperty* prop );
 
+    void DoSetColumnProportion( unsigned int column, int proportion );
+
+    int DoGetColumnProportion( unsigned int column ) const
+    {
+        return m_columnProportions[column];
+    }
+
+    void ResetColumnSizes( int setSplitterFlags );
+
     wxPropertyCategory* GetPropertyCategory( const wxPGProperty* p ) const;
 
     wxPGProperty* GetPropertyByLabel( const wxString& name,
@@ -554,7 +590,7 @@ public:
 
         @param pt
             Logical coordinates in the virtual grid space. Use
-            wxScrolledWindow::CalcUnscrolledPosition() if you need to
+            wxScrolled<T>::CalcUnscrolledPosition() if you need to
             translate a scrolled position into a logical one.
     */
     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
@@ -635,6 +671,11 @@ public:
 
 protected:
 
+    // Utility to check if two properties are visibly next to each other
+    bool ArePropertiesAdjacent( wxPGProperty* prop1,
+                                wxPGProperty* prop2,
+                                int iterFlags = wxPG_ITERATE_VISIBLE ) const;
+
     int DoGetSplitterPosition( int splitterIndex = 0 ) const;
 
     /** Returns column at x coordinate (in GetGrid()->GetPanel()).
@@ -671,6 +712,9 @@ protected:
     /** List of indices of columns the user can edit by clicking it. */
     wxArrayInt                  m_editableColumns;
 
+    /** Column proportions */
+    wxArrayInt                  m_columnProportions;
+
     double                      m_fSplitterX;
 
     /** Most recently added category. */
@@ -699,13 +743,17 @@ protected:
 
     unsigned char               m_vhCalcPending;
 
+    /** True if splitter has been pre-set by the application. */
+    bool                        m_isSplitterPreSet;
+
+    /** Used to (temporarily) disable splitter centering. */
+    bool                        m_dontCenterSplitter;
+
 private:
     /** Only inits arrays, doesn't migrate things or such. */
     void InitNonCatMode();
 };
 
-#endif // #ifndef SWIG
-
 // -----------------------------------------------------------------------
 
 #endif // wxUSE_PROPGRID