Unselect all wxDataViewCtrl items when clicking outside of the item area.

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

diff --git a/include/wx/gtk/dataview.h b/include/wx/gtk/dataview.h
index c31e2fc50b0496ccdd80787a8badbce7c224d82d..fad45a6b48dd8d584bae722b8e9f7b93dd11b24f 100644 (file)
--- a/include/wx/gtk/dataview.h
+++ b/include/wx/gtk/dataview.h
@@ -7,251 +7,225 @@
 // 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 wxDataViewCtrlInternal;

 
 

-class WXDLLIMPEXP_CORE wxDataViewCtrl;
+struct _GtkTreePath;

 
 

-// --------------------------------------------------------- 
-// wxDataViewCell
-// --------------------------------------------------------- 
+// ---------------------------------------------------------
+// wxDataViewColumn
+// ---------------------------------------------------------

 
 

-class wxDataViewCell: public wxDataViewCellBase
+class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase

 {
 public:
 {
 public:

-    wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
+                      unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
+                      wxAlignment align = wxALIGN_CENTER,
+                      int flags = wxDATAVIEW_COL_RESIZABLE );
+    wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
+                      unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
+                      wxAlignment align = wxALIGN_CENTER,
+                      int flags = wxDATAVIEW_COL_RESIZABLE );

 
 

-    // implementation
-    void* GetGtkHandle() { return m_renderer; }

 
 

-protected:
-    // holds the GTK handle
-    void*   m_renderer;
+    // setters:

 
 

-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewTextCell
-// --------------------------------------------------------- 
+    virtual void SetTitle( const wxString &title );
+    virtual void SetBitmap( const wxBitmap &bitmap );

 
 

