Merge in from trunk r68626 - r68683

[wxWidgets.git] / interface / wx / propgrid / manager.h

diff --git a/interface/wx/propgrid/manager.h b/interface/wx/propgrid/manager.h
index 3aa7e9746cee5136167da6b27916a5fdc31b79c9..066a2ace3157cba63ed76e5669ee2edbbbdf647e 100644 (file)
--- a/interface/wx/propgrid/manager.h
+++ b/interface/wx/propgrid/manager.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxPropertyGridManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPropertyGridManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -128,8 +128,8 @@ public:
     @class wxPropertyGridManager
 
     wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
     @class wxPropertyGridManager
 
     wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,

-    which can optionally have toolbar for mode and page selection, and a help text
-    box.
+    which can optionally have toolbar for mode and page selection, a help text
+    box, and a header.

 
     wxPropertyGridManager inherits from wxPropertyGridInterface, and as such
     it has most property manipulation functions. However, only some of them affect
 
     wxPropertyGridManager inherits from wxPropertyGridInterface, and as such
     it has most property manipulation functions. However, only some of them affect


@@ -183,6 +183,9 @@ public:
         page->Append( "Text",wxPG_LABEL,"(no text)" );
 
         page->Append( new wxFontProperty("Font",wxPG_LABEL) );
         page->Append( "Text",wxPG_LABEL,"(no text)" );
 
         page->Append( new wxFontProperty("Font",wxPG_LABEL) );

+
+        // Display a header above the grid
+        pgMan->ShowHeader();

     @endcode
 
     @section propgridmanager_window_styles_ Window Styles
     @endcode
 
     @section propgridmanager_window_styles_ Window Styles


@@ -427,9 +430,22 @@ public:
 
     /**
         Sets number of columns on given page (default is current page).
 
     /**
         Sets number of columns on given page (default is current page).

+
+        @remarks If you use header, then you should always use this
+                 member function to set the column count, instead of
+                 ones present in wxPropertyGrid or wxPropertyGridPage.

     */
     void SetColumnCount( int colCount, int page = -1 );
 
     */
     void SetColumnCount( int colCount, int page = -1 );
 

+    /**
+        Sets a column title. Default title for column 0 is "Property",
+        and "Value" for column 1.
+
+        @remarks If header is not shown yet, then calling this
+                 member function will make it visible.
+    */
+    void SetColumnTitle( int idx, const wxString& title );
+

     /**
         Sets label and text in description box.
     */
     /**
         Sets label and text in description box.
     */


@@ -451,22 +467,41 @@ public:
     */
     void SetSplitterLeft( bool subProps = false, bool allPages = true );
 
     */
     void SetSplitterLeft( bool subProps = false, bool allPages = true );
 

-    /** Sets splitter position on individual page. */
+    /**
+        Sets splitter position on individual page.
+
+        @remarks If you use header, then you should always use this
+                 member function to set the splitter position, instead of
+                 ones present in wxPropertyGrid or wxPropertyGridPage.
+    */

     void SetPageSplitterPosition( int page, int pos, int column = 0 );
 
     /**
         Sets splitter position for all pages.
 
     void SetPageSplitterPosition( int page, int pos, int column = 0 );
 
     /**
         Sets splitter position for all pages.
 

-        @remarks Splitter position cannot exceed grid size, and therefore setting
-                it during form creation may fail as initial grid size is often
-                smaller than desired splitter position, especially when sizers
-                are being used.
+        @remarks Splitter position cannot exceed grid size, and therefore
+                 setting it during form creation may fail as initial grid
+                 size is often smaller than desired splitter position,
+                 especially when sizers are being used.
+
+                 If you use header, then you should always use this
+                 member function to set the splitter position, instead of
+                 ones present in wxPropertyGrid or wxPropertyGridPage.

     */
     void SetSplitterPosition( int pos, int column = 0 );
 
     /** Synonyme for SelectPage(name). */
     void SetStringSelection( const wxChar* name );
 
     */
     void SetSplitterPosition( int pos, int column = 0 );
 
     /** Synonyme for SelectPage(name). */
     void SetStringSelection( const wxChar* name );
 

+    /**
+        Show or hide the property grid header control. It is hidden
+        by the default.
+
+        @remarks Grid may look better if you use wxPG_NO_INTERNAL_BORDER
+                 window style when showing a header.
+    */
+    void ShowHeader(bool show = true);
+

 protected:
 
     //
 protected:
 
     //


@@ -475,7 +510,7 @@ protected:
 
     /**
         Creates property grid for the manager. Reimplement in derived class to
 
     /**
         Creates property grid for the manager. Reimplement in derived class to

-        use subclassed wxPropertyGrid. However, if you you do this then you
+        use subclassed wxPropertyGrid. However, if you do this then you

         must also use the two-step construction (ie. default constructor and
         Create() instead of constructor with arguments) when creating the
         manager.
         must also use the two-step construction (ie. default constructor and
         Create() instead of constructor with arguments) when creating the
         manager.