include/wx/gtk/dvrenderers.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/dvrenderers.h
   3 // Purpose:     All GTK wxDataViewCtrl renderer classes
   4 // Author:      Robert Roebling, Vadim Zeitlin
   5 // Created:     2009-11-07 (extracted from wx/gtk/dataview.h)
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2006 Robert Roebling
   8 //              (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GTK_DVRENDERERS_H_
  13 #define _WX_GTK_DVRENDERERS_H_
  14
  15 typedef struct _GdkRectangle GdkRectangle;
  16
  17 // ---------------------------------------------------------
  18 // wxDataViewTextRenderer
  19 // ---------------------------------------------------------
  20
  21 class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewRenderer
  22 {
  23 public:
  24     wxDataViewTextRenderer( const wxString &varianttype = "string",
  25                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  26                             int align = wxDVR_DEFAULT_ALIGNMENT );
  27
  28     virtual bool SetValue( const wxVariant &value )
  29     {
  30         return SetTextValue(value);
  31     }
  32
  33     virtual bool GetValue( wxVariant &value ) const
  34     {
  35         wxString str;
  36         if ( !GetTextValue(str) )
  37             return false;
  38
  39         value = str;
  40
  41         return true;
  42     }
  43
  44     virtual void SetAlignment( int align );
  45
  46     virtual bool GtkSupportsAttrs() const { return true; }
  47     virtual bool GtkSetAttr(const wxDataViewItemAttr& attr);
  48
  49     virtual GtkCellRendererText *GtkGetTextRenderer() const;
  50
  51 protected:
  52     // implementation of Set/GetValue()
  53     bool SetTextValue(const wxString& str);
  54     bool GetTextValue(wxString& str) const;
  55
  56
  57     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
  58 };
  59
  60 // ---------------------------------------------------------
  61 // wxDataViewBitmapRenderer
  62 // ---------------------------------------------------------
  63
  64 class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewRenderer
  65 {
  66 public:
  67     wxDataViewBitmapRenderer( const wxString &varianttype = "wxBitmap",
  68                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  69                               int align = wxDVR_DEFAULT_ALIGNMENT );
  70
  71     bool SetValue( const wxVariant &value );
  72     bool GetValue( wxVariant &value ) const;
  73
  74 protected:
  75     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
  76 };
  77
  78 // ---------------------------------------------------------
  79 // wxDataViewToggleRenderer
  80 // ---------------------------------------------------------
  81
  82 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
  83 {
  84 public:
  85     wxDataViewToggleRenderer( const wxString &varianttype = "bool",
  86                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  87                               int align = wxDVR_DEFAULT_ALIGNMENT );
  88
  89     bool SetValue( const wxVariant &value );
  90     bool GetValue( wxVariant &value ) const;
  91
  92 protected:
  93     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
  94 };
  95
  96 // ---------------------------------------------------------
  97 // wxDataViewCustomRenderer
  98 // ---------------------------------------------------------
  99
 100 class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewCustomRendererBase
 101 {
 102 public:
 103     wxDataViewCustomRenderer( const wxString &varianttype = "string",
 104                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 105                               int align = wxDVR_DEFAULT_ALIGNMENT,
 106                               bool no_init = false );
 107     virtual ~wxDataViewCustomRenderer();
 108
 109
 110     // Create DC on request
 111     virtual wxDC *GetDC();
 112
 113     // override the base class function to use GTK text cell renderer
 114     virtual void RenderText(const wxString& text,
 115                             int xoffset,
 116                             wxRect cell,
 117                             wxDC *dc,
 118                             int state);
 119
 120     struct GTKRenderParams;
 121
 122     // store GTK render call parameters for possible later use
 123     void GTKSetRenderParams(GTKRenderParams* renderParams)
 124     {
 125         m_renderParams = renderParams;
 126     }
 127
 128     // we may or not support attributes, as we don't know it, return true to
 129     // make it possible to use them
 130     virtual bool GtkSupportsAttrs() const { return true; }
 131
 132     virtual bool GtkSetAttr(const wxDataViewItemAttr& attr)
 133     {
 134         SetAttr(attr);
 135         return !attr.IsDefault();
 136     }
 137
 138     virtual GtkCellRendererText *GtkGetTextRenderer() const;
 139
 140 protected:
 141     bool Init(wxDataViewCellMode mode, int align);
 142
 143 private:
 144     // Called from GtkGetTextRenderer() to really create the renderer if
 145     // necessary.
 146     void GtkInitTextRenderer();
 147
 148     wxDC        *m_dc;
 149
 150     GtkCellRendererText      *m_text_renderer;
 151
 152     // parameters of the original render() call stored so that we could pass
 153     // them forward to m_text_renderer if our RenderText() is called
 154     GTKRenderParams* m_renderParams;
 155
 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 = "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     void GTKSetLabel();
 180
 181     wxString    m_label;
 182     int         m_value;
 183
 184 #if !wxUSE_UNICODE
 185     // Flag used to indicate that we need to set the label because we were
 186     // unable to do it in the ctor (see comments there).
 187     bool m_needsToSetLabel;
 188 #endif // !wxUSE_UNICODE
 189
 190 protected:
 191     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
 192 };
 193
 194 // ---------------------------------------------------------
 195 // wxDataViewIconTextRenderer
 196 // ---------------------------------------------------------
 197
 198 class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewTextRenderer
 199 {
 200 public:
 201     wxDataViewIconTextRenderer( const wxString &varianttype = "wxDataViewIconText",
 202                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 203                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 204     virtual ~wxDataViewIconTextRenderer();
 205
 206     bool SetValue( const wxVariant &value );
 207     bool GetValue( wxVariant &value ) const;
 208
 209     virtual void GtkPackIntoColumn(GtkTreeViewColumn *column);
 210
 211 protected:
 212     virtual void GtkOnCellChanged(const wxVariant& value,
 213                                   const wxDataViewItem& item,
 214                                   unsigned col);
 215
 216 private:
 217     wxDataViewIconText   m_value;
 218
 219     // we use the base class m_renderer for the text and this one for the icon
 220     GtkCellRenderer *m_rendererIcon;
 221
 222     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
 223 };
 224
 225 // -------------------------------------
 226 // wxDataViewChoiceRenderer
 227 // -------------------------------------
 228
 229 class WXDLLIMPEXP_ADV wxDataViewChoiceRenderer: public wxDataViewCustomRenderer
 230 {
 231 public:
 232     wxDataViewChoiceRenderer(const wxArrayString &choices,
 233                              wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
 234                              int alignment = wxDVR_DEFAULT_ALIGNMENT );
 235     virtual bool Render( wxRect rect, wxDC *dc, int state );
 236     virtual wxSize GetSize() const;
 237     virtual bool SetValue( const wxVariant &value );
 238     virtual bool GetValue( wxVariant &value ) const;
 239
 240     void SetAlignment( int align );
 241
 242     wxString GetChoice(size_t index) const { return m_choices[index]; }
 243     const wxArrayString& GetChoices() const { return m_choices; }
 244
 245 private:
 246     wxArrayString m_choices;
 247     wxString      m_data;
 248 };
 249
 250 // ----------------------------------------------------------------------------
 251 // wxDataViewChoiceByIndexRenderer
 252 // ----------------------------------------------------------------------------
 253
 254 class WXDLLIMPEXP_ADV wxDataViewChoiceByIndexRenderer: public wxDataViewChoiceRenderer
 255 {
 256 public:
 257     wxDataViewChoiceByIndexRenderer( const wxArrayString &choices,
 258                               wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
 259                               int alignment = wxDVR_DEFAULT_ALIGNMENT );
 260
 261     virtual bool SetValue( const wxVariant &value );
 262     virtual bool GetValue( wxVariant &value ) const;
 263
 264 private:
 265     virtual void GtkOnTextEdited(const char *itempath, const wxString& str);
 266 };
 267
 268
 269
 270 #endif // _WX_GTK_DVRENDERERS_H_
 271