MuseScore/libmscore/cursor.h
Joachim Schmitz 54ede6a1f6 improve builtin plugin documentation
reformatting, removing some comments that are irrelevant to plugin
framework in a way that DoxyGen should still find them, documenting the
enums and fully qualify all types that are specific to MuseScore,
2014-05-16 13:58:30 +02:00

111 lines
3.2 KiB
C++

//=============================================================================
// MuseScore
// Music Composition & Notation
//
// Copyright (C) 2012 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 __CURSOR_H__
#define __CURSOR_H__
namespace Ms {
class Element;
class Score;
class Chord;
class Rest;
class Note;
class Segment;
class RepeatSegment;
class ChordRest;
class StaffText;
class Measure;
//---------------------------------------------------------
// @@ Cursor
// @P track int current track
// @P staffIdx int current staff (track / 4)
// @P voice int current voice (track % 4)
// @P element Ms::Element* current element at track, read only
// @P segment Ms::Segment* current segment, read only
// @P measure Ms::Measure* current measure, read only
// @P tick int midi tick position, read only
// @P time double time at tick position, read only
// @P score Ms::Score* associated score
//---------------------------------------------------------
class Cursor : public QObject {
Q_OBJECT
Q_PROPERTY(int track READ track WRITE setTrack)
Q_PROPERTY(int staffIdx READ staffIdx WRITE setStaffIdx)
Q_PROPERTY(int voice READ voice WRITE setVoice)
Q_PROPERTY(Ms::Element* element READ element)
Q_PROPERTY(Ms::Segment* segment READ segment)
Q_PROPERTY(Ms::Measure* measure READ measure)
Q_PROPERTY(int tick READ tick)
Q_PROPERTY(double time READ time)
Q_PROPERTY(Ms::Score* score READ score WRITE setScore)
Score* _score;
int _track;
bool _expandRepeats;
//state
Segment* _segment;
// utility methods
void firstChordRestInTrack();
public:
Cursor(Score* c = 0);
Cursor(Score*, bool);
Score* score() const { return _score; }
void setScore(Score* s);
int track() const { return _track; }
void setTrack(int v);
int staffIdx() const;
void setStaffIdx(int v);
int voice() const;
void setVoice(int v);
Element* element() const;
Segment* segment() const { return _segment; }
Measure* measure() const;
int tick();
double time();
//@ rewind cursor
//@ type=0 rewind to start of score
//@ type=1 rewind to start of selection
//@ type=2 rewind to end of selection
Q_INVOKABLE void rewind(int type);
Q_INVOKABLE bool next();
Q_INVOKABLE bool nextMeasure();
Q_INVOKABLE void add(Ms::Element*);
Q_INVOKABLE Ms::Note* addNote(int pitch);
//@ set duration
//@ z: numerator
//@ n: denominator
//@ Quarter, if n == 0
Q_INVOKABLE void setDuration(int z, int n);
};
} // namespace Ms
#endif