xref: /dports/x11-toolkits/kproperty/kproperty-3.2.0/src/KProperty.h

/* This file is part of the KDE project
   Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2004 Alexander Dymo <cloudtemple@mskat.net>
   Copyright (C) 2004-2017 Jarosław Staniek <staniek@kde.org>

   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., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef KPROPERTY_PROPERTY_H
#define KPROPERTY_PROPERTY_H

#include <QVariant>
#include <QStringList>
#include <QByteArray>
#include <QDebug>

#include <cmath>
#include <limits>

#include "kpropertycore_export.h"

class KComposedPropertyInterface;
class KPropertyListData;
class KPropertySet;
class KPropertySetPrivate;

/**
 * @brief Minimum double value working precisely.
 *
 * @since 3.1
 */
#define KPROPERTY_MIN_PRECISE_DOUBLE (-pow(2, std::numeric_limits<double>::digits))

/**
 * @brief Minimum double value working precisely
 *
 * Editor for double values (spin box) has localized contents and its code supports just this maximum.
 * For a 64-bit machine it's 2**53.
 * See also https://phabricator.kde.org/D5419#inline-22329
 *
 * @since 3.1
 */
#define KPROPERTY_MAX_PRECISE_DOUBLE (pow(2, std::numeric_limits<double>::digits))

/*! \brief The base class representing a single property

  KProperty object can hold a property of given type supported by QVariant. Properties of custom types
  can be also created, see using KPropertyFactory. Composed or custom properties
  are not created using subclassing of KProperty but using @ref KComposedPropertyInterface.

  Each property stores old value to allows undoing that reverts the value to the old one.
  Property has a non-empty name (a QByteArray), a caption that is user-visible translated string
  displayed in property editor. Description is a translatable string that can be specified too
  in order to further explain meaning of the property.

  Propery also supports setting arbitrary number of options using KProperty::setOption() that allow
  to customize look or behavior of the property in the editor.

  @code
  // Creating a simple property:
  KProperty *property = new KProperty(name, value, caption, description);
  // name is a QByteArray, value is whatever type QVariant supports

  // Creating a property of type ValueFromList matching keys with names:
  QStringList keys({"one", "two", "three"}); // possible values of the property
  QStringList names({tr("One"), tr("Two"), tr("Three")}); // Names (possibly translated) shown in
                                                          // the editor instead of the keys
  property = new KProperty(name, new KPropertyListData(keys, names), "two", caption);

  // Creating a property of type ValueFromList matching variant keys with names:
  KPropertyListData *listData = new KPropertyListData({1.1, tr("One")}, {2.5, tr("Two")}, {3., tr("Three")}});
  propertySet->addProperty(new KProperty("List", listData, "otheritem", "List"));
  @endcode

  @note Sometimes it makes sense to split property captions that have with more words to multiple lines
  using a newline character, e.g. "Allow Zero Size" to "Allow Zero\nSize".
  This is suitable especially for the needs of property editor which can offer only limited area.
  The text of property caption containing newline characters is available in its original form using
  KProperty::captionForDisplaying(). KProperty::caption() returns modified caption text in which
  the newline characters are substituted with spaces and any trailing and leading whitespace is removed.
*/
class KPROPERTYCORE_EXPORT KProperty
{
public:
    /*! Defines types of properties.
     Properties defined by plugins should have a type number >= UserDefined .*/
    enum Type {
        //standard supported QVariant types
        Auto = 0x00ffffff,
        Invalid = QVariant::Invalid,
        BitArray = QVariant::BitArray,
        Bitmap = QVariant::Bitmap,
        Bool = QVariant::Bool,
        Brush = QVariant::Brush,
        ByteArray = QVariant::ByteArray,
        Char = QVariant::Char,
        Color = QVariant::Color,
        Cursor = QVariant::Cursor,
        Date = QVariant::Date,
        DateTime = QVariant::DateTime,
        Double = QVariant::Double,
        Font = QVariant::Font,
        Icon = QVariant::Icon,
        Image = QVariant::Image,
        Int = QVariant::Int,
        KeySequence = QVariant::KeySequence,
        Line = QVariant::Line,
        LineF = QVariant::LineF,
        List = QVariant::List,
        Locale = QVariant::Locale,
        LongLong = QVariant::LongLong,
        Map = QVariant::Map,
        Matrix = QVariant::Matrix,
        Transform = QVariant::Transform,
        Palette = QVariant::Palette,
        Pen = QVariant::Pen,
        Pixmap = QVariant::Pixmap,
        Point = QVariant::Point,
        PointF = QVariant::PointF,
        Polygon = QVariant::Polygon,
        Rect = QVariant::Rect,
        RectF = QVariant::RectF,
        RegExp = QVariant::RegExp,
        Region = QVariant::Region,
        Size = QVariant::Size,
        SizeF = QVariant::SizeF,
        SizePolicy = QVariant::SizePolicy,
        String = QVariant::String,
        StringList = QVariant::StringList,
        TextFormat = QVariant::TextFormat,
        TextLength = QVariant::TextLength,
        Time = QVariant::Time,
        UInt = QVariant::UInt,
        ULongLong = QVariant::ULongLong,
        Url = QVariant::Url,

