adding SetLabel -> SetTitle redirects, solves missing title updates using wxDocument...

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

diff --git a/include/wx/gtk/dataview.h b/include/wx/gtk/dataview.h
index 1b6ecf086cb35cd4efd263ddc41bc6925215a5be..fad45a6b48dd8d584bae722b8e9f7b93dd11b24f 100644 (file)
--- a/include/wx/gtk/dataview.h
+++ b/include/wx/gtk/dataview.h
@@ -7,250 +7,18 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKDATAVIEWCTRLH__
-#define __GTKDATAVIEWCTRLH__
+#ifndef _WX_GTKDATAVIEWCTRL_H_
+#define _WX_GTKDATAVIEWCTRL_H_

 
 

-#include "wx/defs.h"
-#include "wx/object.h"

 #include "wx/list.h"
 #include "wx/list.h"

-#include "wx/control.h"

 
 

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

 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
 
 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
 

+struct _GtkTreePath;

 
 

-// --------------------------------------------------------- 
-// 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;
-
-    // implementation
-    GtkCellRenderer* GetGtkHandle() { return m_renderer; }
-    void GtkInitHandlers();
-
-protected:
-    GtkCellRenderer   *m_renderer;
-
-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 );
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-    void SetAlignment( int align );
-
-protected:
-    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 cell,
-                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )   
-                           { return false; }
-
-    virtual bool LeftClick( wxPoint cursor, wxRect cell, 
-                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )   
-                           { return false; }
-    virtual bool RightClick( wxPoint cursor, wxRect cell,
-                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )   
-                           { return false; }
-    virtual bool StartDrag( wxPoint cursor, wxRect cell, 
-                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )   
-                           { return false; }
-    
-    // Create DC on request
-    virtual wxDC *GetDC();
-    
-
-protected:
-
-    bool Init(wxDataViewCellMode mode, int align);
-
-private:
-    wxDC        *m_dc;
-
-public:    
-    // Internal, temporay 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 wxDataViewCustomRenderer
-{
-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 bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-    
-    virtual bool HasEditorCtrl() { return true; }
-    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
-    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
-    
-private:
-    wxDataViewIconText   m_value;
-    
-protected:
-    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)
-};
-    
-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewColumn
 // wxDataViewColumn

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 {
 
 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 {


@@ -264,8 +32,6 @@ public:
                       wxAlignment align = wxALIGN_CENTER,
                       int flags = wxDATAVIEW_COL_RESIZABLE );
 
                       wxAlignment align = wxALIGN_CENTER,
                       int flags = wxDATAVIEW_COL_RESIZABLE );
 

-    virtual ~wxDataViewColumn();
-

 
     // setters:
 
 
     // setters:
 


@@ -275,16 +41,19 @@ public:
     virtual void SetOwner( wxDataViewCtrl *owner );
 
     virtual void SetAlignment( wxAlignment align );
     virtual void SetOwner( wxDataViewCtrl *owner );
 
     virtual void SetAlignment( wxAlignment align );

-    
+

     virtual void SetSortable( bool sortable );
     virtual void SetSortOrder( bool ascending );
 
     virtual void SetSortable( bool sortable );
     virtual void SetSortOrder( bool ascending );
 

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

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

+    virtual void SetReorderable( bool reorderable );
+
+    virtual void SetFlags(int flags) { SetIndividualFlags(flags); }

 
     // getters:
 
 
     // getters:
 


@@ -293,67 +62,77 @@ public:
 
     virtual bool IsSortable() const;
     virtual bool IsSortOrderAscending() const;
 
     virtual bool IsSortable() const;
     virtual bool IsSortOrderAscending() const;

+    virtual bool IsSortKey() const;
+

     virtual bool IsResizeable() const;
     virtual bool IsHidden() const;
 
     virtual int GetWidth() const;
     virtual int GetMinWidth() const;
 
     virtual bool IsResizeable() const;
     virtual bool IsHidden() const;
 
     virtual int GetWidth() const;
     virtual int GetMinWidth() const;
 

+    virtual bool IsReorderable() const;
+
+    virtual int GetFlags() const { return GetFromIndividualFlags(); }
+

     // implementation
     // implementation

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

 
 private:
     // holds the GTK handle
     GtkWidget   *m_column;
 
 private:
     // holds the GTK handle
     GtkWidget   *m_column;

