Preferences Class Reference

If this property has something in common with other properties on this container, return a name that can be used to group them (in order to save screen space, for example).

e.g. "Window Type" and "Window Size" might both have a group name of "Window". If this property is not groupable, return the empty string.

Definition at line 45 of file PropertyContainer.cpp.

Referenced by PropertyBox::updatePropertyEditor().

int PropertyContainer::getPropertyRangeAndValue	(	const PropertyName &	,
		int *	min,
		int *	max,
		int *	deflt
	)			const `[virtual, inherited]`

Return the minimum and maximum values for the given property and its current value in this container.

Min and/or max may be passed as NULL if their values are not required.

Definition at line 51 of file PropertyContainer.cpp.

Referenced by PropertyContainer::convertPropertyStrings(), PropertyContainer::SetPropertyCommand::execute(), SpectrogramLayer::getPropertyRangeAndValue(), SingleColourLayer::getPropertyRangeAndValue(), ImageLayer::getPropertyRangeAndValue(), Colour3DPlotLayer::getPropertyRangeAndValue(), PropertyContainer::setPropertyWithCommand(), and PropertyBox::updatePropertyEditor().

QString PropertyContainer::getPropertyValueLabel	(	const PropertyName &	,
		int	value
	)			const `[virtual, inherited]`

If the given property is a ValueProperty, return the display label to be used for the given value for that property.

Definition at line 61 of file PropertyContainer.cpp.

References PropertyContainer::ColourProperty, ColourDatabase::getColourCount(), ColourDatabase::getColourName(), ColourDatabase::getInstance(), and PropertyContainer::getPropertyType().

Referenced by PropertyContainer::convertPropertyStrings(), SingleColourLayer::getPropertyValueLabel(), ImageLayer::getPropertyValueLabel(), and PropertyBox::updatePropertyEditor().

RangeMapper * PropertyContainer::getNewPropertyRangeMapper ( const PropertyName & ) const [virtual, inherited]

If the given property is a RangeProperty, return a new RangeMapper object mapping its integer range onto an underlying floating point value range for human-intelligible display, if appropriate.

The RangeMapper should be allocated with new, and the caller takes responsibility for deleting it. Return NULL (as in the default implementation) if there is no such mapping.

Definition at line 74 of file PropertyContainer.cpp.

Referenced by PropertyContainer::convertPropertyStrings(), and PropertyBox::updatePropertyEditor().

virtual PlayParameters* PropertyContainer::getPlayParameters ( ) [inline, virtual, inherited]

Reimplemented in Layer.

Definition at line 106 of file PropertyContainer.h.

Referenced by PropertyBox::editPlugin(), PropertyBox::pluginConfigurationChanged(), and PropertyBox::populateViewPlayFrame().

void PropertyContainer::propertyChanged ( PropertyContainer::PropertyName ) [signal, inherited]

Referenced by setBackgroundMode(), setOmitTempsFromRecentFiles(), setPropertyBoxLayout(), setResampleOnLoad(), setResampleQuality(), setShowSplash(), setSpectrogramSmoothing(), setTemporaryDirectoryRoot(), setTuningFrequency(), setViewFontSize(), setWindowType(), SpectrogramLayer::SpectrogramLayer(), SpectrumLayer::SpectrumLayer(), and ViewPropertyContainer::ViewPropertyContainer().

void PropertyContainer::setProperty	(	const PropertyName &	,
		int	value
	)			`[virtual, slot, inherited]`

Set a property.

This is used for all property types. For boolean properties, zero is false and non-zero true; for colours, the integer value is an index into the colours in the global ColourDatabase.

Definition at line 80 of file PropertyContainer.cpp.

References PropertyContainer::getPropertyContainerName().

Referenced by PropertyContainer::SetPropertyCommand::execute(), PropertyContainer::setProperty(), ImageLayer::setProperty(), and PropertyContainer::SetPropertyCommand::unexecute().

void PropertyContainer::setProperty	(	QString	nameString,
		QString	valueString
	)			`[virtual, slot, inherited]`

Set a property using a fuzzy match.

Compare nameString with the property labels and underlying names, and if it matches one (with preference given to labels), try to convert valueString appropriately and set it. The valueString should contain a value label for value properties, a mapped value for range properties, "on" or "off" for toggle properties, a colour or unit name, or the underlying integer value for the property.

