include/wx/gtk/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/dataview.h
   3 // Purpose:     wxDataViewCtrl GTK+2 implementation header
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTKDATAVIEWCTRL_H_
  11 #define _WX_GTKDATAVIEWCTRL_H_
  12
  13 #include "wx/list.h"
  14
  15 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
  16
  17 struct _GtkTreePath;
  18
  19 // ---------------------------------------------------------
  20 // wxDataViewColumn
  21 // ---------------------------------------------------------
  22
  23 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
  24 {
  25 public:
  26     wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
  27                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
  28                       wxAlignment align = wxALIGN_CENTER,
  29                       int flags = wxDATAVIEW_COL_RESIZABLE );
  30     wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
  31                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
  32                       wxAlignment align = wxALIGN_CENTER,
  33                       int flags = wxDATAVIEW_COL_RESIZABLE );
  34
  35
  36     // setters:
  37
  38     virtual void SetTitle( const wxString &title );
  39     virtual void SetBitmap( const wxBitmap &bitmap );
  40
  41     virtual void SetOwner( wxDataViewCtrl *owner );
  42
  43     virtual void SetAlignment( wxAlignment align );
  44
  45     virtual void SetSortable( bool sortable );
  46     virtual void SetSortOrder( bool ascending );
  47     virtual void SetAsSortKey(bool sort = true);
  48
  49     virtual void SetResizeable( bool resizable );
  50     virtual void SetHidden( bool hidden );
  51
  52     virtual void SetMinWidth( int minWidth );
  53     virtual void SetWidth( int width );
  54
  55     virtual void SetReorderable( bool reorderable );
  56
  57     virtual void SetFlags(int flags) { SetIndividualFlags(flags); }
  58
  59     // getters:
  60
  61     virtual wxString GetTitle() const;
  62     virtual wxAlignment GetAlignment() const;
  63
  64     virtual bool IsSortable() const;
  65     virtual bool IsSortOrderAscending() const;
  66     virtual bool IsSortKey() const;
  67
  68     virtual bool IsResizeable() const;
  69     virtual bool IsHidden() const;
  70
  71     virtual int GetWidth() const;
  72     virtual int GetMinWidth() const;
  73
  74     virtual bool IsReorderable() const;
  75
  76     virtual int GetFlags() const { return GetFromIndividualFlags(); }
  77
  78     // implementation
  79     GtkWidget* GetGtkHandle() const { return m_column; }
  80
  81 private:
  82     // holds the GTK handle
  83     GtkWidget   *m_column;
  84
  85     // holds GTK handles for title/bitmap in the header
  86     GtkWidget   *m_image;
  87     GtkWidget   *m_label;
  88
  89     // delayed connection to mouse events
  90     friend class wxDataViewCtrl;
  91     void OnInternalIdle();
  92     bool    m_isConnected;
  93
  94     void Init(wxAlignment align, int flags, int width);
  95 };
  96
  97 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
  98                           class WXDLLIMPEXP_ADV);
  99
 100 // ---------------------------------------------------------
 101 // wxDataViewCtrl
 102 // ---------------------------------------------------------
 103
 104 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 105 {
 106 public:
 107     wxDataViewCtrl()
 108     {
 109         Init();
 110     }
 111
 112     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 113            const wxPoint& pos = wxDefaultPosition,
 114            const wxSize& size = wxDefaultSize, long style = 0,
 115            const wxValidator& validator = wxDefaultValidator,
 116            const wxString& name = wxDataViewCtrlNameStr )
 117     {
 118         Init();
 119
 120         Create(parent, id, pos, size, style, validator, name);
 121     }
 122
 123     bool Create(wxWindow *parent, wxWindowID id,
 124            const wxPoint& pos = wxDefaultPosition,
 125            const wxSize& size = wxDefaultSize, long style = 0,
 126            const wxValidator& validator = wxDefaultValidator,
 127            const wxString& name = wxDataViewCtrlNameStr);
 128
 129     virtual ~wxDataViewCtrl();
 130
 131     virtual bool AssociateModel( wxDataViewModel *model );
 132
 133     virtual bool PrependColumn( wxDataViewColumn *col );
 134     virtual bool AppendColumn( wxDataViewColumn *col );
 135     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 136
 137     virtual unsigned int GetColumnCount() const;
 138     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 139     virtual bool DeleteColumn( wxDataViewColumn *column );
 140     virtual bool ClearColumns();
 141     virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
 142
 143     virtual wxDataViewColumn *GetSortingColumn() const;
 144
 145     virtual wxDataViewItem GetSelection() const;
 146     virtual int GetSelections( wxDataViewItemArray & sel ) const;
 147     virtual void SetSelections( const wxDataViewItemArray & sel );
 148     virtual void Select( const wxDataViewItem & item );
 149     virtual void Unselect( const wxDataViewItem & item );
 150     virtual bool IsSelected( const wxDataViewItem & item ) const;
 151     virtual void SelectAll();
 152     virtual void UnselectAll();
 153
 154     virtual void EnsureVisible( const wxDataViewItem& item,
 155                                 const wxDataViewColumn *column = NULL );
 156     virtual void HitTest( const wxPoint &point,
 157                           wxDataViewItem &item,
 158                           wxDataViewColumn *&column ) const;
 159     virtual wxRect GetItemRect( const wxDataViewItem &item,
 160                                 const wxDataViewColumn *column = NULL ) const;
 161
 162     virtual bool SetRowHeight( int rowHeight );
 163
 164     virtual void StartEditor( const wxDataViewItem & item, unsigned int column );
 165
 166     virtual void Expand( const wxDataViewItem & item );
 167     virtual void Collapse( const wxDataViewItem & item );
 168     virtual bool IsExpanded( const wxDataViewItem & item ) const;
 169
 170     virtual bool EnableDragSource( const wxDataFormat &format );
 171     virtual bool EnableDropTarget( const wxDataFormat &format );
 172
 173     static wxVisualAttributes
 174     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 175
 176     wxWindow *GetMainWindow() { return (wxWindow*) this; }
 177
 178     GtkWidget *GtkGetTreeView() { return m_treeview; }
 179     wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
 180
 181     // Convert GTK path to our item. Returned item may be invalid if get_iter()
 182     // failed.
 183     wxDataViewItem GTKPathToItem(struct _GtkTreePath *path) const;
 184
 185     virtual void OnInternalIdle();
 186
 187     int GTKGetUniformRowHeight() const { return m_uniformRowHeight; }
 188
 189 protected:
 190     virtual void DoSetExpanderColumn();
 191     virtual void DoSetIndent();
 192
 193     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 194
 195 private:
 196     void Init();
 197
 198     virtual wxDataViewItem DoGetCurrentItem() const;
 199     virtual void DoSetCurrentItem(const wxDataViewItem& item);
 200
 201     // Return wxDataViewColumn matching the given GtkTreeViewColumn.
 202     //
 203     // If the input argument is NULL, return NULL too. Otherwise we must find
 204     // the matching column and assert if we didn't.
 205     wxDataViewColumn* FromGTKColumn(GtkTreeViewColumn *gtk_col) const;
 206
 207     friend class wxDataViewCtrlDCImpl;
 208     friend class wxDataViewColumn;
 209     friend class wxDataViewCtrlInternal;
 210
 211     GtkWidget               *m_treeview;
 212     wxDataViewCtrlInternal  *m_internal;
 213     wxDataViewColumnList     m_cols;
 214     wxDataViewItem           m_ensureVisibleDefered;
 215
 216     // By default this is set to -1 and the height of the rows is determined by
 217     // GetRect() methods of the renderers but this can be set to a positive
 218     // value to force the height of all rows to the given value.
 219     int m_uniformRowHeight;
 220
 221     virtual void AddChildGTK(wxWindowGTK* child);
 222     void GtkEnableSelectionEvents();
 223     void GtkDisableSelectionEvents();
 224
 225     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 226     wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);
 227 };
 228
 229
 230 #endif // _WX_GTKDATAVIEWCTRL_H_