d4488e443c
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.
130 lines
4.5 KiB
C++
130 lines
4.5 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 __TRILL_H__
|
|
#define __TRILL_H__
|
|
|
|
#include "line.h"
|
|
|
|
class QPainter;
|
|
|
|
namespace Ms {
|
|
|
|
class Trill;
|
|
class Accidental;
|
|
|
|
//---------------------------------------------------------
|
|
// @@ TrillSegment
|
|
//---------------------------------------------------------
|
|
|
|
class TrillSegment : public LineSegment {
|
|
Q_OBJECT
|
|
|
|
QList<SymId> _symbols;
|
|
|
|
void symbolLine(SymId start, SymId fill);
|
|
void symbolLine(SymId start, SymId fill, SymId end);
|
|
|
|
protected:
|
|
public:
|
|
TrillSegment(Score* s) : LineSegment(s) {}
|
|
Trill* trill() const { return (Trill*)spanner(); }
|
|
virtual Element::Type type() const override { return Element::Type::TRILL_SEGMENT; }
|
|
virtual TrillSegment* clone() const override { return new TrillSegment(*this); }
|
|
virtual void draw(QPainter*) const override;
|
|
virtual bool acceptDrop(const DropData&) const override;
|
|
virtual Element* drop(const DropData&) override;
|
|
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 void add(Element*) override;
|
|
virtual void remove(Element*) override;
|
|
virtual void scanElements(void* data, void (*func)(void*, Element*), bool all) override;
|
|
|
|
QList<SymId> symbols() const { return _symbols; }
|
|
void setSymbols(const QList<SymId>& s) { _symbols = s; }
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// @@ Trill
|
|
// @P trillType enum (Trill.DOWNPRALL_LINE, .PRALLPRALL_LINE, .PURE_LINE, .TRILL_LINE, .UPPRALL_LINE)
|
|
//---------------------------------------------------------
|
|
|
|
class Trill : public SLine {
|
|
Q_OBJECT
|
|
Q_ENUMS(Type)
|
|
|
|
public:
|
|
enum class Type : char {
|
|
TRILL_LINE, UPPRALL_LINE, DOWNPRALL_LINE, PRALLPRALL_LINE
|
|
};
|
|
|
|
private:
|
|
Q_PROPERTY(Ms::Trill::Type trillType READ trillType WRITE undoSetTrillType)
|
|
Type _trillType;
|
|
Accidental* _accidental;
|
|
MScore::OrnamentStyle _ornamentStyle; // for use in ornaments such as trill
|
|
bool _playArticulation;
|
|
|
|
public:
|
|
Trill(Score* s);
|
|
virtual ~Trill();
|
|
virtual Trill* clone() const override { return new Trill(*this); }
|
|
virtual Element::Type type() const override { return Element::Type::TRILL; }
|
|
|
|
virtual void layout() override;
|
|
virtual LineSegment* createLineSegment() override;
|
|
virtual void add(Element*) override;
|
|
virtual void remove(Element*) override;
|
|
virtual void write(Xml&) const override;
|
|
virtual void read(XmlReader&) override;
|
|
|
|
void setTrillType(const QString& s);
|
|
void undoSetTrillType(Type val);
|
|
void setTrillType(Type tt) { _trillType = tt; }
|
|
Type trillType() const { return _trillType; }
|
|
void setOrnamentStyle(MScore::OrnamentStyle val) { _ornamentStyle = val;}
|
|
MScore::OrnamentStyle ornamentStyle() const { return _ornamentStyle;}
|
|
void setPlayArticulation(bool val) { _playArticulation = val;}
|
|
bool playArticulation() const { return _playArticulation; }
|
|
QString trillTypeName() const;
|
|
QString trillTypeUserName();
|
|
Accidental* accidental() const { return _accidental; }
|
|
void setAccidental(Accidental* a) { _accidental = a; }
|
|
|
|
Segment* segment() const { return (Segment*)parent(); }
|
|
virtual void scanElements(void* data, void (*func)(void*, Element*), bool all=true) 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 void setYoff(qreal) override;
|
|
|
|
virtual QString accessibleInfo() override;
|
|
};
|
|
|
|
struct TrillTableItem {
|
|
Trill::Type type;
|
|
const char* name;
|
|
QString userName;
|
|
};
|
|
|
|
extern const TrillTableItem trillTable[];
|
|
extern int trillTableSize();
|
|
|
|
} // namespace Ms
|
|
|
|
Q_DECLARE_METATYPE(Ms::Trill::Type);
|
|
|
|
#endif
|
|
|