FreeCAD WebAssembly development snapshot

src/Gui/InputField.h

@@ -0,0 +1,246 @@
+/***************************************************************************
+ *   Copyright (c) 2013 Jürgen Riegel <FreeCAD@juergen-riegel.net>         *
+ *                                                                         *
+ *   This file is part of the FreeCAD CAx development system.              *
+ *                                                                         *
+ *   This library is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU Library General Public           *
+ *   License as published by the Free Software Foundation; either          *
+ *   version 2 of the License, or (at your option) any later version.      *
+ *                                                                         *
+ *   This library  is distributed in the hope that it will be useful,      *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU Library General Public License for more details.                  *
+ *                                                                         *
+ *   You should have received a copy of the GNU Library General Public     *
+ *   License along with this library; see the file COPYING.LIB. If not,    *
+ *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
+ *   Suite 330, Boston, MA  02111-1307, USA                                *
+ *                                                                         *
+ ***************************************************************************/
+
+
+#pragma once
+
+#include <QValidator>
+#include <Base/Parameter.h>
+
+#include "ExpressionBinding.h"
+#include "ExpressionCompleter.h"
+#include "MetaTypes.h"
+#include "Widgets.h"
+
+
+#ifdef Q_MOC_RUN
+Q_DECLARE_METATYPE(Base::Quantity)
+#endif
+
+namespace App
+{
+class DocumentObject;
+class ObjectIdentifier;
+class Expression;
+}  // namespace App
+
+namespace Gui
+{
+
+
+/**
+ * The InputField class
+ * The input field widget handles all around user input of Quantities. That
+ * includes parsing and checking input. Providing a context menu for common operations
+ * and managing default and history values.
+ * Although it's derived from a QLineEdit widget, it supports most of the properties and signals
+ * of a spin box.
+ * \author Jürgen Riegel
+ */
+class GuiExport InputField: public ExpressionLineEdit, public ExpressionWidget
+{
+    Q_OBJECT
+
+    Q_PROPERTY(
+        QByteArray prefPath READ paramGrpPath WRITE setParamGrpPath
+    )  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(
+        double singleStep READ singleStep WRITE setSingleStep
+    )  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(double maximum READ maximum WRITE setMaximum)  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(double minimum READ minimum WRITE setMinimum)  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(double rawValue READ rawValue WRITE setValue NOTIFY valueChanged)
+    Q_PROPERTY(
+        int historySize READ historySize WRITE setHistorySize
+    )  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(QString unit READ getUnitText WRITE setUnitText)  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(int precision READ getPrecision WRITE setPrecision)  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(QString format READ getFormat WRITE setFormat)  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(Base::Quantity quantity READ getQuantity WRITE setValue NOTIFY valueChanged)
+    Q_PROPERTY(
+        QString quantityString READ getQuantityString WRITE setQuantityString
+    )  // clazy:exclude=qproperty-without-notify
+    Q_PROPERTY(QString rawText READ rawText WRITE setRawText)  // clazy:exclude=qproperty-without-notify
+
+
+public:
+    InputField(QWidget* parent = nullptr);
+    ~InputField() override;
+
+    /// set the field with a quantity
+    void setValue(const Base::Quantity&);
+    // set a numerical value which gets converted to a quantity with the currently set unit type
+    void setValue(const double&);
+
+    /// get the current value
+    Base::Quantity getQuantity() const
+    {
+        return this->actQuantity;
+    }
+    /// Get the current quantity without unit
+    double rawValue() const;
+
+    /// get stored, valid quantity as a string (user string - avoid storing)
+    QString getQuantityString() const;
+
+    /// set, validate and display quantity from a string. Must match existing units.
+    void setQuantityString(const QString& text);
+
+    /// return the quantity in C locale, i.e. decimal separator is a dot.
+    QString rawText() const;
+
+    /// expects the string in C locale and internally converts it into the OS-specific locale
+    void setRawText(const QString& text);
+
+    /// gives the current state of the user input, gives true if it is a valid input with correct
+    /// quantity (shown by the green pixmap), returns false if the input is a unparsable string or
+    /// has a wrong unit (shown by the red pixmap in the gui)
+    bool hasValidInput()
+    {
+        return validInput;
+    }
+
+    /** sets the Unit this field is working with.
+     *  After setting the Unit the field will only accept
+     *  user input with this unit type. Or if the user input
+     *  a value without unit, this one will be added to the resulting
+     *  Quantity.
+     */
+    void setUnit(const Base::Unit&);
+    const Base::Unit& getUnit() const;
+
+    /// set the input field to the last used value (works only if the setParamGrpPath() was called)
+    void setToLastUsedValue();
+    /// get the value of the singleStep property
+    double singleStep() const;
+    /// set the value of the singleStep property
+    void setSingleStep(double);
+    /// get the value of the maximum property
+    double maximum() const;
+    /// set the value of the maximum property
+    void setMaximum(double);
+    /// get the value of the minimum property
+    double minimum() const;
+    /// set the value of the minimum property
+    void setMinimum(double);
+    /// get the value of the minimum property
+    int historySize() const;
+    /// set the value of the minimum property
+    void setHistorySize(int);
+    /// set the unit by a string (can be used in the *.ui file)
+    void setUnitText(const QString&);
+    /// get the unit as a string (can be used in the *.ui file)
+    QString getUnitText();
+    /// get the value of the precision property
+    int getPrecision() const;
+    /// set the value of the precision property (can be used in the *.ui file)
+    void setPrecision(const int);
+    /// get the value of the format property: "f" (fixed), "e" (scientific), "g" (general)
+    QString getFormat() const;
+    /// set the value of the format property (can be used in the *.ui file)
+    void setFormat(const QString&);
+    /// set the number portion selected (use after setValue())
+    void selectNumber();
+    /// input validation
+    void fixup(QString& input) const;
+    /// input validation
+    QValidator::State validate(QString& input, int& pos) const;
+
+    /** @name history and default management */
+    //@{
+    /// the param group path where the widget writes and reads the default values
+    QByteArray paramGrpPath() const;
+    /// set the param group path where the widget writes and reads the default values
+    void setParamGrpPath(const QByteArray& name);
+    /// push a new value to the history, if no string given the actual text of the input field is used.
+    void pushToHistory(const QString& valueq = QString());
+    /// get the history of the field, newest first
+    std::vector<QString> getHistory();
+    /// push a new value to the history, if no string given the actual text of the input field is used.
+    void pushToSavedValues(const QString& valueq = QString());
+    /// get the history of the field, newest first
+    std::vector<QString> getSavedValues();
+    //@}
+
+    void bind(const App::ObjectIdentifier& _path) override;
+    bool apply(const std::string& propName) override;
+    bool apply() override;
+
+Q_SIGNALS:
+    /** gets emitted if the user has entered a VALID input
+     *  Valid means the user inputted string obeys all restrictions
+     *  like: minimum, maximum and/or the right Unit (if specified).
+     *  If you want the unfiltered/non-validated input use textChanged(const QString&)
+     *  instead:
+     */
+    void valueChanged(const Base::Quantity&);  // clazy:exclude=overloaded-signal
+    /** gets emitted if the user has entered a VALID input
+     *  Valid means the user inputted string obeys all restrictions
+     *  like: minimum, maximum and/or the right Unit (if specified).
+     *  If you want the unfiltered/non-validated input use textChanged(const QString&)
+     *  instead:
+     */
+    void valueChanged(double);  // clazy:exclude=overloaded-signal
+
+    /// signal for an invalid user input (signals a lot while typing!)
+    void parseError(const QString& errorText);
+
+protected Q_SLOTS:
+    void newInput(const QString& text);
+    void updateIconLabel(const QString& text);
+
+protected:
+    void showEvent(QShowEvent* event) override;
+    void focusInEvent(QFocusEvent* event) override;
+    void focusOutEvent(QFocusEvent* event) override;
+    void keyPressEvent(QKeyEvent* event) override;
+    void wheelEvent(QWheelEvent* event) override;
+    void contextMenuEvent(QContextMenuEvent* event) override;
+    void resizeEvent(QResizeEvent*) override;
+    int getMargin();
+
+private:
+    QPixmap getValidationIcon(const char* name, const QSize& size) const;
+    void updateText(const Base::Quantity&);
+
+private:
+    QByteArray m_sPrefGrp;
+    bool validInput;
+
+    /// handle to the parameter group for defaults and history
+    ParameterGrp::handle _handle;
+    std::string sGroupString;
+
+    Base::Quantity actQuantity;
+    Base::Unit actUnit;
+    double actUnitValue;
+
+    double Maximum;
+    double Minimum;
+    double StepSize;
+    int HistorySize;
+    int SaveSize;
+
+    QPalette defaultPalette;
+};
+
+}  // namespace Gui