Minor corrections to make dist after reports

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

diff --git a/include/wx/gtk/dataview.h b/include/wx/gtk/dataview.h
index 8aaa0b455d333d17dab7fc06672a138ab30c0099..402720cce95a9133c29b727f0fd097649f7966fa 100644 (file)
--- a/include/wx/gtk/dataview.h
+++ b/include/wx/gtk/dataview.h
@@ -7,69 +7,101 @@
 // 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
 // --------------------------------------------------------- 
 
 
 // --------------------------------------------------------- 
 // classes
 // --------------------------------------------------------- 
 

-class WXDLLIMPEXP_CORE wxDataViewCtrl;
+class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
+class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
+

 
 // --------------------------------------------------------- 
 // wxDataViewRenderer
 // --------------------------------------------------------- 
 
 
 // --------------------------------------------------------- 
 // wxDataViewRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewRenderer: public wxDataViewRendererBase
+class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase

 {
 public:
 {
 public:

-    wxDataViewRenderer( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    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
 
     // implementation

-    void* GetGtkHandle() { return m_renderer; }
+    GtkCellRenderer* GetGtkHandle() { return m_renderer; }
+    void GtkInitHandlers();
+    virtual bool GtkHasAttributes() { return false; }
+    void GtkUpdateAlignment();

 
 protected:
 
 protected:

-    // holds the GTK handle
-    void*   m_renderer;
+    GtkCellRenderer   *m_renderer;
+    int                m_alignment;

 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
 };
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
 };

-    
+

 // --------------------------------------------------------- 
 // wxDataViewTextRenderer
 // --------------------------------------------------------- 
 
 // --------------------------------------------------------- 
 // wxDataViewTextRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewTextRenderer: public wxDataViewRenderer
+class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewRenderer

 {
 public:
     wxDataViewTextRenderer( const wxString &varianttype = wxT("string"), 
 {
 public:
     wxDataViewTextRenderer( const wxString &varianttype = wxT("string"), 

-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );

 
     bool SetValue( const wxVariant &value );
 
     bool SetValue( const wxVariant &value );

-    bool GetValue( wxVariant &value );
-    
+    bool GetValue( wxVariant &value ) const;
+
+    void SetAlignment( int align );
+

 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 };
     
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 };
     

+// --------------------------------------------------------- 
+// wxDataViewTextRendererAttr
+// --------------------------------------------------------- 
+
+class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
+{
+public:
+    wxDataViewTextRendererAttr( const wxString &varianttype = wxT("string"), 
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );
+
+    // implementation
+    bool GtkHasAttributes() { return true; }
+    
+protected:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
+};
+    

 // --------------------------------------------------------- 
 // wxDataViewBitmapRenderer
 // --------------------------------------------------------- 
 
 // --------------------------------------------------------- 
 // wxDataViewBitmapRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewBitmapRenderer: public wxDataViewRenderer
+class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewRenderer

 {
 public:
     wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"), 
 {
 public:
     wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"), 

-                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                              int align = wxDVR_DEFAULT_ALIGNMENT );

 
     bool SetValue( const wxVariant &value );
 
     bool SetValue( const wxVariant &value );

-    bool GetValue( wxVariant &value );
+    bool GetValue( wxVariant &value ) const;

     
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
     
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)


@@ -79,14 +111,15 @@ protected:
 // wxDataViewToggleRenderer
 // --------------------------------------------------------- 
 
 // wxDataViewToggleRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewToggleRenderer: public wxDataViewRenderer
+class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer

 {
 public:
     wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"), 
 {
 public:
     wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"), 

-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                              int align = wxDVR_DEFAULT_ALIGNMENT );

 
     bool SetValue( const wxVariant &value );
 
     bool SetValue( const wxVariant &value );

-    bool GetValue( wxVariant &value );
+    bool GetValue( wxVariant &value ) const;

     
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
     
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)


@@ -96,38 +129,54 @@ protected:
 // wxDataViewCustomRenderer
 // --------------------------------------------------------- 
 
 // wxDataViewCustomRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewCustomRenderer: public wxDataViewRenderer
+class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer

 {
 public:
     wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"), 
                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 {
 public:
     wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"), 
                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,

+                              int align = wxDVR_DEFAULT_ALIGNMENT,

                               bool no_init = false );
     virtual ~wxDataViewCustomRenderer();
                               bool no_init = false );
     virtual ~wxDataViewCustomRenderer();

-    bool Init();
-    
+
+

     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;

-    virtual wxSize GetSize() = 0;

     
     

-    virtual bool Activate( wxRect cell,
-                           wxDataViewListModel *model, unsigned int col, unsigned int row )   
-                           { return false; }
+    void RenderText( const wxString &text, int xoffset,  wxRect cell, wxDC *dc, int state );

     
     

-    virtual bool LeftClick( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, unsigned int col, unsigned int row )   
+    virtual wxSize GetSize() const = 0;
+
+    virtual bool Activate( wxRect WXUNUSED(cell),
+                           wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )   

                            { return false; }
                            { return false; }

-    virtual bool RightClick( wxPoint cursor, wxRect cell,
-                           wxDataViewListModel *model, unsigned int col, unsigned int row )   
+
+    virtual bool LeftClick( wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell), 
+                           wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )   

                            { return false; }
                            { return false; }

-    virtual bool StartDrag( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, unsigned int col, unsigned int row )   
+    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();
     
                            { return false; }
     
     // Create DC on request
     virtual wxDC *GetDC();
     

+
+protected:
+
+    bool Init(wxDataViewCellMode mode, int align);
+

 private:
     wxDC        *m_dc;
 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)
 };
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
 };


