/** \file * extension parameter for enumerations. * * It uses a Gtk:ComboBoxText widget in the extension UI. */ /* * Author: * Johan Engelen * * Copyright (C) 2006-2007 Johan Engelen * * Released under GNU GPL, read the file 'COPYING' for more information */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include #include #include #include #include #include "xml/node.h" #include "extension/extension.h" #include "document-private.h" #include "sp-object.h" #include "enum.h" #include "preferences.h" namespace Inkscape { namespace Extension { /* For internal use only. 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. */ class enumentry { public: enumentry (Glib::ustring * val, Glib::ustring * text) { value = val; guitext = text; } ~enumentry() { delete value; delete guitext; } Glib::ustring * value; Glib::ustring * guitext; }; ParamComboBox::ParamComboBox (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, bool gui_hidden, const gchar * gui_tip, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml) : Parameter(name, guitext, desc, scope, gui_hidden, gui_tip, ext) { choices = NULL; _value = NULL; // Read XML tree to add enumeration items: // printf("Extension Constructor: "); if (xml != NULL) { Inkscape::XML::Node *child_repr = sp_repr_children(xml); while (child_repr != NULL) { char const * chname = child_repr->name(); if (!strcmp(chname, "extension:item") || !strcmp(chname, "extension:_item")) { Glib::ustring * newguitext = NULL; Glib::ustring * newvalue = NULL; const char * contents = sp_repr_children(child_repr)->content(); if (contents != NULL) // don't translate when 'item' but do translate when '_item' // NOTE: internal extensions use build_from_mem and don't need _item but // still need to include if are to be localized newguitext = new Glib::ustring( !strcmp(chname, "extension:_item") ? _(contents) : contents ); else continue; const char * val = child_repr->attribute("value"); if (val != NULL) newvalue = new Glib::ustring(val); else newvalue = new Glib::ustring(contents); if ( (newguitext) && (newvalue) ) { // logical error if this is not true here choices = g_slist_append( choices, new enumentry(newvalue, newguitext) ); } } child_repr = sp_repr_next(child_repr); } } // Initialize _value with the default value from xml // for simplicity : default to the contents of the first xml-child const char * defaultval = NULL; if (sp_repr_children(sp_repr_children(xml)) != NULL) defaultval = sp_repr_children(xml)->attribute("value"); gchar * pref_name = this->pref_name(); Inkscape::Preferences *prefs = Inkscape::Preferences::get(); Glib::ustring paramval = prefs->getString(extension_pref_root + pref_name); g_free(pref_name); if (!paramval.empty()) defaultval = paramval.data(); if (defaultval != NULL) _value = g_strdup(defaultval); return; } ParamComboBox::~ParamComboBox (void) { //destroy choice strings for (GSList * list = choices; list != NULL; list = g_slist_next(list)) { delete (reinterpret_cast(list->data)); } g_slist_free(choices); g_free(_value); } /** \brief A function to set the \c _value \param in The value to set \param doc A document that should be used to set the value. \param node The node where the value may be placed This function sets ONLY the internal value, but it also sets the value in the preferences structure. To put it in the right place, \c PREF_DIR and \c pref_name() are used. To copy the data into _value the old memory must be free'd first. It is important to note that \c g_free handles \c NULL just fine. Then the passed in value is duplicated using \c g_strdup(). */ const gchar * ParamComboBox::set (const gchar * in, SPDocument * /*doc*/, Inkscape::XML::Node * /*node*/) { if (in == NULL) return NULL; /* Can't have NULL string */ Glib::ustring * settext = NULL; for (GSList * list = choices; list != NULL; list = g_slist_next(list)) { enumentry * entr = reinterpret_cast(list->data); if ( !entr->guitext->compare(in) ) { settext = entr->value; break; // break out of for loop } } if (settext) { if (_value != NULL) g_free(_value); _value = g_strdup(settext->c_str()); gchar * prefname = this->pref_name(); Inkscape::Preferences *prefs = Inkscape::Preferences::get(); prefs->setString(extension_pref_root + prefname, _value); g_free(prefname); } return _value; } void ParamComboBox::changed (void) { } /** \brief A function to get the value of the parameter in string form \return A string with the 'value' as command line argument */ void ParamComboBox::string (std::string &string) { string += _value; return; } /** \brief A special category of Gtk::Entry to handle string parameteres */ class ParamComboBoxEntry : public Gtk::ComboBoxText { private: ParamComboBox * _pref; SPDocument * _doc; Inkscape::XML::Node * _node; sigc::signal * _changeSignal; public: /** \brief Build a string preference for the given parameter \param pref Where to get the string from, and where to put it when it changes. */ ParamComboBoxEntry (ParamComboBox * pref, SPDocument * doc, Inkscape::XML::Node * node, sigc::signal * changeSignal) : Gtk::ComboBoxText(), _pref(pref), _doc(doc), _node(node), _changeSignal(changeSignal) { this->signal_changed().connect(sigc::mem_fun(this, &ParamComboBoxEntry::changed)); }; void changed (void); }; /** \brief Respond to the text box changing This function responds to the box changing by grabbing the value from the text box and putting it in the parameter. */ void ParamComboBoxEntry::changed (void) { Glib::ustring data = this->get_active_text(); _pref->set(data.c_str(), _doc, _node); if (_changeSignal != NULL) { _changeSignal->emit(); } } /** \brief Creates a combobox widget for an enumeration parameter */ Gtk::Widget * ParamComboBox::get_widget (SPDocument * doc, Inkscape::XML::Node * node, sigc::signal * changeSignal) { if (_gui_hidden) return NULL; Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox(false, 4)); Gtk::Label * label = Gtk::manage(new Gtk::Label(_(_text), Gtk::ALIGN_LEFT)); label->show(); hbox->pack_start(*label, false, false); ParamComboBoxEntry * combo = Gtk::manage(new ParamComboBoxEntry(this, doc, node, changeSignal)); // add choice strings: Glib::ustring * settext = 0; for (GSList * list = choices; list != NULL; list = g_slist_next(list)) { enumentry * entr = reinterpret_cast(list->data); Glib::ustring * text = entr->guitext; combo->append_text(*text); if ( !entr->value->compare(_value) ) { settext = entr->guitext; } } if (settext) combo->set_active_text(*settext); combo->show(); hbox->pack_start(*combo, true, true); hbox->show(); return dynamic_cast(hbox); } } /* namespace Extension */ } /* namespace Inkscape */