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 __GTKDATAVIEWCTRLH__
  11 #define __GTKDATAVIEWCTRLH__
  12
  13 #include "wx/defs.h"
  14 #include "wx/object.h"
  15 #include "wx/list.h"
  16 #include "wx/control.h"
  17
  18 // ---------------------------------------------------------
  19 // classes
  20 // ---------------------------------------------------------
  21
  22 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  23 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
  24
  25
  26 // ---------------------------------------------------------
  27 // wxDataViewRenderer
  28 // ---------------------------------------------------------
  29
  30 class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
  31 {
  32 public:
  33     wxDataViewRenderer( const wxString &varianttype,
  34                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  35                         int align = wxDVR_DEFAULT_ALIGNMENT );
  36
  37     virtual void SetMode( wxDataViewCellMode mode );
  38     virtual wxDataViewCellMode GetMode() const;
  39
  40     virtual void SetAlignment( int align );
  41     virtual int GetAlignment() const;
  42
  43     // implementation
  44     GtkCellRenderer* GetGtkHandle() { return m_renderer; }
  45     void GtkInitHandlers();
  46
  47 protected:
  48     GtkCellRenderer   *m_renderer;
  49
  50 protected:
  51     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
  52 };
  53
  54 // ---------------------------------------------------------
  55 // wxDataViewTextRenderer
  56 // ---------------------------------------------------------
  57
  58 class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewRenderer
  59 {
  60 public:
  61     wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
  62                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  63                             int align = wxDVR_DEFAULT_ALIGNMENT );
  64
  65     bool SetValue( const wxVariant &value );
  66     bool GetValue( wxVariant &value ) const;
  67
  68     void SetAlignment( int align );
  69
  70 protected:
  71     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
  72 };
  73
  74 // ---------------------------------------------------------
  75 // wxDataViewBitmapRenderer
  76 // ---------------------------------------------------------
  77
  78 class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewRenderer
  79 {
  80 public:
  81     wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
  82                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  83                               int align = wxDVR_DEFAULT_ALIGNMENT );
  84
  85     bool SetValue( const wxVariant &value );
  86     bool GetValue( wxVariant &value ) const;
  87
  88 protected:
  89     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
  90 };
  91
  92 // ---------------------------------------------------------
  93 // wxDataViewToggleRenderer
  94 // ---------------------------------------------------------
  95
  96 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
  97 {
  98 public:
  99     wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
 100                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 101                               int align = wxDVR_DEFAULT_ALIGNMENT );
 102
 103     bool SetValue( const wxVariant &value );
 104     bool GetValue( wxVariant &value ) const;
 105
 106 protected:
 107     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
 108 };
 109
 110 // ---------------------------------------------------------
 111 // wxDataViewCustomRenderer
 112 // ---------------------------------------------------------
 113
 114 class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
 115 {
 116 public:
 117     wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
 118                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 119                               int align = wxDVR_DEFAULT_ALIGNMENT,
 120                               bool no_init = false );
 121     virtual ~wxDataViewCustomRenderer();
 122
 123
 124     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
 125
 126     void RenderText( const wxString &text, int xoffset,  wxRect cell, wxDC *dc, int state );
 127
 128     virtual wxSize GetSize() const = 0;
 129
 130     virtual bool Activate( wxRect cell,
 131                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )
 132                            { return false; }
 133
 134     virtual bool LeftClick( wxPoint cursor, wxRect cell,
 135                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )
 136                            { return false; }
 137     virtual bool RightClick( wxPoint cursor, wxRect cell,
 138                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )
 139                            { return false; }
 140     virtual bool StartDrag( wxPoint cursor, wxRect cell,
 141                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col )
 142                            { return false; }
 143
 144     // Create DC on request
 145     virtual wxDC *GetDC();
 146
 147
 148 protected:
 149
 150     bool Init(wxDataViewCellMode mode, int align);
 151
 152 private:
 153     wxDC        *m_dc;
 154
 155 protected:
 156     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
 157 };
 158
 159 // ---------------------------------------------------------
 160 // wxDataViewProgressRenderer
 161 // ---------------------------------------------------------
 162
 163 class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
 164 {
 165 public:
 166     wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
 167                                 const wxString &varianttype = wxT("long"),
 168                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 169                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 170     virtual ~wxDataViewProgressRenderer();
 171
 172     bool SetValue( const wxVariant &value );
 173     bool GetValue( wxVariant &value ) const;
 174
 175     virtual bool Render( wxRect cell, wxDC *dc, int state );
 176     virtual wxSize GetSize() const;
 177
 178 private:
 179     wxString    m_label;
 180     int         m_value;
 181
 182 protected:
 183     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
 184 };
 185
 186 // ---------------------------------------------------------
 187 // wxDataViewIconTextRenderer
 188 // ---------------------------------------------------------
 189
 190 class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
 191 {
 192 public:
 193     wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
 194                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 195                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 196     virtual ~wxDataViewIconTextRenderer();
 197
 198     bool SetValue( const wxVariant &value );
 199     bool GetValue( wxVariant &value ) const;
 200
 201     virtual bool Render( wxRect cell, wxDC *dc, int state );
 202     virtual wxSize GetSize() const;
 203
 204     virtual bool HasEditorCtrl() { return true; }
 205     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
 206     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
 207
 208 private:
 209     wxDataViewIconText   m_value;
 210
 211 protected:
 212     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
 213 };
 214
 215 // ---------------------------------------------------------
 216 // wxDataViewDateRenderer
 217 // ---------------------------------------------------------
 218
 219 class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
 220 {
 221 public:
 222     wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
 223                             wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
 224                             int align = wxDVR_DEFAULT_ALIGNMENT );
 225
 226     bool SetValue( const wxVariant &value );
 227     bool GetValue( wxVariant &value ) const;
 228
 229     virtual bool Render( wxRect cell, wxDC *dc, int state );
 230     virtual wxSize GetSize() const;
 231     virtual bool Activate( wxRect cell,
 232                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col );
 233
 234 private:
 235     wxDateTime    m_date;
 236
 237 protected:
 238     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
 239 };
 240
 241 // ---------------------------------------------------------
 242 // wxDataViewColumn
 243 // ---------------------------------------------------------
 244
 245 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 246 {
 247 public:
 248     wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
 249                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 250                       wxAlignment align = wxALIGN_CENTER,
 251                       int flags = wxDATAVIEW_COL_RESIZABLE );
 252     wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
 253                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 254                       wxAlignment align = wxALIGN_CENTER,
 255                       int flags = wxDATAVIEW_COL_RESIZABLE );
 256
 257     virtual ~wxDataViewColumn();
 258
 259
 260     // setters:
 261
 262     virtual void SetTitle( const wxString &title );
 263     virtual void SetBitmap( const wxBitmap &bitmap );
 264
 265     virtual void SetOwner( wxDataViewCtrl *owner );
 266
 267     virtual void SetAlignment( wxAlignment align );
 268
 269     virtual void SetSortable( bool sortable );
 270     virtual void SetSortOrder( bool ascending );
 271
 272     virtual void SetResizeable( bool resizeable );
 273     virtual void SetHidden( bool hidden );
 274
 275     virtual void SetMinWidth( int minWidth );
 276     virtual void SetWidth( int width );
 277
 278
 279     // getters:
 280
 281     virtual wxString GetTitle() const;
 282     virtual wxAlignment GetAlignment() const;
 283
 284     virtual bool IsSortable() const;
 285     virtual bool IsSortOrderAscending() const;
 286     virtual bool IsResizeable() const;
 287     virtual bool IsHidden() const;
 288
 289     virtual int GetWidth() const;
 290     virtual int GetMinWidth() const;
 291
 292     // implementation
 293     GtkWidget* GetGtkHandle() { return m_column; }
 294     GtkWidget* GetConstGtkHandle() const { return m_column; }
 295
 296 private:
 297     // holds the GTK handle
 298     GtkWidget   *m_column;
 299
 300     // delayed connection to mouse events
 301     friend class wxDataViewCtrl;
 302     void OnInternalIdle();
 303     bool    m_isConnected;
 304
 305     void Init(wxAlignment align, int flags, int width);
 306
 307 protected:
 308     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 309 };
 310
 311 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
 312                           class WXDLLIMPEXP_ADV);
 313
 314 // ---------------------------------------------------------
 315 // wxDataViewCtrl
 316 // ---------------------------------------------------------
 317
 318 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 319 {
 320 public:
 321     wxDataViewCtrl()
 322     {
 323         Init();
 324     }
 325
 326     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 327            const wxPoint& pos = wxDefaultPosition,
 328            const wxSize& size = wxDefaultSize, long style = 0,
 329            const wxValidator& validator = wxDefaultValidator )
 330     {
 331         Create(parent, id, pos, size, style, validator );
 332     }
 333
 334     virtual ~wxDataViewCtrl();
 335
 336     void Init();
 337
 338     bool Create(wxWindow *parent, wxWindowID id,
 339            const wxPoint& pos = wxDefaultPosition,
 340            const wxSize& size = wxDefaultSize, long style = 0,
 341            const wxValidator& validator = wxDefaultValidator );
 342
 343     virtual bool AssociateModel( wxDataViewModel *model );
 344
 345     virtual bool PrependColumn( wxDataViewColumn *col );
 346     virtual bool AppendColumn( wxDataViewColumn *col );
 347     virtual unsigned int GetColumnCount() const;
 348     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 349     virtual bool DeleteColumn( wxDataViewColumn *column );
 350     virtual bool ClearColumns();
 351     virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
 352
 353     virtual wxDataViewColumn *GetSortingColumn() const;
 354
 355     virtual wxDataViewItem GetSelection() const;
 356     virtual int GetSelections( wxDataViewItemArray & sel ) const;
 357     virtual void SetSelections( const wxDataViewItemArray & sel );
 358     virtual void Select( const wxDataViewItem & item );
 359     virtual void Unselect( const wxDataViewItem & item );
 360     virtual bool IsSelected( const wxDataViewItem & item ) const;
 361     virtual void SelectAll();
 362     virtual void UnselectAll();
 363
 364     virtual void EnsureVisible( const wxDataViewItem& item,
 365                                 const wxDataViewColumn *column = NULL );
 366     virtual void HitTest( const wxPoint &point,
 367                           wxDataViewItem &item,
 368                           wxDataViewColumn *&column ) const;
 369     virtual wxRect GetItemRect( const wxDataViewItem &item,
 370                                 const wxDataViewColumn *column = NULL ) const;
 371
 372     virtual void Expand( const wxDataViewItem & item );
 373     virtual void Collapse( const wxDataViewItem & item );
 374
 375     static wxVisualAttributes
 376     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 377
 378     wxWindow *GetMainWindow() { return (wxWindow*) this; }
 379
 380     GtkWidget *GtkGetTreeView() { return m_treeview; }
 381     wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
 382
 383 protected:
 384     virtual void DoSetExpanderColumn();
 385     virtual void DoSetIndent();
 386
 387 private:
 388     friend class wxDataViewCtrlDC;
 389     friend class wxDataViewColumn;
 390     friend class wxGtkDataViewModelNotifier;
 391     GtkWidget               *m_treeview;
 392     wxDataViewModelNotifier *m_notifier;
 393     wxDataViewCtrlInternal  *m_internal;
 394     wxDataViewColumnList     m_cols;
 395
 396
 397     virtual void OnInternalIdle();
 398
 399     void GtkEnableSelectionEvents();
 400     void GtkDisableSelectionEvents();
 401
 402 private:
 403     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 404     DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
 405 };
 406
 407
 408 #endif // __GTKDATAVIEWCTRLH__