move virtual GetPath() implementation out of line to work around an apparent Fedora...

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

diff --git a/include/wx/propgrid/editors.h b/include/wx/propgrid/editors.h
index d07e7adf0d464055bb79761bae1f83010761d154..dcc66671e580a20b92c793b93ab9146ebbe4bae4 100644 (file)
--- a/include/wx/propgrid/editors.h
+++ b/include/wx/propgrid/editors.h
@@ -4,7 +4,7 @@
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2007-04-14
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2007-04-14

-// RCS-ID:      $Id:
+// RCS-ID:      $Id$

 // Copyright:   (c) Jaakko Salli
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Jaakko Salli
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////


@@ -92,10 +92,11 @@ public:
 
     /**
         Returns pointer to the name of the editor. For example,
 
     /**
         Returns pointer to the name of the editor. For example,

-        wxPG_EDITOR(TextCtrl) has name "TextCtrl". This method is autogenerated
-        for custom editors.
+        wxPGEditor_TextCtrl has name "TextCtrl". If you dont' need to access
+        your custom editor by string name, then you do not need to implement
+        this function.

     */
     */

-    virtual wxString GetName() const = 0;
+    virtual wxString GetName() const;

 
     /**
         Instantiates editor controls.
 
     /**
         Instantiates editor controls.


@@ -113,26 +114,15 @@ public:
         @remarks
         - Primary control shall use id wxPG_SUBID1, and secondary (button)
           control shall use wxPG_SUBID2.
         @remarks
         - Primary control shall use id wxPG_SUBID1, and secondary (button)
           control shall use wxPG_SUBID2.

-        - Implementation shoud connect all necessary events to the
-          wxPropertyGrid::OnCustomEditorEvent. For Example:
-            @code
-                // Relays wxEVT_COMMAND_TEXT_UPDATED events of primary editor
-                // control to the OnEvent.
-                control->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
-                                 wxCommandEventHandler(wxPropertyGrid::OnCustomEditorEvent),
-                                 NULL, propgrid);
-            @endcode
-          OnCustomEditorEvent will then forward events, first to
-          wxPGEditor::OnEvent() and then to wxPGProperty::OnEvent().
+        - Unlike in previous version of wxPropertyGrid, it is no longer
+          necessary to call wxEvtHandler::Connect() for interesting editor
+          events. Instead, all events from control are now automatically
+          forwarded to wxPGEditor::OnEvent() and wxPGProperty::OnEvent().

     */
     virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
                                           wxPGProperty* property,
                                           const wxPoint& pos,
                                           const wxSize& size) const = 0;
     */
     virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
                                           wxPGProperty* property,
                                           const wxPoint& pos,
                                           const wxSize& size) const = 0;

-    #define wxPG_DECLARE_CREATECONTROLS \
-        virtual wxPGWindowList \
-            CreateControls( wxPropertyGrid* propgrid, wxPGProperty* property, \
-        const wxPoint& pos, const wxSize& sz ) const;

 
     /** Loads value from property to the control. */
     virtual void UpdateControl( wxPGProperty* property,
 
     /** Loads value from property to the control. */
     virtual void UpdateControl( wxPGProperty* property,


@@ -155,6 +145,12 @@ public:
 
     /** Handles events. Returns true if value in control was modified
         (see wxPGProperty::OnEvent for more information).
 
     /** Handles events. Returns true if value in control was modified
         (see wxPGProperty::OnEvent for more information).

+
+        @remarks wxPropertyGrid will automatically unfocus the editor when
+                wxEVT_COMMAND_TEXT_ENTER is received and when it results in
+                property value being modified. This happens regardless of
+                editor type (ie. behavior is same for any wxTextCtrl and
+                wxComboBox based editor).

     */
     virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property,
         wxWindow* wnd_primary, wxEvent& event ) const = 0;
     */
     virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property,
         wxWindow* wnd_primary, wxEvent& event ) const = 0;


@@ -212,41 +208,13 @@ public:
 };
 
 
 };
 
 