-    
+
+    // holds GTK handles for title/bitmap in the header
+    GtkWidget   *m_image;
+    GtkWidget   *m_label;
+

     // delayed connection to mouse events
     friend class wxDataViewCtrl;
     void OnInternalIdle();
     bool    m_isConnected;
 
     void Init(wxAlignment align, int flags, int width);
     // delayed connection to mouse events
     friend class wxDataViewCtrl;
     void OnInternalIdle();
     bool    m_isConnected;
 
     void Init(wxAlignment align, int flags, int width);

-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)

 };
 
 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
                           class WXDLLIMPEXP_ADV);
 
 };
 
 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
                           class WXDLLIMPEXP_ADV);
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewCtrl
 // wxDataViewCtrl

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 {
 public:
 
 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 {
 public:

-    wxDataViewCtrl() 
+    wxDataViewCtrl()

     {
         Init();
     }
     {
         Init();
     }

-    
+

     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 );

-    
+

     virtual bool PrependColumn( wxDataViewColumn *col );
     virtual bool AppendColumn( wxDataViewColumn *col );
     virtual bool PrependColumn( wxDataViewColumn *col );
     virtual bool AppendColumn( wxDataViewColumn *col );

+    virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
+

     virtual unsigned int GetColumnCount() const;
     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
     virtual bool DeleteColumn( wxDataViewColumn *column );
     virtual unsigned int GetColumnCount() const;
     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
     virtual bool DeleteColumn( wxDataViewColumn *column );


@@ -362,7 +141,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 );


@@ -371,48 +150,82 @@ public:
     virtual void SelectAll();
     virtual void UnselectAll();
 
     virtual void SelectAll();
     virtual void UnselectAll();
 

-    virtual void EnsureVisible( const wxDataViewItem& item, 
+    virtual void EnsureVisible( const wxDataViewItem& item,

                                 const wxDataViewColumn *column = NULL );
                                 const wxDataViewColumn *column = NULL );

-    virtual void HitTest( const wxPoint &point, 
-                          wxDataViewItem &item, 
+    virtual void HitTest( const wxPoint &point,
+                          wxDataViewItem &item,

                           wxDataViewColumn *&column ) const;
                           wxDataViewColumn *&column ) const;

-    virtual wxRect GetItemRect( const wxDataViewItem &item, 
+    virtual wxRect GetItemRect( const wxDataViewItem &item,

                                 const wxDataViewColumn *column = NULL ) const;
 
                                 const wxDataViewColumn *column = NULL ) const;
 

+    virtual bool SetRowHeight( int rowHeight );
+
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
+

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

+    virtual bool IsExpanded( const wxDataViewItem & item ) const;
+
+    virtual bool EnableDragSource( const wxDataFormat &format );
+    virtual bool EnableDropTarget( const wxDataFormat &format );
+
+    virtual wxDataViewColumn *GetCurrentColumn() const;

 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

-    
+

     wxWindow *GetMainWindow() { return (wxWindow*) this; }
     wxWindow *GetMainWindow() { return (wxWindow*) this; }

-    
+

     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();
+
+    int GTKGetUniformRowHeight() const { return m_uniformRowHeight; }
+

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

+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+

 private:
 private:

-    friend class wxDataViewCtrlDC;
+    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 wxDataViewColumn;

-    friend class wxGtkDataViewModelNotifier;
+    friend class wxDataViewCtrlInternal;
+

     GtkWidget               *m_treeview;
     GtkWidget               *m_treeview;

-    wxDataViewModelNotifier *m_notifier;

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

+    wxDataViewItem           m_ensureVisibleDefered;

 
 

-    
-    virtual void OnInternalIdle();
-    
+    // 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();
     void GtkDisableSelectionEvents();
     void GtkEnableSelectionEvents();
     void GtkDisableSelectionEvents();

-    
-private:
+

     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)

-    DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);

 };
 
 
 };
 
 

-#endif // __GTKDATAVIEWCTRLH__
+#endif // _WX_GTKDATAVIEWCTRL_H_