Document that message box with wxYES_NO but without wxCANCEL can't be closed.

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

diff --git a/interface/wx/propgrid/propgridiface.h b/interface/wx/propgrid/propgridiface.h
index 2b1cb12d27e3039ed234f03e65cd92a8f91bc477..efd9067b68acab54edf699e733e0bb3acddd0666 100644 (file)
--- a/interface/wx/propgrid/propgridiface.h
+++ b/interface/wx/propgrid/propgridiface.h
@@ -135,11 +135,19 @@ public:
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 
     /**
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 
     /**

-        Deletes a property.
+        Removes and deletes a property and any children.

 
 

-        @remarks This functions deselects selected property, if any. Validation
-                failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie.
-                selection is cleared even if editor had invalid value.
+        @param id
+            Pointer or name of a property.
+
+        @remarks If you delete a property in a wxPropertyGrid event
+                 handler, the actual deletion is postponed until the next
+                 idle event.
+
+                 This functions deselects selected property, if any.
+                 Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not
+                 respected, ie. selection is cleared even if editor had
+                 invalid value.

     */
     void DeleteProperty( wxPGPropArg id );
 
     */
     void DeleteProperty( wxPGPropArg id );
 


@@ -192,6 +200,13 @@ public:
     */
     bool ExpandAll( bool expand = true );
 
     */
     bool ExpandAll( bool expand = true );
 

+    /**
+        Returns auto-resize proportion of the given column.
+
+        @see SetColumnProportion()
+    */
+    int GetColumnProportion( unsigned int column ) const;
+

     /**
         Returns id of first child of given property.
 
     /**
         Returns id of first child of given property.
 


@@ -582,12 +597,17 @@ public:
     static void RegisterAdditionalEditors();
 
     /**
     static void RegisterAdditionalEditors();
 
     /**

-        Removes and returns a property.
+        Removes a property. Does not delete the property object, but
+        instead returns it.

 
         @param id
             Pointer or name of a property.
 
         @remarks Removed property cannot have any children.
 
         @param id
             Pointer or name of a property.
 
         @remarks Removed property cannot have any children.

+
+                 Also, if you remove property in a wxPropertyGrid event
+                 handler, the actual removal is postponed until the next
+                 idle event.

     */
     wxPGProperty* RemoveProperty( wxPGPropArg id );
 
     */
     wxPGProperty* RemoveProperty( wxPGPropArg id );
 


@@ -678,6 +698,20 @@ public:
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 

+    /**
+        Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER
+        window style needs to be used to indicate that columns are auto-
+        resizeable.
+
+        @returns Returns @false on failure.
+
+        @remarks You should call this for individual pages of
+                 wxPropertyGridManager (if used).
+
+        @see GetColumnProportion()
+    */
+    bool SetColumnProportion( unsigned int column, int proportion );
+

     /**
         Sets an attribute for this property.
 
     /**
         Sets an attribute for this property.
 


@@ -794,9 +828,6 @@ public:
         In other words, user cannot change the value in the editor, but they can
         still copy it.
 
         In other words, user cannot change the value in the editor, but they can
         still copy it.
 

-        @remarks This is mainly for use with textctrl editor. Only some other
-                editors fully support it.
-

         @param id
             Property name or pointer.
 
         @param id
             Property name or pointer.
 


@@ -806,6 +837,9 @@ public:
         @param flags
             By default changes are applied recursively. Set this parameter
             wxPG_DONT_RECURSE to prevent this.
         @param flags
             By default changes are applied recursively. Set this parameter
             wxPG_DONT_RECURSE to prevent this.

+
+        @remarks This is mainly for use with textctrl editor. Only some other
+                 editors fully support it.

     */
     void SetPropertyReadOnly( wxPGPropArg id, bool set = true,
                               int flags = wxPG_RECURSE );
     */
     void SetPropertyReadOnly( wxPGPropArg id, bool set = true,
                               int flags = wxPG_RECURSE );