        //predefined custom types
        ValueFromList = 1000,         /**<string value from a list*/
        Symbol,                       /**<unicode symbol code*/
        FontName,                     /**<font name, e.g. "times new roman"*/
        LineStyle,                    /**<line style*/
        ComposedUrl                   /**<composed URL @since 3.2 */,

        UserDefined = 4000            /**<plugin defined properties should start here*/
    };

    /**
     * Constructs a null property.
     * Null properties have empty names and captions and Invalid types.
     */
    KProperty();

    /*! Constructs property of a simple type. */
    explicit KProperty(const QByteArray &name, const QVariant &value = QVariant(),
             const QString &caption = QString(), const QString &description = QString(),
             int type = Auto, KProperty* parent = nullptr);

    /**
     * @brief Constructs property of ValueFromList type
     *
     * Ownership of @a listData is passed to the property object.
     */
    KProperty(const QByteArray &name, KPropertyListData *listData,
             const QVariant &value = QVariant(),
             const QString &caption = QString(), const QString &description = QString(),
             int type = ValueFromList, KProperty* parent = nullptr);

    /*! Constructs a deep copy of \a prop property. */
    KProperty(const KProperty &prop);

    ~KProperty();

    /**
     * @return name of the property
     * @note empty name means a null property
     */
    QByteArray name() const;

    /**
     * Sets name of the property
     * @note empty name means a null property
     */
    void setName(const QByteArray &name);

    /*! \return the caption of the property. Does not contain newline characters. Can be empty. */
    QString caption() const;

    /*! \return the caption of the property or name() if the caption is empty. */
    inline QString captionOrName() const
    {
        return caption().isEmpty() ? QString::fromLatin1(name()) : caption();
    }

    /*! \return the caption text of the property for displaying.
     It is similar to caption() but if the property caption contains newline characters,
     these are not substituted with spaces. */
    QString captionForDisplaying() const;

    /*! Sets the name of the property. If the caption contains newline characters,
     these are substituted with spaces.
     @see captionForDisplaying
    */
    void setCaption(const QString &caption);

    /*! \return the description of the property.*/
    QString description() const;

    /*! Sets the description of the property.*/
    void setDescription(const QString &description);

    /*! \return the type of the property.*/
    int type() const;

    /*! Sets the type of the property.*/
    void setType(int type);

    /*! \return the value of the property.*/
    QVariant value() const;

    /*! Returns the previous property value if it was set in setValue(). */
    QVariant oldValue() const;

    //! Options that influence how values are handled in setValue() and valueEqualsTo()
    //! @since 3.1
    enum class ValueOption {
        None = 0,        //!< No options, that is 1. old value is remembered before setting a new one;
                         //!< 2. composed properties are considered while comparing old and new value
        IgnoreOld = 1,   //!< Do not remember the old value before setting a new one
        IgnoreComposedProperty = 2 //!< Do not use composed property when comparing values
    };
    Q_DECLARE_FLAGS(ValueOptions, ValueOption)