Note that as property and value labels may be translatable, the results of this function may vary by locale. It is intended for handling user-originated strings, _not_ persistent storage.

The default implementation should work for most subclasses.

Definition at line 96 of file PropertyContainer.cpp.

References PropertyContainer::convertPropertyStrings(), and PropertyContainer::setProperty().

void PropertyContainer::setPropertyWithCommand	(	const PropertyName &	,
		int	value
	)			`[virtual, slot, inherited]`

Set a property using a command, supporting undo and redo.

The default implementation should work for most subclasses.

Definition at line 86 of file PropertyContainer.cpp.

References CommandHistory::addCommand(), CommandHistory::getInstance(), and PropertyContainer::getPropertyRangeAndValue().

Referenced by MainWindow::handleOSCMessage(), PropertyBox::propertyControllerChanged(), and PropertyContainer::setPropertyWithCommand().

void PropertyContainer::setPropertyWithCommand	(	QString	nameString,
		QString	valueString
	)			`[virtual, slot, inherited]`

As above, but using a command.

Definition at line 111 of file PropertyContainer.cpp.

References PropertyContainer::convertPropertyStrings(), and PropertyContainer::setPropertyWithCommand().

bool PropertyContainer::convertPropertyStrings	(	QString	nameString,
		QString	valueString,
		PropertyName &	name,
		int &	value
	)			`[protected, virtual, inherited]`

Member Data Documentation

Preferences * Preferences::m_instance [static, private]

Definition at line 93 of file Preferences.h.

Referenced by getInstance().

SpectrogramSmoothing Preferences::m_spectrogramSmoothing [private]

Definition at line 95 of file Preferences.h.

Referenced by getPropertyRangeAndValue(), getSpectrogramSmoothing(), Preferences(), and setSpectrogramSmoothing().

float Preferences::m_tuningFrequency [private]

Definition at line 96 of file Preferences.h.

Referenced by getTuningFrequency(), Preferences(), and setTuningFrequency().

PropertyBoxLayout Preferences::m_propertyBoxLayout [private]

Definition at line 97 of file Preferences.h.

Referenced by getPropertyBoxLayout(), getPropertyRangeAndValue(), Preferences(), and setPropertyBoxLayout().

WindowType Preferences::m_windowType [private]

Definition at line 98 of file Preferences.h.

Referenced by getPropertyRangeAndValue(), getWindowType(), Preferences(), and setWindowType().

int Preferences::m_resampleQuality [private]

Definition at line 99 of file Preferences.h.

Referenced by getPropertyRangeAndValue(), getResampleQuality(), Preferences(), and setResampleQuality().

bool Preferences::m_omitRecentTemps [private]

Definition at line 100 of file Preferences.h.

Referenced by getOmitTempsFromRecentFiles(), and setOmitTempsFromRecentFiles().

QString Preferences::m_tempDirRoot [private]

Definition at line 101 of file Preferences.h.

Referenced by getTemporaryDirectoryRoot(), Preferences(), and setTemporaryDirectoryRoot().

bool Preferences::m_resampleOnLoad [private]

Definition at line 102 of file Preferences.h.

Referenced by getResampleOnLoad(), Preferences(), and setResampleOnLoad().

int Preferences::m_viewFontSize [private]

Definition at line 103 of file Preferences.h.

Referenced by getPropertyRangeAndValue(), getViewFontSize(), Preferences(), and setViewFontSize().

BackgroundMode Preferences::m_backgroundMode [private]

Definition at line 104 of file Preferences.h.

Referenced by getBackgroundMode(), getPropertyRangeAndValue(), Preferences(), and setBackgroundMode().

bool Preferences::m_showSplash [private]

Definition at line 105 of file Preferences.h.

Referenced by getShowSplash(), Preferences(), and setShowSplash().

The documentation for this class was generated from the following files:

Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by

1.5.1


Public Types
enum	SpectrogramSmoothing { NoSpectrogramSmoothing, SpectrogramInterpolated, SpectrogramZeroPadded, SpectrogramZeroPaddedAndInterpolated }
enum	PropertyBoxLayout { VerticallyStacked, Layered }
	!! harmonise with PaneStack More...
