src/ui/widget/combo-enums.h

   1 /**
   2  * \brief Simplified management of enumerations in the UI as combobox.
   3  *
   4  * Authors:
   5  *   Nicholas Bishop <nicholasbishop@gmail.com>
   6  *   Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
   7  *
   8  * Copyright (C) 2007 Authors
   9  *
  10  * Released under GNU GPL.  Read the file 'COPYING' for more information.
  11  */
  12
  13 #ifndef INKSCAPE_UI_WIDGET_COMBO_ENUMS_H
  14 #define INKSCAPE_UI_WIDGET_COMBO_ENUMS_H
  15
  16 #include <gtkmm/combobox.h>
  17 #include <gtkmm/liststore.h>
  18 #include "attr-widget.h"
  19 #include "util/enums.h"
  20 #include "ui/widget/labelled.h"
  21
  22 namespace Inkscape {
  23 namespace UI {
  24 namespace Widget {
  25
  26 template<typename E> class ComboBoxEnum : public Gtk::ComboBox, public AttrWidget
  27 {
  28 private:
  29     int on_sort_compare( const Gtk::TreeModel::iterator & a, const Gtk::TreeModel::iterator & b)
  30     {
  31         Glib::ustring an=(*a)[_columns.label];
  32         Glib::ustring bn=(*b)[_columns.label];
  33         return an.compare(bn);
  34     }
  35
  36 public:
  37     ComboBoxEnum(E default_value, const Util::EnumDataConverter<E>& c, const SPAttributeEnum a = SP_ATTR_INVALID)
  38         : AttrWidget(a, (unsigned int)default_value), setProgrammatically(false), _converter(c)
  39     {
  40         signal_changed().connect(signal_attr_changed().make_slot());
  41
  42         _model = Gtk::ListStore::create(_columns);
  43         set_model(_model);
  44
  45         pack_start(_columns.label);
  46
  47         // Initialize list
  48         for(int i = 0; i < static_cast<int>(_converter._length); ++i) {
  49             Gtk::TreeModel::Row row = *_model->append();
  50             const Util::EnumData<E>* data = &_converter.data(i);
  51             row[_columns.data] = data;
  52             row[_columns.label] = _( _converter.get_label(data->id).c_str() );
  53         }
  54         set_active_by_id(default_value);
  55
  56         // Sort the list
  57         _model->set_default_sort_func(sigc::mem_fun(*this, &ComboBoxEnum<E>::on_sort_compare));
  58         _model->set_sort_column(_columns.label, Gtk::SORT_ASCENDING);
  59     }
  60
  61     ComboBoxEnum(const Util::EnumDataConverter<E>& c, const SPAttributeEnum a = SP_ATTR_INVALID)
  62         : AttrWidget(a, (unsigned int) 0), setProgrammatically(false), _converter(c)
  63     {
  64         signal_changed().connect(signal_attr_changed().make_slot());
  65
  66         _model = Gtk::ListStore::create(_columns);
  67         set_model(_model);
  68
  69         pack_start(_columns.label);
  70
  71         // Initialize list
  72         for(unsigned int i = 0; i < _converter._length; ++i) {
  73             Gtk::TreeModel::Row row = *_model->append();
  74             const Util::EnumData<E>* data = &_converter.data(i);
  75             row[_columns.data] = data;
  76             row[_columns.label] = _( _converter.get_label(data->id).c_str() );
  77         }
  78         set_active(0);
  79
  80         // Sort the list
  81         _model->set_default_sort_func(sigc::mem_fun(*this, &ComboBoxEnum<E>::on_sort_compare));
  82         _model->set_sort_column(_columns.label, Gtk::SORT_ASCENDING);
  83     }
  84
  85     virtual Glib::ustring get_as_attribute() const
  86     {
  87         return get_active_data()->key;
  88     }
  89
  90     virtual void set_from_attribute(SPObject* o)
  91     {
  92         setProgrammatically = true;
  93         const gchar* val = attribute_value(o);
  94         if(val)
  95             set_active_by_id(_converter.get_id_from_key(val));
  96         else
  97             set_active(get_default()->as_uint());
  98     }
  99
 100     const Util::EnumData<E>* get_active_data() const
 101     {
 102         Gtk::TreeModel::iterator i = this->get_active();
 103         if(i)
 104             return (*i)[_columns.data];
 105         return 0;
 106     }
 107
 108     void add_row(const Glib::ustring& s)
 109     {
 110         Gtk::TreeModel::Row row = *_model->append();
 111         row[_columns.data] = 0;
 112         row[_columns.label] = s;
 113     }
 114
 115     void remove_row(E id) {
 116         Gtk::TreeModel::iterator i;
 117
 118         for(i = _model->children().begin(); i != _model->children().end(); ++i) {
 119             const Util::EnumData<E>* data = (*i)[_columns.data];
 120
 121             if(data->id == id)
 122                 break;
 123         }
 124
 125         if(i != _model->children().end())
 126             _model->erase(i);
 127     }
 128
 129     void set_active_by_id(E id) {
 130         setProgrammatically = true;
 131         for(Gtk::TreeModel::iterator i = _model->children().begin();
 132             i != _model->children().end(); ++i)
 133         {
 134             const Util::EnumData<E>* data = (*i)[_columns.data];
 135             if(data->id == id) {
 136                 set_active(i);
 137                 break;
 138             }
 139         }
 140     };
 141
 142     void set_active_by_key(const Glib::ustring& key) {
 143         setProgrammatically = true;
 144         set_active_by_id( _converter.get_id_from_key(key) );
 145     };
 146
 147     bool setProgrammatically;
 148
 149 private:
 150     class Columns : public Gtk::TreeModel::ColumnRecord
 151     {
 152     public:
 153         Columns()
 154         {
 155             add(data);
 156             add(label);
 157         }
 158
 159         Gtk::TreeModelColumn<const Util::EnumData<E>*> data;
 160         Gtk::TreeModelColumn<Glib::ustring> label;
 161     };
 162
 163     Columns _columns;
 164     Glib::RefPtr<Gtk::ListStore> _model;
 165     const Util::EnumDataConverter<E>& _converter;
 166 };
 167
 168
 169 template<typename E> class LabelledComboBoxEnum : public Labelled
 170 {
 171 public:
 172     LabelledComboBoxEnum( Glib::ustring const &label,
 173                           Glib::ustring const &tooltip,
 174                           const Util::EnumDataConverter<E>& c,
 175                           Glib::ustring const &suffix = "",
 176                           Glib::ustring const &icon = "",
 177                           bool mnemonic = true)
 178         : Labelled(label, tooltip, new ComboBoxEnum<E>(c), suffix, icon, mnemonic)
 179     { }
 180
 181     ComboBoxEnum<E>* getCombobox() {
 182         return static_cast< ComboBoxEnum<E>* > (_widget);
 183     }
 184 };
 185
 186 }
 187 }
 188 }
 189
 190 #endif
 191
 192 /*
 193   Local Variables:
 194   mode:c++
 195   c-file-style:"stroustrup"
 196   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 197   indent-tabs-mode:nil
 198   fill-column:99
 199   End:
 200 */
 201 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :