summaryrefslogtreecommitdiffstats
path: root/src/extension/prefdialog/parameter-enum.cpp
diff options
context:
space:
mode:
authorPatrick Storz <eduard.braun2@gmx.de>2019-07-22 23:06:21 +0000
committerPatrick Storz <eduard.braun2@gmx.de>2019-08-31 14:50:38 +0000
commit8f7a3a637f6a465e78e88490a03f539f0d8fdc1a (patch)
treee503502036ba4268921ded10a81ab3b4157d89d5 /src/extension/prefdialog/parameter-enum.cpp
parentMove error classes to Parameter where they belong (diff)
downloadinkscape-8f7a3a637f6a465e78e88490a03f539f0d8fdc1a.tar.gz
inkscape-8f7a3a637f6a465e78e88490a03f539f0d8fdc1a.zip
Refactor a lot of the parameter handling code
Many fixes, improvements and simplifications to existing code. Implements the first part of the changes discussed in https://gitlab.com/inkscape/inkscape/issues/333
Diffstat (limited to 'src/extension/prefdialog/parameter-enum.cpp')
-rw-r--r--src/extension/prefdialog/parameter-enum.cpp269
1 files changed, 0 insertions, 269 deletions
diff --git a/src/extension/prefdialog/parameter-enum.cpp b/src/extension/prefdialog/parameter-enum.cpp
deleted file mode 100644
index 9c71c3df8..000000000
--- a/src/extension/prefdialog/parameter-enum.cpp
+++ /dev/null
@@ -1,269 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0-or-later
-/** \file
- * extension parameter for enumerations.
- *
- * It uses a Gtk:ComboBoxText widget in the extension UI.
- */
-
-/*
- * Author:
- * Johan Engelen <johan@shouraizou.nl>
- * Jon A. Cruz <jon@joncruz.org>
- *
- * Copyright (C) 2006-2007 Johan Engelen
- *
- * Released under GNU GPL v2+, read the file 'COPYING' for more information.
- */
-
-#include "parameter-enum.h"
-
-#include <gtkmm/box.h>
-#include <gtkmm/comboboxtext.h>
-#include <glibmm/i18n.h>
-
-#include "xml/node.h"
-#include "extension/extension.h"
-#include "preferences.h"
-
-namespace Inkscape {
-namespace Extension {
-
-ParamComboBox::ParamComboBox(const gchar * name,
- const gchar * text,
- const gchar * description,
- bool hidden,
- int indent,
- Inkscape::Extension::Extension * ext,
- Inkscape::XML::Node * xml)
- : Parameter(name, text, description, hidden, indent, ext)
- , _value(nullptr)
-{
- const char *xmlval = nullptr; // the value stored in XML
-
- if (xml != nullptr) {
- // Read XML tree to add enumeration items:
- for (Inkscape::XML::Node *node = xml->firstChild(); node; node = node->next()) {
- char const * chname = node->name();
- if (!strcmp(chname, INKSCAPE_EXTENSION_NS "item") || !strcmp(chname, INKSCAPE_EXTENSION_NS "_item")) {
- Glib::ustring newtext, newvalue;
- const char * contents = nullptr;
- if (node->firstChild()) {
- contents = node->firstChild()->content();
- }
- if (contents != nullptr) {
- // 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
- if (!strcmp(chname, INKSCAPE_EXTENSION_NS "_item")) {
- if (node->attribute("msgctxt") != nullptr) {
- newtext = g_dpgettext2(nullptr, node->attribute("msgctxt"), contents);
- } else {
- newtext = _(contents);
- }
- } else {
- newtext = contents;
- }
- } else
- continue;
-
- const char * val = node->attribute("value");
- if (val != nullptr) {
- newvalue = val;
- } else {
- newvalue = contents;
- }
-
- if ( (!newtext.empty()) && (!newvalue.empty()) ) { // logical error if this is not true here
- choices.push_back(new enumentry(newvalue, newtext) );
- }
- }
- }
-
- // Initialize _value with the default value from xml
- // for simplicity : default to the contents of the first xml-child
- if (xml->firstChild() && xml->firstChild()->firstChild()) {
- xmlval = xml->firstChild()->attribute("value");
- }
- }
-
- gchar * pref_name = this->pref_name();
- Inkscape::Preferences *prefs = Inkscape::Preferences::get();
- Glib::ustring paramval = prefs ? prefs->getString(extension_pref_root + pref_name) : "";
- g_free(pref_name);
-
- if (!paramval.empty()) {
- _value = g_strdup(paramval.data());
- } else if (xmlval) {
- _value = g_strdup(xmlval);
- }
-}
-
-ParamComboBox::~ParamComboBox ()
-{
- //destroy choice strings
- for (auto i:choices) {
- delete i;
- }
- g_free(_value);
-}
-
-
-/**
- * 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_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().
- *
- * @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.
- */
-const gchar *ParamComboBox::set(const gchar * in, SPDocument * /*doc*/, Inkscape::XML::Node * /*node*/)
-{
- if (in == nullptr) {
- return nullptr; /* Can't have NULL string */
- }
-
- Glib::ustring settext;
- for (auto entr:choices) {
- if ( !entr->text.compare(in) ) {
- settext = entr->value;
- break; // break out of for loop
- }
- }
- if (!settext.empty()) {
- if (_value != nullptr) {
- g_free(_value);
- }
- _value = g_strdup(settext.data());
- gchar * prefname = this->pref_name();
- Inkscape::Preferences *prefs = Inkscape::Preferences::get();
- prefs->setString(extension_pref_root + prefname, _value);
- g_free(prefname);
- }
-
- return _value;
-}
-
-/**
- * function to test if \c text is selectable
- */
-bool ParamComboBox::contains(const gchar * text, SPDocument const * /*doc*/, Inkscape::XML::Node const * /*node*/) const
-{
- if (text == nullptr) {
- return false; /* Can't have NULL string */
- }
-
- for (auto entr:choices) {
- if ( !entr->text.compare(text) )
- return true;
- }
- // if we did not find the text in this ParamComboBox:
- return false;
-}
-
-void
-ParamComboBox::changed () {
-
-}
-
-void ParamComboBox::string(std::string &string) const
-{
- string += _value;
-}
-
-
-
-
-/** 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<void> * _changeSignal;
-public:
- /**
- * 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<void> * changeSignal) :
- Gtk::ComboBoxText(), _pref(pref), _doc(doc), _node(node), _changeSignal(changeSignal) {
- this->signal_changed().connect(sigc::mem_fun(this, &ParamComboBoxEntry::changed));
- };
- void changed ();
-};
-
-/**
- * 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 ()
-{
- Glib::ustring data = this->get_active_text();
- _pref->set(data.c_str(), _doc, _node);
- if (_changeSignal != nullptr) {
- _changeSignal->emit();
- }
-}
-
-/**
- * Creates a combobox widget for an enumeration parameter.
- */
-Gtk::Widget *ParamComboBox::get_widget(SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal)
-{
- if (_hidden) {
- return nullptr;
- }
-
- Gtk::HBox * hbox = Gtk::manage(new Gtk::HBox(false, Parameter::GUI_PARAM_WIDGETS_SPACING));
- Gtk::Label * label = Gtk::manage(new Gtk::Label(_text, Gtk::ALIGN_START));
- label->show();
- hbox->pack_start(*label, false, false);
-
- ParamComboBoxEntry * combo = Gtk::manage(new ParamComboBoxEntry(this, doc, node, changeSignal));
- // add choice strings:
- Glib::ustring settext;
- for (auto entr:choices) {
- Glib::ustring text = entr->text;
- combo->append(text);
-
- if ( _value && !entr->value.compare(_value) ) {
- settext = entr->text;
- }
- }
- if (!settext.empty()) {
- combo->set_active_text(settext);
- }
-
- combo->show();
- hbox->pack_start(*combo, true, true);
-
- hbox->show();
-
- return dynamic_cast<Gtk::Widget *>(hbox);
-}
-
-
-} // 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 :