QCustomValidator.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QCustomValidator
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Unit.h>
#include <NDEVR/TypeInfo.h>
#include <NDEVR/Pointer.h>
#include <NDEVR/String.h>
#include <QValidator>
namespace NDEVR
{
    struct Unit;
    /**--------------------------------------------------------------------------------------------------
    \brief Responsible on most user input fields for correcting the input when possible or allerting
        the user that the input is incorrect. Used on all QCustomLineEdit widgets and derivatives.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API QCustomValidator : public QValidator
    {
        Q_OBJECT
    public:
        enum ValidityMessage
        {
            e_is_valid
            , e_unexpected_format
            , e_value_is_not_a_real_number
            , e_too_many_decimals
            , e_value_too_high
            , e_value_too_low
            , e_value_is_empty
            , e_string_is_too_long
            , e_string_is_too_short
            , e_file_exists
        };
    public:
        explicit QCustomValidator(QObject *parent = nullptr);
        explicit QCustomValidator(const TypeInfo& info, QObject *parent = nullptr);
        QCustomValidator(const QCustomValidator& validator);
        virtual ~QCustomValidator();
        void fixup(QString & input) const override;
        String& fixup(String& input, bool to_unit = true, bool from_unit = true) const;
        QValidator::State validate(QString& input, int& pos) const override;
        ValidityMessage getMessage(const String& input) const;
        TranslatedString getMessageString(ValidityMessage message);
        void setNumberOfDecimals(uint04 decimals)
        {
            m_number_of_decimals = decimals;
        }
        //Return empty string for valid, otherwise error message
        void setCustomCallback(const std::function<ValidityMessage(const String&)>& callback) { m_custom_validation_step = callback; }
        void setAllowWrapping(bool allow_wrapping) { m_allow_wrapping = allow_wrapping; }
        void setAllowEmpty(bool allow_empty) { m_allow_empty = allow_empty; }
        void setMax(fltp08 max) { m_max = max; }
        void setMin(fltp08 min) { m_min = min; }
        template<class t_angle_type>
        void setMax(Angle<t_angle_type> max) { m_max = max.template as<INTERNAL_ANGLE>(); }
        template<class t_angle_type>
        void setMin(Angle<t_angle_type> min) { m_min = min.template as<INTERNAL_ANGLE>(); }
        [[nodiscard]] fltp08 max() const { return m_max; }
        [[nodiscard]] fltp08 min() const { return m_min; }
        void setStep(fltp08 step) { m_step = step; }
        [[nodiscard]] fltp08 step() const;
        void setRegex(const String& regex);
        [[nodiscard]] const String& regex() const { return m_regex; }
        void setUnitValidator(const ConstPointer<Unit>& unit, uint01 dimension = Constant<uint01>::Invalid);
        void setUnitType(UnitCategory type);
        [[nodiscard]] const ConstPointer<Unit>& unit() const { return m_unit; }
        [[nodiscard]] const UnitCategory& unitType() const { return m_unit_type; }
        void setTypeInfo(const TypeInfo& info) { m_type_info = info; }
        [[nodiscard]] const TypeInfo& typeInfo() const { return m_type_info; }
        [[nodiscard]] uint01 unitDimension() const { return m_unit_dimension; }
        const QCustomValidator& operator=(const QCustomValidator& other);
    private:
        ConstPointer<Unit> m_unit;
        UnitCategory m_unit_type;
        uint01 m_unit_dimension;
        TypeInfo m_type_info;
        uint04 m_number_of_decimals;
        String m_regex;
        fltp08 m_max;
        fltp08 m_min;
        fltp08 m_step;
        bool m_allow_wrapping;
        bool m_allow_empty;
        std::function<ValidityMessage(const String&)> m_custom_validation_step = nullptr;
    };
}