Harmonize wxDataViewCtrl::GetSelection() behaviour in all ports.

[wxWidgets.git] / include / wx / gtk / dataview.h

diff --git a/include/wx/gtk/dataview.h b/include/wx/gtk/dataview.h
index 8ed57ec0d8a2fb09a27c5e2c53712188b24b5c4e..8a4e12c3545dc2395de6c3810332517ccfa106e9 100644 (file)
--- a/include/wx/gtk/dataview.h
+++ b/include/wx/gtk/dataview.h
@@ -12,308 +12,9 @@
 
 #include "wx/list.h"
 
 
 #include "wx/list.h"
 

-// ---------------------------------------------------------
-// classes
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;

 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
 
 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
 

-typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
-
-// ---------------------------------------------------------
-// wxDataViewRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
-{
-public:
-    wxDataViewRenderer( const wxString &varianttype,
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                        int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    virtual void SetMode( wxDataViewCellMode mode );
-    virtual wxDataViewCellMode GetMode() const;
-
-    virtual void SetAlignment( int align );
-    virtual int GetAlignment() const;
-
-    virtual void EnableEllipsize(wxEllipsizeMode mode = wxELLIPSIZE_MIDDLE);
-    virtual wxEllipsizeMode GetEllipsizeMode() const;
-
-    // GTK-specific implementation
-    // ---------------------------
-
-    // pack the GTK cell renderers used by this renderer to the given column
-    //
-    // by default only a single m_renderer is used but some renderers use more
-    // than one GTK cell renderer
-    virtual void GtkPackIntoColumn(GtkTreeViewColumn *column);
-
-    // called when the cell value was edited by user with the new value
-    //
-    // it validates the new value and notifies the model about the change by
-    // calling GtkOnCellChanged() if it was accepted
-    void GtkOnTextEdited(const gchar *itempath, const wxString& value);
-
-    GtkCellRenderer* GetGtkHandle() { return m_renderer; }
-    void GtkInitHandlers();
-    void GtkUpdateAlignment();
-
-    bool GtkIsUsingDefaultAttrs() const { return m_usingDefaultAttrs; }
-    void GtkSetUsingDefaultAttrs(bool def) { m_usingDefaultAttrs = def; }
-
-protected:
-    virtual void GtkOnCellChanged(const wxVariant& value,
-                                  const wxDataViewItem& item,
-                                  unsigned col);
-
-
-    GtkCellRenderer   *m_renderer;
-    int                m_alignment;
-
-    // true if we hadn't changed any visual attributes or restored them since
-    // doing this
-    bool m_usingDefaultAttrs;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewTextRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewRenderer
-{
-public:
-    wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                            int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    virtual bool SetValue( const wxVariant &value )
-    {
-        return SetTextValue(value);
-    }
-
-    virtual bool GetValue( wxVariant &value ) const
-    {
-        wxString str;
-        if ( !GetTextValue(str) )
-            return false;
-
-        value = str;
-
-        return true;
-    }
-
-    virtual void SetAlignment( int align );
-
-protected:
-    // implementation of Set/GetValue()
-    bool SetTextValue(const wxString& str);
-    bool GetTextValue(wxString& str) const;
-
-
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewBitmapRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewRenderer
-{
-public:
-    wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
-                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                              int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewToggleRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
-{
-public:
-    wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
-                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                              int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewCustomRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
-{
-public:
-    wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
-                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                              int align = wxDVR_DEFAULT_ALIGNMENT,
-                              bool no_init = false );
-    virtual ~wxDataViewCustomRenderer();
-
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
-
-    void RenderText( const wxString &text, int xoffset,  wxRect cell, wxDC *dc, int state );
-
-    virtual wxSize GetSize() const = 0;
-
-    virtual bool Activate( wxRect WXUNUSED(cell),
-                           wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
-                           { return false; }
-
-    virtual bool LeftClick( wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell),
-                           wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
-                           { return false; }
-    virtual bool StartDrag( wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell),
-                           wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
-                           { return false; }
-
-    // Create DC on request
-    virtual wxDC *GetDC();
-
-
-protected:
-
-    bool Init(wxDataViewCellMode mode, int align);
-
-private:
-    wxDC        *m_dc;
-
-public:
-    // Internal, temporary for RenderText.
-    GtkCellRenderer      *m_text_renderer;
-    GdkWindow            *window;
-    GtkWidget            *widget;
-    void                 *background_area;
-    void                 *cell_area;
-    void                 *expose_area;
-    int                   flags;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewProgressRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
-                                const wxString &varianttype = wxT("long"),
-                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                                int align = wxDVR_DEFAULT_ALIGNMENT );
-    virtual ~wxDataViewProgressRenderer();
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-
-private:
-    wxString    m_label;
-    int         m_value;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewIconTextRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewTextRenderer
-{
-public:
-    wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
-                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                                int align = wxDVR_DEFAULT_ALIGNMENT );
-    virtual ~wxDataViewIconTextRenderer();
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-    virtual void GtkPackIntoColumn(GtkTreeViewColumn *column);
-
-protected:
-    virtual void GtkOnCellChanged(const wxVariant& value,
-                                  const wxDataViewItem& item,
-                                  unsigned col);
-
-private:
-    wxDataViewIconText   m_value;
-
-    // we use the base class m_renderer for the text and this one for the icon
-    GtkCellRenderer *m_rendererIcon;
-
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewDateRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
-                            int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-    virtual bool Activate( wxRect cell,
-                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col );
-
-private:
-    wxDateTime    m_date;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
-};
-
-// -------------------------------------
-// wxDataViewChoiceRenderer
-// -------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewChoiceRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewChoiceRenderer( const wxArrayString &choices,
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
-                            int alignment = wxDVR_DEFAULT_ALIGNMENT );
-    virtual bool Render( wxRect rect, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-    virtual bool SetValue( const wxVariant &value );
-    virtual bool GetValue( wxVariant &value ) const;
-
-    void SetAlignment( int align );
-private:
-    wxArrayString m_choices;
-    wxString      m_data;
-};
+struct _GtkTreePath;

 
 // ---------------------------------------------------------
 // wxDataViewColumn
 
 // ---------------------------------------------------------
 // wxDataViewColumn


@@ -345,7 +46,7 @@ public:
     virtual void SetSortOrder( bool ascending );
     virtual void SetAsSortKey(bool sort = true);
 
     virtual void SetSortOrder( bool ascending );
     virtual void SetAsSortKey(bool sort = true);
 

-    virtual void SetResizeable( bool resizeable );
+    virtual void SetResizeable( bool resizable );

     virtual void SetHidden( bool hidden );
 
     virtual void SetMinWidth( int minWidth );
     virtual void SetHidden( bool hidden );
 
     virtual void SetMinWidth( int minWidth );


@@ -375,8 +76,7 @@ public:
     virtual int GetFlags() const { return GetFromIndividualFlags(); }
 
     // implementation
     virtual int GetFlags() const { return GetFromIndividualFlags(); }
 
     // implementation

-    GtkWidget* GetGtkHandle() { return m_column; }
-    GtkWidget* GetConstGtkHandle() const { return m_column; }
+    GtkWidget* GetGtkHandle() const { return m_column; }

 
 private:
     // holds the GTK handle
 
 private:
     // holds the GTK handle


@@ -412,19 +112,21 @@ public:
     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,
     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,

-           const wxValidator& validator = wxDefaultValidator )
+           const wxValidator& validator = wxDefaultValidator,
+           const wxString& name = wxDataViewCtrlNameStr )

     {
     {

-        Create(parent, id, pos, size, style, validator );
-    }
-
-    virtual ~wxDataViewCtrl();
+        Init();

 
 

-    void Init();
+        Create(parent, id, pos, size, style, validator, name);
+    }

 
     bool Create(wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,
 
     bool Create(wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,

-           const wxValidator& validator = wxDefaultValidator );
+           const wxValidator& validator = wxDefaultValidator,
+           const wxString& name = wxDataViewCtrlNameStr);
+
+    virtual ~wxDataViewCtrl();

 
     virtual bool AssociateModel( wxDataViewModel *model );
 
 
     virtual bool AssociateModel( wxDataViewModel *model );
 


@@ -440,7 +142,7 @@ public:
 
     virtual wxDataViewColumn *GetSortingColumn() const;
 
 
     virtual wxDataViewColumn *GetSortingColumn() const;
 

-    virtual wxDataViewItem GetSelection() const;
+    virtual int GetSelectedItemsCount() const;

     virtual int GetSelections( wxDataViewItemArray & sel ) const;
     virtual void SetSelections( const wxDataViewItemArray & sel );
     virtual void Select( const wxDataViewItem & item );
     virtual int GetSelections( wxDataViewItemArray & sel ) const;
     virtual void SetSelections( const wxDataViewItemArray & sel );
     virtual void Select( const wxDataViewItem & item );


@@ -457,6 +159,10 @@ public:
     virtual wxRect GetItemRect( const wxDataViewItem &item,
                                 const wxDataViewColumn *column = NULL ) const;
 
     virtual wxRect GetItemRect( const wxDataViewItem &item,
                                 const wxDataViewColumn *column = NULL ) const;
 

+    virtual bool SetRowHeight( int rowHeight );
+
+    virtual void StartEditor( const wxDataViewItem & item, unsigned int column );
+

     virtual void Expand( const wxDataViewItem & item );
     virtual void Collapse( const wxDataViewItem & item );
     virtual bool IsExpanded( const wxDataViewItem & item ) const;
     virtual void Expand( const wxDataViewItem & item );
     virtual void Collapse( const wxDataViewItem & item );
     virtual bool IsExpanded( const wxDataViewItem & item ) const;


@@ -472,8 +178,14 @@ public:
     GtkWidget *GtkGetTreeView() { return m_treeview; }
     wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
 
     GtkWidget *GtkGetTreeView() { return m_treeview; }
     wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
 

+    // Convert GTK path to our item. Returned item may be invalid if get_iter()
+    // failed.
+    wxDataViewItem GTKPathToItem(struct _GtkTreePath *path) const;
+

     virtual void OnInternalIdle();
 
     virtual void OnInternalIdle();
 

+    int GTKGetUniformRowHeight() const { return m_uniformRowHeight; }
+

 protected:
     virtual void DoSetExpanderColumn();
     virtual void DoSetIndent();
 protected:
     virtual void DoSetExpanderColumn();
     virtual void DoSetIndent();


@@ -481,15 +193,30 @@ protected:
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
 private:
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
 private:

+    void Init();
+
+    virtual wxDataViewItem DoGetCurrentItem() const;
+    virtual void DoSetCurrentItem(const wxDataViewItem& item);
+
+    // Return wxDataViewColumn matching the given GtkTreeViewColumn.
+    //
+    // If the input argument is NULL, return NULL too. Otherwise we must find
+    // the matching column and assert if we didn't.
+    wxDataViewColumn* FromGTKColumn(GtkTreeViewColumn *gtk_col) const;
+

     friend class wxDataViewCtrlDCImpl;
     friend class wxDataViewColumn;
     friend class wxDataViewCtrlDCImpl;
     friend class wxDataViewColumn;

-    friend class wxGtkDataViewModelNotifier;

     friend class wxDataViewCtrlInternal;
 
     GtkWidget               *m_treeview;
     friend class wxDataViewCtrlInternal;
 
     GtkWidget               *m_treeview;

-    wxDataViewModelNotifier *m_notifier;

     wxDataViewCtrlInternal  *m_internal;
     wxDataViewColumnList     m_cols;
     wxDataViewCtrlInternal  *m_internal;
     wxDataViewColumnList     m_cols;

+    wxDataViewItem           m_ensureVisibleDefered;
+
+    // By default this is set to -1 and the height of the rows is determined by
+    // GetRect() methods of the renderers but this can be set to a positive
+    // value to force the height of all rows to the given value.
+    int m_uniformRowHeight;

 
     virtual void AddChildGTK(wxWindowGTK* child);
     void GtkEnableSelectionEvents();
 
     virtual void AddChildGTK(wxWindowGTK* child);
     void GtkEnableSelectionEvents();