enum	BackgroundMode { BackgroundFromTheme, DarkBackground, LightBackground }
enum	PropertyType { ToggleProperty, RangeProperty, ValueProperty, ColourProperty, UnitsProperty, InvalidProperty }
typedef QString	PropertyName
typedef std::vector< PropertyName >	PropertyList
Public Slots
virtual void	setProperty (const PropertyName &, int)
void	setSpectrogramSmoothing (SpectrogramSmoothing smoothing)
void	setTuningFrequency (float freq)
void	setPropertyBoxLayout (PropertyBoxLayout layout)
void	setWindowType (WindowType type)
void	setResampleQuality (int quality)
void	setOmitTempsFromRecentFiles (bool omit)
void	setTemporaryDirectoryRoot (QString tempDirRoot)
void	setResampleOnLoad (bool)
void	setBackgroundMode (BackgroundMode mode)
void	setViewFontSize (int size)
void	setShowSplash (bool)
virtual void	setProperty (const PropertyName &, int value)
	Set a property.
virtual void	setProperty (QString nameString, QString valueString)
	Set a property using a fuzzy match.
virtual void	setPropertyWithCommand (const PropertyName &, int value)
	Set a property using a command, supporting undo and redo.
virtual void	setPropertyWithCommand (QString nameString, QString valueString)
	As above, but using a command.
Signals
void	propertyChanged (PropertyContainer::PropertyName)
Public Member Functions
virtual PropertyList	getProperties () const
	Get a list of the names of all the supported properties on this container.
virtual QString	getPropertyLabel (const PropertyName &) const
virtual PropertyType	getPropertyType (const PropertyName &) const
virtual int	getPropertyRangeAndValue (const PropertyName &, int , int , int *) const
virtual QString	getPropertyValueLabel (const PropertyName &, int value) const
virtual QString	getPropertyContainerName () const
virtual QString	getPropertyContainerIconName () const
SpectrogramSmoothing	getSpectrogramSmoothing () const
float	getTuningFrequency () const
WindowType	getWindowType () const
int	getResampleQuality () const
PropertyBoxLayout	getPropertyBoxLayout () const
int	getViewFontSize () const
bool	getOmitTempsFromRecentFiles () const
QString	getTemporaryDirectoryRoot () const
bool	getResampleOnLoad () const
BackgroundMode	getBackgroundMode () const
bool	getShowSplash () const
virtual QString	getPropertyLabel (const PropertyName &) const =0
	Return the human-readable (and i18n'ised) name of a property.
virtual PropertyType	getPropertyType (const PropertyName &) const
	Return the type of the given property, or InvalidProperty if the property is not supported on this container.
virtual QString	getPropertyIconName (const PropertyName &) const
	Return an icon for the property, if any.
virtual QString	getPropertyGroupName (const PropertyName &) const
	If this property has something in common with other properties on this container, return a name that can be used to group them (in order to save screen space, for example).
virtual int	getPropertyRangeAndValue (const PropertyName &, int min, int max, int *deflt) const
	Return the minimum and maximum values for the given property and its current value in this container.
virtual QString	getPropertyValueLabel (const PropertyName &, int value) const
	If the given property is a ValueProperty, return the display label to be used for the given value for that property.
virtual RangeMapper *	getNewPropertyRangeMapper (const PropertyName &) const
	If the given property is a RangeProperty, return a new RangeMapper object mapping its integer range onto an underlying floating point value range for human-intelligible display, if appropriate.
virtual PlayParameters *	getPlayParameters ()
Static Public Member Functions
static Preferences *	getInstance ()
Protected Member Functions
virtual bool	convertPropertyStrings (QString nameString, QString valueString, PropertyName &name, int &value)
Private Member Functions
	Preferences ()
virtual	~Preferences ()
Private Attributes
SpectrogramSmoothing	m_spectrogramSmoothing
float	m_tuningFrequency
PropertyBoxLayout	m_propertyBoxLayout
WindowType	m_windowType
int	m_resampleQuality
bool	m_omitRecentTemps
QString	m_tempDirRoot
bool	m_resampleOnLoad
int	m_viewFontSize
BackgroundMode	m_backgroundMode
bool	m_showSplash
Static Private Attributes
static Preferences *	m_instance