diff --git a/src/KProperty.h b/src/KProperty.h index 43a6b09..23e0241 100644 --- a/src/KProperty.h +++ b/src/KProperty.h @@ -1,472 +1,474 @@ /* This file is part of the KDE project Copyright (C) 2004 Cedric Pasteur Copyright (C) 2004 Alexander Dymo Copyright (C) 2004-2016 Jarosław Staniek 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 #include #include #include #include "kpropertycore_export.h" /*! \brief Namespace for a set of classes implementing generic properties framework. Main classes of this framework are: - KProperty, representing a single property with its own type and value - KPropertySet, a set of properties - KPropertyEditorView, a widget for displaying and editing properties provided by a KPropertySet object. Every property has its own row displayed within the editor view. The editor view enables editing of property values. The KProperty framework also supports adding composed and property types and custom property editor types. Take a look at the example application, available in the examples/ directory. @author Cedric Pasteur @author Alexander Dymo @author Jarosław Staniek */ class KComposedPropertyInterface; class KPropertySet; /*! Data container for properties of list type. */ class KPROPERTYCORE_EXPORT KPropertyListData { public: /*! Data container for list-value property. We will be able to choose an item from this list. */ KPropertyListData(const QStringList& keys_, const QStringList& names_); KPropertyListData(const QList keys_, const QStringList& names_); KPropertyListData(); ~KPropertyListData(); void setKeysAsStringList(const QStringList& list); QStringList keysAsStringList() const; /*! The string list containing all possible keys for this property or NULL if this is not a property of type 'list'. The values in this list are ordered, so the first key element is associated with first element from the 'names' list, and so on. */ QList keys; // QStringList keys; //! @todo what about using QValueList here too? /*! The list of translated names that will be visible on the screen. First value is referenced by first key, and so on. */ QStringList names; //unused for now /*! True (the default), if the list has fixed number of possible //unused for now items (keys). If this is false, user can add or enter own values. */ //unused for now bool fixed; }; /*! \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 custome 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 valueFromList property matching keys with names: QStringList keys, names; keys << "one" << "two" << "three"; // possible values of the property // Names (possibly translated) shown in the editor instead of the keys names << tr("One") << tr("Two") << tr("Three"); property = new KProperty(name, keys, names, "two", caption); // Creating a valueFromList property matching QVariant keys with names: QValueList variantKeys; variantKeys << 1 << 2 << 3; KPropertyListData *listData = new KPropertyListData(variantKeys, names); 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. \author Cedric Pasteur \author Alexander Dymo \author Jarosław Staniek */ 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 /*** 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. Null properties have empty names. */ bool isNull() const; //! \return true if this property value is changed. bool isModified() const; //! Clears "modified" flag, so isModified() will return false. 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); /*! \return 1 if the property should be synced automatically in the property editor as soon as editor contents change (e.g. when the user types text). If autoSync() == 0, property value will be updated when the user presses Enter or when another editor gets the focus. Property follows property editor's global rule if autoSync() !=0 and !=1 (the default). */ int autoSync() const; /*! If \a sync is 1, the property will be synced automatically in the property editor as soon as editor's contents change (e.g. when the user types text). If \a sync is 0, property value will be updated when the user presses Enter or when another editor gets the focus. Property follows property editor's global rule if sync !=0 and !=1 (the default). */ void setAutoSync(int sync); /*! Sets value \a val for option \a name. Options are used to override default settings of individual properties. This is most visible in property editor widget. Currently supported options are:
  • min: integer value describing minimum value for properties of integer and double types. The default is 0.
  • minValueText: user-visible translated string to be displayed in editor for integer type when minimum is set for the property. @see QAbstractSpinBox::specialValueText
  • max: integer describing minimum value for properties of integer type. Default is 0xffff.
  • -
  • precision: integer value describing the number of decimals after the decimal point - for double type.
  • -
  • step: integer describing the size of the step that is taken when the user hits - the up or down button of editor for double type.
  • +
  • precision: integer value >= 0 describing the number of decimals after the decimal + point for double type. Default value is 2. + @see QDoubleSpinBox::decimals
  • +
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • extraValueAllowed: boolean value, if @c true the user is able to manually add extra values to a combobox.
  • fileMode: string value that describes what objects may select in the file dialog of the url editor:
    • "dirsOnly": only support and display directories; @see QFileDialog::ShowDirsOnly QFileDialog::Directory
    • "existingFile": only allow to select one existing file; @see QFileDialog::ExistingFile
    • Any other value: any file is supported, whether it exists or not @see QFileDialog::AnyFile
  • confirmOverwrites: boolean value, if @c true, user will be asked for confirmation of file overwriting in the url editor. @c false by default. @note The line edit does not validate the content.
*/ void setOption(const char* name, const QVariant& val); /*! \return a value for option \a name or @a defaultValue value if there is no such option set. @see setOption */ QVariant option(const char* name, const QVariant& defaultValue = QVariant()) const; /*! \return true if at least one option is defined for this property. */ 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); /*! Compares two properties.*/ 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 protected: /*! Adds \a prop as a child of this property. The children will be owned by this property. */ void addChild(KProperty *prop); /*! Adds \a set to this property. */ void addSet(KPropertySet *set); #if 0 /*! Sets a key used for sorting. */ void setSortingKey(int key); #endif /*! \return a list of related properties for this property. */ const QList* related() const; /*! Adds related property for this property. */ void addRelatedProperty(KProperty *property); /*! This method emits the \a KPropertySet::propertyChanged() signal. KProperty::setValue() calls this method if the value has been changed. */ void emitPropertyChanged(); /*! Outputs debug string for this property to the standard debug output. */ void debug() const; /*! Used by debug operator <<. */ QMap options() const; //! @internal class Private; friend class Private; Private * const d; friend class KPropertySet; friend class KPropertyBuffer; friend class KComposedPropertyInterface; 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); #endif