Implement GetPageText for the OSX WebKit implementation.

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

diff --git a/include/wx/propgrid/editors.h b/include/wx/propgrid/editors.h
index d07e7adf0d464055bb79761bae1f83010761d154..4432b37958adb2886f6d1db5bc5e4c5fa147312c 100644 (file)
--- a/include/wx/propgrid/editors.h
+++ b/include/wx/propgrid/editors.h
@@ -4,14 +4,16 @@
 // 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
 // Copyright:   (c) Jaakko Salli

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

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROPGRID_EDITORS_H_
 #define _WX_PROPGRID_EDITORS_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROPGRID_EDITORS_H_
 #define _WX_PROPGRID_EDITORS_H_
 

+#include "wx/defs.h"
+

 #if wxUSE_PROPGRID
 
 // -----------------------------------------------------------------------
 #if wxUSE_PROPGRID
 
 // -----------------------------------------------------------------------


@@ -30,7 +32,6 @@ public:
     wxWindow*   m_primary;
     wxWindow*   m_secondary;
 
     wxWindow*   m_primary;
     wxWindow*   m_secondary;
 

-#ifndef SWIG

     wxPGWindowList( wxWindow* a )
     {
         m_primary = a;
     wxPGWindowList( wxWindow* a )
     {
         m_primary = a;


@@ -41,7 +42,6 @@ public:
         m_primary = a;
         m_secondary = b;
     };
         m_primary = a;
         m_secondary = b;
     };

-#endif

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