    /**
     * @brief Sets value of the property.
     * @param value New value
     * @param options Options for the value setting.
     * @return @c true if the value has been changed and @c false if the @a value was the same
     *         as previous one so it was not changed of if this property is null.
     */
    bool setValue(const QVariant &value, ValueOptions options = ValueOptions());

    /**
     * @return true if value of this property is equal to specified value
     *
     * Takes type into account.
     * @param value Value to compare.
     * @param valueOptions Options to use when comparing.
     *                     Only the @c None and IgnoreComposedProperties are supported.
     * @since 3.1
     */
    bool valueEqualsTo(const QVariant &value, ValueOptions valueOptions = ValueOptions()) const;

    /*! Resets the value of the property to the old value.
     @see oldValue() */
    void resetValue();

    /*! \return the qstring-to-value correspondence list of the property.
     used to create comboboxes-like property editors.*/
    KPropertyListData* listData() const;

    /*! Sets the qstring-to-value correspondence list of the property.
    This is used to create comboboxes-like property editors.*/
    void setListData(KPropertyListData* list);

    /*! Sets the string-to-value correspondence list of the property.
     This is used to create comboboxes-like property editors.
     This is overload of the above ctor added for convenience. */
    void setListData(const QStringList &keys, const QStringList &names);

    /*! Sets icon name to \a name for this property. Icons are optional and are used e.g.
     in property editor - displayed at the left hand. */
    void setIconName(const QString &name);

    /*! \return property icon's name. Can be empty. */
    QString iconName() const;

    /*! \return a list of all children for this property, or NULL of there
     is no children for this property */
    const QList<KProperty*>*  children() const;

    /*! \return a child property for \a name, or NULL if there is no property with that name. */
    KProperty* child(const QByteArray &name);

    /*! \return parent property for this property, or NULL if there is no parent property. */
    KProperty* parent() const;

    /*! \return the composed property for this property, or NULL if there was
    no composed property defined. */
    KComposedPropertyInterface* composedProperty() const;

    /*! Sets composed property \a prop for this property. */
    void setComposedProperty(KComposedPropertyInterface *prop);

    /*! \return true if this property is null. Property is null if it has empty name. */
    bool isNull() const;

    /**
     * @brief Return @c true if value of this property or value of any child property is modified.
     *
     * @see clearModifiedFlag()
     */
    bool isModified() const;

    /**
     * @brief Clears the "modified" flag for this property and all its child properties.
     *
     * After calling this method isModified() returs false for the property and all child
     * properties.
     *
     * @see isModified()
     */
    void clearModifiedFlag();

    /*! \return true if the property is read-only when used in a property editor.
     @c false by default.
     The property can be read-write but still not editable for the user if the parent property set's
     read-only flag is set.
     @see KPropertySet::isReadOnly() */
    bool isReadOnly() const;

    /*! Sets this property to be read-only.
     @see isReadOnly() */
    void setReadOnly(bool readOnly);

    /*! \return true if the property is visible.
     Only visible properties are displayed by the property editor view. */
    bool isVisible() const;

    /*! Sets the visibility flag.*/
    void setVisible(bool visible);

    /*! \return true if the property can be saved to a stream, xml, etc.
    There is a possibility to use "GUI" properties that aren't
    stored but used only in a GUI.*/
    bool isStorable() const;

    /*! Sets "storable" flag for this property. @see isStorable() */
    void setStorable(bool storable);

    //! Synchronization policy for property values
    //! @since 3.1
    enum class ValueSyncPolicy {
        Editor,   //!< Allow to synchronize by the property editor using its valueSync setting (default)
        FocusOut, //!< Synchronize the value when focus is out of the editor widget for this property
                  //!< or when the user presses the Enter key
        Auto      //!< Synchronize automatically as soon as the editor widget for this property signals
                  //! (using commitData) that the value has been changed, e.g. when the user types
                  //! another letter in a text box
    };

