props

[wxWidgets.git] / include / wx / dvrenderers.h

diff --git a/include/wx/dvrenderers.h b/include/wx/dvrenderers.h
index 94a4330dcbed437b007dc643e9801e2b0cde9ca2..717f73608a4c2e2ab59cf7e7de9e724e310fc47e 100644 (file)
--- a/include/wx/dvrenderers.h
+++ b/include/wx/dvrenderers.h
@@ -3,7 +3,7 @@
 // Purpose:     Declare all wxDataViewCtrl classes
 // Author:      Robert Roebling, Vadim Zeitlin
 // Created:     2009-11-08 (extracted from wx/dataview.h)
 // Purpose:     Declare all wxDataViewCtrl classes
 // Author:      Robert Roebling, Vadim Zeitlin
 // Created:     2009-11-08 (extracted from wx/dataview.h)

-// RCS-ID:      $Id: wxhead.h,v 1.11 2009-06-29 10:23:04 zeitlin Exp $
+// RCS-ID:      $Id$

 // Copyright:   (c) 2006 Robert Roebling
 //              (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 // Copyright:   (c) 2006 Robert Roebling
 //              (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence


@@ -109,13 +109,22 @@ public:
     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
     wxDataViewColumn* GetOwner() const          { return m_owner; }
 
     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
     wxDataViewColumn* GetOwner() const          { return m_owner; }
 

-    // renderer properties:
+    // renderer value and attributes: SetValue() and SetAttr() are called
+    // before a cell is rendered using this renderer
+    virtual bool SetValue(const wxVariant& value) = 0;
+    virtual bool GetValue(wxVariant& value) const = 0;
+
+    virtual void SetAttr(const wxDataViewItemAttr& WXUNUSED(attr)) { }

 
 

-    virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
-    virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
+    virtual void SetEnabled(bool WXUNUSED(enabled)) { }

 
     wxString GetVariantType() const             { return m_variantType; }
 
 
     wxString GetVariantType() const             { return m_variantType; }
 

+    // helper that calls SetValue and SetAttr:
+    void PrepareForItem(const wxDataViewModel *model,
+                        const wxDataViewItem& item, unsigned column);
+
+    // renderer properties:

     virtual void SetMode( wxDataViewCellMode mode ) = 0;
     virtual wxDataViewCellMode GetMode() const = 0;
 
     virtual void SetMode( wxDataViewCellMode mode ) = 0;
     virtual wxDataViewCellMode GetMode() const = 0;
 


@@ -151,6 +160,9 @@ public:
     wxControl *GetEditorCtrl() { return m_editorCtrl; }
 
 protected:
     wxControl *GetEditorCtrl() { return m_editorCtrl; }
 
 protected:

+    // Called from {Cancel,Finish}Editing() to cleanup m_editorCtrl
+    void DestroyEditControl();
+

     wxString                m_variantType;
     wxDataViewColumn       *m_owner;
     wxWeakRef<wxControl>    m_editorCtrl;
     wxString                m_variantType;
     wxDataViewColumn       *m_owner;
     wxWeakRef<wxControl>    m_editorCtrl;


@@ -204,6 +216,12 @@ public:
     }
 
 
     }
 
 

+    // Render the item using the current value (returned by GetValue()).
+    virtual bool Render(wxRect cell, wxDC *dc, int state) = 0;
+
+    // Return the size of the item appropriate to its current value.
+    virtual wxSize GetSize() const = 0;
+

     // Define virtual function which are called when the item is activated
     // (double-clicked or Enter is pressed on it), clicked or the user starts
     // to drag it: by default they all simply return false indicating that the
     // Define virtual function which are called when the item is activated
     // (double-clicked or Enter is pressed on it), clicked or the user starts
     // to drag it: by default they all simply return false indicating that the


@@ -230,7 +248,44 @@ public:
         { return false; }
 
 
         { return false; }
 
 

+    // Helper which can be used by Render() implementation in the derived
+    // classes: it will draw the text in the same manner as the standard
+    // renderers do.
+    virtual void RenderText(const wxString& text,
+                            int xoffset,
+                            wxRect cell,
+                            wxDC *dc,
+                            int state);
+
+
+    // Override the base class virtual method to simply store the attribute so
+    // that it can be accessed using GetAttr() from Render() if needed.
+    virtual void SetAttr(const wxDataViewItemAttr& attr) { m_attr = attr; }
+    const wxDataViewItemAttr& GetAttr() const { return m_attr; }
+
+    // Store the enabled state of the item so that it can be accessed from
+    // Render() via GetEnabled() if needed.
+    virtual void SetEnabled(bool enabled) { m_enabled = enabled; }
+    bool GetEnabled() const { return m_enabled; }
+
+
+    // Implementation only from now on
+
+    // Retrieve the DC to use for drawing. This is implemented in derived
+    // platform-specific classes.
+    virtual wxDC *GetDC() = 0;
+
+    // Prepare DC to use attributes and call Render().
+    void WXCallRender(wxRect rect, wxDC *dc, int state);
+
+protected:
+    // helper for GetSize() implementations, respects attributes
+    wxSize GetTextExtent(const wxString& str) const;
+

 private:
 private:

+    wxDataViewItemAttr m_attr;
+    bool m_enabled;
+

     wxDECLARE_NO_COPY_CLASS(wxDataViewCustomRendererBase);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxDataViewCustomRendererBase);
 };
 


@@ -294,11 +349,33 @@ public:
     virtual bool SetValue( const wxVariant &value );
     virtual bool GetValue( wxVariant &value ) const;
 
     virtual bool SetValue( const wxVariant &value );
     virtual bool GetValue( wxVariant &value ) const;
 

+    wxString GetChoice(size_t index) const { return m_choices[index]; }
+    const wxArrayString& GetChoices() const { return m_choices; }
+

 private:
     wxArrayString m_choices;
     wxString      m_data;
 };
 
 private:
     wxArrayString m_choices;
     wxString      m_data;
 };
 

+// ----------------------------------------------------------------------------
+// wxDataViewChoiceByIndexRenderer
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewChoiceByIndexRenderer: public wxDataViewChoiceRenderer
+{
+public:
+    wxDataViewChoiceByIndexRenderer( const wxArrayString &choices,
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
+                              int alignment = wxDVR_DEFAULT_ALIGNMENT );
+
+    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
+    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
+
+    virtual bool SetValue( const wxVariant &value );
+    virtual bool GetValue( wxVariant &value ) const;
+};
+
+

 #endif // generic or Carbon versions
 
 // this class is obsolete, its functionality was merged in
 #endif // generic or Carbon versions
 
 // this class is obsolete, its functionality was merged in