]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/propgrid/manager.h
use DECLARE_NO_ASSIGN_CLASS() for better readability
[wxWidgets.git] / include / wx / propgrid / manager.h
index ceb1e6289952f6cd0d06c439a286a92131cd04a6..58850722645814f0ba5acd283d8eec0218dcc997 100644 (file)
@@ -4,7 +4,7 @@
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2005-01-14
-// RCS-ID:      $Id:
+// RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
@@ -27,7 +27,7 @@
 // -----------------------------------------------------------------------
 
 #ifndef SWIG
-extern WXDLLIMPEXP_PROPGRID const wxChar *wxPropertyGridManagerNameStr;
+extern WXDLLIMPEXP_DATA_PROPGRID(const char) wxPropertyGridManagerNameStr[];
 #endif
 
 /** @class wxPropertyGridPage
@@ -163,14 +163,8 @@ protected:
     */
     virtual void DoSetSplitterPosition( int pos,
                                         int splitterColumn = 0,
-                                        bool allPages = false );
-
-    /** Propagate to other pages.
-    */
-    void DoSetSplitterPositionThisPage( int pos, int splitterColumn = 0 )
-    {
-        wxPropertyGridPageState::DoSetSplitterPosition( pos, splitterColumn );
-    }
+                                        bool allPages = false,
+                                        bool fromAutoCenter = false );
 
     /** Page label (may be referred as name in some parts of documentation).
         Can be set in constructor, or passed in
@@ -260,7 +254,7 @@ public:
                            const wxPoint& pos = wxDefaultPosition,
                            const wxSize& size = wxDefaultSize,
                            long style = wxPGMAN_DEFAULT_STYLE,
-                           const wxChar* name = wxPropertyGridManagerNameStr );
+                           const wxString& name = wxPropertyGridManagerNameStr );
 
     /** Destructor */
     virtual ~wxPropertyGridManager();
@@ -277,25 +271,20 @@ public:
         @param pageObj
         wxPropertyGridPage instance. Manager will take ownership of this object.
         NULL indicates that a default page instance should be created.
+
         @return
-        Returns index to the page created.
+        Returns pointer to created page.
+
         @remarks
         If toolbar is used, it is highly recommended that the pages are
         added when the toolbar is not turned off using window style flag
         switching.
     */
-    int AddPage( const wxString& label = wxEmptyString,
-                 const wxBitmap& bmp = wxPG_NULL_BITMAP,
-                 wxPropertyGridPage* pageObj = (wxPropertyGridPage*) NULL )
+    wxPropertyGridPage* AddPage( const wxString& label = wxEmptyString,
+                                 const wxBitmap& bmp = wxPG_NULL_BITMAP,
+                                 wxPropertyGridPage* pageObj = NULL )
     {
-        return InsertPage(-1,label,bmp,pageObj);
-    }
-
-    void ClearModifiedStatus ( wxPGPropArg id );
-
-    void ClearModifiedStatus ()
-    {
-        m_pPropGrid->ClearModifiedStatus();
+        return InsertPage(-1, label, bmp, pageObj);
     }
 
     /** Deletes all all properties and all pages.
@@ -325,7 +314,7 @@ public:
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxPGMAN_DEFAULT_STYLE,
-                 const wxChar* name = wxPropertyGridManagerNameStr );
+                 const wxString& name = wxPropertyGridManagerNameStr );
 
     /**
         Enables or disables (shows/hides) categories according to parameter
@@ -346,25 +335,6 @@ public:
     */
     bool EnsureVisible( wxPGPropArg id );
 
-    /** Returns number of children of the root property of the selected page. */
-    size_t GetChildrenCount()
-    {
-        return GetChildrenCount( m_pPropGrid->m_pState->m_properties );
-    }
-
-    /** Returns number of children of the root property of given page. */
-    size_t GetChildrenCount( int pageIndex );
-
-    /** Returns number of children for the property.
-
-        NB: Cannot be in container methods class due to name hiding.
-    */
-    size_t GetChildrenCount( wxPGPropArg id ) const
-    {
-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(0)
-        return p->GetChildCount();
-    }
-
     /** Returns number of columns on given page. By the default,
         returns number of columns on current page. */
     int GetColumnCount( int page = -1 ) const;
