1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
//=============================================================================
// 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 __QMLPLUGIN_H__
#define __QMLPLUGIN_H__
#include "config.h"
#include "libmscore/mscore.h"
#include "libmscore/musescoreCore.h"
#include "libmscore/utils.h"
namespace Ms {
class MsProcess;
class Score;
class Element;
class MScore;
//---------------------------------------------------------
// QmlPlugin
// @@ MuseScore
// @P menuPath QString where the plugin is placed in menu
// @P filePath QString source file path, without the file name (read only)
// @P version QString version of this plugin
// @P description QString human readable description, displayed in Plugin Manager
// @P pluginType QString type may be dialog, dock, or not defined.
// @P dockArea QString where to dock on main screen. left,top,bottom, right(default)
// @P requiresScore bool whether the plugin requires an existing score to run
// @P division int number of MIDI ticks for 1/4 note (read only)
// @P mscoreVersion int complete version number of MuseScore in the form: MMmmuu (read only)
// @P mscoreMajorVersion int 1st part of the MuseScore version (read only)
// @P mscoreMinorVersion int 2nd part of the MuseScore version (read only)
// @P mscoreUpdateVersion int 3rd part of the MuseScore version (read only)
// @P mscoreDPI qreal (read only)
// @P curScore Ms::Score* current score, if any (read only)
// @P scores array[Ms::Score] all currently open scores (read only)
//---------------------------------------------------------
class QmlPlugin : public QQuickItem {
Q_OBJECT
QString _menuPath;
QString _pluginType;
QString _dockArea;
bool _requiresScore = true;
QString _version;
QString _description;
protected:
QString _filePath; // the path of the source file, without file name
MuseScoreCore* msc() { return MuseScoreCore::mscoreCore; }
const MuseScoreCore* msc() const { return MuseScoreCore::mscoreCore; }
public:
QmlPlugin(QQuickItem* parent = 0);
void setMenuPath(const QString& s) { _menuPath = s; }
QString menuPath() const { return _menuPath; }
void setVersion(const QString& s) { _version = s; }
QString version() const { return _version; }
void setDescription(const QString& s) { _description = s; }
QString description() const { return _description; }
void setFilePath(const QString s) { _filePath = s; }
QString filePath() const { return _filePath; }
void setPluginType(const QString& s) { _pluginType = s; }
QString pluginType() const { return _pluginType; }
void setDockArea(const QString& s) { _dockArea = s; }
QString dockArea() const { return _dockArea; }
void setRequiresScore(bool b) { _requiresScore = b; }
bool requiresScore() const { return _requiresScore; }
virtual void runPlugin() = 0;
int division() const { return MScore::division; }
int mscoreVersion() const { return Ms::version(); }
int mscoreMajorVersion() const { return majorVersion(); }
int mscoreMinorVersion() const { return minorVersion(); }
int mscoreUpdateVersion() const { return updateVersion(); }
qreal mscoreDPI() const { return DPI; }
};
} // namespace Ms
#endif
|