    //! @return synchronization policy for property values of this property
    //! @since 3.1
    ValueSyncPolicy valueSyncPolicy() const;

    //! Sets synchronization policy for property values of this property
    //! See ValueSyncPolicy for details.
    //! @since 3.1
    void setValueSyncPolicy(ValueSyncPolicy policy);

    /*! Sets value \a val for option \a name.
     Options are used to override default settings of individual properties.
     They are most visible in property editor widgets. Option is set if it is not null.
     This means that empty string can be still a valid value.
     To unset given option, call setOption() with a null QVariant value.

    Currently supported options are:
    <ul>
    <li> min: value describing minimum value for properties of integer, double,
         date, date/time and time types. Default is 0 for double and unsigned integer types,
         -INT_MAX for signed integer type.
         Defaults for date, date/time and time types are specified in documentation
         of QDateEdit::minimumDate, QDateTimeEdit::minimumDateTime and QTime::minimumTime, respectively.
         The value specified for this option is accepted if:
         - it is not larger than the value of the "max" option
         - it is not smaller than KPROPERTY_MIN_PRECISE_DOUBLE (for double type)
         - it is not smaller than -INT_MAX (for integer type)
         - it is not smaller than 0 (for unsigned integer type).
         </li>
    <li> minValueText: user-visible translated string to be displayed in editor for integer,
         double, date, date/time and time types when the value is equal to the value of
         "min" option.
         The value specified for this option is accepted if min option is supported for given type
         and is specified.
         @see QAbstractSpinBox::specialValueText</li>
    <li> max: value describing minimum value for properties of integer type.
         Default is KPROPERTY_MAX_PRECISE_DOUBLE for double type (maximum precise value)
         and INT_MAX for integer type.
         Defaults for date, date/time and time types are specified in documentation
         of QDateEdit::maximumDate, QDateTimeEdit::maximumDateTime and QTime::maximumTime, respectively.
         The value is ignored if it is smaller than the value of "min" option. </li>
         The value specified for this option is accepted if:
         - it is not smaller than the value of the "min" option
         - it is not larger than KPROPERTY_MAX_PRECISE_DOUBLE (for double type)
         - it is not larger than INT_MAX (for integer and unsigned integer type).
         </li>
    <li> precision: integer value >= 0 describing the number of decimals after the decimal
         point for double type. Default value is 2.
         @see QDoubleSpinBox::decimals</li>
    <li> step: double value > 0.0 describing the size of the step that is taken when
         the user hits the up or down button of editor for double type. Default value is 0.01.
         @see QDoubleSpinBox::singleStep</li>
    <li> 3State: boolean value used for boolean type; if @c true, the editor becomes a combobox
         (instead of checkable button) and accepts the third "null" state. Otherwise the boolean
         type only accepts @c true and @c false values, anything other, including invalid and null
         values, is converted to @c false.</li>
    <li> yesName: user-visible translated string used for boolean type (both 2- and 3-state)
         to visually represent the "true" value. If not present, tr("Yes") is used.</li>
    <li> noName: user-visible translated string used for boolean type (both 2- and 3-state)
         to visually represent the "false" value. If not present, tr("No") is used.</li>
    <li> 3rdStateName: user-visible translated string used for boolean type (both 2- and 3-state)
         to visually represent the third "null" value. If not present, tr("None") is used.</li>
    <li> nullName: user-visible translated string used for boolean type to display the "null"
         value, if and only if the property accepts two states (i.e. when "3State" option
         is @c false). If the "nullName" option is not set, null values are displayed as
         @c false.</li>
    <li> extraValueAllowed: boolean value, if @c true the user is able to manually add extra
         values to a combobox.</li>
    <li> fileMode: string value that describes types of objects that can be selected by the url
         editor:
         <ul>
         <li>"dirsOnly": only display and allow to select existing directories;
             @see QFileDialog::getExistingDirectoryUrl()</li>
         <li>"existingFile": only allow to select one existing file for opening, i.e. confirmation
             of overwriting is not performed;
             @see QFileDialog::getOpenFileUrl()</li>
         <li>Any other value: any file is supported, whether it exists or not; if the file exists,
             "confirmOverwrites" option is honored; this mode is the only one supporting non-file
             protocols such as ftp or http; to use them user has to enter them explicitly,
             file protocol is still the default
             @see QFileDialog::getSaveFileUrl()</li>
         </ul>
         @note Empty URLs are always allowed.
         </li>
    <li> confirmOverwrites: boolean value supported by the url editor; if @c true and the "fileMode"
         option is not equal to "existingFile" nor "dirsOnly" user will be asked for confirmation
         of file overwriting if selected file exists. @c false by default.
         @note The line edit does not validate the content.</li>
    <li> multiLine: boolean value used for string type. If @c true, a multi-line
         QPlainTextEdit-based widget is used for editor; otherwise a single-line QLineEdit
         widget is used. @c false by default. Added in version 3.1.</li>
    <li>prefix: string to display before the value, e.g. '$'. Supported for double and integer
        types and composed types based on double and integer types (Point*, Size*, Rect*).
        @see QDoubleSpinBox::prefix QSpinBox::prefix</li>
    <li>suffix: string to display after the value, e.g. unit such as 'mm'.
        Supported for double and integer types and composed types based on double and
        integer types (Point*, Size*, Rect*). Note that only display is affected, value
        is not converted to any unit.
        @see QDoubleSpinBox::suffix QSpinBox::suffix</li>
    </ul>*/
    void setOption(const char* name, const QVariant& val);