@@ -445,18 +415,11 @@ public:
         return GetPage(m_selPage);
     }
 
-    /** Returns last page.
-    */
-    wxPropertyGridPage* GetLastPage() const
-    {
-        return GetPage(m_arrPages.size()-1);
-    }
-
     /** Returns page object for given page index.
     */
     wxPropertyGridPage* GetPage( unsigned int ind ) const
     {
-        return (wxPropertyGridPage*)m_arrPages.Item(ind);
+        return m_arrPages[ind];
     }
 
     /** Returns page object for given page name.
@@ -479,10 +442,12 @@ public:
     */
     int GetPageByState( const wxPropertyGridPageState* pstate ) const;
 
+protected:
     /** Returns wxPropertyGridPageState of given page, current page's for -1.
     */
     virtual wxPropertyGridPageState* GetPageState( int page ) const;
 
+public:
     /** Returns number of managed pages. */
     size_t GetPageCount() const;
 
@@ -497,6 +462,12 @@ public:
     /** Returns index to currently selected page. */
     int GetSelectedPage() const { return m_selPage; }
 
+    /** Alias for GetSelection(). */
+    wxPGProperty* GetSelectedProperty() const
+    {
+        return GetSelection();
+    }
+
     /** Shortcut for GetGrid()->GetSelection(). */
     wxPGProperty* GetSelection() const
     {
@@ -519,13 +490,14 @@ public:
         @param pageObj
         wxPropertyGridPage instance. Manager will take ownership of this object.
         If NULL, default page object is constructed.
+
         @return
-        Returns index to the page created.
+        Returns pointer to created page.
     */
-    virtual int InsertPage( int index,
-                            const wxString& label,
-                            const wxBitmap& bmp = wxNullBitmap,
-                            wxPropertyGridPage* pageObj = NULL );
+    virtual wxPropertyGridPage* InsertPage( int index,
+                                            const wxString& label,
+                                            const wxBitmap& bmp = wxNullBitmap,
+                                            wxPropertyGridPage* pageObj = NULL );
 
     /**
         Returns true if any property on any page has been modified by the user.
@@ -640,17 +612,13 @@ protected:
     */
     virtual wxPropertyGrid* CreatePropertyGrid() const;
 
-    virtual void RefreshProperty( wxPGProperty* p );
-
 public:
-
-#ifndef DOXYGEN
+    virtual void RefreshProperty( wxPGProperty* p );
 
     //
     // Overridden functions - no documentation required.
     //
 
-    virtual wxSize DoGetBestSize() const;
     void SetId( wxWindowID winid );
 
     virtual void Freeze();
@@ -660,11 +628,13 @@ public:
     virtual void SetWindowStyleFlag ( long style );
 
 protected:
+    virtual wxSize DoGetBestSize() const;
 
 public:
 
 #ifndef SWIG
 
+    virtual bool ProcessEvent( wxEvent& event );
     //
     // Event handlers
     //
@@ -683,7 +653,7 @@ protected:
 
     wxPropertyGrid* m_pPropGrid;
 
-    wxArrayPtrVoid  m_arrPages;
+    wxVector<wxPropertyGridPage*>   m_arrPages;
 
 #if wxUSE_TOOLBAR
     wxToolBar*      m_pToolbar;
@@ -745,7 +715,7 @@ protected:
     /** (Re)creates/destroys controls, according to the window style bits. */
     void RecreateControls();
 
-    void RefreshHelpBox( int new_splittery, int new_width, int new_height );
+    void UpdateDescriptionBox( int new_splittery, int new_width, int new_height );
 
     void RepaintSplitter( wxDC& dc,
                           int new_splittery,
@@ -755,12 +725,13 @@ protected:
 
     void SetDescribedProperty( wxPGProperty* p );
 
-    virtual bool ProcessEvent( wxEvent& event );
+    // Reimplement these to handle "descboxheight" state item
+    virtual bool SetEditableStateItem( const wxString& name, wxVariant value );
+    virtual wxVariant GetEditableStateItem( const wxString& name ) const;
 
 private:
     DECLARE_EVENT_TABLE()
 #endif // #ifndef SWIG
-#endif // #ifndef DOXYGEN
 };
 
 // -----------------------------------------------------------------------