@@ -75,9 +75,7 @@ public:
 */
 class WXDLLIMPEXP_PROPGRID wxPGEditor : public wxObject
 {
 */
 class WXDLLIMPEXP_PROPGRID wxPGEditor : public wxObject
 {

-#ifndef SWIG

     DECLARE_ABSTRACT_CLASS(wxPGEditor)
     DECLARE_ABSTRACT_CLASS(wxPGEditor)

-#endif

 public:
 
     /** Constructor. */
 public:
 
     /** Constructor. */


@@ -92,10 +90,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 +112,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,11 +143,16 @@ 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. behaviour 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;
 

-#if !defined(SWIG) || defined(CREATE_VCW)

     /** Returns value from control, via parameter 'variant'.
         Usually ends up calling property's StringToValue or IntToValue.
         Returns true if value was different.
     /** Returns value from control, via parameter 'variant'.
         Usually ends up calling property's StringToValue or IntToValue.
         Returns true if value was different.


@@ -167,11 +160,36 @@ public:
     virtual bool GetValueFromControl( wxVariant& variant,
                                       wxPGProperty* property,
                                       wxWindow* ctrl ) const;
     virtual bool GetValueFromControl( wxVariant& variant,
                                       wxPGProperty* property,
                                       wxWindow* ctrl ) const;

-#endif

 
 

-    /** Sets value in control to unspecified. */
+    /**
+        Sets new appearance for the control. Default implementation
+        sets foreground colour, background colour, font, plus text
+        for wxTextCtrl and wxComboCtrl.
+
+        @param appearance
+            New appearance to be applied.
+
+        @param oldAppearance
+            Previously applied appearance. Used to detect which
+            control attributes need to be changed (e.g. so we only
+            change background colour if really needed).
+
+        @param unspecified
+            @true if the new appearance represents an unspecified
+            property value.
+    */
+    virtual void SetControlAppearance( wxPropertyGrid* pg,
+                                       wxPGProperty* property,
+                                       wxWindow* ctrl,
+                                       const wxPGCell& appearance,
+                                       const wxPGCell& oldAppearance,
+                                       bool unspecified ) const;
+
+    /**
+        Sets value in control to unspecified.
+    */

     virtual void SetValueToUnspecified( wxPGProperty* property,
     virtual void SetValueToUnspecified( wxPGProperty* property,

-                                        wxWindow* ctrl ) const = 0;
+                                        wxWindow* ctrl ) const;

 
     /** Sets control's value specifically from string. */
     virtual void SetControlStringValue( wxPGProperty* property,
 
     /** Sets control's value specifically from string. */
     virtual void SetControlStringValue( wxPGProperty* property,


@@ -212,41 +230,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;

 
 
 //
 
 
 //


@@ -255,14 +245,25 @@ virtual void SetValueToUnspecified( wxPGProperty* property, \
 
 class WXDLLIMPEXP_PROPGRID wxPGTextCtrlEditor : public wxPGEditor
 {
 
 class WXDLLIMPEXP_PROPGRID wxPGTextCtrlEditor : public wxPGEditor
 {

-#ifndef SWIG

     DECLARE_DYNAMIC_CLASS(wxPGTextCtrlEditor)
     DECLARE_DYNAMIC_CLASS(wxPGTextCtrlEditor)

-#endif

 public:
     wxPGTextCtrlEditor() {}
     virtual ~wxPGTextCtrlEditor();
 
 public:
     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 wxString GetName() const;
 
     //virtual wxPGCellRenderer* GetCellRenderer() const;
     virtual wxString GetName() const;
 
     //virtual wxPGCellRenderer* GetCellRenderer() const;


@@ -287,14 +288,26 @@ public:
 
 class WXDLLIMPEXP_PROPGRID wxPGChoiceEditor : public wxPGEditor
 {
 
 class WXDLLIMPEXP_PROPGRID wxPGChoiceEditor : public wxPGEditor
 {

-#ifndef SWIG

     DECLARE_DYNAMIC_CLASS(wxPGChoiceEditor)
     DECLARE_DYNAMIC_CLASS(wxPGChoiceEditor)

-#endif

 public:
     wxPGChoiceEditor() {}
     virtual ~wxPGChoiceEditor();
 
 public:
     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,


@@ -322,15 +335,15 @@ public:
 
 class WXDLLIMPEXP_PROPGRID wxPGComboBoxEditor : public wxPGChoiceEditor
 {
 
 class WXDLLIMPEXP_PROPGRID wxPGComboBoxEditor : public wxPGChoiceEditor
 {

-#ifndef SWIG

     DECLARE_DYNAMIC_CLASS(wxPGComboBoxEditor)
     DECLARE_DYNAMIC_CLASS(wxPGComboBoxEditor)

-#endif

 public:
     wxPGComboBoxEditor() {}
     virtual ~wxPGComboBoxEditor();
 
 public:
     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;
 


@@ -348,9 +361,6 @@ public:
 };
 
 
 };
 
 

-// Exclude classes from being able to be derived from in wxPython bindings
-#ifndef SWIG
-

 class WXDLLIMPEXP_PROPGRID wxPGChoiceAndButtonEditor : public wxPGChoiceEditor
 {
 public:
 class WXDLLIMPEXP_PROPGRID wxPGChoiceAndButtonEditor : public wxPGChoiceEditor
 {
 public:


@@ -358,8 +368,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,15 +383,17 @@ 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)
 };
 

-#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


@@ -387,15 +401,27 @@ public:
 //
 class WXDLLIMPEXP_PROPGRID wxPGCheckBoxEditor : public wxPGEditor
 {
 //
 class WXDLLIMPEXP_PROPGRID wxPGCheckBoxEditor : public wxPGEditor
 {

-#ifndef SWIG

     DECLARE_DYNAMIC_CLASS(wxPGCheckBoxEditor)
     DECLARE_DYNAMIC_CLASS(wxPGCheckBoxEditor)

-#endif

 public:
     wxPGCheckBoxEditor() {}
     virtual ~wxPGCheckBoxEditor();
 
     virtual wxString GetName() const;
 public:
     wxPGCheckBoxEditor() {}
     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 +438,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


@@ -449,9 +463,7 @@ if ( wxPGEditor_##EDITOR == (wxPGEditor*) NULL ) \
 */
 class WXDLLIMPEXP_PROPGRID wxPGEditorDialogAdapter : public wxObject
 {
 */
 class WXDLLIMPEXP_PROPGRID wxPGEditorDialogAdapter : public wxObject
 {

-#ifndef SWIG

     DECLARE_ABSTRACT_CLASS(wxPGEditorDialogAdapter)
     DECLARE_ABSTRACT_CLASS(wxPGEditorDialogAdapter)

-#endif

 public:
     wxPGEditorDialogAdapter()
         : wxObject()
 public:
     wxPGEditorDialogAdapter()
         : wxObject()


@@ -500,6 +512,7 @@ class WXDLLIMPEXP_PROPGRID wxPGMultiButton : public wxWindow
 {
 public:
     wxPGMultiButton( wxPropertyGrid* pg, const wxSize& sz );
 {
 public:
     wxPGMultiButton( wxPropertyGrid* pg, const wxSize& sz );

+    virtual ~wxPGMultiButton() {}

 
     wxWindow* GetButton( unsigned int i ) { return (wxWindow*) m_buttons[i]; }
     const wxWindow* GetButton( unsigned int i ) const
 
     wxWindow* GetButton( unsigned int i ) { return (wxWindow*) m_buttons[i]; }
     const wxWindow* GetButton( unsigned int i ) const


@@ -511,7 +524,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 +538,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

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