#include <TimeRulerLayer.h>
Inherits SingleColourLayer.
Inheritance diagram for TimeRulerLayer:
Definition at line 28 of file TimeRulerLayer.h.
Public Types | |
| enum | LabelHeight { LabelTop, LabelMiddle, LabelBottom } |
| enum | VerticalPosition { PositionTop, PositionMiddle, PositionBottom } |
| enum | SnapType { SnapLeft, SnapRight, SnapNearest, SnapNeighbouring } |
| enum | ColourSignificance { ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant, ColourHasMeaningfulValue } |
| enum | PropertyType { ToggleProperty, RangeProperty, ValueProperty, ColourProperty, UnitsProperty, InvalidProperty } |
| typedef QString | PropertyName |
| typedef std::vector< PropertyName > | PropertyList |
Public Slots | |
| virtual void | setProperty (const PropertyName &, int value) |
| Set a property. | |
| virtual void | setProperty (QString nameString, QString valueString) |
| Set a property using a fuzzy match. | |
| void | showLayer (View *, bool show) |
| 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 | modelChanged () |
| void | modelChanged (size_t startFrame, size_t endFrame) |
| void | modelCompletionChanged () |
| void | modelAlignmentCompletionChanged () |
| void | modelReplaced () |
| void | layerParametersChanged () |
| void | layerParameterRangesChanged () |
| void | layerMeasurementRectsChanged () |
| void | layerNameChanged () |
| void | verticalZoomChanged () |
| void | propertyChanged (PropertyContainer::PropertyName) |
Public Member Functions | |
| TimeRulerLayer () | |
| virtual void | paint (View *v, QPainter &paint, QRect rect) const |
| void | setModel (Model *) |
| virtual const Model * | getModel () const |
| void | setLabelHeight (LabelHeight h) |
| LabelHeight | getLabelHeight () const |
| virtual bool | snapToFeatureFrame (View *, int &, size_t &, SnapType) const |
| Adjust the given frame to snap to the nearest feature, if possible. | |
| virtual ColourSignificance | getLayerColourSignificance () const |
| This should return the degree of meaning associated with colour in this layer. | |
| virtual bool | getValueExtents (float &, float &, bool &, QString &) const |
| Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display. | |
| virtual QString | getLayerPresentationName () const |
| virtual void | toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const |
| Convert the layer's data (though not those of the model it refers to) into XML for file output. | |
| void | setProperties (const QXmlAttributes &attributes) |
| Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes. | |
| virtual void | setBaseColour (int) |
| virtual int | getBaseColour () const |
| virtual bool | hasLightBackground () const |
| virtual QPixmap | getLayerPresentationPixmap (QSize size) const |
| 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 QString | getPropertyLabel (const PropertyName &) const =0 |
| Return the human-readable (and i18n'ised) name of a property. | |
| virtual PropertyType | getPropertyType (const PropertyName &) const |
| 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 | getPropertyGroupName (const PropertyName &) const |
| 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 |
| 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 |
| 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 |
| 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 void | setProperty (const PropertyName &, int value) |
| virtual void | setDefaultColourFor (View *v) |
| virtual Model * | getModel () |
| virtual const ZoomConstraint * | getZoomConstraint () const |
| Return a zoom constraint object defining the supported zoom levels for this layer. | |
| virtual bool | supportsOtherZoomLevels () const |
| Return true if this layer can handle zoom levels other than those supported by its zoom constraint (presumably less efficiently or accurately than the officially supported zoom levels). | |
| virtual VerticalPosition | getPreferredTimeRulerPosition () const |
| virtual VerticalPosition | getPreferredFrameCountPosition () const |
| virtual QString | getPropertyContainerIconName () const |
| virtual QString | getPropertyContainerName () const |
| virtual void | setPresentationName (QString name) |
| virtual int | getVerticalScaleWidth (View *, QPainter &) const |
| virtual void | paintVerticalScale (View *, QPainter &, QRect) const |
| virtual bool | getCrosshairExtents (View *, QPainter &, QPoint, std::vector< QRect > &) const |
| virtual void | paintCrosshairs (View *, QPainter &, QPoint) const |
| virtual void | paintMeasurementRects (View *, QPainter &, bool showFocus, QPoint focusPoint) const |
| virtual bool | nearestMeasurementRectChanged (View *, QPoint prev, QPoint now) const |
| virtual QString | getFeatureDescription (View *, QPoint &) const |
| virtual void | drawStart (View *, QMouseEvent *) |
| virtual void | drawDrag (View *, QMouseEvent *) |
| virtual void | drawEnd (View *, QMouseEvent *) |
| virtual void | eraseStart (View *, QMouseEvent *) |
| virtual void | eraseDrag (View *, QMouseEvent *) |
| virtual void | eraseEnd (View *, QMouseEvent *) |
| virtual void | editStart (View *, QMouseEvent *) |
| virtual void | editDrag (View *, QMouseEvent *) |
| virtual void | editEnd (View *, QMouseEvent *) |
| virtual void | measureStart (View *, QMouseEvent *) |
| virtual void | measureDrag (View *, QMouseEvent *) |
| virtual void | measureEnd (View *, QMouseEvent *) |
| virtual void | measureDoubleClick (View *, QMouseEvent *) |
| virtual bool | haveCurrentMeasureRect () const |
| virtual void | deleteCurrentMeasureRect () |
| virtual bool | editOpen (View *, QMouseEvent *) |
| Open an editor on the item under the mouse (e.g. | |
| virtual void | moveSelection (Selection, size_t) |
| virtual void | resizeSelection (Selection, Selection) |
| virtual void | deleteSelection (Selection) |
| virtual void | copy (View *, Selection, Clipboard &) |
| virtual bool | paste (View *, const Clipboard &, int, bool) |
| Paste from the given clipboard onto the layer at the given frame offset. | |
| virtual bool | isLayerScrollable (const View *) const |
| This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning. | |
| virtual bool | isLayerOpaque () const |
| This should return true if the layer completely obscures any underlying layers. | |
| virtual bool | isLayerEditable () const |
| This should return true if the layer can be edited by the user. | |
| virtual int | getCompletion (View *) const |
| Return the proportion of background work complete in drawing this view, as a percentage -- in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call. | |
| virtual void | setObjectName (const QString &name) |
| virtual void | toBriefXml (QTextStream &stream, QString indent="", QString extraAttributes="") const |
| Produce XML containing the layer's ID and type. | |
| virtual void | addMeasurementRect (const QXmlAttributes &) |
| Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element). | |
| virtual void | setLayerDormant (const View *v, bool dormant) |
| Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it). | |
| virtual bool | isLayerDormant (const View *v) const |
| Return whether the layer is dormant (i.e. | |
| virtual PlayParameters * | getPlayParameters () |
| virtual bool | needsTextLabelHeight () const |
| virtual bool | hasTimeXAxis () const |
| virtual bool | getDisplayExtents (float &, float &) const |
| Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed. | |
| virtual bool | setDisplayExtents (float, float) |
| Set the displayed minimum and maximum values for the y axis to the given range, if supported. | |
| virtual bool | getXScaleValue (const View *v, int x, float &value, QString &unit) const |
| Return the value and unit at the given x coordinate in the given view. | |
| virtual bool | getYScaleValue (const View *, int, float &, QString &) const |
| Return the value and unit at the given y coordinate in the given view. | |
| virtual bool | getYScaleDifference (const View *v, int y0, int y1, float &diff, QString &unit) const |
| Return the difference between the values at the given y coordinates in the given view, and the unit of the difference. | |
| virtual int | getVerticalZoomSteps (int &) const |
| Get the number of vertical zoom steps available for this layer. | |
| virtual int | getCurrentVerticalZoomStep () const |
| Get the current vertical zoom step. | |
| virtual void | setVerticalZoomStep (int) |
| Set the vertical zoom step. | |
| virtual RangeMapper * | getNewVerticalZoomRangeMapper () const |
| Create and return a range mapper for vertical zoom step values. | |
| virtual QString | getPropertyIconName (const PropertyName &) const |
| Return an icon for the property, if any. | |
| virtual QString | toXmlString (QString indent="", QString extraAttributes="") const |
| Convert this exportable object to XML in a string. | |
Static Public Member Functions | |
| static QString | encodeEntities (QString) |
| static QString | encodeColour (QColor) |
| static int | getObjectExportId (const void *) |
Protected Types | |
| typedef std::map< int, int > | ColourRefCount |
| typedef std::set< MeasureRect > | MeasureRectSet |
Protected Member Functions | |
| virtual int | getDefaultColourHint (bool dark, bool &impose) |
| int | getMajorTickSpacing (View *, bool &quarterTicks) const |
| virtual QColor | getBaseQColor () const |
| virtual QColor | getBackgroundQColor (View *v) const |
| virtual QColor | getForegroundQColor (View *v) const |
| std::vector< QColor > | getPartialShades (View *v) const |
| virtual void | flagBaseColourChanged () |
| void | connectSignals (const Model *) |
| virtual size_t | alignToReference (View *v, size_t frame) const |
| virtual size_t | alignFromReference (View *v, size_t frame) const |
| bool | clipboardHasDifferentAlignment (View *v, const Clipboard &clip) const |
| void | addMeasureRectToSet (const MeasureRect &r) |
| void | deleteMeasureRectFromSet (const MeasureRect &r) |
| void | updateMeasurePixrects (View *v) const |
| virtual void | updateMeasureRectYCoords (View *v, const MeasureRect &r) const |
| virtual void | setMeasureRectYCoord (View *v, MeasureRect &r, bool start, int y) const |
| virtual void | setMeasureRectFromPixrect (View *v, MeasureRect &r, QRect pixrect) const |
| MeasureRectSet::const_iterator | findFocusedMeasureRect (QPoint) const |
| void | paintMeasurementRect (View *v, QPainter &paint, const MeasureRect &r, bool focus) const |
| virtual bool | convertPropertyStrings (QString nameString, QString valueString, PropertyName &name, int &value) |
Protected Attributes | |
| Model * | m_model |
| LabelHeight | m_labelHeight |
| int | m_colour |
| bool | m_colourExplicitlySet |
| bool | m_defaultColourSet |
| MeasureRectSet | m_measureRects |
| MeasureRect | m_draggingRect |
| bool | m_haveDraggingRect |
| bool | m_haveCurrentMeasureRect |
| QPoint | m_currentMeasureRectPoint |
| QString | m_presentationName |
Static Protected Attributes | |
| static ColourRefCount | m_colourRefCount |
typedef std::map<int, int> SingleColourLayer::ColourRefCount [protected, inherited] |
Definition at line 68 of file SingleColourLayer.h.
typedef std::set<MeasureRect> Layer::MeasureRectSet [protected, inherited] |
typedef QString PropertyContainer::PropertyName [inherited] |
Definition at line 35 of file PropertyContainer.h.
typedef std::vector<PropertyName> PropertyContainer::PropertyList [inherited] |
Definition at line 36 of file PropertyContainer.h.
enum Layer::VerticalPosition [inherited] |
enum Layer::SnapType [inherited] |
enum Layer::ColourSignificance [inherited] |
enum PropertyContainer::PropertyType [inherited] |
Definition at line 38 of file PropertyContainer.h.
| TimeRulerLayer::TimeRulerLayer | ( | ) |
Definition at line 35 of file TimeRulerLayer.cpp.
| void TimeRulerLayer::paint | ( | View * | v, | |
| QPainter & | paint, | |||
| QRect | rect | |||
| ) | const [virtual] |
Implements Layer.
Definition at line 195 of file TimeRulerLayer.cpp.
References View::drawVisibleText(), RealTime::fromMilliseconds(), SingleColourLayer::getBaseQColor(), View::getFrameForX(), View::getLayer(), getMajorTickSpacing(), ViewManager::getOverlayMode(), SingleColourLayer::getPartialShades(), Model::getSampleRate(), View::getViewManager(), View::getXForFrame(), View::getZoomLevel(), Model::isOK(), LabelBottom, LabelMiddle, LabelTop, m_labelHeight, m_model, ViewManager::NoOverlays, View::OutlinedText, and RealTime::toText().
| void TimeRulerLayer::setModel | ( | Model * | ) |
| virtual const Model* TimeRulerLayer::getModel | ( | ) | const [inline, virtual] |
| void TimeRulerLayer::setLabelHeight | ( | LabelHeight | h | ) | [inline] |
| LabelHeight TimeRulerLayer::getLabelHeight | ( | ) | const [inline] |
| bool TimeRulerLayer::snapToFeatureFrame | ( | View * | v, | |
| int & | frame, | |||
| size_t & | resolution, | |||
| SnapType | snap | |||
| ) | const [virtual] |
Adjust the given frame to snap to the nearest feature, if possible.
If snap is SnapLeft or SnapRight, adjust the frame to match that of the nearest feature in the given direction regardless of how far away it is. If snap is SnapNearest, adjust the frame to that of the nearest feature in either direction. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature if it is close, and leave it alone (returning false) otherwise. SnapNeighbouring should always choose the same feature that would be used in an editing operation through calls to editStart etc.
Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). Also return the resolution of the model in this layer in sample frames.
Reimplemented from Layer.
Definition at line 52 of file TimeRulerLayer.cpp.
References RealTime::frame2RealTime(), RealTime::fromMilliseconds(), View::getEndFrame(), getMajorTickSpacing(), Model::getSampleRate(), View::getStartFrame(), View::getXForFrame(), m_model, RealTime::realTime2Frame(), Layer::SnapLeft, Layer::SnapNearest, Layer::SnapNeighbouring, and Layer::SnapRight.
| virtual ColourSignificance TimeRulerLayer::getLayerColourSignificance | ( | ) | const [inline, virtual] |
This should return the degree of meaning associated with colour in this layer.
If ColourAbsent, the layer does not use colour. If ColourIrrelevant, the layer is coloured and the colour may be set by the user, but it doesn't really matter what the colour is (for example, in a time ruler layer). If ColourDistinguishes, then the colour is used to distinguish this layer from other similar layers (e.g. for data layers). If ColourAndBackgroundSignificant, then the layer should be given greater weight than ColourDistinguishes layers when choosing a background colour (e.g. for waveforms). If ColourHasMeaningfulValue, colours are actually meaningful -- the view will then show selections using unfilled rectangles instead of translucent filled rectangles, so as not to disturb the colours underneath.
Reimplemented from SingleColourLayer.
Definition at line 46 of file TimeRulerLayer.h.
References Layer::ColourIrrelevant.
| virtual bool TimeRulerLayer::getValueExtents | ( | float & | , | |
| float & | , | |||
| bool & | , | |||
| QString & | ||||
| ) | const [inline, virtual] |
Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display.
Also return the unit for these values if known.
This function returns the "normal" extents for the layer, not necessarily the extents actually in use in the display.
Implements Layer.
Definition at line 50 of file TimeRulerLayer.h.
| QString TimeRulerLayer::getLayerPresentationName | ( | ) | const [virtual] |
Reimplemented from Layer.
Definition at line 367 of file TimeRulerLayer.cpp.
References LayerFactory::getInstance(), LayerFactory::getLayerPresentationName(), and LayerFactory::getLayerType().
| void TimeRulerLayer::toXml | ( | QTextStream & | stream, | |
| QString | indent = "", |
|||
| QString | extraAttributes = "" | |||
| ) | const [virtual] |
Convert the layer's data (though not those of the model it refers to) into XML for file output.
This class implements the basic name/type/model-id output; subclasses will typically call this superclass implementation with extra attributes describing their particular properties.
Reimplemented from SingleColourLayer.
Definition at line 376 of file TimeRulerLayer.cpp.
References SingleColourLayer::toXml().
| void TimeRulerLayer::setProperties | ( | const QXmlAttributes & | attributes | ) | [virtual] |
Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes.
This is the effective inverse of the toXml method.
Reimplemented from SingleColourLayer.
Definition at line 383 of file TimeRulerLayer.cpp.
References SingleColourLayer::setProperties().
| int TimeRulerLayer::getDefaultColourHint | ( | bool | dark, | |
| bool & | impose | |||
| ) | [protected, virtual] |
Reimplemented from SingleColourLayer.
Definition at line 360 of file TimeRulerLayer.cpp.
References ColourDatabase::getColourIndex(), and ColourDatabase::getInstance().
| int TimeRulerLayer::getMajorTickSpacing | ( | View * | , | |
| bool & | quarterTicks | |||
| ) | const [protected] |
Definition at line 144 of file TimeRulerLayer.cpp.
References RealTime::frame2RealTime(), View::getEndFrame(), Model::getSampleRate(), View::getStartFrame(), m_model, RealTime::msec(), and RealTime::sec.
Referenced by paint(), and snapToFeatureFrame().
| void SingleColourLayer::setBaseColour | ( | int | ) | [virtual, inherited] |
Definition at line 215 of file SingleColourLayer.cpp.
References SingleColourLayer::flagBaseColourChanged(), Layer::layerParametersChanged(), SingleColourLayer::m_colour, SingleColourLayer::m_colourExplicitlySet, and SingleColourLayer::m_colourRefCount.
Referenced by MainWindow::MainWindow(), MainWindow::preferenceChanged(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperty().
| int SingleColourLayer::getBaseColour | ( | ) | const [virtual, inherited] |
| bool SingleColourLayer::hasLightBackground | ( | ) | const [virtual, inherited] |
Reimplemented from Layer.
Definition at line 45 of file SingleColourLayer.cpp.
References ColourDatabase::getInstance(), SingleColourLayer::m_colour, and ColourDatabase::useDarkBackground().
| QPixmap SingleColourLayer::getLayerPresentationPixmap | ( | QSize | size | ) | const [virtual, inherited] |
Reimplemented from Layer.
Definition at line 39 of file SingleColourLayer.cpp.
References ColourDatabase::getExamplePixmap(), ColourDatabase::getInstance(), and SingleColourLayer::m_colour.
| Layer::PropertyList SingleColourLayer::getProperties | ( | ) | const [virtual, inherited] |
Get a list of the names of all the supported properties on this container.
These should be fixed (i.e. not internationalized).
Reimplemented from PropertyContainer.
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 52 of file SingleColourLayer.cpp.
References PropertyContainer::getProperties().
Referenced by WaveformLayer::getProperties(), TimeValueLayer::getProperties(), TimeInstantLayer::getProperties(), TextLayer::getProperties(), SliceLayer::getProperties(), and NoteLayer::getProperties().
| QString SingleColourLayer::getPropertyLabel | ( | const PropertyName & | ) | const [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 60 of file SingleColourLayer.cpp.
Referenced by WaveformLayer::getPropertyLabel(), TimeValueLayer::getPropertyLabel(), TimeInstantLayer::getPropertyLabel(), TextLayer::getPropertyLabel(), SliceLayer::getPropertyLabel(), and NoteLayer::getPropertyLabel().
| virtual QString PropertyContainer::getPropertyLabel | ( | const PropertyName & | ) | const [pure virtual, inherited] |
Return the human-readable (and i18n'ised) name of a property.
Referenced by PropertyContainer::convertPropertyStrings(), and PropertyBox::updatePropertyEditor().
| Layer::PropertyType SingleColourLayer::getPropertyType | ( | const PropertyName & | ) | const [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 67 of file SingleColourLayer.cpp.
References PropertyContainer::ColourProperty, and PropertyContainer::InvalidProperty.
Referenced by WaveformLayer::getPropertyType(), TimeValueLayer::getPropertyType(), TimeInstantLayer::getPropertyType(), TextLayer::getPropertyType(), SliceLayer::getPropertyType(), and NoteLayer::getPropertyType().
| PropertyContainer::PropertyType PropertyContainer::getPropertyType | ( | const PropertyName & | ) | const [virtual, inherited] |
Return the type of the given property, or InvalidProperty if the property is not supported on this container.
Definition at line 33 of file PropertyContainer.cpp.
References PropertyContainer::InvalidProperty.
Referenced by PropertyBox::colourDatabaseChanged(), PropertyContainer::convertPropertyStrings(), ImageLayer::getPropertyType(), PropertyContainer::getPropertyValueLabel(), PropertyBox::propertyControllerChanged(), PropertyBox::unitDatabaseChanged(), and PropertyBox::updatePropertyEditor().
| QString SingleColourLayer::getPropertyGroupName | ( | const PropertyName & | ) | const [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TimeValueLayer, and WaveformLayer.
Definition at line 74 of file SingleColourLayer.cpp.
Referenced by TimeValueLayer::getPropertyGroupName(), SliceLayer::getPropertyGroupName(), and NoteLayer::getPropertyGroupName().
| QString PropertyContainer::getPropertyGroupName | ( | const PropertyName & | ) | const [virtual, inherited] |
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 SingleColourLayer::getPropertyRangeAndValue | ( | const PropertyName & | , | |
| int * | min, | |||
| int * | max, | |||
| int * | deflt | |||
| ) | const [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 80 of file SingleColourLayer.cpp.
References ColourDatabase::getColourPropertyRange(), ColourDatabase::getInstance(), PropertyContainer::getPropertyRangeAndValue(), and SingleColourLayer::m_colour.
Referenced by WaveformLayer::getPropertyRangeAndValue(), TimeValueLayer::getPropertyRangeAndValue(), TimeInstantLayer::getPropertyRangeAndValue(), TextLayer::getPropertyRangeAndValue(), SliceLayer::getPropertyRangeAndValue(), and NoteLayer::getPropertyRangeAndValue().
| 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 SingleColourLayer::getPropertyValueLabel | ( | const PropertyName & | , | |
| int | value | |||
| ) | const [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 105 of file SingleColourLayer.cpp.
References PropertyContainer::getPropertyValueLabel().
Referenced by WaveformLayer::getPropertyValueLabel(), TimeValueLayer::getPropertyValueLabel(), TimeInstantLayer::getPropertyValueLabel(), TextLayer::getPropertyValueLabel(), SliceLayer::getPropertyValueLabel(), and NoteLayer::getPropertyValueLabel().
| 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 * SingleColourLayer::getNewPropertyRangeMapper | ( | const PropertyName & | ) | const [virtual, inherited] |
Reimplemented in SliceLayer, SpectrumLayer, and WaveformLayer.
Definition at line 115 of file SingleColourLayer.cpp.
Referenced by SliceLayer::getNewPropertyRangeMapper().
| 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().
| void SingleColourLayer::setProperty | ( | const PropertyName & | , | |
| int | value | |||
| ) | [virtual, inherited] |
Reimplemented in NoteLayer, SliceLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 121 of file SingleColourLayer.cpp.
References SingleColourLayer::setBaseColour().
Referenced by WaveformLayer::setProperty(), TimeValueLayer::setProperty(), TimeInstantLayer::setProperty(), TextLayer::setProperty(), SliceLayer::setProperty(), and NoteLayer::setProperty().
| 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 SingleColourLayer::setDefaultColourFor | ( | View * | v | ) | [virtual, inherited] |
Definition at line 129 of file SingleColourLayer.cpp.
References ColourDatabase::getColourCount(), SingleColourLayer::getDefaultColourHint(), ColourDatabase::getInstance(), View::hasLightBackground(), SingleColourLayer::m_colour, SingleColourLayer::m_colourExplicitlySet, SingleColourLayer::m_colourRefCount, SingleColourLayer::m_defaultColourSet, SingleColourLayer::setBaseColour(), and ColourDatabase::useDarkBackground().
Referenced by View::addLayer(), and SingleColourLayer::SingleColourLayer().
| QColor SingleColourLayer::getBaseQColor | ( | ) | const [protected, virtual, inherited] |
Definition at line 245 of file SingleColourLayer.cpp.
References ColourDatabase::getColour(), ColourDatabase::getInstance(), and SingleColourLayer::m_colour.
Referenced by SingleColourLayer::getPartialShades(), WaveformLayer::paint(), TimeValueLayer::paint(), paint(), TimeInstantLayer::paint(), TextLayer::paint(), SliceLayer::paint(), and NoteLayer::paint().
| QColor SingleColourLayer::getBackgroundQColor | ( | View * | v | ) | const [protected, virtual, inherited] |
Definition at line 251 of file SingleColourLayer.cpp.
References View::getBackground().
Referenced by SingleColourLayer::getPartialShades(), and WaveformLayer::paint().
| QColor SingleColourLayer::getForegroundQColor | ( | View * | v | ) | const [protected, virtual, inherited] |
Definition at line 257 of file SingleColourLayer.cpp.
References View::getForeground().
Referenced by WaveformLayer::paint(), TimeValueLayer::paint(), and TimeInstantLayer::paint().
| std::vector< QColor > SingleColourLayer::getPartialShades | ( | View * | v | ) | const [protected, inherited] |
Definition at line 263 of file SingleColourLayer.cpp.
References SingleColourLayer::getBackgroundQColor(), and SingleColourLayer::getBaseQColor().
Referenced by WaveformLayer::paint(), and paint().
| virtual void SingleColourLayer::flagBaseColourChanged | ( | ) | [inline, protected, virtual, inherited] |
Reimplemented in WaveformLayer.
Definition at line 64 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setBaseColour(), and SingleColourLayer::setProperties().
| virtual Model* Layer::getModel | ( | ) | [inline, virtual, inherited] |
| virtual const ZoomConstraint* Layer::getZoomConstraint | ( | ) | const [inline, virtual, inherited] |
Return a zoom constraint object defining the supported zoom levels for this layer.
If this returns zero, the layer will support any integer zoom level.
Reimplemented in Colour3DPlotLayer, SpectrogramLayer, and WaveformLayer.
| virtual bool Layer::supportsOtherZoomLevels | ( | ) | const [inline, virtual, inherited] |
Return true if this layer can handle zoom levels other than those supported by its zoom constraint (presumably less efficiently or accurately than the officially supported zoom levels).
If true, the layer will unenthusistically accept any integer zoom level from 1 to the maximum returned by its zoom constraint.
| virtual VerticalPosition Layer::getPreferredTimeRulerPosition | ( | ) | const [inline, virtual, inherited] |
| virtual VerticalPosition Layer::getPreferredFrameCountPosition | ( | ) | const [inline, virtual, inherited] |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
Definition at line 85 of file Layer.h.
References Layer::PositionBottom.
| QString Layer::getPropertyContainerIconName | ( | ) | const [virtual, inherited] |
Implements PropertyContainer.
Definition at line 65 of file Layer.cpp.
References LayerFactory::getInstance(), and LayerFactory::getLayerIconName().
| virtual QString Layer::getPropertyContainerName | ( | ) | const [inline, virtual, inherited] |
Implements PropertyContainer.
Definition at line 94 of file Layer.h.
References Layer::m_presentationName.
| void Layer::setPresentationName | ( | QString | name | ) | [virtual, inherited] |
Definition at line 72 of file Layer.cpp.
References Layer::m_presentationName.
Referenced by SVFileReader::readLayer(), and MainWindow::renameCurrentLayer().
| virtual int Layer::getVerticalScaleWidth | ( | View * | , | |
| QPainter & | ||||
| ) | const [inline, virtual, inherited] |
Reimplemented in Colour3DPlotLayer, SliceLayer, SpectrogramLayer, TimeValueLayer, and WaveformLayer.
Definition at line 104 of file Layer.h.
Referenced by Pane::drawVerticalScale().
| virtual void Layer::paintVerticalScale | ( | View * | , | |
| QPainter & | , | |||
| QRect | ||||
| ) | const [inline, virtual, inherited] |
Reimplemented in Colour3DPlotLayer, SliceLayer, SpectrogramLayer, TimeValueLayer, and WaveformLayer.
Definition at line 105 of file Layer.h.
Referenced by Pane::drawVerticalScale().
| virtual bool Layer::getCrosshairExtents | ( | View * | , | |
| QPainter & | , | |||
| QPoint | , | |||
| std::vector< QRect > & | ||||
| ) | const [inline, virtual, inherited] |
| virtual void Layer::paintCrosshairs | ( | View * | , | |
| QPainter & | , | |||
| QPoint | ||||
| ) | const [inline, virtual, inherited] |
| void Layer::paintMeasurementRects | ( | View * | , | |
| QPainter & | , | |||
| bool | showFocus, | |||
| QPoint | focusPoint | |||
| ) | const [virtual, inherited] |
Definition at line 428 of file Layer.cpp.
References Layer::findFocusedMeasureRect(), Layer::m_currentMeasureRectPoint, Layer::m_draggingRect, Layer::m_haveCurrentMeasureRect, Layer::m_haveDraggingRect, Layer::m_measureRects, Layer::paintMeasurementRect(), and Layer::updateMeasurePixrects().
Referenced by Pane::paintEvent().
| bool Layer::nearestMeasurementRectChanged | ( | View * | , | |
| QPoint | prev, | |||
| QPoint | now | |||
| ) | const [virtual, inherited] |
Definition at line 460 of file Layer.cpp.
References Layer::findFocusedMeasureRect(), and Layer::updateMeasurePixrects().
| virtual QString Layer::getFeatureDescription | ( | View * | , | |
| QPoint & | ||||
| ) | const [inline, virtual, inherited] |
Reimplemented in Colour3DPlotLayer, ImageLayer, NoteLayer, SliceLayer, SpectrogramLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
Definition at line 119 of file Layer.h.
Referenced by Pane::drawFeatureDescription().
| virtual void Layer::drawStart | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 162 of file Layer.h.
Referenced by Pane::mousePressEvent().
| virtual void Layer::drawDrag | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 163 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
| virtual void Layer::drawEnd | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 164 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
| virtual void Layer::eraseStart | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 166 of file Layer.h.
Referenced by Pane::mousePressEvent().
| virtual void Layer::eraseDrag | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 167 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
| virtual void Layer::eraseEnd | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 168 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
| virtual void Layer::editStart | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 170 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
| virtual void Layer::editDrag | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 171 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
| virtual void Layer::editEnd | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 172 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
| void Layer::measureStart | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [virtual, inherited] |
Definition at line 374 of file Layer.cpp.
References Layer::m_draggingRect, Layer::m_haveDraggingRect, and Layer::setMeasureRectFromPixrect().
Referenced by Pane::mousePressEvent().
| void Layer::measureDrag | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [virtual, inherited] |
Definition at line 382 of file Layer.cpp.
References Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::MeasureRect::pixrect, and Layer::setMeasureRectFromPixrect().
Referenced by Layer::measureEnd(), and Pane::mouseMoveEvent().
| void Layer::measureEnd | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [virtual, inherited] |
Definition at line 394 of file Layer.cpp.
References CommandHistory::addCommand(), CommandHistory::getInstance(), Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::measureDrag(), and Layer::MeasureRect::pixrect.
Referenced by Pane::mouseReleaseEvent().
| void Layer::measureDoubleClick | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [virtual, inherited] |
Reimplemented in SpectrogramLayer.
Definition at line 408 of file Layer.cpp.
Referenced by Pane::mouseDoubleClickEvent().
| virtual bool Layer::haveCurrentMeasureRect | ( | ) | const [inline, virtual, inherited] |
| void Layer::deleteCurrentMeasureRect | ( | ) | [virtual, inherited] |
Definition at line 414 of file Layer.cpp.
References CommandHistory::addCommand(), Layer::findFocusedMeasureRect(), CommandHistory::getInstance(), Layer::m_currentMeasureRectPoint, Layer::m_haveCurrentMeasureRect, and Layer::m_measureRects.
Referenced by MainWindowBase::deleteSelected().
| virtual bool Layer::editOpen | ( | View * | , | |
| QMouseEvent * | ||||
| ) | [inline, virtual, inherited] |
Open an editor on the item under the mouse (e.g.
on double-click). If there is no item or editing is not supported, return false.
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 193 of file Layer.h.
Referenced by Pane::mouseDoubleClickEvent().
| virtual void Layer::moveSelection | ( | Selection | , | |
| size_t | ||||
| ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 195 of file Layer.h.
Referenced by Pane::editSelectionEnd().
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 196 of file Layer.h.
Referenced by Pane::editSelectionEnd().
| virtual void Layer::deleteSelection | ( | Selection | ) | [inline, virtual, inherited] |
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 197 of file Layer.h.
Referenced by MainWindowBase::cut().
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 199 of file Layer.h.
Referenced by MainWindowBase::copy(), and MainWindowBase::cut().
Paste from the given clipboard onto the layer at the given frame offset.
If interactive is true, the layer may ask the user about paste options through a dialog if desired, and may return false if the user cancelled the paste operation. This function should return true if a paste actually occurred.
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 208 of file Layer.h.
Referenced by MainWindowBase::paste().
| virtual bool Layer::isLayerScrollable | ( | const View * | ) | const [inline, virtual, inherited] |
This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning.
For the view widget as a whole this is usually not possible because of invariant (non-scrolling) material displayed over the top, but the widget may be able to optimise scrolling better if it is known that individual views can be scrolled safely in this way.
Reimplemented in Colour3DPlotLayer, ImageLayer, NoteLayer, SliceLayer, SpectrogramLayer, SpectrumLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
| virtual bool Layer::isLayerOpaque | ( | ) | const [inline, virtual, inherited] |
This should return true if the layer completely obscures any underlying layers.
It's used to determine whether the view can safely draw any selection rectangles under the layer instead of over it, in the case where the layer is not scrollable and therefore needs to be redrawn each time (so that the selection rectangle can be cached).
Reimplemented in SpectrogramLayer.
| virtual bool Layer::isLayerEditable | ( | ) | const [inline, virtual, inherited] |
This should return true if the layer can be edited by the user.
If this is the case, the appropriate edit tools may be made available by the application and the layer's drawStart/Drag/End and editStart/Drag/End methods should be implemented.
Reimplemented in ImageLayer, NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.
Definition at line 276 of file Layer.h.
Referenced by Pane::mouseDoubleClickEvent(), Pane::mouseMoveEvent(), Pane::mousePressEvent(), Pane::mouseReleaseEvent(), MainWindowBase::paste(), Pane::updateContextHelp(), MainWindowBase::updateMenuStates(), and MainWindow::updateMenuStates().
| virtual int Layer::getCompletion | ( | View * | ) | const [inline, virtual, inherited] |
Return the proportion of background work complete in drawing this view, as a percentage -- in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call.
The view may choose to show a progress meter if it finds that this returns < 100 at any given moment.
Reimplemented in Colour3DPlotLayer, ImageLayer, NoteLayer, SpectrogramLayer, TextLayer, TimeInstantLayer, TimeValueLayer, and WaveformLayer.
| void Layer::setObjectName | ( | const QString & | name | ) | [virtual, inherited] |
Definition at line 100 of file Layer.cpp.
References Layer::layerNameChanged().
Referenced by Document::createDerivedLayer(), Document::createImportedLayer(), LayerFactory::createLayer(), Document::createLayer(), and SVFileReader::readLayer().
| void Layer::toBriefXml | ( | QTextStream & | stream, | |
| QString | indent = "", |
|||
| QString | extraAttributes = "" | |||
| ) | const [virtual, inherited] |
Produce XML containing the layer's ID and type.
This is used to refer to the layer in the display section of the SV session file, for a layer that has already been described in the data section.
Definition at line 626 of file Layer.cpp.
References XmlExportable::encodeEntities(), LayerFactory::getInstance(), Layer::getModel(), XmlExportable::getObjectExportId(), and Layer::m_presentationName.
| void Layer::addMeasurementRect | ( | const QXmlAttributes & | ) | [virtual, inherited] |
Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element).
Does not use a command.
Definition at line 317 of file Layer.cpp.
References Layer::addMeasureRectToSet(), Layer::MeasureRect::endFrame, Layer::MeasureRect::endY, Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::MeasureRect::startFrame, and Layer::MeasureRect::startY.
Referenced by SVFileReader::readMeasurement().
| void Layer::setLayerDormant | ( | const View * | v, | |
| bool | dormant | |||
| ) | [virtual, inherited] |
Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it).
The layer may respond by (for example) freeing any cache memory it is using, until next time its paint method is called, when it should set itself un-dormant again.
A layer class that overrides this function must also call this class's implementation.
Reimplemented in ImageLayer, and SpectrogramLayer.
Definition at line 118 of file Layer.cpp.
References Layer::m_dormancy, and Layer::m_dormancyMutex.
Referenced by Document::RemoveLayerCommand::execute(), Document::AddLayerCommand::execute(), SpectrogramLayer::paint(), SVFileReader::readLayer(), SpectrogramLayer::setLayerDormant(), Layer::showLayer(), Document::RemoveLayerCommand::unexecute(), and Document::AddLayerCommand::unexecute().
| bool Layer::isLayerDormant | ( | const View * | v | ) | const [virtual, inherited] |
Return whether the layer is dormant (i.e.
hidden) in the given view.
Definition at line 126 of file Layer.cpp.
References Layer::m_dormancy, and Layer::m_dormancyMutex.
Referenced by SpectrogramLayer::paint(), PropertyStack::propertyContainerPropertyChanged(), PropertyStack::repopulate(), and SpectrogramLayer::setLayerDormant().
| PlayParameters * Layer::getPlayParameters | ( | ) | [virtual, inherited] |
Reimplemented from PropertyContainer.
Definition at line 107 of file Layer.cpp.
References PlayParameterRepository::getInstance(), Layer::getModel(), and PlayParameterRepository::getPlayParameters().
Referenced by LayerTreeModel::setData().
| virtual bool Layer::needsTextLabelHeight | ( | ) | const [inline, virtual, inherited] |
| virtual bool Layer::hasTimeXAxis | ( | ) | const [inline, virtual, inherited] |
Reimplemented in SliceLayer.
Definition at line 346 of file Layer.h.
Referenced by Layer::getXScaleValue(), Pane::mouseMoveEvent(), and Layer::setMeasureRectFromPixrect().
| virtual bool Layer::getDisplayExtents | ( | float & | , | |
| float & | ||||
| ) | const [inline, virtual, inherited] |
Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed.
Return false if the layer is not imposing a particular display extent (using the normal layer extents or deferring to whatever is in use for the same units elsewhere in the view).
Reimplemented in NoteLayer, SpectrogramLayer, and TimeValueLayer.
Definition at line 368 of file Layer.h.
Referenced by Pane::drawVerticalScale(), and Pane::getTopLayerDisplayExtents().
| virtual bool Layer::setDisplayExtents | ( | float | , | |
| float | ||||
| ) | [inline, virtual, inherited] |
Set the displayed minimum and maximum values for the y axis to the given range, if supported.
Return false if not supported on this layer (and set nothing). In most cases, layers that return false for getDisplayExtents should also return false for this function.
Reimplemented in SpectrogramLayer.
Definition at line 380 of file Layer.h.
Referenced by MainWindow::handleOSCMessage(), Pane::setTopLayerDisplayExtents(), and Pane::zoomToRegion().
| bool Layer::getXScaleValue | ( | const View * | v, | |
| int | x, | |||
| float & | value, | |||
| QString & | unit | |||
| ) | const [virtual, inherited] |
Return the value and unit at the given x coordinate in the given view.
This is for descriptive purposes using the measurement tool. The default implementation works correctly if the layer hasTimeXAxis().
Reimplemented in SpectrumLayer.
Definition at line 142 of file Layer.cpp.
References View::getFrameForX(), Layer::getModel(), Model::getSampleRate(), and Layer::hasTimeXAxis().
Referenced by View::drawMeasurementRect().
| virtual bool Layer::getYScaleValue | ( | const View * | , | |
| int | , | |||
| float & | , | |||
| QString & | ||||
| ) | const [inline, virtual, inherited] |
Return the value and unit at the given y coordinate in the given view.
Reimplemented in SpectrogramLayer, SpectrumLayer, and WaveformLayer.
Definition at line 398 of file Layer.h.
Referenced by View::drawMeasurementRect(), and Layer::getYScaleDifference().
| bool Layer::getYScaleDifference | ( | const View * | v, | |
| int | y0, | |||
| int | y1, | |||
| float & | diff, | |||
| QString & | unit | |||
| ) | const [virtual, inherited] |
Return the difference between the values at the given y coordinates in the given view, and the unit of the difference.
The default implementation just calls getYScaleValue twice and returns the difference, with the same unit.
Reimplemented in SpectrumLayer, and WaveformLayer.
Definition at line 155 of file Layer.cpp.
References Layer::getYScaleValue().
Referenced by View::drawMeasurementRect(), and SpectrumLayer::getYScaleDifference().
| virtual int Layer::getVerticalZoomSteps | ( | int & | ) | const [inline, virtual, inherited] |
Get the number of vertical zoom steps available for this layer.
If vertical zooming is not available, return 0. The meaning of "zooming" is entirely up to the layer -- changing the zoom level may cause the layer to reset its display extents or change another property such as display gain. However, layers are advised for consistency to treat smaller zoom steps as "more distant" or "zoomed out" and larger ones as "closer" or "zoomed in".
Layers that provide this facility should also emit the verticalZoomChanged signal if their vertical zoom changes due to factors other than setVerticalZoomStep being called.
Reimplemented in SpectrogramLayer, and WaveformLayer.
Definition at line 426 of file Layer.h.
Referenced by MainWindow::handleOSCMessage(), Pane::updateHeadsUpDisplay(), Pane::updateVerticalPanner(), and Pane::verticalThumbwheelMoved().
| virtual int Layer::getCurrentVerticalZoomStep | ( | ) | const [inline, virtual, inherited] |
Get the current vertical zoom step.
A layer may support finer control over ranges etc than is available through the integer zoom step mechanism; if this one does, it should just return the nearest of the available zoom steps to the current settings.
Reimplemented in SpectrogramLayer, and WaveformLayer.
Definition at line 434 of file Layer.h.
Referenced by MainWindow::handleOSCMessage(), Pane::updateHeadsUpDisplay(), and Pane::verticalZoomChanged().
| virtual void Layer::setVerticalZoomStep | ( | int | ) | [inline, virtual, inherited] |
Set the vertical zoom step.
The meaning of "zooming" is entirely up to the layer -- changing the zoom level may cause the layer to reset its display extents or change another property such as display gain.
Reimplemented in SpectrogramLayer, and WaveformLayer.
Definition at line 442 of file Layer.h.
Referenced by MainWindow::handleOSCMessage(), and Pane::verticalThumbwheelMoved().
| virtual RangeMapper* Layer::getNewVerticalZoomRangeMapper | ( | ) | const [inline, virtual, inherited] |
Create and return a range mapper for vertical zoom step values.
See the RangeMapper documentation for more details. The returned value is allocated on the heap and will be deleted by the caller.
Reimplemented in SpectrogramLayer.
Definition at line 450 of file Layer.h.
Referenced by Pane::propertyContainerSelected(), and Pane::updateHeadsUpDisplay().
| void Layer::showLayer | ( | View * | , | |
| bool | show | |||
| ) | [slot, inherited] |
Definition at line 135 of file Layer.cpp.
References Layer::layerParametersChanged(), and Layer::setLayerDormant().
Referenced by LayerTreeModel::setData(), and PropertyStack::showLayer().
| void Layer::modelChanged | ( | ) | [signal, inherited] |
| void Layer::modelChanged | ( | size_t | startFrame, | |
| size_t | endFrame | |||
| ) | [signal, inherited] |
| void Layer::modelCompletionChanged | ( | ) | [signal, inherited] |
Referenced by Layer::connectSignals().
| void Layer::modelAlignmentCompletionChanged | ( | ) | [signal, inherited] |
Referenced by Layer::connectSignals().
| void Layer::modelReplaced | ( | ) | [signal, inherited] |
| void Layer::layerParametersChanged | ( | ) | [signal, inherited] |
Referenced by SpectrogramLayer::preferenceChanged(), WaveformLayer::setAggressiveCacheing(), WaveformLayer::setAutoNormalize(), SingleColourLayer::setBaseColour(), SpectrogramLayer::setBinDisplay(), SliceLayer::setBinScale(), WaveformLayer::setChannel(), SpectrumLayer::setChannel(), SpectrogramLayer::setChannel(), WaveformLayer::setChannelMode(), SpectrogramLayer::setColourMap(), Colour3DPlotLayer::setColourMap(), SpectrogramLayer::setColourRotation(), SpectrogramLayer::setColourScale(), Colour3DPlotLayer::setColourScale(), SpectrogramLayer::setDisplayExtents(), SliceLayer::setEnergyScale(), TimeValueLayer::setFillColourMap(), SliceLayer::setFillColourMap(), SpectrogramLayer::setFrequencyScale(), WaveformLayer::setGain(), SpectrogramLayer::setGain(), SliceLayer::setGain(), Colour3DPlotLayer::setInvertVertical(), SpectrogramLayer::setMaxFrequency(), SpectrogramLayer::setMinFrequency(), WaveformLayer::setModel(), SpectrumLayer::setModel(), SliceLayer::setNormalize(), SpectrogramLayer::setNormalizeColumns(), Colour3DPlotLayer::setNormalizeColumns(), SpectrogramLayer::setNormalizeVisibleArea(), Colour3DPlotLayer::setNormalizeVisibleArea(), TimeValueLayer::setPlotStyle(), TimeInstantLayer::setPlotStyle(), SliceLayer::setPlotStyle(), SliceLayer::setSamplingMode(), WaveformLayer::setScale(), WaveformLayer::setShowMeans(), SpectrumLayer::setShowPeaks(), SpectrogramLayer::setThreshold(), SliceLayer::setThreshold(), WaveformLayer::setUseGreyscale(), TimeValueLayer::setVerticalScale(), NoteLayer::setVerticalScale(), SpectrumLayer::setWindowHopLevel(), SpectrogramLayer::setWindowHopLevel(), SpectrumLayer::setWindowSize(), SpectrogramLayer::setWindowSize(), SpectrumLayer::setWindowType(), SpectrogramLayer::setWindowType(), SpectrogramLayer::setZeroPadLevel(), and Layer::showLayer().
| void Layer::layerParameterRangesChanged | ( | ) | [signal, inherited] |
Referenced by TimeValueLayer::setPlotStyle(), and SliceLayer::setPlotStyle().
| void Layer::layerMeasurementRectsChanged | ( | ) | [signal, inherited] |
Referenced by Layer::addMeasureRectToSet(), and Layer::deleteMeasureRectFromSet().
| void Layer::layerNameChanged | ( | ) | [signal, inherited] |
Referenced by Layer::setObjectName().
| void Layer::verticalZoomChanged | ( | ) | [signal, inherited] |
Referenced by SpectrogramLayer::setDisplayExtents(), WaveformLayer::setGain(), and SpectrogramLayer::setProperty().
| void Layer::connectSignals | ( | const Model * | ) | [protected, inherited] |
Definition at line 49 of file Layer.cpp.
References Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), and Layer::modelCompletionChanged().
Referenced by WaveformLayer::setModel(), TimeValueLayer::setModel(), TimeInstantLayer::setModel(), TextLayer::setModel(), SpectrogramLayer::setModel(), NoteLayer::setModel(), ImageLayer::setModel(), Colour3DPlotLayer::setModel(), and SliceLayer::setSliceableModel().
| size_t Layer::alignToReference | ( | View * | v, | |
| size_t | frame | |||
| ) | const [protected, virtual, inherited] |
Definition at line 169 of file Layer.cpp.
References View::alignToReference(), Model::alignToReference(), Model::getAlignmentReference(), and Layer::getModel().
Referenced by Layer::clipboardHasDifferentAlignment(), TimeValueLayer::copy(), TimeInstantLayer::copy(), TextLayer::copy(), NoteLayer::copy(), and ImageLayer::copy().
| size_t Layer::alignFromReference | ( | View * | v, | |
| size_t | frame | |||
| ) | const [protected, virtual, inherited] |
Definition at line 181 of file Layer.cpp.
References View::alignFromReference(), Model::alignFromReference(), Model::getAlignmentReference(), and Layer::getModel().
Referenced by TimeValueLayer::paste(), TimeInstantLayer::paste(), TextLayer::paste(), NoteLayer::paste(), and ImageLayer::paste().
| bool Layer::clipboardHasDifferentAlignment | ( | View * | v, | |
| const Clipboard & | clip | |||
| ) | const [protected, inherited] |
Definition at line 193 of file Layer.cpp.
References Layer::alignToReference(), and Clipboard::getPoints().
Referenced by TimeValueLayer::paste(), TimeInstantLayer::paste(), TextLayer::paste(), NoteLayer::paste(), and ImageLayer::paste().
| void Layer::addMeasureRectToSet | ( | const MeasureRect & | r | ) | [inline, protected, inherited] |
Definition at line 519 of file Layer.h.
References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.
Referenced by Layer::addMeasurementRect(), Layer::AddMeasurementRectCommand::execute(), and Layer::DeleteMeasurementRectCommand::unexecute().
| void Layer::deleteMeasureRectFromSet | ( | const MeasureRect & | r | ) | [inline, protected, inherited] |
Definition at line 524 of file Layer.h.
References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.
Referenced by Layer::DeleteMeasurementRectCommand::execute(), and Layer::AddMeasurementRectCommand::unexecute().
| void Layer::updateMeasurePixrects | ( | View * | v | ) | const [protected, inherited] |
Definition at line 471 of file Layer.cpp.
References View::getEndFrame(), View::getStartFrame(), View::getXForFrame(), Layer::m_measureRects, and Layer::updateMeasureRectYCoords().
Referenced by Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().
| void Layer::updateMeasureRectYCoords | ( | View * | v, | |
| const MeasureRect & | r | |||
| ) | const [protected, virtual, inherited] |
Definition at line 510 of file Layer.cpp.
References Layer::MeasureRect::endY, Layer::MeasureRect::pixrect, and Layer::MeasureRect::startY.
Referenced by Layer::updateMeasurePixrects().
| void Layer::setMeasureRectYCoord | ( | View * | v, | |
| MeasureRect & | r, | |||
| bool | start, | |||
| int | y | |||
| ) | const [protected, virtual, inherited] |
Definition at line 518 of file Layer.cpp.
References Layer::MeasureRect::endY, and Layer::MeasureRect::startY.
Referenced by Layer::setMeasureRectFromPixrect().
| void Layer::setMeasureRectFromPixrect | ( | View * | v, | |
| MeasureRect & | r, | |||
| QRect | pixrect | |||
| ) | const [protected, virtual, inherited] |
Definition at line 529 of file Layer.cpp.
References Layer::MeasureRect::endFrame, View::getFrameForX(), Layer::hasTimeXAxis(), Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::setMeasureRectYCoord(), and Layer::MeasureRect::startFrame.
Referenced by SpectrogramLayer::measureDoubleClick(), Layer::measureDrag(), and Layer::measureStart().
| Layer::MeasureRectSet::const_iterator Layer::findFocusedMeasureRect | ( | QPoint | ) | const [protected, inherited] |
Definition at line 542 of file Layer.cpp.
References Layer::m_measureRects.
Referenced by Layer::deleteCurrentMeasureRect(), Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().
| void Layer::paintMeasurementRect | ( | View * | v, | |
| QPainter & | paint, | |||
| const MeasureRect & | r, | |||
| bool | focus | |||
| ) | const [protected, inherited] |
Definition at line 569 of file Layer.cpp.
References View::drawMeasurementRect(), Layer::MeasureRect::endFrame, View::getEndFrame(), View::getStartFrame(), View::getXForFrame(), Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, and Layer::MeasureRect::startFrame.
Referenced by Layer::paintMeasurementRects().
| QString PropertyContainer::getPropertyIconName | ( | const PropertyName & | ) | const [virtual, inherited] |
Return an icon for the property, if any.
Definition at line 39 of file PropertyContainer.cpp.
Referenced by PropertyBox::updatePropertyEditor().
| void PropertyContainer::propertyChanged | ( | PropertyContainer::PropertyName | ) | [signal, inherited] |
Referenced by Preferences::setBackgroundMode(), Preferences::setOmitTempsFromRecentFiles(), Preferences::setPropertyBoxLayout(), Preferences::setResampleOnLoad(), Preferences::setResampleQuality(), Preferences::setShowSplash(), Preferences::setSpectrogramSmoothing(), Preferences::setTemporaryDirectoryRoot(), Preferences::setTuningFrequency(), Preferences::setViewFontSize(), Preferences::setWindowType(), SpectrogramLayer::SpectrogramLayer(), SpectrumLayer::SpectrumLayer(), and ViewPropertyContainer::ViewPropertyContainer().
| 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] |
Definition at line 126 of file PropertyContainer.cpp.
References PropertyContainer::ColourProperty, ColourDatabase::getColourIndex(), UnitDatabase::getInstance(), ColourDatabase::getInstance(), PropertyContainer::getNewPropertyRangeMapper(), RangeMapper::getPositionForValue(), PropertyContainer::getProperties(), PropertyContainer::getPropertyLabel(), PropertyContainer::getPropertyRangeAndValue(), PropertyContainer::getPropertyType(), PropertyContainer::getPropertyValueLabel(), UnitDatabase::getUnitId(), PropertyContainer::InvalidProperty, PropertyContainer::RangeProperty, PropertyContainer::ToggleProperty, PropertyContainer::UnitsProperty, and PropertyContainer::ValueProperty.
Referenced by PropertyContainer::setProperty(), and PropertyContainer::setPropertyWithCommand().
| QString XmlExportable::toXmlString | ( | QString | indent = "", |
|
| QString | extraAttributes = "" | |||
| ) | const [virtual, inherited] |
Convert this exportable object to XML in a string.
The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.
Definition at line 25 of file XmlExportable.cpp.
References XmlExportable::toXml().
Referenced by LayerFactory::setLayerDefaultProperties().
| QString XmlExportable::encodeEntities | ( | QString | ) | [static, inherited] |
Definition at line 41 of file XmlExportable.cpp.
Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), TextPoint::toXml(), PluginXml::toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().
| QString XmlExportable::encodeColour | ( | QColor | ) | [static, inherited] |
| int XmlExportable::getObjectExportId | ( | const void * | ) | [static, inherited] |
Definition at line 71 of file XmlExportable.cpp.
Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().
Model* TimeRulerLayer::m_model [protected] |
Definition at line 62 of file TimeRulerLayer.h.
Referenced by getMajorTickSpacing(), getModel(), paint(), setModel(), and snapToFeatureFrame().
LabelHeight TimeRulerLayer::m_labelHeight [protected] |
Definition at line 63 of file TimeRulerLayer.h.
Referenced by getLabelHeight(), paint(), and setLabelHeight().
SingleColourLayer::ColourRefCount SingleColourLayer::m_colourRefCount [static, protected, inherited] |
Definition at line 69 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperties().
int SingleColourLayer::m_colour [protected, inherited] |
Definition at line 71 of file SingleColourLayer.h.
Referenced by SingleColourLayer::getBaseColour(), SingleColourLayer::getBaseQColor(), SingleColourLayer::getLayerPresentationPixmap(), SingleColourLayer::getPropertyRangeAndValue(), SingleColourLayer::hasLightBackground(), SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), SingleColourLayer::setProperties(), WaveformLayer::toXml(), and SingleColourLayer::toXml().
bool SingleColourLayer::m_colourExplicitlySet [protected, inherited] |
Definition at line 72 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperties().
bool SingleColourLayer::m_defaultColourSet [protected, inherited] |
Definition at line 73 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setDefaultColourFor().
MeasureRectSet Layer::m_measureRects [protected, inherited] |
Definition at line 530 of file Layer.h.
Referenced by Layer::addMeasureRectToSet(), Layer::deleteCurrentMeasureRect(), Layer::deleteMeasureRectFromSet(), Layer::findFocusedMeasureRect(), Layer::paintMeasurementRects(), Layer::toXml(), and Layer::updateMeasurePixrects().
MeasureRect Layer::m_draggingRect [protected, inherited] |
Definition at line 531 of file Layer.h.
Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().
bool Layer::m_haveDraggingRect [protected, inherited] |
Definition at line 532 of file Layer.h.
Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().
bool Layer::m_haveCurrentMeasureRect [mutable, protected, inherited] |
Definition at line 533 of file Layer.h.
Referenced by Layer::deleteCurrentMeasureRect(), Layer::haveCurrentMeasureRect(), and Layer::paintMeasurementRects().
QPoint Layer::m_currentMeasureRectPoint [mutable, protected, inherited] |
Definition at line 534 of file Layer.h.
Referenced by Layer::deleteCurrentMeasureRect(), and Layer::paintMeasurementRects().
QString Layer::m_presentationName [protected, inherited] |
Definition at line 551 of file Layer.h.
Referenced by Layer::getLayerPresentationName(), Layer::getPropertyContainerName(), Layer::setPresentationName(), Layer::toBriefXml(), and Layer::toXml().
1.5.1