X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fextension%2Fparameter.cpp;h=a034022d9f8a5b2413626569ffa86d35ad516010;hb=e173aaf34472892de413d42ef20b7fd00aafd45b;hp=ce6c8c272634a19baadfe1558c19da1c3fd270d0;hpb=7609a14f6d6ead42fa3871182b75511f87311faf;p=inkscape.git diff --git a/src/extension/parameter.cpp b/src/extension/parameter.cpp index ce6c8c272..a034022d9 100644 --- a/src/extension/parameter.cpp +++ b/src/extension/parameter.cpp @@ -6,7 +6,7 @@ * Authors: * Ted Gould * - * Copyright (C) 2005 Authors + * Copyright (C) 2005-2006 Authors * * Released under GNU GPL, read the file 'COPYING' for more information */ @@ -22,8 +22,12 @@ #include +#include + #include "extension.h" #include "prefs-utils.h" +#include "document-private.h" +#include "sp-object.h" #include "parameter.h" @@ -34,6 +38,16 @@ namespace Inkscape { namespace Extension { +/** \brief A description parameter */ +class ParamDescription : public Parameter { +private: + /** \brief Internal value. */ + gchar * _value; +public: + ParamDescription(const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); +}; + /** \brief A boolean parameter */ class ParamBool : public Parameter { private: @@ -42,9 +56,9 @@ private: public: ParamBool(const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); /** \brief Returns \c _value */ - bool get (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) { return _value; } - bool set (bool in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node); - Gtk::Widget * get_widget(void); + bool get (const SPDocument * doc, const Inkscape::XML::Node * node) { return _value; } + bool set (bool in, SPDocument * doc, Inkscape::XML::Node * node); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); Glib::ustring * string (void); }; @@ -78,11 +92,11 @@ private: public: ParamInt (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); /** \brief Returns \c _value */ - int get (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) { return _value; } - int set (int in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node); + int get (const SPDocument * doc, const Inkscape::XML::Node * node) { return _value; } + int set (int in, SPDocument * doc, Inkscape::XML::Node * node); int max (void) { return _max; } int min (void) { return _min; } - Gtk::Widget * get_widget(void); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); Glib::ustring * string (void); }; @@ -132,11 +146,11 @@ private: public: ParamFloat (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); /** \brief Returns \c _value */ - float get (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) { return _value; } - float set (float in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node); + float get (const SPDocument * doc, const Inkscape::XML::Node * node) { return _value; } + float set (float in, SPDocument * doc, Inkscape::XML::Node * node); float max (void) { return _max; } float min (void) { return _min; } - Gtk::Widget * get_widget(void); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); Glib::ustring * string (void); }; @@ -186,12 +200,45 @@ public: ParamString(const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); ~ParamString(void); /** \brief Returns \c _value, with a \i const to protect it. */ - const gchar * get (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) { return _value; } - const gchar * set (const gchar * in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node); - Gtk::Widget * get_widget(void); + const gchar * get (const SPDocument * doc, const Inkscape::XML::Node * node) { return _value; } + const gchar * set (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); Glib::ustring * string (void); }; +class ParamEnum : public Parameter { +private: + class Choice { + public: + gchar * _gui_name; + gchar * _value; + Choice(gchar * gui_name, gchar * value) : _gui_name(NULL), _value(NULL) { + if (gui_name != NULL) + _gui_name = g_strdup(_(gui_name)); + if (value != NULL) + _value = g_strdup(value); + return; + }; + ~Choice (void) { + g_free(_gui_name); + g_free(_value); + }; + }; /* class Choice */ + /** \brief Internal value. This should point to a string that has + been allocated in memory. And should be free'd. */ + Choice * _current_choice; + typedef std::list choice_list_t; + choice_list_t _choice_list; +public: + ParamEnum(const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml); + ~ParamEnum(void); + /** \brief Returns \c _value, with a \i const to protect it. */ + const gchar * get (const SPDocument * doc, const Inkscape::XML::Node * node) { return _current_choice != NULL ? _current_choice->_value : NULL; } + const gchar * set (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node); + Gtk::Widget * get_widget(SPDocument * doc, Inkscape::XML::Node * node); + Glib::ustring * string (void); +}; /* class ParamEnum */ + /** \return None \brief This function creates a parameter that can be used later. This @@ -259,6 +306,10 @@ Parameter::make (Inkscape::XML::Node * in_repr, Inkscape::Extension::Extension * param = new ParamFloat(name, guitext, desc, scope, in_ext, in_repr); } else if (!strcmp(type, "string")) { param = new ParamString(name, guitext, desc, scope, in_ext, in_repr); + } else if (!strcmp(type, "description")) { + param = new ParamDescription(name, guitext, desc, scope, in_ext, in_repr); + } else if (!strcmp(type, "enum")) { + param = new ParamEnum(name, guitext, desc, scope, in_ext, in_repr); } /* Note: param could equal NULL */ @@ -275,7 +326,7 @@ Parameter::make (Inkscape::XML::Node * in_repr, Inkscape::Extension::Extension * and \c pref_name() are used. */ bool -ParamBool::set (bool in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +ParamBool::set (bool in, SPDocument * doc, Inkscape::XML::Node * node) { _value = in; @@ -296,7 +347,7 @@ ParamBool::set (bool in, Inkscape::XML::Document * doc, Inkscape::XML::Node * no and \c pref_name() are used. */ int -ParamInt::set (int in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +ParamInt::set (int in, SPDocument * doc, Inkscape::XML::Node * node) { _value = in; if (_value > _max) _value = _max; @@ -319,7 +370,7 @@ ParamInt::set (int in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node and \c pref_name() are used. */ float -ParamFloat::set (float in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +ParamFloat::set (float in, SPDocument * doc, Inkscape::XML::Node * node) { _value = in; if (_value > _max) _value = _max; @@ -346,7 +397,7 @@ ParamFloat::set (float in, Inkscape::XML::Document * doc, Inkscape::XML::Node * the passed in value is duplicated using \c g_strdup(). */ const gchar * -ParamString::set (const gchar * in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +ParamString::set (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node) { if (in == NULL) return NULL; /* Can't have NULL string */ @@ -363,7 +414,7 @@ ParamString::set (const gchar * in, Inkscape::XML::Document * doc, Inkscape::XML /** \brief Wrapper to cast to the object and use it's function. */ bool -Parameter::get_bool (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) +Parameter::get_bool (const SPDocument * doc, const Inkscape::XML::Node * node) { ParamBool * boolpntr; boolpntr = dynamic_cast(this); @@ -374,7 +425,7 @@ Parameter::get_bool (const Inkscape::XML::Document * doc, const Inkscape::XML::N /** \brief Wrapper to cast to the object and use it's function. */ int -Parameter::get_int (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) +Parameter::get_int (const SPDocument * doc, const Inkscape::XML::Node * node) { ParamInt * intpntr; intpntr = dynamic_cast(this); @@ -385,7 +436,7 @@ Parameter::get_int (const Inkscape::XML::Document * doc, const Inkscape::XML::No /** \brief Wrapper to cast to the object and use it's function. */ float -Parameter::get_float (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) +Parameter::get_float (const SPDocument * doc, const Inkscape::XML::Node * node) { ParamFloat * floatpntr; floatpntr = dynamic_cast(this); @@ -396,7 +447,7 @@ Parameter::get_float (const Inkscape::XML::Document * doc, const Inkscape::XML:: /** \brief Wrapper to cast to the object and use it's function. */ const gchar * -Parameter::get_string (const Inkscape::XML::Document * doc, const Inkscape::XML::Node * node) +Parameter::get_string (const SPDocument * doc, const Inkscape::XML::Node * node) { ParamString * stringpntr; stringpntr = dynamic_cast(this); @@ -407,7 +458,7 @@ Parameter::get_string (const Inkscape::XML::Document * doc, const Inkscape::XML: /** \brief Wrapper to cast to the object and use it's function. */ bool -Parameter::set_bool (bool in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +Parameter::set_bool (bool in, SPDocument * doc, Inkscape::XML::Node * node) { ParamBool * boolpntr; boolpntr = dynamic_cast(this); @@ -418,7 +469,7 @@ Parameter::set_bool (bool in, Inkscape::XML::Document * doc, Inkscape::XML::Node /** \brief Wrapper to cast to the object and use it's function. */ int -Parameter::set_int (int in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +Parameter::set_int (int in, SPDocument * doc, Inkscape::XML::Node * node) { ParamInt * intpntr; intpntr = dynamic_cast(this); @@ -429,7 +480,7 @@ Parameter::set_int (int in, Inkscape::XML::Document * doc, Inkscape::XML::Node * /** \brief Wrapper to cast to the object and use it's function. */ float -Parameter::set_float (float in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +Parameter::set_float (float in, SPDocument * doc, Inkscape::XML::Node * node) { ParamFloat * floatpntr; floatpntr = dynamic_cast(this); @@ -440,7 +491,7 @@ Parameter::set_float (float in, Inkscape::XML::Document * doc, Inkscape::XML::No /** \brief Wrapper to cast to the object and use it's function. */ const gchar * -Parameter::set_string (const gchar * in, Inkscape::XML::Document * doc, Inkscape::XML::Node * node) +Parameter::set_string (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node) { ParamString * stringpntr; stringpntr = dynamic_cast(this); @@ -510,9 +561,53 @@ Parameter::pref_name (void) return g_strdup_printf("%s.%s", extension->get_id(), _name); } +Inkscape::XML::Node * +Parameter::find_child (Inkscape::XML::Node * adult) +{ + return sp_repr_lookup_child(adult, "name", _name); +} + +Inkscape::XML::Node * +Parameter::new_child (Inkscape::XML::Node * parent) +{ + Inkscape::XML::Node * retval; + retval = sp_repr_new("inkscape:extension-param"); + retval->setAttribute("name", _name); + + parent->appendChild(retval); + return retval; +} + +Inkscape::XML::Node * +Parameter::document_param_node (SPDocument * doc) +{ + Inkscape::XML::Node * defs = SP_OBJECT_REPR(SP_DOCUMENT_DEFS(doc)); + Inkscape::XML::Node * params = NULL; + + GQuark const name_quark = g_quark_from_string("inkscape:extension-params"); + + for (Inkscape::XML::Node * child = defs->firstChild(); + child != NULL; + child = child->next()) { + if ((GQuark)child->code() == name_quark && + !strcmp(child->attribute("extension"), extension->get_id())) { + params = child; + break; + } + } + + if (params == NULL) { + params = sp_repr_new("inkscape:extension-param"); + params->setAttribute("extension", extension->get_id()); + defs->appendChild(params); + } + + return params; +} + /** \brief Basically, if there is no widget pass a NULL. */ Gtk::Widget * -Parameter::get_widget (void) +Parameter::get_widget (SPDocument * doc, Inkscape::XML::Node * node) { return NULL; } @@ -529,11 +624,13 @@ Parameter::string (void) class ParamFloatAdjustment : public Gtk::Adjustment { /** The parameter to adjust */ ParamFloat * _pref; + SPDocument * _doc; + Inkscape::XML::Node * _node; public: /** \brief Make the adjustment using an extension and the string describing the parameter. */ - ParamFloatAdjustment (ParamFloat * param) : - Gtk::Adjustment(0.0, param->min(), param->max(), 0.1), _pref(param) { + ParamFloatAdjustment (ParamFloat * param, SPDocument * doc, Inkscape::XML::Node * node) : + Gtk::Adjustment(0.0, param->min(), param->max(), 0.1), _pref(param), _doc(doc), _node(node) { this->set_value(_pref->get(NULL, NULL) /* \todo fix */); this->signal_value_changed().connect(sigc::mem_fun(this, &ParamFloatAdjustment::val_changed)); return; @@ -552,7 +649,7 @@ void ParamFloatAdjustment::val_changed (void) { // std::cout << "Value Changed to: " << this->get_value() << std::endl; - _pref->set(this->get_value(), NULL /* \todo fix */, NULL); + _pref->set(this->get_value(), _doc, _node); return; } @@ -560,11 +657,13 @@ ParamFloatAdjustment::val_changed (void) class ParamIntAdjustment : public Gtk::Adjustment { /** The parameter to adjust */ ParamInt * _pref; + SPDocument * _doc; + Inkscape::XML::Node * _node; public: /** \brief Make the adjustment using an extension and the string describing the parameter. */ - ParamIntAdjustment (ParamInt * param) : - Gtk::Adjustment(0.0, param->min(), param->max(), 1.0), _pref(param) { + ParamIntAdjustment (ParamInt * param, SPDocument * doc, Inkscape::XML::Node * node) : + Gtk::Adjustment(0.0, param->min(), param->max(), 1.0), _pref(param), _doc(doc), _node(node) { this->set_value(_pref->get(NULL, NULL) /* \todo fix */); this->signal_value_changed().connect(sigc::mem_fun(this, &ParamIntAdjustment::val_changed)); return; @@ -583,7 +682,7 @@ void ParamIntAdjustment::val_changed (void) { // std::cout << "Value Changed to: " << this->get_value() << std::endl; - _pref->set((int)this->get_value(), NULL /* \todo fix */, NULL); + _pref->set((int)this->get_value(), _doc, _node); return; } @@ -593,15 +692,15 @@ ParamIntAdjustment::val_changed (void) Builds a hbox with a label and a float adjustment in it. */ Gtk::Widget * -ParamFloat::get_widget (void) +ParamFloat::get_widget (SPDocument * doc, Inkscape::XML::Node * node) { - Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox()); + 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, true, true); - ParamFloatAdjustment * fadjust = new ParamFloatAdjustment(this); + ParamFloatAdjustment * fadjust = Gtk::manage(new ParamFloatAdjustment(this, doc, node)); Gtk::SpinButton * spin = Gtk::manage(new Gtk::SpinButton(*fadjust, 0.1, 1)); spin->show(); hbox->pack_start(*spin, false, false); @@ -617,15 +716,15 @@ ParamFloat::get_widget (void) Builds a hbox with a label and a int adjustment in it. */ Gtk::Widget * -ParamInt::get_widget (void) +ParamInt::get_widget (SPDocument * doc, Inkscape::XML::Node * node) { - Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox()); + 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, true, true); - ParamIntAdjustment * fadjust = new ParamIntAdjustment(this); + ParamIntAdjustment * fadjust = Gtk::manage(new ParamIntAdjustment(this, doc, node)); Gtk::SpinButton * spin = Gtk::manage(new Gtk::SpinButton(*fadjust, 1.0, 0)); spin->show(); hbox->pack_start(*spin, false, false); @@ -642,6 +741,8 @@ class ParamBoolCheckButton : public Gtk::CheckButton { private: /** \brief Param to change */ ParamBool * _pref; + SPDocument * _doc; + Inkscape::XML::Node * _node; public: /** \brief Initialize the check button \param param Which parameter to adjust on changing the check button @@ -649,8 +750,8 @@ public: This function sets the value of the checkbox to be that of the parameter, and then sets up a callback to \c on_toggle. */ - ParamBoolCheckButton (ParamBool * param) : - Gtk::CheckButton(), _pref(param) { + ParamBoolCheckButton (ParamBool * param, SPDocument * doc, Inkscape::XML::Node * node) : + Gtk::CheckButton(), _pref(param), _doc(doc), _node(node) { this->set_active(_pref->get(NULL, NULL) /**\todo fix */); this->signal_toggled().connect(sigc::mem_fun(this, &ParamBoolCheckButton::on_toggle)); return; @@ -676,15 +777,15 @@ ParamBoolCheckButton::on_toggle (void) Builds a hbox with a label and a check button in it. */ Gtk::Widget * -ParamBool::get_widget (void) +ParamBool::get_widget (SPDocument * doc, Inkscape::XML::Node * node) { - Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox()); + 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, true, true); - ParamBoolCheckButton * checkbox = new ParamBoolCheckButton(this); + ParamBoolCheckButton * checkbox = new ParamBoolCheckButton(this, doc, node); checkbox->show(); hbox->pack_start(*checkbox, false, false); @@ -697,13 +798,15 @@ ParamBool::get_widget (void) class ParamStringEntry : public Gtk::Entry { private: ParamString * _pref; + SPDocument * _doc; + Inkscape::XML::Node * _node; 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. */ - ParamStringEntry (ParamString * pref) : - Gtk::Entry(), _pref(pref) { + ParamStringEntry (ParamString * pref, SPDocument * doc, Inkscape::XML::Node * node) : + Gtk::Entry(), _pref(pref), _doc(doc), _node(node) { if (_pref->get(NULL, NULL) != NULL) this->set_text(Glib::ustring(_pref->get(NULL, NULL))); this->signal_changed().connect(sigc::mem_fun(this, &ParamStringEntry::changed_text)); @@ -720,7 +823,7 @@ void ParamStringEntry::changed_text (void) { Glib::ustring data = this->get_text(); - _pref->set(data.c_str(), NULL, NULL); + _pref->set(data.c_str(), _doc, _node); return; } @@ -730,17 +833,17 @@ ParamStringEntry::changed_text (void) Builds a hbox with a label and a text box in it. */ Gtk::Widget * -ParamString::get_widget (void) +ParamString::get_widget (SPDocument * doc, Inkscape::XML::Node * node) { - Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox()); + 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, true, true); + hbox->pack_start(*label, false, false); - ParamStringEntry * textbox = new ParamStringEntry(this); + ParamStringEntry * textbox = new ParamStringEntry(this, doc, node); textbox->show(); - hbox->pack_start(*textbox, false, false); + hbox->pack_start(*textbox, true, true); hbox->show(); @@ -792,6 +895,70 @@ ParamString::string (void) return mystring; } +/** \brief Create a label for the description */ +Gtk::Widget * +ParamDescription::get_widget (SPDocument * doc, Inkscape::XML::Node * node) +{ + Gtk::Label * label = Gtk::manage(new Gtk::Label(_(_value))); + label->set_line_wrap(); + label->show(); + + Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox(false, 4)); + hbox->pack_start(*label, true, true, 5); + hbox->show(); + + return hbox; +} + +/** \brief Initialize the object, to do that, copy the data. */ +ParamDescription::ParamDescription (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml) : + Parameter(name, guitext, desc, scope, ext), _value(NULL) +{ + // printf("Building Description\n"); + const char * defaultval = NULL; + if (sp_repr_children(xml) != NULL) + defaultval = sp_repr_children(xml)->content(); + + if (defaultval != NULL) + _value = g_strdup(defaultval); + + return; +} + +ParamEnum::ParamEnum (const gchar * name, const gchar * guitext, const gchar * desc, const Parameter::_scope_t scope, Inkscape::Extension::Extension * ext, Inkscape::XML::Node * xml) : + Parameter(name, guitext, desc, scope, ext), _current_choice(NULL) +{ + return; +} + +ParamEnum::~ParamEnum (void) +{ + +} + +/** \brief Return the value as a string */ +Glib::ustring * +ParamEnum::string (void) +{ + Glib::ustring * mystring = new Glib::ustring(""); + *mystring += "\""; + *mystring += this->get(NULL, NULL); + *mystring += "\""; + return mystring; +} + +Gtk::Widget * +ParamEnum::get_widget (SPDocument * doc, Inkscape::XML::Node * node) +{ + return NULL; +} + +const gchar * +ParamEnum::set (const gchar * in, SPDocument * doc, Inkscape::XML::Node * node) +{ + return NULL; +} + } /* namespace Extension */ } /* namespace Inkscape */