Adding upstream version 1.2.2.upstream/1.2.2upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 351 insertions, 0 deletions

diff --git a/src/extension/prefdialog/parameter-optiongroup.cpp b/src/extension/prefdialog/parameter-optiongroup.cpp
new file mode 100644
index 0000000..4652788
--- /dev/null
+++ b/src/extension/prefdialog/parameter-optiongroup.cpp
@@ -0,0 +1,351 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/** \file
+ *extension parameter for options with multiple predefined value choices
+ *
+ * Currently implemented as either Gtk::RadioButton or Gtk::ComboBoxText
+ */
+
+/*
+ * Author:
+ *   Johan Engelen <johan@shouraizou.nl>
+ *
+ * Copyright (C) 2006-2007 Johan Engelen
+ * Copyright (C) 2008 Jon A. Cruz
+ *
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ */
+
+#include "parameter-optiongroup.h"
+
+#include <unordered_set>
+
+#include <gtkmm/box.h>
+#include <gtkmm/comboboxtext.h>
+#include <gtkmm/radiobutton.h>
+
+#include "xml/node.h"
+#include "extension/extension.h"
+#include "preferences.h"
+
+
+namespace Inkscape {
+namespace Extension {
+
+ParamOptionGroup::ParamOptionGroup(Inkscape::XML::Node *xml, Inkscape::Extension::Extension *ext)
+    : InxParameter(xml, ext)
+{
+    // Read valid optiongroup choices from XML tree, i,e.
+    //   - <option> elements
+    //   - <item> elements (for backwards-compatibility with params of type enum)
+    //   - underscored variants of both (for backwards-compatibility)
+    if (xml) {
+        Inkscape::XML::Node *child_repr = xml->firstChild();
+        while (child_repr) {
+            const char *chname = child_repr->name();
+            if (chname && (!strcmp(chname, INKSCAPE_EXTENSION_NS "option") ||
+                           !strcmp(chname, INKSCAPE_EXTENSION_NS "_option") ||
+                           !strcmp(chname, INKSCAPE_EXTENSION_NS "item") ||
+                           !strcmp(chname, INKSCAPE_EXTENSION_NS "_item")) ) {
+                child_repr->setAttribute("name", "option"); // TODO: hack to allow options to be parameters
+                child_repr->setAttribute("gui-text", "option"); // TODO: hack to allow options to be parameters
+                ParamOptionGroupOption *param = new ParamOptionGroupOption(child_repr, ext, this);
+                choices.push_back(param);
+            } else if (child_repr->type() == XML::NodeType::ELEMENT_NODE) {
+                g_warning("Invalid child element ('%s') for parameter '%s' in extension '%s'. Expected 'option'.",
+                          chname, _name, _extension->get_id());
+            } else if (child_repr->type() != XML::NodeType::COMMENT_NODE){
+                g_warning("Invalid child element found in parameter '%s' in extension '%s'. Expected 'option'.",
+                          _name, _extension->get_id());
+            }
+            child_repr = child_repr->next();
+        }
+    }
+    if (choices.empty()) {
+        g_warning("No (valid) choices for parameter '%s' in extension '%s'", _name, _extension->get_id());
+    }
+
+    // check for duplicate option texts and values
+    std::unordered_set<std::string> texts;
+    std::unordered_set<std::string> values;
+    for (auto choice : choices) {
+        auto ret1 = texts.emplace(choice->_text.raw());
+        if (!ret1.second) {
+            g_warning("Duplicate option text ('%s') for parameter '%s' in extension '%s'.",
+                      choice->_text.c_str(), _name, _extension->get_id());
+        }
+        auto ret2 = values.emplace(choice->_value.raw());
+        if (!ret2.second) {
+            g_warning("Duplicate option value ('%s') for parameter '%s' in extension '%s'.",
+                      choice->_value.c_str(), _name, _extension->get_id());
+        }
+    }
+
+    // get value (initialize with value of first choice if pref is empty)
+    Inkscape::Preferences *prefs = Inkscape::Preferences::get();
+    _value = prefs->getString(pref_name());
+
+    if (_value.empty()) {
+        if (!choices.empty()) {
+            _value = choices[0]->_value;
+        }
+    }
+
+    // parse appearance
+    // (we support "combo" and "radio"; "minimal" is for backwards-compatibility)
+    if (_appearance) {
+        if (!strcmp(_appearance, "combo") || !strcmp(_appearance, "minimal")) {
+            _mode = COMBOBOX;
+        } else if (!strcmp(_appearance, "radio")) {
+            _mode = RADIOBUTTON;
+        } else {
+            g_warning("Invalid value ('%s') for appearance of parameter '%s' in extension '%s'",
+                      _appearance, _name, _extension->get_id());
+        }
+    }
+}
+
+ParamOptionGroup::~ParamOptionGroup ()
+{
+    // destroy choice strings
+    for (auto choice : choices) {
+        delete choice;
+    }
+}
+
+
+/**
+ * A function to set the \c _value.
+ *
+ * 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_name() is used.
+ *
+ * @param  in   The value to set.
+ */
+const Glib::ustring& ParamOptionGroup::set(Glib::ustring in)
+{
+    if (contains(in)) {
+        _value = in;
+        Inkscape::Preferences *prefs = Inkscape::Preferences::get();
+        prefs->setString(pref_name(), _value.c_str());
+    } else {
+        g_warning("Could not set value ('%s') for parameter '%s' in extension '%s'. Not a valid choice.",
+                  in.c_str(), _name, _extension->get_id());
+    }
+
+    return _value;
+}
+
+bool ParamOptionGroup::contains(const Glib::ustring text) const
+{
+    for (auto choice : choices) {
+        if (choice->_value == text) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+std::string ParamOptionGroup::value_to_string() const
+{
+    return _value.raw();
+}
+
+/**
+ * Returns the value for the options label parameter
+ */
+Glib::ustring ParamOptionGroup::value_from_label(const Glib::ustring label)
+{
+    Glib::ustring value;
+
+    for (auto choice : choices) {
+        if (choice->_text == label) {
+            value = choice->_value;
+            break;
+        }
+    }
+
+    return value;
+}
+
+
+
+/** A special RadioButton class to use in ParamOptionGroup. */
+class RadioWidget : public Gtk::RadioButton {
+private:
+    ParamOptionGroup *_pref;
+    sigc::signal<void> *_changeSignal;
+public:
+    RadioWidget(Gtk::RadioButtonGroup& group, const Glib::ustring& label,
+                ParamOptionGroup *pref, sigc::signal<void> *changeSignal)
+        : Gtk::RadioButton(group, label)
+        , _pref(pref)
+        , _changeSignal(changeSignal)
+    {
+        add_changesignal();
+    };
+
+    void add_changesignal() {
+        this->signal_toggled().connect(sigc::mem_fun(this, &RadioWidget::changed));
+    };
+
+    void changed();
+};
+
+/**
+ * Respond to the selected radiobutton changing.
+ *
+ * This function responds to the radiobutton selection changing by grabbing the value
+ * from the text box and putting it in the parameter.
+ */
+void RadioWidget::changed()
+{
+    if (this->get_active()) {
+        Glib::ustring value = _pref->value_from_label(this->get_label());
+        _pref->set(value.c_str());
+    }
+
+    if (_changeSignal) {
+        _changeSignal->emit();
+    }
+}
+
+
+/** A special ComboBoxText class to use in ParamOptionGroup. */
+class ComboWidget : public Gtk::ComboBoxText {
+private:
+    ParamOptionGroup *_pref;
+    sigc::signal<void> *_changeSignal;
+
+public:
+    ComboWidget(ParamOptionGroup *pref, sigc::signal<void> *changeSignal)
+        : _pref(pref)
+        , _changeSignal(changeSignal)
+    {
+        this->signal_changed().connect(sigc::mem_fun(this, &ComboWidget::changed));
+    }
+
+    ~ComboWidget() override = default;
+
+    void changed();
+};
+
+void ComboWidget::changed()
+{
+    if (_pref) {
+        Glib::ustring value = _pref->value_from_label(get_active_text());
+        _pref->set(value.c_str());
+    }
+
+    if (_changeSignal) {
+        _changeSignal->emit();
+    }
+}
+
+
+
+/**
+ * Creates the widget for the optiongroup parameter.
+ */
+Gtk::Widget *ParamOptionGroup::get_widget(sigc::signal<void> *changeSignal)
+{
+    if (_hidden) {
+        return nullptr;
+    }
+
+    auto hbox = Gtk::manage(new Gtk::Box(Gtk::ORIENTATION_HORIZONTAL, GUI_PARAM_WIDGETS_SPACING));
+
+    Gtk::Label *label = Gtk::manage(new Gtk::Label(_text, Gtk::ALIGN_START));
+    hbox->pack_start(*label, false, false);
+
+    if (_mode == COMBOBOX) {
+        ComboWidget *combo = Gtk::manage(new ComboWidget(this, changeSignal));
+
+        for (auto choice : choices) {
+            combo->append(choice->_text);
+            if (choice->_value == _value) {
+                combo->set_active_text(choice->_text);
+            }
+        }
+
+        if (combo->get_active_row_number() == -1) {
+            combo->set_active(0);
+        }
+
+        hbox->pack_end(*combo, false, false);
+    } else if (_mode == RADIOBUTTON) {
+        label->set_valign(Gtk::ALIGN_START); // align label and first radio
+
+        Gtk::Box *radios = Gtk::manage(new Gtk::Box(Gtk::ORIENTATION_VERTICAL, 0));
+        Gtk::RadioButtonGroup group;
+
+        for (auto choice : choices) {
+            RadioWidget *radio = Gtk::manage(new RadioWidget(group, choice->_text, this, changeSignal));
+            radios->pack_start(*radio, true, true);
+            if (choice->_value == _value) {
+                radio->set_active();
+            }
+        }
+
+        hbox->pack_end(*radios, false, false);
+    }
+
+    hbox->show_all();
+    return static_cast<Gtk::Widget *>(hbox);
+}
+
+
+ParamOptionGroup::ParamOptionGroupOption::ParamOptionGroupOption(Inkscape::XML::Node *xml, Inkscape::Extension::Extension *ext,
+                                                                 const Inkscape::Extension::ParamOptionGroup *parent)
+    : InxParameter(xml, ext)
+{
+    // get content (=label) of option and translate it
+    const char *text = nullptr;
+    if (xml->firstChild()) {
+        text = xml->firstChild()->content();
+    }
+    if (text) {
+        if (_translatable != NO) { // translate unless explicitly marked untranslatable
+            _text = get_translation(text);
+        } else {
+            _text = text;
+        }
+    } else {
+        g_warning("Missing content in option of parameter '%s' in extension '%s'.",
+                  parent->_name, _extension->get_id());
+    }
+
+    // get string value of option
+    const char *value = xml->attribute("value");
+    if (value) {
+        _value = value;
+    } else {
+        if (text) {
+            const char *name = xml->name();
+            if (!strcmp(name, INKSCAPE_EXTENSION_NS "item") || !strcmp(name, INKSCAPE_EXTENSION_NS "_item")) {
+                _value = text; // use untranslated UI text as value (for backwards-compatibility)
+            } else {
+                _value = _text; // use translated UI text as value
+            }
+        } else {
+            g_warning("Missing value for option '%s' of parameter '%s' in extension '%s'.",
+                      _text.c_str(), parent->_name, _extension->get_id());
+        }
+    }
+}
+
+
+
+}  /* namespace Extension */
+}  /* namespace Inkscape */
+
+/*
+  Local Variables:
+  mode:c++
+  c-file-style:"stroustrup"
+  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+  indent-tabs-mode:nil
+  fill-column:99
+  End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :