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 // ---------------------------------------------------------
  16 // classes
  17 // ---------------------------------------------------------
  18
  19 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  20 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrlInternal;
  21
  22
  23 // ---------------------------------------------------------
  24 // wxDataViewRenderer
  25 // ---------------------------------------------------------
  26
  27 class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
  28 {
  29 public:
  30     wxDataViewRenderer( const wxString &varianttype,
  31                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  32                         int align = wxDVR_DEFAULT_ALIGNMENT );
  33
  34     virtual void SetMode( wxDataViewCellMode mode );
  35     virtual wxDataViewCellMode GetMode() const;
  36
  37     virtual void SetAlignment( int align );
  38     virtual int GetAlignment() const;
  39
  40     // implementation
  41     GtkCellRenderer* GetGtkHandle() { return m_renderer; }
  42     void GtkInitHandlers();
  43     virtual bool GtkHasAttributes() { return false; }
  44     void GtkUpdateAlignment();
  45
  46 protected:
  47     GtkCellRenderer   *m_renderer;
  48     int                m_alignment;
  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 // wxDataViewTextRendererAttr
  76 // ---------------------------------------------------------
  77
  78 class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
  79 {
  80 public:
  81     wxDataViewTextRendererAttr( const wxString &varianttype = wxT("string"),
  82                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  83                             int align = wxDVR_DEFAULT_ALIGNMENT );
  84
  85     // implementation
  86     bool GtkHasAttributes() { return true; }
  87
  88 protected:
  89     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
  90 };
  91
  92 // ---------------------------------------------------------
  93 // wxDataViewBitmapRenderer
  94 // ---------------------------------------------------------
  95
  96 class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewRenderer
  97 {
  98 public:
  99     wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
 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(wxDataViewBitmapRenderer)
 108 };
 109
 110 // ---------------------------------------------------------
 111 // wxDataViewToggleRenderer
 112 // ---------------------------------------------------------
 113
 114 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
 115 {
 116 public:
 117     wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
 118                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 119                               int align = wxDVR_DEFAULT_ALIGNMENT );
 120
 121     bool SetValue( const wxVariant &value );
 122     bool GetValue( wxVariant &value ) const;
 123
 124 protected:
 125     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
 126 };
 127
 128 // ---------------------------------------------------------
 129 // wxDataViewCustomRenderer
 130 // ---------------------------------------------------------
 131
 132 class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
 133 {
 134 public:
 135     wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
 136                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 137                               int align = wxDVR_DEFAULT_ALIGNMENT,
 138                               bool no_init = false );
 139     virtual ~wxDataViewCustomRenderer();
 140
 141
 142     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
 143
 144     void RenderText( const wxString &text, int xoffset,  wxRect cell, wxDC *dc, int state );
 145
 146     virtual wxSize GetSize() const = 0;
 147
 148     virtual bool Activate( wxRect WXUNUSED(cell),
 149                            wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
 150                            { return false; }
 151
 152     virtual bool LeftClick( wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell),
 153                            wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
 154                            { return false; }
 155     virtual bool StartDrag( wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell),
 156                            wxDataViewModel *WXUNUSED(model), const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col) )
 157                            { return false; }
 158
 159     // Create DC on request
 160     virtual wxDC *GetDC();
 161
 162
 163 protected:
 164
 165     bool Init(wxDataViewCellMode mode, int align);
 166
 167 private:
 168     wxDC        *m_dc;
 169
 170 public:
 171     // Internal, temporay for RenderText.
 172     GtkCellRenderer      *m_text_renderer;
 173     GdkWindow            *window;
 174     GtkWidget            *widget;
 175     void                 *background_area;
 176     void                 *cell_area;
 177     void                 *expose_area;
 178     int                   flags;
 179
 180 protected:
 181     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
 182 };
 183
 184 // ---------------------------------------------------------
 185 // wxDataViewProgressRenderer
 186 // ---------------------------------------------------------
 187
 188 class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
 189 {
 190 public:
 191     wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
 192                                 const wxString &varianttype = wxT("long"),
 193                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 194                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 195     virtual ~wxDataViewProgressRenderer();
 196
 197     bool SetValue( const wxVariant &value );
 198     bool GetValue( wxVariant &value ) const;
 199
 200     virtual bool Render( wxRect cell, wxDC *dc, int state );
 201     virtual wxSize GetSize() const;
 202
 203 private:
 204     wxString    m_label;
 205     int         m_value;
 206
 207 protected:
 208     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
 209 };
 210
 211 // ---------------------------------------------------------
 212 // wxDataViewIconTextRenderer
 213 // ---------------------------------------------------------
 214
 215 class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
 216 {
 217 public:
 218     wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
 219                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 220                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 221     virtual ~wxDataViewIconTextRenderer();
 222
 223     bool SetValue( const wxVariant &value );
 224     bool GetValue( wxVariant &value ) const;
 225
 226     virtual bool Render( wxRect cell, wxDC *dc, int state );
 227     virtual wxSize GetSize() const;
 228
 229     virtual bool HasEditorCtrl() const { return true; }
 230     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
 231     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
 232
 233 private:
 234     wxDataViewIconText   m_value;
 235
 236 protected:
 237     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
 238 };
 239
 240 // ---------------------------------------------------------
 241 // wxDataViewDateRenderer
 242 // ---------------------------------------------------------
 243
 244 class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
 245 {
 246 public:
 247     wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
 248                             wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
 249                             int align = wxDVR_DEFAULT_ALIGNMENT );
 250
 251     bool SetValue( const wxVariant &value );
 252     bool GetValue( wxVariant &value ) const;
 253
 254     virtual bool Render( wxRect cell, wxDC *dc, int state );
 255     virtual wxSize GetSize() const;
 256     virtual bool Activate( wxRect cell,
 257                            wxDataViewModel *model, const wxDataViewItem &item, unsigned int col );
 258
 259 private:
 260     wxDateTime    m_date;
 261
 262 protected:
 263     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
 264 };
 265
 266 // -------------------------------------
 267 // wxDataViewChoiceRenderer
 268 // -------------------------------------
 269
 270 class WXDLLIMPEXP_ADV wxDataViewChoiceRenderer: public wxDataViewCustomRenderer
 271 {
 272 public:
 273     wxDataViewChoiceRenderer( const wxArrayString &choices,
 274                             wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
 275                             int alignment = wxDVR_DEFAULT_ALIGNMENT );
 276     virtual bool Render( wxRect rect, wxDC *dc, int state );
 277     virtual wxSize GetSize() const;
 278     virtual bool SetValue( const wxVariant &value );
 279     virtual bool GetValue( wxVariant &value ) const;
 280
 281     void SetAlignment( int align );
 282 private:
 283     wxArrayString m_choices;
 284     wxString      m_data;
 285 };
 286
 287 // ---------------------------------------------------------
 288 // wxDataViewColumn
 289 // ---------------------------------------------------------
 290
 291 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 292 {
 293 public:
 294     wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
 295                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 296                       wxAlignment align = wxALIGN_CENTER,
 297                       int flags = wxDATAVIEW_COL_RESIZABLE );
 298     wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
 299                       unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 300                       wxAlignment align = wxALIGN_CENTER,
 301                       int flags = wxDATAVIEW_COL_RESIZABLE );
 302
 303
 304     // setters:
 305
 306     virtual void SetTitle( const wxString &title );
 307     virtual void SetBitmap( const wxBitmap &bitmap );
 308
 309     virtual void SetOwner( wxDataViewCtrl *owner );
 310
 311     virtual void SetAlignment( wxAlignment align );
 312
 313     virtual void SetSortable( bool sortable );
 314     virtual void SetSortOrder( bool ascending );
 315     virtual void SetAsSortKey(bool sort = true);
 316
 317     virtual void SetResizeable( bool resizeable );
 318     virtual void SetHidden( bool hidden );
 319
 320     virtual void SetMinWidth( int minWidth );
 321     virtual void SetWidth( int width );
 322
 323     virtual void SetReorderable( bool reorderable );
 324
 325     virtual void SetFlags(int flags) { SetIndividualFlags(flags); }
 326
 327     // getters:
 328
 329     virtual wxString GetTitle() const;
 330     virtual wxAlignment GetAlignment() const;
 331
 332     virtual bool IsSortable() const;
 333     virtual bool IsSortOrderAscending() const;
 334     virtual bool IsSortKey() const;
 335
 336     virtual bool IsResizeable() const;
 337     virtual bool IsHidden() const;
 338
 339     virtual int GetWidth() const;
 340     virtual int GetMinWidth() const;
 341
 342     virtual bool IsReorderable() const;
 343
 344     virtual int GetFlags() const { return GetFromIndividualFlags(); }
 345
 346     // implementation
 347     GtkWidget* GetGtkHandle() { return m_column; }
 348     GtkWidget* GetConstGtkHandle() const { return m_column; }
 349
 350 private:
 351     // holds the GTK handle
 352     GtkWidget   *m_column;
 353
 354     // holds GTK handles for title/bitmap in the header
 355     GtkWidget   *m_image;
 356     GtkWidget   *m_label;
 357
 358     // delayed connection to mouse events
 359     friend class wxDataViewCtrl;
 360     void OnInternalIdle();
 361     bool    m_isConnected;
 362
 363     void Init(wxAlignment align, int flags, int width);
 364 };
 365
 366 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
 367                           class WXDLLIMPEXP_ADV);
 368
 369 // ---------------------------------------------------------
 370 // wxDataViewCtrl
 371 // ---------------------------------------------------------
 372
 373 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 374 {
 375 public:
 376     wxDataViewCtrl()
 377     {
 378         Init();
 379     }
 380
 381     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 382            const wxPoint& pos = wxDefaultPosition,
 383            const wxSize& size = wxDefaultSize, long style = 0,
 384            const wxValidator& validator = wxDefaultValidator )
 385     {
 386         Create(parent, id, pos, size, style, validator );
 387     }
 388
 389     virtual ~wxDataViewCtrl();
 390
 391     void Init();
 392
 393     bool Create(wxWindow *parent, wxWindowID id,
 394            const wxPoint& pos = wxDefaultPosition,
 395            const wxSize& size = wxDefaultSize, long style = 0,
 396            const wxValidator& validator = wxDefaultValidator );
 397
 398     virtual bool AssociateModel( wxDataViewModel *model );
 399
 400     virtual bool PrependColumn( wxDataViewColumn *col );
 401     virtual bool AppendColumn( wxDataViewColumn *col );
 402     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 403
 404     virtual unsigned int GetColumnCount() const;
 405     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 406     virtual bool DeleteColumn( wxDataViewColumn *column );
 407     virtual bool ClearColumns();
 408     virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
 409
 410     virtual wxDataViewColumn *GetSortingColumn() const;
 411
 412     virtual wxDataViewItem GetSelection() const;
 413     virtual int GetSelections( wxDataViewItemArray & sel ) const;
 414     virtual void SetSelections( const wxDataViewItemArray & sel );
 415     virtual void Select( const wxDataViewItem & item );
 416     virtual void Unselect( const wxDataViewItem & item );
 417     virtual bool IsSelected( const wxDataViewItem & item ) const;
 418     virtual void SelectAll();
 419     virtual void UnselectAll();
 420
 421     virtual void EnsureVisible( const wxDataViewItem& item,
 422                                 const wxDataViewColumn *column = NULL );
 423     virtual void HitTest( const wxPoint &point,
 424                           wxDataViewItem &item,
 425                           wxDataViewColumn *&column ) const;
 426     virtual wxRect GetItemRect( const wxDataViewItem &item,
 427                                 const wxDataViewColumn *column = NULL ) const;
 428
 429     virtual void Expand( const wxDataViewItem & item );
 430     virtual void Collapse( const wxDataViewItem & item );
 431     virtual bool IsExpanded( const wxDataViewItem & item ) const;
 432
 433     virtual bool EnableDragSource( const wxDataFormat &format );
 434     virtual bool EnableDropTarget( const wxDataFormat &format );
 435
 436     static wxVisualAttributes
 437     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 438
 439     wxWindow *GetMainWindow() { return (wxWindow*) this; }
 440
 441     GtkWidget *GtkGetTreeView() { return m_treeview; }
 442     wxDataViewCtrlInternal* GtkGetInternal() { return m_internal; }
 443
 444     virtual void OnInternalIdle();
 445
 446 protected:
 447     virtual void DoSetExpanderColumn();
 448     virtual void DoSetIndent();
 449
 450 private:
 451     friend class wxDataViewCtrlDCImpl;
 452     friend class wxDataViewColumn;
 453     friend class wxGtkDataViewModelNotifier;
 454     friend class wxDataViewCtrlInternal;
 455
 456     GtkWidget               *m_treeview;
 457     wxDataViewModelNotifier *m_notifier;
 458     wxDataViewCtrlInternal  *m_internal;
 459     wxDataViewColumnList     m_cols;
 460
 461     virtual void AddChildGTK(wxWindowGTK* child);
 462     void GtkEnableSelectionEvents();
 463     void GtkDisableSelectionEvents();
 464
 465     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 466     wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);
 467 };
 468
 469
 470 #endif // _WX_GTKDATAVIEWCTRL_H_