-class wxDataViewTextCell: public wxDataViewCell
-{
-public:
-    wxDataViewTextCell( const wxString &varianttype = wxT("string"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    virtual void SetOwner( wxDataViewCtrl *owner );

 
 

-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value );
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewBitmapCell
-// --------------------------------------------------------- 
+    virtual void SetAlignment( wxAlignment align );

 
 

-class wxDataViewBitmapCell: public wxDataViewCell
-{
-public:
-    wxDataViewBitmapCell( const wxString &varianttype = wxT("wxBitmap"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    virtual void SetSortable( bool sortable );
+    virtual void SetSortOrder( bool ascending );

 
 

-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value );
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewToggleCell
-// --------------------------------------------------------- 
+    virtual void SetResizeable( bool resizable );
+    virtual void SetHidden( bool hidden );

 
 

-class wxDataViewToggleCell: public wxDataViewCell
-{
-public:
-    wxDataViewToggleCell( const wxString &varianttype = wxT("bool"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    virtual void SetMinWidth( int minWidth );
+    virtual void SetWidth( int width );

 
 

-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value );
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewCustomCell
-// --------------------------------------------------------- 
+    virtual void SetReorderable( bool reorderable );

 
 

-class wxDataViewCustomCell: public wxDataViewCell
-{
-public:
-    wxDataViewCustomCell( const wxString &varianttype = wxT("string"), 
-                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                          bool no_init = false );
-    virtual ~wxDataViewCustomCell();
-    bool Init();
-    
-    virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
-    virtual wxSize GetSize() = 0;
-    
-    virtual bool Activate( wxRect cell,
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    
-    virtual bool LeftClick( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    virtual bool RightClick( wxPoint cursor, wxRect cell,
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    virtual bool StartDrag( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    
-    // Create DC on request
-    virtual wxDC *GetDC();
-    
-private:
-    wxDC        *m_dc;
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewProgressCell
-// --------------------------------------------------------- 
+    virtual void SetFlags(int flags) { SetIndividualFlags(flags); }

 
 

-class wxDataViewProgressCell: public wxDataViewCustomCell
-{
-public:
-    wxDataViewProgressCell( const wxString &label = wxEmptyString, 
-                            const wxString &varianttype = wxT("long"), 
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    virtual ~wxDataViewProgressCell();
-    
-    bool SetValue( const wxVariant &value );
-    
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize();
-    
-private:
-    wxString    m_label;
-    int         m_value;
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewDateCell
-// --------------------------------------------------------- 
+    // getters:

 
 

-class wxDataViewDateCell: public wxDataViewCustomCell
-{
-public:
-    wxDataViewDateCell( const wxString &varianttype = wxT("datetime"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
-    
-    bool SetValue( const wxVariant &value );
-    
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize();
-    virtual bool Activate( wxRect cell,
-                           wxDataViewListModel *model, size_t col, size_t row );
-    
-private:
-    wxDateTime    m_date;
-    
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell)
-};
-    
-// --------------------------------------------------------- 
-// wxDataViewColumn
-// --------------------------------------------------------- 
+    virtual wxString GetTitle() const;
+    virtual wxAlignment GetAlignment() const;

 
 

-class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase
-{
-public:
-    wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column,
-        int fixed_width = 80, wxDataViewColumnSizing sizing = wxDATAVIEW_COL_WIDTH_FIXED, int flags = 0 );
-    virtual ~wxDataViewColumn();
+    virtual bool IsSortable() const;
+    virtual bool IsSortOrderAscending() const;
+    virtual bool IsSortKey() const;

 
 

-    virtual void SetTitle( const wxString &title );
+    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(); }

 
 

-    virtual int GetWidth();
-    
-    virtual void SetFixedWidth( int width );
-    virtual int GetFixedWidth();
-    

     // implementation
     // implementation

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

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

-    void*   m_column;
+    GtkWidget   *m_column;

 
 

-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
+    // 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);

 };
 
 };
 

-// --------------------------------------------------------- 
+WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
+                          class WXDLLIMPEXP_ADV);
+
+// ---------------------------------------------------------

 // wxDataViewCtrl
 // wxDataViewCtrl

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

 
 

-class WXDLLIMPEXP_CORE wxDataViewCtrl: public wxDataViewCtrlBase
+class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase

 {
 public:
 {
 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 bool AssociateModel( wxDataViewListModel *model );
+    virtual ~wxDataViewCtrl();
+
+    virtual bool AssociateModel( wxDataViewModel *model );
+
+    virtual bool PrependColumn( wxDataViewColumn *col );

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

-    
-private:
-    friend class wxDataViewCtrlDC;
-    friend class wxGtkDataViewListModelNotifier;
-    GtkWidget                   *m_treeview;
-    wxDataViewListModelNotifier *m_notifier;
-    
+    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 bool ClearColumns();
+    virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
+
+    virtual wxDataViewColumn *GetSortingColumn() const;
+
+    virtual int GetSelectedItemsCount() const;
+    virtual int GetSelections( wxDataViewItemArray & sel ) const;
+    virtual void SetSelections( const wxDataViewItemArray & sel );
+    virtual void Select( const wxDataViewItem & item );
+    virtual void Unselect( const wxDataViewItem & item );
+    virtual bool IsSelected( const wxDataViewItem & item ) const;
+    virtual void SelectAll();
+    virtual void UnselectAll();
+
+    virtual void EnsureVisible( const wxDataViewItem& item,
+                                const wxDataViewColumn *column = NULL );
+    virtual void HitTest( const wxPoint &point,
+                          wxDataViewItem &item,
+                          wxDataViewColumn *&column ) const;
+    virtual wxRect GetItemRect( const wxDataViewItem &item,
+                                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 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);
+
+    wxWindow *GetMainWindow() { return (wxWindow*) this; }
+
+    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();
+
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+

 private:
 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 wxDataViewCtrlInternal;
+
+    GtkWidget               *m_treeview;
+    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();
+    void GtkDisableSelectionEvents();
+

     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)

-    DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);

 };
 
 
 };
 
 

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