-//
-// Note that we don't use this macro in this file because
-// otherwise doxygen gets confused.
-//
-#define WX_PG_DECLARE_EDITOR_CLASS(CLASSNAME) \
-    DECLARE_DYNAMIC_CLASS(CLASSNAME) \
-public: \
-    virtual wxString GetName() const; \
-private:
-
-
-#define WX_PG_IMPLEMENT_EDITOR_CLASS(EDITOR,CLASSNAME,BASECLASS) \
+#define WX_PG_IMPLEMENT_INTERNAL_EDITOR_CLASS(EDITOR,CLASSNAME,BASECLASS) \

 IMPLEMENT_DYNAMIC_CLASS(CLASSNAME, BASECLASS) \
 wxString CLASSNAME::GetName() const \
 { \
     return wxS(#EDITOR); \
 } \
 IMPLEMENT_DYNAMIC_CLASS(CLASSNAME, BASECLASS) \
 wxString CLASSNAME::GetName() const \
 { \
     return wxS(#EDITOR); \
 } \

-wxPGEditor* wxPGEditor_##EDITOR = (wxPGEditor*) NULL; \
-wxPGEditor* wxPGConstruct##EDITOR##EditorClass() \
-{ \
-    wxASSERT( !wxPGEditor_##EDITOR ); \
-    return new CLASSNAME(); \
-}
-
-
-#define WX_PG_IMPLEMENT_EDITOR_CLASS_STD_METHODS() \
-wxPG_DECLARE_CREATECONTROLS \
-virtual void UpdateControl( wxPGProperty* property, wxWindow* ctrl ) const; \
-virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property, \
-    wxWindow* primary, wxEvent& event ) const; \
-virtual bool GetValueFromControl( wxVariant& variant, \
-                                  wxPGProperty* property, \
-                                  wxWindow* ctrl ) const; \
-virtual void SetValueToUnspecified( wxPGProperty* property, \
-                                    wxWindow* ctrl ) const;
+wxPGEditor* wxPGEditor_##EDITOR = NULL;

 
 
 //
 
 
 //


@@ -262,7 +230,22 @@ public:
     wxPGTextCtrlEditor() {}
     virtual ~wxPGTextCtrlEditor();
 
     wxPGTextCtrlEditor() {}
     virtual ~wxPGTextCtrlEditor();
 

-    WX_PG_IMPLEMENT_EDITOR_CLASS_STD_METHODS()
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;
+    virtual void UpdateControl( wxPGProperty* property,
+                                wxWindow* ctrl ) const;
+    virtual bool OnEvent( wxPropertyGrid* propgrid,
+                          wxPGProperty* property,
+                          wxWindow* primaryCtrl,
+                          wxEvent& event ) const;
+    virtual bool GetValueFromControl( wxVariant& variant,
+                                      wxPGProperty* property,
+                                      wxWindow* ctrl ) const;
+    virtual void SetValueToUnspecified( wxPGProperty* property,
+                                        wxWindow* ctrl ) const;
+

     virtual wxString GetName() const;
 
     //virtual wxPGCellRenderer* GetCellRenderer() const;
     virtual wxString GetName() const;
 
     //virtual wxPGCellRenderer* GetCellRenderer() const;


@@ -294,7 +277,21 @@ public:
     wxPGChoiceEditor() {}
     virtual ~wxPGChoiceEditor();
 
     wxPGChoiceEditor() {}
     virtual ~wxPGChoiceEditor();
 

-    WX_PG_IMPLEMENT_EDITOR_CLASS_STD_METHODS()
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;
+    virtual void UpdateControl( wxPGProperty* property,
+                                wxWindow* ctrl ) const;
+    virtual bool OnEvent( wxPropertyGrid* propgrid,
+                          wxPGProperty* property,
+                          wxWindow* primaryCtrl,
+                          wxEvent& event ) const;
+    virtual bool GetValueFromControl( wxVariant& variant,
+                                      wxPGProperty* property,
+                                      wxWindow* ctrl ) const;
+    virtual void SetValueToUnspecified( wxPGProperty* property,
+                                        wxWindow* ctrl ) const;

     virtual wxString GetName() const;
 
     virtual void SetControlIntValue( wxPGProperty* property,
     virtual wxString GetName() const;
 
     virtual void SetControlIntValue( wxPGProperty* property,


@@ -329,8 +326,10 @@ public:
     wxPGComboBoxEditor() {}
     virtual ~wxPGComboBoxEditor();
 
     wxPGComboBoxEditor() {}
     virtual ~wxPGComboBoxEditor();
 

-    // Macro is used for convenience due to different signature with wxPython
-    wxPG_DECLARE_CREATECONTROLS
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;

 
     virtual wxString GetName() const;
 
 
     virtual wxString GetName() const;
 


@@ -358,8 +357,10 @@ public:
     virtual ~wxPGChoiceAndButtonEditor();
     virtual wxString GetName() const;
 
     virtual ~wxPGChoiceAndButtonEditor();
     virtual wxString GetName() const;
 

-    // Macro is used for convenience due to different signature with wxPython
-    wxPG_DECLARE_CREATECONTROLS
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;

 
     DECLARE_DYNAMIC_CLASS(wxPGChoiceAndButtonEditor)
 };
 
     DECLARE_DYNAMIC_CLASS(wxPGChoiceAndButtonEditor)
 };


@@ -371,7 +372,11 @@ public:
     wxPGTextCtrlAndButtonEditor() {}
     virtual ~wxPGTextCtrlAndButtonEditor();
     virtual wxString GetName() const;
     wxPGTextCtrlAndButtonEditor() {}
     virtual ~wxPGTextCtrlAndButtonEditor();
     virtual wxString GetName() const;

-    wxPG_DECLARE_CREATECONTROLS
+
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;

 
     DECLARE_DYNAMIC_CLASS(wxPGTextCtrlAndButtonEditor)
 };
 
     DECLARE_DYNAMIC_CLASS(wxPGTextCtrlAndButtonEditor)
 };


