annotate base/PropertyContainer.h @ 1158:d9c766274c8b

Merge
author Chris Cannam
date Sat, 30 Jan 2016 12:08:50 +0000
parents 57857a57a03a
children a54016762f77
rev   line source
Chris@49 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@52 4 Sonic Visualiser
Chris@52 5 An audio file viewer and annotation editor.
Chris@52 6 Centre for Digital Music, Queen Mary, University of London.
Chris@202 7 This file copyright 2006 Chris Cannam and QMUL.
Chris@0 8
Chris@52 9 This program is free software; you can redistribute it and/or
Chris@52 10 modify it under the terms of the GNU General Public License as
Chris@52 11 published by the Free Software Foundation; either version 2 of the
Chris@52 12 License, or (at your option) any later version. See the file
Chris@52 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@0 16 #ifndef _PROPERTY_CONTAINER_H_
Chris@0 17 #define _PROPERTY_CONTAINER_H_
Chris@0 18
Chris@46 19 #include "Command.h"
Chris@46 20
Chris@0 21 #include <QString>
Chris@0 22 #include <QObject>
Chris@0 23 #include <vector>
Chris@0 24
Chris@28 25 class PlayParameters;
Chris@190 26 class RangeMapper;
Chris@0 27
Chris@29 28 class PropertyContainer : public QObject
Chris@0 29 {
Chris@29 30 Q_OBJECT
Chris@29 31
Chris@0 32 public:
Chris@27 33 virtual ~PropertyContainer() { }
Chris@27 34
Chris@0 35 typedef QString PropertyName;
Chris@0 36 typedef std::vector<PropertyName> PropertyList;
Chris@0 37
Chris@0 38 enum PropertyType {
Chris@0 39 ToggleProperty, // on or off
Chris@0 40 RangeProperty, // range of integers
Chris@0 41 ValueProperty, // range of integers given string labels
Chris@277 42 ColourProperty, // colours, get/set as ColourDatabase indices
Chris@116 43 UnitsProperty, // unit from UnitDatabase, get/set unit id
Chris@0 44 InvalidProperty, // property not found!
Chris@0 45 };
Chris@0 46
Chris@0 47 /**
Chris@0 48 * Get a list of the names of all the supported properties on this
Chris@94 49 * container. These should be fixed (i.e. not internationalized).
Chris@0 50 */
Chris@0 51 virtual PropertyList getProperties() const;
Chris@0 52
Chris@0 53 /**
Chris@94 54 * Return the human-readable (and i18n'ised) name of a property.
Chris@94 55 */
Chris@94 56 virtual QString getPropertyLabel(const PropertyName &) const = 0;
Chris@94 57
Chris@94 58 /**
Chris@0 59 * Return the type of the given property, or InvalidProperty if
Chris@0 60 * the property is not supported on this container.
Chris@0 61 */
Chris@0 62 virtual PropertyType getPropertyType(const PropertyName &) const;
Chris@0 63
Chris@0 64 /**
Chris@340 65 * Return an icon for the property, if any.
Chris@340 66 */
Chris@340 67 virtual QString getPropertyIconName(const PropertyName &) const;
Chris@340 68
Chris@340 69 /**
Chris@0 70 * If this property has something in common with other properties
Chris@0 71 * on this container, return a name that can be used to group them
Chris@0 72 * (in order to save screen space, for example). e.g. "Window
Chris@0 73 * Type" and "Window Size" might both have a group name of "Window".
Chris@0 74 * If this property is not groupable, return the empty string.
Chris@0 75 */
Chris@0 76 virtual QString getPropertyGroupName(const PropertyName &) const;
Chris@0 77
Chris@0 78 /**
Chris@0 79 * Return the minimum and maximum values for the given property
Chris@0 80 * and its current value in this container. Min and/or max may be
Chris@0 81 * passed as NULL if their values are not required.
Chris@0 82 */
Chris@0 83 virtual int getPropertyRangeAndValue(const PropertyName &,
Chris@245 84 int *min, int *max, int *deflt) const;
Chris@0 85
Chris@0 86 /**
Chris@0 87 * If the given property is a ValueProperty, return the display
Chris@0 88 * label to be used for the given value for that property.
Chris@0 89 */
Chris@0 90 virtual QString getPropertyValueLabel(const PropertyName &,
Chris@0 91 int value) const;
Chris@0 92
Chris@190 93 /**
Chris@190 94 * If the given property is a RangeProperty, return a new
Chris@190 95 * RangeMapper object mapping its integer range onto an underlying
Chris@190 96 * floating point value range for human-intelligible display, if
Chris@190 97 * appropriate. The RangeMapper should be allocated with new, and
Chris@190 98 * the caller takes responsibility for deleting it. Return NULL
Chris@190 99 * (as in the default implementation) if there is no such mapping.
Chris@190 100 */
Chris@190 101 virtual RangeMapper *getNewPropertyRangeMapper(const PropertyName &) const;
Chris@190 102
Chris@29 103 virtual QString getPropertyContainerName() const = 0;
Chris@29 104 virtual QString getPropertyContainerIconName() const = 0;
Chris@29 105
Chris@29 106 virtual PlayParameters *getPlayParameters() { return 0; }
Chris@29 107
Chris@29 108 signals:
Chris@141 109 void propertyChanged(PropertyContainer::PropertyName);
Chris@224 110
Chris@29 111 public slots:
Chris@0 112 /**
Chris@0 113 * Set a property. This is used for all property types. For
Chris@0 114 * boolean properties, zero is false and non-zero true; for
Chris@277 115 * colours, the integer value is an index into the colours in the
Chris@277 116 * global ColourDatabase.
Chris@0 117 */
Chris@0 118 virtual void setProperty(const PropertyName &, int value);
Chris@46 119
Chris@46 120 /**
Chris@387 121 * Obtain a command that sets the given property, which can be
Chris@387 122 * added to the command history for undo/redo. Returns NULL
Chris@387 123 * if the property is already set to the given value.
Chris@46 124 */
Chris@387 125 virtual Command *getSetPropertyCommand(const PropertyName &, int value);
Chris@46 126
Chris@199 127 /**
Chris@199 128 * Set a property using a fuzzy match. Compare nameString with
Chris@199 129 * the property labels and underlying names, and if it matches one
Chris@199 130 * (with preference given to labels), try to convert valueString
Chris@199 131 * appropriately and set it. The valueString should contain a
Chris@199 132 * value label for value properties, a mapped value for range
Chris@199 133 * properties, "on" or "off" for toggle properties, a colour or
Chris@199 134 * unit name, or the underlying integer value for the property.
Chris@199 135 *
Chris@199 136 * Note that as property and value labels may be translatable, the
Chris@199 137 * results of this function may vary by locale. It is intended
Chris@199 138 * for handling user-originated strings, _not_ persistent storage.
Chris@199 139 *
Chris@199 140 * The default implementation should work for most subclasses.
Chris@199 141 */
Chris@528 142 virtual void setPropertyFuzzy(QString nameString, QString valueString);
Chris@199 143
Chris@199 144 /**
Chris@387 145 * As above, but returning a command.
Chris@199 146 */
Chris@387 147 virtual Command *getSetPropertyCommand(QString nameString, QString valueString);
Chris@199 148
Chris@46 149 protected:
Chris@46 150
Chris@46 151 class SetPropertyCommand : public Command
Chris@46 152 {
Chris@46 153 public:
Chris@46 154 SetPropertyCommand(PropertyContainer *pc, const PropertyName &pn, int);
Chris@46 155 virtual ~SetPropertyCommand() { }
Chris@46 156
Chris@46 157 virtual void execute();
Chris@46 158 virtual void unexecute();
Chris@46 159 virtual QString getName() const;
Chris@46 160
Chris@46 161 protected:
Chris@46 162 PropertyContainer *m_pc;
Chris@46 163 PropertyName m_pn;
Chris@46 164 int m_value;
Chris@46 165 int m_oldValue;
Chris@46 166 };
Chris@199 167
Chris@199 168 virtual bool convertPropertyStrings(QString nameString, QString valueString,
Chris@199 169 PropertyName &name, int &value);
Chris@0 170 };
Chris@0 171
Chris@0 172 #endif