Adding upstream version 1.2.2.upstream/1.2.2upstream

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

1 files changed, 455 insertions, 0 deletions

diff --git a/src/ui/widget/registered-widget.h b/src/ui/widget/registered-widget.h
new file mode 100644
index 0000000..f843540
--- /dev/null
+++ b/src/ui/widget/registered-widget.h
@@ -0,0 +1,455 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Authors:
+ *   Ralf Stephan <ralf@ark.in-berlin.de>
+ *   Johan Engelen <j.b.c.engelen@utwente.nl>
+ *   Abhishek Sharma
+ *
+ * Copyright (C) 2005-2008 Authors
+ *
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ *
+ *
+ * Used by Live Path Effects (see src/live_effects/parameter/) and Document Properties dialog.
+ *
+ */
+
+#ifndef INKSCAPE_UI_WIDGET_REGISTERED_WIDGET__H_
+#define INKSCAPE_UI_WIDGET_REGISTERED_WIDGET__H_
+
+#include <2geom/affine.h>
+#include "xml/node.h"
+#include "registry.h"
+
+#include "ui/widget/scalar.h"
+#include "ui/widget/scalar-unit.h"
+#include "ui/widget/point.h"
+#include "ui/widget/text.h"
+#include "ui/widget/random.h"
+#include "ui/widget/unit-menu.h"
+#include "ui/widget/font-button.h"
+#include "ui/widget/color-picker.h"
+#include "inkscape.h"
+
+#include "document.h"
+#include "document-undo.h"
+#include "desktop.h"
+#include "object/sp-namedview.h"
+
+#include <gtkmm/checkbutton.h>
+
+class SPDocument;
+
+namespace Gtk {
+    class HScale;
+    class RadioButton;
+    class SpinButton;
+}
+
+namespace Inkscape {
+namespace UI {
+namespace Widget {
+
+class Registry;
+
+template <class W>
+class RegisteredWidget : public W {
+public:
+    void set_undo_parameters(Glib::ustring _event_description, Glib::ustring _icon_name)
+    {
+        icon_name = _icon_name;
+        event_description = _event_description;
+        write_undo = true;
+    }
+    void set_xml_target(Inkscape::XML::Node *xml_node, SPDocument *document)
+    {
+        repr = xml_node;
+        doc = document;
+    }
+
+    bool is_updating() {if (_wr) return _wr->isUpdating(); else return false;}
+
+protected:
+    RegisteredWidget() : W() {}
+    template< typename A >
+    explicit RegisteredWidget( A& a ): W( a ) {}
+    template< typename A, typename B >
+    RegisteredWidget( A& a, B& b ): W( a, b ) {}
+    template< typename A, typename B, typename C >
+    RegisteredWidget( A& a, B& b, C* c ): W( a, b, c ) {}
+    template< typename A, typename B, typename C >
+    RegisteredWidget( A& a, B& b, C& c ): W( a, b, c ) {}
+    template< typename A, typename B, typename C, typename D >
+    RegisteredWidget( A& a, B& b, C c, D d ): W( a, b, c, d ) {}
+    template< typename A, typename B, typename C, typename D, typename E >
+    RegisteredWidget( A& a, B& b, C& c, D d, E e ): W( a, b, c, d, e ) {}
+    template< typename A, typename B, typename C, typename D, typename E , typename F>
+    RegisteredWidget( A& a, B& b, C c, D& d, E& e, F* f): W( a, b, c, d, e, f) {}
+    template< typename A, typename B, typename C, typename D, typename E , typename F, typename G>
+    RegisteredWidget( A& a, B& b, C& c, D& d, E& e, F f, G& g): W( a, b, c, d, e, f, g) {}
+
+    ~RegisteredWidget() override = default;;
+
+    void init_parent(const Glib::ustring& key, Registry& wr, Inkscape::XML::Node* repr_in, SPDocument *doc_in)
+    {
+        _wr = &wr;
+        _key = key;
+        repr = repr_in;
+        doc = doc_in;
+        if (repr && !doc)  // doc cannot be NULL when repr is not NULL
+            g_warning("Initialization of registered widget using defined repr but with doc==NULL");
+    }
+
+    void write_to_xml(const char * svgstr)
+    {
+        // Use local repr here. When repr is specified, use that one, but
+        // if repr==NULL, get the repr of namedview of active desktop.
+        Inkscape::XML::Node *local_repr = repr;
+        SPDocument *local_doc = doc;
+        if (!local_repr) {
+            SPDesktop* dt = _wr->desktop();
+            if (!dt) {
+                return;
+            }
+            local_repr = reinterpret_cast<SPObject *>(dt->getNamedView())->getRepr();
+            local_doc = dt->getDocument();
+        }
+
+        bool saved = DocumentUndo::getUndoSensitive(local_doc);
+        DocumentUndo::setUndoSensitive(local_doc, false);
+        const char * svgstr_old = local_repr->attribute(_key.c_str());
+        if (!write_undo) {
+            local_repr->setAttribute(_key, svgstr);
+        }
+        DocumentUndo::setUndoSensitive(local_doc, saved);
+        if (svgstr_old && svgstr && strcmp(svgstr_old,svgstr)) {
+            local_doc->setModifiedSinceSave();
+        }
+
+        if (write_undo) {
+            local_repr->setAttribute(_key, svgstr);
+            DocumentUndo::done(local_doc, event_description, icon_name);
+        }
+    }
+
+    Registry * _wr = nullptr;
+    Glib::ustring _key;
+    Inkscape::XML::Node * repr = nullptr;
+    SPDocument * doc = nullptr;
+    Glib::ustring event_description;
+    Glib::ustring icon_name; // Used by History dialog.
+    bool write_undo = false;
+};
+
+//#######################################################
+
+class RegisteredCheckButton : public RegisteredWidget<Gtk::CheckButton> {
+public:
+    ~RegisteredCheckButton() override;
+    RegisteredCheckButton (const Glib::ustring& label, const Glib::ustring& tip, const Glib::ustring& key, Registry& wr, bool right=false, Inkscape::XML::Node* repr_in=nullptr, SPDocument *doc_in=nullptr, char const *active_str = "true", char const *inactive_str = "false");
+
+    void setActive (bool);
+
+    std::list<Gtk::Widget*> _slavewidgets;
+
+    // a slave button is only sensitive when the master button is active
+    // i.e. a slave button is greyed-out when the master button is not checked
+
+    void setSlaveWidgets(std::list<Gtk::Widget*> const &btns) {
+        _slavewidgets = btns;
+    }
+
+    bool setProgrammatically; // true if the value was set by setActive, not changed by the user;
+                                // if a callback checks it, it must reset it back to false
+
+protected:
+    char const *_active_str, *_inactive_str;
+    sigc::connection  _toggled_connection;
+    void on_toggled() override;
+};
+
+class RegisteredToggleButton : public RegisteredWidget<Gtk::ToggleButton> {
+public:
+    ~RegisteredToggleButton() override;
+    RegisteredToggleButton (const Glib::ustring& label, const Glib::ustring& tip, const Glib::ustring& key, Registry& wr, bool right=true, Inkscape::XML::Node* repr_in=nullptr, SPDocument *doc_in=nullptr, char const *icon_active = "true", char const *icon_inactive = "false");
+
+    void setActive (bool);
+
+    std::list<Gtk::Widget*> _slavewidgets;
+
+    // a slave button is only sensitive when the master button is active
+    // i.e. a slave button is greyed-out when the master button is not checked
+
+    void setSlaveWidgets(std::list<Gtk::Widget*> const &btns) {
+        _slavewidgets = btns;
+    }
+
+    bool setProgrammatically; // true if the value was set by setActive, not changed by the user;
+                                // if a callback checks it, it must reset it back to false
+
+protected:
+    sigc::connection  _toggled_connection;
+    void on_toggled() override;
+};
+
+class RegisteredUnitMenu : public RegisteredWidget<Labelled> {
+public:
+    ~RegisteredUnitMenu() override;
+    RegisteredUnitMenu ( const Glib::ustring& label,
+                         const Glib::ustring& key,
+                         Registry& wr,
+                         Inkscape::XML::Node* repr_in = nullptr,
+                         SPDocument *doc_in = nullptr );
+
+    void setUnit (const Glib::ustring);
+    Unit const * getUnit() const { return static_cast<UnitMenu*>(_widget)->getUnit(); };
+    UnitMenu* getUnitMenu() const { return static_cast<UnitMenu*>(_widget); };
+    sigc::connection _changed_connection;
+
+protected:
+    void on_changed();
+};
+
+// Allow RegisteredScalarUnit to output lengths in 'user units' (which may have direction dependent
+// scale factors).
+enum RSU_UserUnits {
+    RSU_none,
+    RSU_x,
+    RSU_y
+};
+
+class RegisteredScalarUnit : public RegisteredWidget<ScalarUnit> {
+public:
+    ~RegisteredScalarUnit() override;
+    RegisteredScalarUnit ( const Glib::ustring& label,
+                           const Glib::ustring& tip,
+                           const Glib::ustring& key,
+                           const RegisteredUnitMenu &rum,
+                           Registry& wr,
+                           Inkscape::XML::Node* repr_in = nullptr,
+                           SPDocument *doc_in = nullptr,
+                           RSU_UserUnits _user_units = RSU_none );
+
+protected:
+    sigc::connection  _value_changed_connection;
+    UnitMenu         *_um;
+    void on_value_changed();
+    RSU_UserUnits _user_units;
+};
+
+class RegisteredScalar : public RegisteredWidget<Scalar> {
+public:
+    ~RegisteredScalar() override;
+    RegisteredScalar (const Glib::ustring& label,
+            const Glib::ustring& tip,
+            const Glib::ustring& key,
+            Registry& wr,
+            Inkscape::XML::Node* repr_in = nullptr,
+            SPDocument *doc_in = nullptr );
+protected:
+    sigc::connection _value_changed_connection;
+    void on_value_changed();
+};
+
+class RegisteredText : public RegisteredWidget<Text> {
+public:
+    ~RegisteredText() override;
+    RegisteredText (const Glib::ustring& label,
+            const Glib::ustring& tip,
+            const Glib::ustring& key,
+            Registry& wr,
+            Inkscape::XML::Node* repr_in = nullptr,
+            SPDocument *doc_in = nullptr );
+
+protected:
+    sigc::connection  _activate_connection;
+    void on_activate();
+};
+
+class RegisteredColorPicker : public RegisteredWidget<LabelledColorPicker> {
+public:
+    ~RegisteredColorPicker() override;
+
+    RegisteredColorPicker (const Glib::ustring& label,
+                           const Glib::ustring& title,
+                           const Glib::ustring& tip,
+                           const Glib::ustring& ckey,
+                           const Glib::ustring& akey,
+                           Registry& wr,
+                           Inkscape::XML::Node* repr_in = nullptr,
+                           SPDocument *doc_in = nullptr);
+
+    void setRgba32 (guint32);
+    void closeWindow();
+
+protected:
+    Glib::ustring _ckey, _akey;
+    void on_changed (guint32);
+    sigc::connection _changed_connection;
+};
+
+class RegisteredSuffixedInteger : public RegisteredWidget<Scalar> {
+public:
+    ~RegisteredSuffixedInteger() override;
+    RegisteredSuffixedInteger ( const Glib::ustring& label,
+                                const Glib::ustring& tip, 
+                                const Glib::ustring& suffix,
+                                const Glib::ustring& key,
+                                Registry& wr,
+                                Inkscape::XML::Node* repr_in = nullptr,
+                                SPDocument *doc_in = nullptr );
+
+    bool setProgrammatically; // true if the value was set by setValue, not changed by the user;
+                                // if a callback checks it, it must reset it back to false
+
+protected:
+    sigc::connection _changed_connection;
+    void on_value_changed();
+};
+
+class RegisteredRadioButtonPair : public RegisteredWidget<Gtk::Box> {
+public:
+    ~RegisteredRadioButtonPair() override;
+    RegisteredRadioButtonPair ( const Glib::ustring& label,
+                                const Glib::ustring& label1,
+                                const Glib::ustring& label2,
+                                const Glib::ustring& tip1,
+                                const Glib::ustring& tip2,
+                                const Glib::ustring& key,
+                                Registry& wr,
+                                Inkscape::XML::Node* repr_in = nullptr,
+                                SPDocument *doc_in = nullptr );
+
+    void setValue (bool second);
+
+    bool setProgrammatically; // true if the value was set by setValue, not changed by the user;
+                                    // if a callback checks it, it must reset it back to false
+protected:
+    Gtk::RadioButton *_rb1, *_rb2;
+    sigc::connection _changed_connection;
+    void on_value_changed();
+};
+
+class RegisteredPoint : public RegisteredWidget<Point> {
+public:
+    ~RegisteredPoint() override;
+    RegisteredPoint ( const Glib::ustring& label,
+                      const Glib::ustring& tip,
+                      const Glib::ustring& key,
+                      Registry& wr,
+                      Inkscape::XML::Node* repr_in = nullptr,
+                      SPDocument *doc_in = nullptr );
+
+protected:
+    sigc::connection  _value_x_changed_connection;
+    sigc::connection  _value_y_changed_connection;
+    void on_value_changed();
+};
+
+
+class RegisteredTransformedPoint : public RegisteredWidget<Point> {
+public:
+    ~RegisteredTransformedPoint() override;
+    RegisteredTransformedPoint (  const Glib::ustring& label,
+                                  const Glib::ustring& tip,
+                                  const Glib::ustring& key,
+                                  Registry& wr,
+                                  Inkscape::XML::Node* repr_in = nullptr,
+                                  SPDocument *doc_in = nullptr );
+
+    // redefine setValue, because transform must be applied
+    void setValue(Geom::Point const & p);
+
+    void setTransform(Geom::Affine const & canvas_to_svg);
+
+protected:
+    sigc::connection  _value_x_changed_connection;
+    sigc::connection  _value_y_changed_connection;
+    void on_value_changed();
+
+    Geom::Affine to_svg;
+};
+
+
+class RegisteredVector : public RegisteredWidget<Point> {
+public:
+    ~RegisteredVector() override;
+    RegisteredVector (const Glib::ustring& label,
+                      const Glib::ustring& tip,
+                      const Glib::ustring& key,
+                      Registry& wr,
+                      Inkscape::XML::Node* repr_in = nullptr,
+                      SPDocument *doc_in = nullptr );
+
+    // redefine setValue, because transform must be applied
+    void setValue(Geom::Point const & p);
+    void setValue(Geom::Point const & p, Geom::Point const & origin);
+
+    /**
+     * Changes the widgets text to polar coordinates. The SVG output will still be a normal cartesian vector.
+     * Careful: when calling getValue(), the return value's X-coord will be the angle, Y-value will be the distance/length. 
+     * After changing the coords type (polar/non-polar), the value has to be reset (setValue).
+     */
+    void setPolarCoords(bool polar_coords = true);
+
+protected:
+    sigc::connection  _value_x_changed_connection;
+    sigc::connection  _value_y_changed_connection;
+    void on_value_changed();
+
+    Geom::Point _origin;
+    bool _polar_coords;
+};
+
+
+class RegisteredRandom : public RegisteredWidget<Random> {
+public:
+    ~RegisteredRandom() override;
+    RegisteredRandom ( const Glib::ustring& label,
+                       const Glib::ustring& tip,
+                       const Glib::ustring& key,
+                       Registry& wr,
+                       Inkscape::XML::Node* repr_in = nullptr,
+                       SPDocument *doc_in = nullptr);
+
+    void setValue (double val, long startseed);
+
+protected:
+    sigc::connection  _value_changed_connection;
+    sigc::connection  _reseeded_connection;
+    void on_value_changed();
+};
+
+class RegisteredFontButton : public RegisteredWidget<FontButton> {
+public:
+    ~RegisteredFontButton() override;
+    RegisteredFontButton ( const Glib::ustring& label,
+                             const Glib::ustring& tip,
+                             const Glib::ustring& key,
+                             Registry& wr,
+                             Inkscape::XML::Node* repr_in = nullptr,
+                             SPDocument *doc_in = nullptr);
+
+    void setValue (Glib::ustring fontspec);
+
+protected:
+    sigc::connection  _signal_font_set;
+    void on_value_changed();
+};
+
+} // namespace Widget
+} // namespace UI
+} // namespace Inkscape
+
+#endif // INKSCAPE_UI_WIDGET_REGISTERED_WIDGET__H_
+
+/*
+  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:fileencoding=utf-8:textwidth=99 :