MuseScore/libmscore/volta.h
Maurizio M. Gavioli d4488e443c Plugin Manual - Documentation update for classes S-Z
Updates the documentation for classes named from S to Z to proposal A) in http://dev-list.musescore.org/Plugin-documentation-generated-manual-td7579164.html

Properties are also sorted in alphabetical order for easier identification.

No attempt made to evaluate what to include and what to exclude from documentation: anything which is currently documented is retained. Case by case decisions can always be made.

Description of some methods for `Score` (in file libmscore/score.h) are stubs.
2015-07-13 11:38:28 +02:00

107 lines
3.4 KiB
C++

//=============================================================================
// MuseScore
// Music Composition & Notation
//
// Copyright (C) 2002-2011 Werner Schweer
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2
// as published by the Free Software Foundation and appearing in
// the file LICENCE.GPL
//=============================================================================
#ifndef __VOLTA_H__
#define __VOLTA_H__
#include "textline.h"
namespace Ms {
class Score;
class Xml;
class Volta;
class Measure;
extern void vdebug(int n);
extern LineSegment* voltaDebug;
//---------------------------------------------------------
// @@ VoltaSegment
//---------------------------------------------------------
class VoltaSegment : public TextLineSegment {
Q_OBJECT
public:
VoltaSegment(Score* s) : TextLineSegment(s) {}
virtual Element::Type type() const override { return Element::Type::VOLTA_SEGMENT; }
virtual VoltaSegment* clone() const override { return new VoltaSegment(*this); }
Volta* volta() const { return (Volta*)spanner(); }
virtual void layout() override;
virtual QVariant getProperty(P_ID propertyId) const override;
virtual bool setProperty(P_ID propertyId, const QVariant&) override;
virtual QVariant propertyDefault(P_ID) const override;
virtual PropertyStyle propertyStyle(P_ID) const override;
virtual void resetProperty(P_ID id) override;
virtual void styleChanged() override;
};
//---------------------------------------------------------
// @@ Volta
// @P voltaType enum (Volta.CLOSE, Volta.OPEN)
//---------------------------------------------------------
class Volta : public TextLine {
Q_OBJECT
Q_PROPERTY(Ms::Volta::Type voltaType READ voltaType WRITE undoSetVoltaType)
Q_ENUMS(Type)
QList<int> _endings;
PropertyStyle lineWidthStyle;
PropertyStyle lineStyleStyle;
public:
enum class Type : char {
OPEN, CLOSED
};
Volta(Score* s);
virtual Volta* clone() const override { return new Volta(*this); }
virtual Element::Type type() const override { return Element::Type::VOLTA; }
virtual LineSegment* createLineSegment() override;
virtual void write(Xml&) const override;
virtual void read(XmlReader& e) override;
QList<int> endings() const { return _endings; }
QList<int>& endings() { return _endings; }
void setEndings(const QList<int>& l) { _endings = l; }
void setText(const QString& s);
QString text() const;
void setVoltaType(Type val);
void undoSetVoltaType(Type val);
Type voltaType() const;
bool hasEnding(int repeat) const;
virtual QVariant getProperty(P_ID propertyId) const override;
virtual bool setProperty(P_ID propertyId, const QVariant&) override;
virtual QVariant propertyDefault(P_ID) const override;
virtual PropertyStyle propertyStyle(P_ID) const override;
virtual void resetProperty(P_ID id) override;
virtual void styleChanged() override;
virtual void setYoff(qreal) override;
virtual void reset() override;
virtual bool systemFlag() const override { return true; }
virtual QString accessibleInfo() override;
};
} // namespace Ms
Q_DECLARE_METATYPE(Ms::Volta::Type);
#endif