1 /** \file
2 * extension parameter for enumerations.
3 *
4 * It uses a Gtk:ComboBoxText widget in the extension UI.
5 */
7 /*
8 * Author:
9 * Johan Engelen <johan@shouraizou.nl>
10 *
11 * Copyright (C) 2006-2007 Johan Engelen
12 *
13 * Released under GNU GPL, read the file 'COPYING' for more information
14 */
16 #ifdef HAVE_CONFIG_H
17 # include "config.h"
18 #endif
21 #include <gtkmm/box.h>
22 #include <gtkmm/comboboxtext.h>
23 #include <gtkmm/tooltips.h>
24 #include <gtkmm/label.h>
26 #include <glibmm/i18n.h>
28 #include <xml/node.h>
30 #include "extension.h"
31 #include "prefs-utils.h"
32 #include "document-private.h"
33 #include "sp-object.h"
35 #include "paramenum.h"
37 /** \brief The root directory in the preferences database for extension
38 related parameters. */
39 #define PREF_DIR "extensions"
41 namespace Inkscape {
42 namespace Extension {
44 /* For internal use only.
45 Note that value and guitext MUST be non-NULL. This is ensured by newing only at one location in the code where non-NULL checks are made. */
46 class enumentry {
47 public:
48 enumentry (Glib::ustring * val, Glib::ustring * text) {
49 value = val;
50 guitext = text;
51 }
52 ~enumentry() {
53 delete value;
54 delete guitext;
55 }
57 Glib::ustring * value;
58 Glib::ustring * guitext;
59 };
62 ParamComboBox::ParamComboBox (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml) :
63 Parameter(name, guitext, desc, scope, ext)
64 {
65 choices = NULL;
66 _value = NULL;
68 // Read XML tree to add enumeration items:
69 // printf("Extension Constructor: ");
70 if (xml != NULL) {
71 Inkscape::XML::Node *child_repr = sp_repr_children(xml);
72 while (child_repr != NULL) {
73 char const * chname = child_repr->name();
74 if (!strcmp(chname, "item") || !strcmp(chname, "_item")) {
75 Glib::ustring * newguitext = NULL;
76 Glib::ustring * newvalue = NULL;
77 const char * contents = sp_repr_children(child_repr)->content();
78 if (contents != NULL)
79 // don't translate when 'item' but do translate when '_item'
80 newguitext = new Glib::ustring( !strcmp(chname, "_item") ? _(contents) : contents );
81 else
82 continue;
84 const char * val = child_repr->attribute("value");
85 if (val != NULL)
86 newvalue = new Glib::ustring(val);
87 else
88 newvalue = new Glib::ustring(contents);
90 if ( (newguitext) && (newvalue) ) { // logical error if this is not true here
91 choices = g_slist_append( choices, new enumentry(newvalue, newguitext) );
92 }
93 }
94 child_repr = sp_repr_next(child_repr);
95 }
96 }
98 // Initialize _value with the default value from xml
99 // for simplicity : default to the contents of the first xml-child
100 const char * defaultval = NULL;
101 if (sp_repr_children(sp_repr_children(xml)) != NULL)
102 defaultval = sp_repr_children(xml)->attribute("value");
104 gchar * pref_name = this->pref_name();
105 const gchar * paramval = prefs_get_string_attribute(PREF_DIR, pref_name);
106 g_free(pref_name);
108 if (paramval != NULL)
109 defaultval = paramval;
110 if (defaultval != NULL)
111 _value = g_strdup(defaultval); // allocate space for _value
113 return;
114 }
116 ParamComboBox::~ParamComboBox (void)
117 {
118 //destroy choice strings
119 for (GSList * list = choices; list != NULL; list = g_slist_next(list)) {
120 delete (reinterpret_cast<enumentry *>(list->data));
121 }
122 g_slist_free(choices);
124 g_free(_value);
125 }
128 /** \brief A function to set the \c _value
129 \param in The value to set
130 \param doc A document that should be used to set the value.
131 \param node The node where the value may be placed
133 This function sets ONLY the internal value, but it also sets the value
134 in the preferences structure. To put it in the right place, \c PREF_DIR
135 and \c pref_name() are used.
137 To copy the data into _value the old memory must be free'd first.
138 It is important to note that \c g_free handles \c NULL just fine. Then
139 the passed in value is duplicated using \c g_strdup().
140 */
141 const gchar *
142 ParamComboBox::set (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node)
143 {
144 if (in == NULL) return NULL; /* Can't have NULL string */
146 Glib::ustring * settext = NULL;
147 for (GSList * list = choices; list != NULL; list = g_slist_next(list)) {
148 enumentry * entr = reinterpret_cast<enumentry *>(list->data);
149 if ( !entr->guitext->compare(in) ) {
150 settext = entr->value;
151 break; // break out of for loop
152 }
153 }
154 if (settext) {
155 if (_value != NULL) g_free(_value);
156 _value = g_strdup(settext->c_str());
157 gchar * prefname = this->pref_name();
158 prefs_set_string_attribute(PREF_DIR, prefname, _value);
159 g_free(prefname);
160 }
162 return _value;
163 }
165 void
166 ParamComboBox::changed (void) {
168 }
171 /**
172 \brief A function to get the value of the parameter in string form
173 \return A string with the 'value' as command line argument
174 */
175 Glib::ustring *
176 ParamComboBox::string (void)
177 {
178 Glib::ustring * param_string = new Glib::ustring("");
179 *param_string += _value;
180 return param_string;
181 }
186 /** \brief A special category of Gtk::Entry to handle string parameteres */
187 class ParamComboBoxEntry : public Gtk::ComboBoxText {
188 private:
189 ParamComboBox * _pref;
190 SPDocument * _doc;
191 Inkscape::XML::Node * _node;
192 sigc::signal<void> * _changeSignal;
193 public:
194 /** \brief Build a string preference for the given parameter
195 \param pref Where to get the string from, and where to put it
196 when it changes.
197 */
198 ParamComboBoxEntry (ParamComboBox * pref, SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal) :
199 Gtk::ComboBoxText(), _pref(pref), _doc(doc), _node(node), _changeSignal(changeSignal) {
200 this->signal_changed().connect(sigc::mem_fun(this, &ParamComboBoxEntry::changed));
201 };
202 void changed (void);
203 };
205 /** \brief Respond to the text box changing
207 This function responds to the box changing by grabbing the value
208 from the text box and putting it in the parameter.
209 */
210 void
211 ParamComboBoxEntry::changed (void)
212 {
213 Glib::ustring data = this->get_active_text();
214 _pref->set(data.c_str(), _doc, _node);
215 if (_changeSignal != NULL) {
216 _changeSignal->emit();
217 }
218 }
220 /**
221 \brief Creates a combobox widget for an enumeration parameter
222 */
223 Gtk::Widget *
224 ParamComboBox::get_widget (SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal)
225 {
226 Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox(false, 4));
228 Gtk::Label * label = Gtk::manage(new Gtk::Label(_(_text), Gtk::ALIGN_LEFT));
229 label->show();
230 hbox->pack_start(*label, false, false);
232 ParamComboBoxEntry * combo = Gtk::manage(new ParamComboBoxEntry(this, doc, node, changeSignal));
233 // add choice strings:
234 Glib::ustring * settext = 0;
235 for (GSList * list = choices; list != NULL; list = g_slist_next(list)) {
236 enumentry * entr = reinterpret_cast<enumentry *>(list->data);
237 Glib::ustring * text = entr->guitext;
238 combo->append_text(*text);
239 if ( !entr->value->compare(_value) ) {
240 settext = entr->guitext;
241 }
242 }
243 if (settext) combo->set_active_text(*settext);
245 combo->show();
246 hbox->pack_start(*combo, true, true);
248 hbox->show();
250 return dynamic_cast<Gtk::Widget *>(hbox);
251 }
254 } /* namespace Extension */
255 } /* namespace Inkscape */