@@ -136,18 +185,20 @@ protected:
 // wxDataViewProgressRenderer
 // --------------------------------------------------------- 
 
 // wxDataViewProgressRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewProgressRenderer: public wxDataViewCustomRenderer
+class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer

 {
 public:
     wxDataViewProgressRenderer( const wxString &label = wxEmptyString, 
                                 const wxString &varianttype = wxT("long"), 
 {
 public:
     wxDataViewProgressRenderer( const wxString &label = wxEmptyString, 
                                 const wxString &varianttype = wxT("long"), 

-                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                                int align = wxDVR_DEFAULT_ALIGNMENT );

     virtual ~wxDataViewProgressRenderer();
     
     bool SetValue( const wxVariant &value );
     virtual ~wxDataViewProgressRenderer();
     
     bool SetValue( const wxVariant &value );

+    bool GetValue( wxVariant &value ) const;

     
     virtual bool Render( wxRect cell, wxDC *dc, int state );
     
     virtual bool Render( wxRect cell, wxDC *dc, int state );

-    virtual wxSize GetSize();
+    virtual wxSize GetSize() const;

     
 private:
     wxString    m_label;
     
 private:
     wxString    m_label;


@@ -157,22 +208,53 @@ protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
 };
     
     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
 // --------------------------------------------------------- 
 
 // --------------------------------------------------------- 
 // wxDataViewDateRenderer
 // --------------------------------------------------------- 
 

-class wxDataViewDateRenderer: public wxDataViewCustomRenderer
+class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer

 {
 public:
     wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"), 
 {
 public:
     wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"), 

-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );

     
     bool SetValue( const wxVariant &value );
     
     bool SetValue( const wxVariant &value );

+    bool GetValue( wxVariant &value ) const;

     
     virtual bool Render( wxRect cell, wxDC *dc, int state );
     
     virtual bool Render( wxRect cell, wxDC *dc, int state );

-    virtual wxSize GetSize();
+    virtual wxSize GetSize() const;

     virtual bool Activate( wxRect cell,
     virtual bool Activate( wxRect cell,

-                           wxDataViewListModel *model, unsigned int col, unsigned int row );
+                           wxDataViewModel *model, const wxDataViewItem &item, unsigned int col );

     
 private:
     wxDateTime    m_date;
     
 private:
     wxDateTime    m_date;


@@ -185,36 +267,87 @@ protected:
 // wxDataViewColumn
 // --------------------------------------------------------- 
 
 // wxDataViewColumn
 // --------------------------------------------------------- 
 

-class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase
+class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase

 {
 public:
 {
 public:

-    wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer, unsigned int model_column,
-        int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
+    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 );
+

     virtual ~wxDataViewColumn();
 
     virtual ~wxDataViewColumn();
 

+
+    // setters:
+

     virtual void SetTitle( const wxString &title );
     virtual void SetTitle( const wxString &title );

+    virtual void SetBitmap( const wxBitmap &bitmap );
+
+    virtual void SetOwner( wxDataViewCtrl *owner );

 
 

-    virtual int GetWidth();
+    virtual void SetAlignment( wxAlignment align );

     
     

-    virtual void SetFixedWidth( int width );
-    virtual int GetFixedWidth();
+    virtual void SetSortable( bool sortable );
+    virtual void SetSortOrder( bool ascending );
+
+    virtual void SetResizeable( bool resizeable );
+    virtual void SetHidden( bool hidden );
+
+    virtual void SetMinWidth( int minWidth );
+    virtual void SetWidth( int width );
+
+    virtual void SetReorderable( bool reorderable );
+
+    // getters:
+
+    virtual wxString GetTitle() const;
+    virtual wxAlignment GetAlignment() const;
+
+    virtual bool IsSortable() const;
+    virtual bool IsSortOrderAscending() const;
+    virtual bool IsResizeable() const;
+    virtual bool IsHidden() const;
+
+    virtual int GetWidth() const;
+    virtual int GetMinWidth() const;

     
     

+    virtual bool IsReorderable() const;
+

     // implementation
     // implementation

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

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

-    void*   m_column;
+    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);

 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 };
 
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 };
 

+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:
     wxDataViewCtrl() 
 {
 public:
     wxDataViewCtrl() 


@@ -239,28 +372,71 @@ public:
            const wxSize& size = wxDefaultSize, long style = 0,
            const wxValidator& validator = wxDefaultValidator );
 
            const wxSize& size = wxDefaultSize, long style = 0,
            const wxValidator& validator = wxDefaultValidator );
 

-    virtual bool AssociateModel( wxDataViewListModel *model );
-    virtual bool AppendColumn( wxDataViewColumn *col );
+    virtual bool AssociateModel( wxDataViewModel *model );

     
     

-    virtual void SetSelection( int row ); // -1 for unselect
-    virtual void SetSelectionRange( unsigned int from, unsigned int to );
-    virtual void SetSelections( const wxArrayInt& aSelections);
+    virtual bool PrependColumn( wxDataViewColumn *col );
+    virtual bool AppendColumn( wxDataViewColumn *col );
+    virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );

     
     

-    virtual bool IsSelected( unsigned int row ) const;
-    virtual int GetSelection() const;
-    virtual int GetSelections(wxArrayInt& aSelections) const;
+    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 wxDataViewItem GetSelection() 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 void Expand( const wxDataViewItem & item );
+    virtual void Collapse( const wxDataViewItem & item );
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

     
     

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

     
     

+    GtkWidget *GtkGetTreeView() { return m_treeview; }
+    wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
+
+    virtual void OnInternalIdle();
+
+protected:
+    virtual void DoSetExpanderColumn();
+    virtual void DoSetIndent();
+

 private:
 private:

-    friend class wxDataViewCtrlDC;
-    friend class wxGtkDataViewListModelNotifier;
-    GtkWidget                   *m_treeview;
-    wxDataViewListModelNotifier *m_notifier;
+    friend class wxDataViewCtrlDCImpl;
+    friend class wxDataViewColumn;
+    friend class wxGtkDataViewModelNotifier;
+    friend class wxDataViewCtrlInternal;
+    
+    GtkWidget               *m_treeview;
+    wxDataViewModelNotifier *m_notifier;
+    wxDataViewCtrlInternal  *m_internal;
+    wxDataViewColumnList     m_cols;
+
+    void GtkEnableSelectionEvents();
+    void GtkDisableSelectionEvents();

     
     

-private:

     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
     DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
 };
 
 
     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
     DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
 };
 
 

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