    /*! @brief Returns value of given option
     * Option is set if returned value is not null.
     * If there is no option for @a name in given property and parent property is present (see parent()),
     * parent property is checked. If the parent property offers the option, the value
     * is returned. If it is not present there, @a defaultValue value is returned.
     * Looking at parent property is available since 3.1.
     * @note The lookup is performed recursively, first in parent, then grand parent, etc.
     * @see setOption
     */
    QVariant option(const char* name, const QVariant& defaultValue = QVariant()) const;

    /*! @brief Returns @c true if at least one option is specified for this property
     * If there are no options defined @c true can be still returned if parent property
     * is present and it has at least one option specified.
     * Looking at parent property is available since 3.1.
     * @note The lookup is performed recursively, first in parent, then grand parent, etc.
     */
    bool hasOptions() const;

    /*! Equivalent to setValue(const QVariant &) */
    KProperty& operator= (const QVariant& val);

    /*! Assigns a deep copy of all attributes of \a property to this property. */
    KProperty& operator= (const KProperty &property);

    /**
     * @return @c true if the property is equal to @a prop; otherwise returns @c false.
     * Two properties are equal if they have the same name and type.
     * @note All null properties are equal
     * @todo Compare properties deeper?
     */
    bool operator==(const KProperty &prop) const;

    /**
     * @return @c true if the property is different from @a prop; otherwise returns @c false.
     * Two properties are different if they have different names or types.
     * @since 3.1
     */
    bool operator!=(const KProperty &prop) const;

#if 0
    /*! \return a key used for sorting.
     Usually its set by KPropertySet::addProperty() and KProperty::addChild() to a unique value,
     so that this property can be sorted in a property editor in original order.
     \see EditorItem::compare() */
    int sortingKey() const;
#endif

private:
    //! Added only to help porting old code. Use public setValue() methods.
    void setValue(const QVariant &value, bool a1, bool a2 = true);

    class Private;
    Private * const d;

    friend class KPropertySet;
    friend class KPropertySetPrivate;
    friend class KPropertySetBuffer;
    friend KPROPERTYCORE_EXPORT QDebug operator<<(QDebug dbg, const KProperty &p);
};

//! qDebug() stream operator. Writes property @a p to the debug output in a nicely formatted way.
KPROPERTYCORE_EXPORT QDebug operator<<(QDebug dbg, const KProperty &p);

Q_DECLARE_OPERATORS_FOR_FLAGS(KProperty::ValueOptions)

#endif