@@ -379,7 +384,7 @@ public:
 #endif  // !SWIG
 
 
 #endif  // !SWIG
 
 

-#if wxPG_INCLUDE_CHECKBOX || defined(DOXYGEN)
+#if wxPG_INCLUDE_CHECKBOX

 
 //
 // Use custom check box code instead of native control
 
 //
 // Use custom check box code instead of native control


@@ -395,7 +400,21 @@ public:
     virtual ~wxPGCheckBoxEditor();
 
     virtual wxString GetName() const;
     virtual ~wxPGCheckBoxEditor();
 
     virtual wxString GetName() const;

-    WX_PG_IMPLEMENT_EDITOR_CLASS_STD_METHODS()
+    virtual wxPGWindowList CreateControls(wxPropertyGrid* propgrid,
+                                          wxPGProperty* property,
+                                          const wxPoint& pos,
+                                          const wxSize& size) const;
+    virtual void UpdateControl( wxPGProperty* property,
+                                wxWindow* ctrl ) const;
+    virtual bool OnEvent( wxPropertyGrid* propgrid,
+                          wxPGProperty* property,
+                          wxWindow* primaryCtrl,
+                          wxEvent& event ) const;
+    virtual bool GetValueFromControl( wxVariant& variant,
+                                      wxPGProperty* property,
+                                      wxWindow* ctrl ) const;
+    virtual void SetValueToUnspecified( wxPGProperty* property,
+                                        wxWindow* ctrl ) const;

 
     virtual void DrawValue( wxDC& dc,
                             const wxRect& rect,
 
     virtual void DrawValue( wxDC& dc,
                             const wxRect& rect,


@@ -412,27 +431,15 @@ public:
 
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------

-// Editor class registeration macros
+// Editor class registeration macro (mostly for internal use)

 
 #define wxPGRegisterEditorClass(EDITOR) \
 
 #define wxPGRegisterEditorClass(EDITOR) \

-    if ( wxPGEditor_##EDITOR == (wxPGEditor*) NULL ) \
+    if ( wxPGEditor_##EDITOR == NULL ) \

     { \
         wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
     { \
         wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \

-                wxPGConstruct##EDITOR##EditorClass() ); \
+                new wxPG##EDITOR##Editor ); \

     }
 
     }
 

-// Use this in RegisterDefaultEditors.
-#define wxPGRegisterDefaultEditorClass(EDITOR) \
-if ( wxPGEditor_##EDITOR == (wxPGEditor*) NULL ) \
-    { \
-        wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
-                wxPGConstruct##EDITOR##EditorClass(), true ); \
-    }
-
-#define wxPG_INIT_REQUIRED_EDITOR(T) \
-    wxPGRegisterEditorClass(T)
-
-

 // -----------------------------------------------------------------------
 
 /** @class wxPGEditorDialogAdapter
 // -----------------------------------------------------------------------
 
 /** @class wxPGEditorDialogAdapter


@@ -511,7 +518,7 @@ public:
 
     /** Returns number of buttons.
     */
 
     /** Returns number of buttons.
     */

-    int GetCount() const { return m_buttons.Count(); }
+    unsigned int GetCount() const { return (unsigned int) m_buttons.size(); }

 
     void Add( const wxString& label, int id = -2 );
 #if wxUSE_BMPBUTTON
 
     void Add( const wxString& label, int id = -2 );
 #if wxUSE_BMPBUTTON


@@ -525,15 +532,15 @@ public:
 
     void Finalize( wxPropertyGrid* propGrid, const wxPoint& pos );
 
 
     void Finalize( wxPropertyGrid* propGrid, const wxPoint& pos );
 

-#ifndef DOXYGEN

 protected:
 
 protected:
 

+    void DoAddButton( wxWindow* button, const wxSize& sz );
+

     int GenId( int id ) const;
 
     wxArrayPtrVoid  m_buttons;
     wxSize          m_fullEditorSize;
     int             m_buttonsWidth;
     int GenId( int id ) const;
 
     wxArrayPtrVoid  m_buttons;
     wxSize          m_fullEditorSize;
     int             m_buttonsWidth;

-#endif // !DOXYGEN

 };
 
 // -----------------------------------------------------------------------
 };
 
 // -----------------------------------------------------------------------