Minor tweak to improve understandability

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

diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h
index e4b3d7b2c16d36d8bdd56953f4906441a9d5b25c..3ab534149fa482c945b3af3eaf66c52b5367743f 100644 (file)
--- a/interface/wx/propgrid/propgrid.h
+++ b/interface/wx/propgrid/propgrid.h
@@ -45,7 +45,7 @@ wxPG_BOLD_MODIFIED                  = 0x00000040,
 
 /**
     When wxPropertyGrid is resized, splitter moves to the center. This
 
 /**
     When wxPropertyGrid is resized, splitter moves to the center. This

-    behavior stops once the user manually moves the splitter.
+    behaviour stops once the user manually moves the splitter.

 */
 wxPG_SPLITTER_AUTO_CENTER           = 0x00000080,
 
 */
 wxPG_SPLITTER_AUTO_CENTER           = 0x00000080,
 


@@ -209,7 +209,7 @@ wxPG_EX_TOOLBAR_SEPARATOR               = 0x08000000
 // -----------------------------------------------------------------------
 
 /**
 // -----------------------------------------------------------------------
 
 /**

-    @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags
+    @section propgrid_vfbflags wxPropertyGrid Validation Failure behaviour Flags

     @{
 */
 
     @{
 */
 


@@ -218,7 +218,7 @@ enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS
 
 /**
     Prevents user from leaving property unless value is valid. If this
 
 /**
     Prevents user from leaving property unless value is valid. If this

-    behavior flag is not used, then value change is instead cancelled.
+    behaviour flag is not used, then value change is instead cancelled.

 */
 wxPG_VFB_STAY_IN_PROPERTY           = 0x01,
 
 */
 wxPG_VFB_STAY_IN_PROPERTY           = 0x01,
 


@@ -237,7 +237,7 @@ wxPG_VFB_MARK_CELL                  = 0x04,
 
     To customize the way the message is displayed, you need to
     reimplement wxPropertyGrid::DoShowPropertyError() in a
 
     To customize the way the message is displayed, you need to
     reimplement wxPropertyGrid::DoShowPropertyError() in a

-    derived class. Default behavior is to display the text on
+    derived class. Default behaviour is to display the text on

     the top-level frame's status bar, if present, and otherwise
     using wxMessageBox.
 */
     the top-level frame's status bar, if present, and otherwise
     using wxMessageBox.
 */


@@ -279,7 +279,7 @@ class wxPGValidationInfo
 {
 public:
     /**
 {
 public:
     /**

-        @return Returns failure behavior which is a combination of
+        @return Returns failure behaviour which is a combination of

             @ref propgrid_vfbflags.
     */
     wxPGVFBFlags GetFailureBehavior();
             @ref propgrid_vfbflags.
     */
     wxPGVFBFlags GetFailureBehavior();


@@ -294,7 +294,7 @@ public:
     */
     wxVariant& GetValue();
 
     */
     wxVariant& GetValue();
 

-    /** Set validation failure behavior
+    /** Set validation failure behaviour

 
         @param failureBehavior
             Mixture of @ref propgrid_vfbflags.
 
         @param failureBehavior
             Mixture of @ref propgrid_vfbflags.


@@ -481,7 +481,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxPG_DEFAULT_STYLE,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxPG_DEFAULT_STYLE,

-                    const wxChar* name = wxPropertyGridNameStr );
+                    const wxString& name = wxPropertyGridNameStr );

 
     /** Destructor */
     virtual ~wxPropertyGrid();
 
     /** Destructor */
     virtual ~wxPropertyGrid();


@@ -597,7 +597,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxPG_DEFAULT_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxPG_DEFAULT_STYLE,

-                const wxChar* name = wxPropertyGridNameStr );
+                const wxString& name = wxPropertyGridNameStr );

 
     /**
         Dedicates a specific keycode to wxPropertyGrid. This means that such
 
     /**
         Dedicates a specific keycode to wxPropertyGrid. This means that such


@@ -892,12 +892,16 @@ public:
     */
     virtual void RefreshProperty( wxPGProperty* p );
 
     */
     virtual void RefreshProperty( wxPGProperty* p );
 

+
+    /** Forwards to DoRegisterEditorClass with empty name. */
+    static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
+                                            bool noDefCheck = false );

     /**
         Registers a new editor class.
 
         @return Returns pointer  to the editor class instance that should be used.
     */
     /**
         Registers a new editor class.
 
         @return Returns pointer  to the editor class instance that should be used.
     */

-    static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
+    static wxPGEditor* DoRegisterEditorClass( wxPGEditor* editor,

                                             const wxString& name,
                                             bool noDefCheck = false );
 
                                             const wxString& name,
                                             bool noDefCheck = false );
 


@@ -946,14 +950,6 @@ public:
     */
     bool SelectProperty( wxPGPropArg id, bool focus = false );
 
     */
     bool SelectProperty( wxPGPropArg id, bool focus = false );
 

-    /**
-        Changes keyboard shortcut to push the editor button.
-
-        @remarks You can set default with keycode 0. Good value for the platform
-                is guessed, but don't expect it to be very accurate.
-    */
-    void SetButtonShortcut( int keycode, bool ctrlDown = false, bool altDown = false );
-

     /**
         Sets category caption background colour.
     */
     /**
         Sets category caption background colour.
     */


@@ -1092,7 +1088,7 @@ public:
         @name wxPropertyGrid customization
 
         Reimplement these member functions in derived class for better
         @name wxPropertyGrid customization
 
         Reimplement these member functions in derived class for better

-        control over wxPropertyGrid behavior.
+        control over wxPropertyGrid behaviour.

     */
     //@{
 
     */
     //@{
 


@@ -1121,7 +1117,7 @@ public:
     /**
         Return wxStatusBar that is used by this wxPropertyGrid. You can
         reimplement this member function in derived class to override
     /**
         Return wxStatusBar that is used by this wxPropertyGrid. You can
         reimplement this member function in derived class to override

-        the default behavior of using the top-level wxFrame's status
+        the default behaviour of using the top-level wxFrame's status

         bar, if any.
     */
     virtual wxStatusBar* GetStatusBar();
         bar, if any.
     */
     virtual wxStatusBar* GetStatusBar();


@@ -1282,7 +1278,7 @@ public:
     void SetProperty( wxPGProperty* p );
 
     /**
     void SetProperty( wxPGProperty* p );
 
     /**

-        Set override validation failure behavior. Only effective if Veto() was
+        Set override validation failure behaviour. Only effective if Veto() was

         also called, and only allowed if event type is @c wxEVT_PG_CHANGING.
     */
     void SetValidationFailureBehavior( wxPGVFBFlags flags );
         also called, and only allowed if event type is @c wxEVT_PG_CHANGING.
     */
     void SetValidationFailureBehavior( wxPGVFBFlags flags );