MuseScore  3.4
Music composition and notation
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Ms::Clef Class Referencefinal

Graphic representation of a clef. More...

#include <clef.h>

Inheritance diagram for Ms::Clef:
Inheritance graph
[legend]
Collaboration diagram for Ms::Clef:
Collaboration graph
[legend]

Public Member Functions

 Clef (Score *)
 
virtual Clefclone () const
 
virtual ElementType type () const
 
virtual qreal mag () const
 
Segmentsegment () const
 
Measuremeasure () const
 
virtual bool acceptDrop (EditData &) const override
 Return true if this element accepts a drop at canvas relative pos of given element type and subtype. More...
 
virtual Elementdrop (EditData &)
 Handle a dropped element at canvas relative pos of given element type and subtype. More...
 
virtual void layout ()
 
virtual void draw (QPainter *) const
 
virtual void read (XmlReader &)
 
virtual void write (XmlWriter &) const
 
virtual bool isEditable () const
 
bool small () const
 
void setSmall (bool val)
 
bool showCourtesy () const
 
void setShowCourtesy (bool v)
 
void undoSetShowCourtesy (bool v)
 
ClefotherClef ()
 
const char * clefTypeName ()
 
ClefType clefType () const
 
void setClefType (ClefType i)
 
void setClefType (const QString &s)
 
ClefTypeList clefTypeList () const
 
ClefType concertClef () const
 
ClefType transposingClef () const
 
void setConcertClef (ClefType val)
 
void setTransposingClef (ClefType val)
 
void setClefType (const ClefTypeList &ctl)
 
virtual void spatiumChanged (qreal oldValue, qreal newValue) override
 
QVariant getProperty (Pid propertyId) const
 
bool setProperty (Pid propertyId, const QVariant &)
 
QVariant propertyDefault (Pid id) const
 
virtual ElementnextSegmentElement () override
 
virtual ElementprevSegmentElement () override
 
QString accessibleInfo () const override
 
void clear ()
 
- Public Member Functions inherited from Ms::Element
 Element (Score *=0, ElementFlags=ElementFlag::NOTHING)
 
 Element (const Element &)
 
virtual ~Element ()
 
Elementoperator= (const Element &)=delete
 
virtual ElementlinkedClone ()
 
Elementparent () const
 
void setParent (Element *e)
 
MeasurefindMeasure ()
 
const MeasurefindMeasure () const
 
MeasureBasefindMeasureBase ()
 
const MeasureBasefindMeasureBase () const
 
virtual bool isElement () const override
 
qreal spatium () const
 
void setFlag (ElementFlag f, bool v)
 
void setFlag (ElementFlag f, bool v) const
 
bool flag (ElementFlag f) const
 
bool selected () const
 
virtual void setSelected (bool f)
 
bool visible () const
 
virtual void setVisible (bool f)
 
virtual bool sizeIsSpatiumDependent () const override
 
void setSizeIsSpatiumDependent (bool v)
 
Placement placement () const
 
void setPlacement (Placement val)
 
bool placeAbove () const
 
bool placeBelow () const
 
bool generated () const
 
void setGenerated (bool val)
 
Spatium minDistance () const
 
void setMinDistance (Spatium v)
 
OffsetChange offsetChanged () const
 
void setOffsetChanged (bool v, bool absolute=true, const QPointF &diff=QPointF())
 
const QPointF & ipos () const
 
virtual const QPointF pos () const
 
virtual qreal x () const
 
virtual qreal y () const
 
void setPos (qreal x, qreal y)
 
void setPos (const QPointF &p)
 
QPointF & rpos ()
 
qreal & rxpos ()
 
qreal & rypos ()
 
virtual void move (const QPointF &s)
 
virtual QPointF pagePos () const
 position in page coordinates More...
 
virtual QPointF canvasPos () const
 position in canvas coordinates More...
 
qreal pageX () const
 
qreal canvasX () const
 
const QPointF & offset () const
 
virtual void setOffset (const QPointF &o)
 
void setOffset (qreal x, qreal y)
 
QPointF & roffset ()
 
qreal & rxoffset ()
 
qreal & ryoffset ()
 
virtual Fraction tick () const
 
virtual Fraction rtick () const
 
bool isNudged () const
 
virtual const QRectF & bbox () const
 
virtual QRectF & bbox ()
 
virtual qreal height () const
 
virtual void setHeight (qreal v)
 
virtual qreal width () const
 
virtual void setWidth (qreal v)
 
QRectF abbox () const
 
QRectF pageBoundingRect () const
 
QRectF canvasBoundingRect () const
 
virtual void setbbox (const QRectF &r) const
 
virtual void addbbox (const QRectF &r) const
 
bool contains (const QPointF &p) const
 
bool intersects (const QRectF &r) const
 
virtual Shape shape () const
 
virtual qreal baseLine () const
 
virtual int subtype () const
 
void drawAt (QPainter *p, const QPointF &pt) const
 
virtual void writeProperties (XmlWriter &xml) const
 
virtual bool readProperties (XmlReader &)
 
virtual void startDrag (EditData &)
 
virtual QRectF drag (EditData &)
 Return update Rect relative to canvas. More...
 
virtual void endDrag (EditData &)
 
virtual QLineF dragAnchor () const
 
virtual void startEdit (EditData &)
 
virtual bool edit (EditData &)
 
virtual void startEditDrag (EditData &)
 
virtual void editDrag (EditData &)
 
virtual void endEditDrag (EditData &)
 
virtual void endEdit (EditData &)
 
virtual void editCut (EditData &)
 
virtual void editCopy (EditData &)
 
void updateGrips (EditData &) const
 
virtual bool nextGrip (EditData &) const
 
virtual bool prevGrip (EditData &) const
 
virtual QPointF gripAnchor (Grip) const
 
virtual EditBehavior normalModeEditBehavior () const
 
virtual int gripsCount () const
 
virtual Grip initialEditModeGrip () const
 
virtual Grip defaultGrip () const
 
virtual std::vector< QPointF > gripsPositions (const EditData &) const
 
int track () const
 
virtual void setTrack (int val)
 
int z () const
 
void setZ (int val)
 
int staffIdx () const
 
virtual int vStaffIdx () const
 
int voice () const
 
void setVoice (int v)
 
Staffstaff () const
 
StaffTypestaffType () const
 
Partpart () const
 
virtual void add (Element *)
 
virtual void remove (Element *)
 
virtual void change (Element *o, Element *n)
 
virtual void localSpatiumChanged (qreal, qreal)
 
virtual void dump () const
 
virtual Q_INVOKABLE QString subtypeName () const
 
virtual Q_INVOKABLE QString _name () const
 
virtual QColor color () const
 
QColor curColor () const
 
QColor curColor (bool isVisible) const
 
QColor curColor (bool isVisible, QColor normalColor) const
 
virtual void setColor (const QColor &c)
 
void undoSetColor (const QColor &c)
 
void undoSetVisible (bool v)
 
virtual QByteArray mimeData (const QPointF &) const
 
virtual bool mousePress (EditData &)
 delivers mouseEvent to element in edit mode returns true if mouse event is accepted by element More...
 
virtual void scanElements (void *data, void(*func)(void *, Element *), bool all=true)
 
virtual void reset () override
 
void setMag (qreal val)
 
qreal magS () const
 
bool isPrintable () const
 
qreal point (const Spatium sp) const
 
bool systemFlag () const
 
void setSystemFlag (bool v) const
 
bool header () const
 
void setHeader (bool v)
 
bool trailer () const
 
void setTrailer (bool val)
 
bool selectable () const
 
void setSelectable (bool val)
 
bool dropTarget () const
 
void setDropTarget (bool v) const
 
bool composition () const
 
void setComposition (bool v) const
 
virtual bool isMovable () const
 
bool enabled () const
 
void setEnabled (bool val)
 
uint tag () const
 
void setTag (uint val)
 
bool autoplace () const
 
virtual void setAutoplace (bool v)
 
bool addToSkyline () const
 
virtual void undoChangeProperty (Pid id, const QVariant &, PropertyFlags ps) override
 
virtual Pid propertyId (const QStringRef &xmlName) const override
 
virtual QString propertyUserValue (Pid) const override
 
virtual ElementpropertyDelegate (Pid)
 
bool custom (Pid) const
 
virtual bool isUserModified () const
 
void drawSymbol (SymId id, QPainter *p, const QPointF &o=QPointF(), qreal scale=1.0) const
 
void drawSymbol (SymId id, QPainter *p, const QPointF &o, int n) const
 
void drawSymbols (const std::vector< SymId > &, QPainter *p, const QPointF &o=QPointF(), qreal scale=1.0) const
 
void drawSymbols (const std::vector< SymId > &, QPainter *p, const QPointF &o, const QSizeF &scale) const
 
qreal symHeight (SymId id) const
 
qreal symWidth (SymId id) const
 
qreal symWidth (const std::vector< SymId > &) const
 
QRectF symBbox (SymId id) const
 
QRectF symBbox (const std::vector< SymId > &) const
 
QPointF symStemDownNW (SymId id) const
 
QPointF symStemUpSE (SymId id) const
 
QPointF symCutOutNE (SymId id) const
 
QPointF symCutOutNW (SymId id) const
 
QPointF symCutOutSE (SymId id) const
 
QPointF symCutOutSW (SymId id) const
 
qreal symAdvance (SymId id) const
 
bool symIsValid (SymId id) const
 
bool concertPitch () const
 
virtual ElementnextElement ()
 
virtual ElementprevElement ()
 
virtual QString screenReaderInfo () const
 
virtual QString accessibleExtraInfo () const
 
virtual void triggerLayout () const
 
virtual void triggerLayoutAll () const
 
virtual void drawEditMode (QPainter *, EditData &)
 
void autoplaceSegmentElement (bool above, bool add)
 
void autoplaceMeasureElement (bool above, bool add)
 
void autoplaceSegmentElement (bool add=true)
 
void autoplaceMeasureElement (bool add=true)
 
void autoplaceCalculateOffset (QRectF &r, qreal minDistance)
 
qreal rebaseOffset (bool nox=true)
 
bool rebaseMinDistance (qreal &md, qreal &yd, qreal sp, qreal rebase, bool above, bool fix)
 
qreal styleP (Sid idx) const
 
- Public Member Functions inherited from Ms::ScoreElement
 ScoreElement (Score *s)
 
 ScoreElement (const ScoreElement &se)
 
virtual ~ScoreElement ()
 
Scorescore () const
 
MasterScoremasterScore () const
 
virtual void setScore (Score *s)
 
const char * name () const
 
virtual QString userName () const
 
virtual void resetProperty (Pid id)
 
QVariant propertyDefault (Pid pid, Tid tid) const
 
virtual void initElementStyle (const ElementStyle *)
 
virtual const ElementStylestyledProperties () const
 
virtual PropertyFlagspropertyFlagsList () const
 
virtual PropertyFlags propertyFlags (Pid) const
 
bool isStyled (Pid pid) const
 
QVariant styleValue (Pid, Sid) const
 
void setPropertyFlags (Pid, PropertyFlags)
 
virtual Sid getPropertyStyle (Pid) const
 
bool readProperty (const QStringRef &, XmlReader &, Pid)
 
void readProperty (XmlReader &, Pid)
 
bool readStyledProperty (XmlReader &e, const QStringRef &tag)
 
virtual void readAddConnector (ConnectorInfoReader *info, bool pasteMode)
 
virtual void styleChanged ()
 
void undoChangeProperty (Pid id, const QVariant &)
 
void undoResetProperty (Pid id)
 
void undoPushProperty (Pid)
 
void writeProperty (XmlWriter &xml, Pid id) const
 
void writeStyledProperties (XmlWriter &) const
 
QList< ScoreElement * > linkList () const
 
void linkTo (ScoreElement *)
 
void unlink ()
 
bool isLinked (ScoreElement *)
 return true if se is different and linked to this element More...
 
virtual void undoUnlink ()
 
int lid () const
 
LinkedElementslinks () const
 
void setLinks (LinkedElements *le)
 
bool isNote () const
 
bool isRest () const
 
bool isChord () const
 
bool isBarLine () const
 
bool isArticulation () const
 
bool isFermata () const
 
bool isMarker () const
 
bool isClef () const
 
bool isKeySig () const
 
bool isTimeSig () const
 
bool isMeasure () const
 
bool isTempoText () const
 
bool isBreath () const
 
bool isHBox () const
 
bool isVBox () const
 
bool isTBox () const
 
bool isFBox () const
 
bool isTie () const
 
bool isSlur () const
 
bool isGlissando () const
 
bool isGlissandoSegment () const
 
bool isSystemDivider () const
 
bool isRehearsalMark () const
 
bool isHarmony () const
 
bool isVolta () const
 
bool isJump () const
 
bool isOttava () const
 
bool isLayoutBreak () const
 
bool isSegment () const
 
bool isTremolo () const
 
bool isSystem () const
 
bool isLyrics () const
 
bool isStem () const
 
bool isBeam () const
 
bool isHook () const
 
bool isStemSlash () const
 
bool isSlurSegment () const
 
bool isTieSegment () const
 
bool isSpacer () const
 
bool isStaffLines () const
 
bool isAmbitus () const
 
bool isBracket () const
 
bool isInstrumentChange () const
 
bool isStaffTypeChange () const
 
bool isHairpin () const
 
bool isHairpinSegment () const
 
bool isBend () const
 
bool isTremoloBar () const
 
bool isRepeatMeasure () const
 
bool isTuplet () const
 
bool isNoteDot () const
 
bool isDynamic () const
 
bool isInstrumentName () const
 
bool isAccidental () const
 
bool isTextLine () const
 
bool isTextLineSegment () const
 
bool isPedal () const
 
bool isPedalSegment () const
 
bool isOttavaSegment () const
 
bool isLedgerLine () const
 
bool isIcon () const
 
bool isVoltaSegment () const
 
bool isNoteLine () const
 
bool isTrill () const
 
bool isTrillSegment () const
 
bool isLetRing () const
 
bool isLetRingSegment () const
 
bool isVibrato () const
 
bool isPalmMute () const
 
bool isPalmMuteSegment () const
 
bool isVibratoSegment () const
 
bool isSymbol () const
 
bool isFSymbol () const
 
bool isFingering () const
 
bool isNoteHead () const
 
bool isLyricsLine () const
 
bool isLyricsLineSegment () const
 
bool isFiguredBass () const
 
bool isStaffState () const
 
bool isArpeggio () const
 
bool isImage () const
 
bool isChordLine () const
 
bool isFretDiagram () const
 
bool isPage () const
 
bool isText () const
 
bool isMeasureNumber () const
 
bool isStaffText () const
 
bool isSystemText () const
 
bool isBracketItem () const
 
bool isScore () const
 
bool isStaff () const
 
bool isPart () const
 
bool isBagpipeEmbellishment () const
 
bool isLasso () const
 
bool isSticking () const
 
bool isChordRest () const
 
bool isDurationElement () const
 
bool isSlurTieSegment () const
 
bool isSLineSegment () const
 
bool isBox () const
 
bool isVBoxBase () const
 
bool isMeasureBase () const
 
bool isTextBase () const
 
bool isTextLineBaseSegment () const
 
bool isLineSegment () const
 
bool isSpannerSegment () const
 
bool isBSymbol () const
 
bool isTextLineBase () const
 
bool isSLine () const
 
bool isSpanner () const
 
bool isStaffTextBase () const
 

Static Public Member Functions

static ClefType clefType (const QString &s)
 
- Static Public Member Functions inherited from Ms::Element
static ElementType readType (XmlReader &node, QPointF *, Fraction *)
 
static ElementreadMimeData (Score *score, const QByteArray &data, QPointF *, Fraction *)
 
static Ms::Elementcreate (Ms::ElementType type, Score *)
 
static Elementname2Element (const QStringRef &, Score *)
 
- Static Public Member Functions inherited from Ms::ScoreElement
static ElementType name2type (const QStringRef &, bool silent=false)
 
static ElementType name2type (const QString &s)
 
static const char * name (ElementType)
 

Private Attributes

SymId symId
 
bool _showCourtesy = true
 
bool _small = false
 
ClefTypeList _clefTypes { ClefType::INVALID }
 

Additional Inherited Members

- Public Types inherited from Ms::Element
enum  EditBehavior { EditBehavior::SelectOnly, EditBehavior::Edit }
 
- Public Attributes inherited from Ms::Element
bool itemDiscovered { false }
 helper flag for bsp More...
 
- Protected Member Functions inherited from Ms::ScoreElement
virtual int getPropertyFlagsIdx (Pid id) const
 
- Protected Attributes inherited from Ms::Element
int _z
 
QColor _color
 element color attribute More...
 
- Protected Attributes inherited from Ms::ScoreElement
const ElementStyle_elementStyle { &emptyStyle }
 
PropertyFlags_propertyFlagsList { 0 }
 
LinkedElements_links { 0 }
 

Detailed Description

Graphic representation of a clef.

Constructor & Destructor Documentation

◆ Clef()

Ms::Clef::Clef ( Score s)

Member Function Documentation

◆ acceptDrop()

bool Ms::Clef::acceptDrop ( EditData ) const
overridevirtual

Return true if this element accepts a drop at canvas relative pos of given element type and subtype.

Reimplemented by elements that accept drops. Used to change cursor shape while dragging to indicate drop targets.

generated() &&

Reimplemented from Ms::Element.

◆ accessibleInfo()

QString Ms::Clef::accessibleInfo ( ) const
overridevirtual

Reimplemented from Ms::Element.

◆ clear()

void Ms::Clef::clear ( )

◆ clefType() [1/2]

ClefType Ms::Clef::clefType ( const QString &  s)
static

◆ clefType() [2/2]

ClefType Ms::Clef::clefType ( ) const

◆ clefTypeList()

ClefTypeList Ms::Clef::clefTypeList ( ) const
inline

◆ clefTypeName()

const char * Ms::Clef::clefTypeName ( )

◆ clone()

virtual Clef* Ms::Clef::clone ( ) const
inlinevirtual

Implements Ms::Element.

◆ concertClef()

ClefType Ms::Clef::concertClef ( ) const
inline

◆ draw()

void Ms::Clef::draw ( QPainter *  painter) const
virtual

Reimplemented from Ms::Element.

◆ drop()

Element * Ms::Clef::drop ( EditData )
virtual

Handle a dropped element at canvas relative pos of given element type and subtype.

Returns dropped element if any. The ownership of element in DropData is transferred to the called element (if not used, element has to be deleted). The returned element will be selected if not in note edit mode.

Reimplemented by elements that accept drops.

Reimplemented from Ms::Element.

◆ getProperty()

QVariant Ms::Clef::getProperty ( Pid  propertyId) const
virtual

Reimplemented from Ms::Element.

◆ isEditable()

virtual bool Ms::Clef::isEditable ( ) const
inlinevirtual

Reimplemented from Ms::Element.

◆ layout()

void Ms::Clef::layout ( )
virtual

Reimplemented from Ms::Element.

◆ mag()

qreal Ms::Clef::mag ( ) const
virtual

Reimplemented from Ms::Element.

◆ measure()

Measure* Ms::Clef::measure ( ) const
inline

◆ nextSegmentElement()

Element * Ms::Clef::nextSegmentElement ( )
overridevirtual

Reimplemented from Ms::Element.

◆ otherClef()

Clef * Ms::Clef::otherClef ( )

◆ prevSegmentElement()

Element * Ms::Clef::prevSegmentElement ( )
overridevirtual

Reimplemented from Ms::Element.

◆ propertyDefault()

QVariant Ms::Clef::propertyDefault ( Pid  id) const
virtual

Reimplemented from Ms::Element.

◆ read()

void Ms::Clef::read ( XmlReader e)
virtual

Reimplemented from Ms::Element.

◆ segment()

Segment* Ms::Clef::segment ( ) const
inline

◆ setClefType() [1/3]

void Ms::Clef::setClefType ( ClefType  i)

◆ setClefType() [2/3]

void Ms::Clef::setClefType ( const QString &  s)

◆ setClefType() [3/3]

void Ms::Clef::setClefType ( const ClefTypeList ctl)
inline

◆ setConcertClef()

void Ms::Clef::setConcertClef ( ClefType  val)

◆ setProperty()

bool Ms::Clef::setProperty ( Pid  propertyId,
const QVariant &  v 
)
virtual

Reimplemented from Ms::Element.

◆ setShowCourtesy()

void Ms::Clef::setShowCourtesy ( bool  v)
inline

◆ setSmall()

void Ms::Clef::setSmall ( bool  val)

◆ setTransposingClef()

void Ms::Clef::setTransposingClef ( ClefType  val)

◆ showCourtesy()

bool Ms::Clef::showCourtesy ( ) const
inline

◆ small()

bool Ms::Clef::small ( ) const
inline

◆ spatiumChanged()

void Ms::Clef::spatiumChanged ( qreal  oldValue,
qreal  newValue 
)
overridevirtual

Reimplemented from Ms::Element.

◆ transposingClef()

ClefType Ms::Clef::transposingClef ( ) const
inline

◆ type()

virtual ElementType Ms::Clef::type ( ) const
inlinevirtual

Implements Ms::ScoreElement.

◆ undoSetShowCourtesy()

void Ms::Clef::undoSetShowCourtesy ( bool  v)

◆ write()

void Ms::Clef::write ( XmlWriter xml) const
virtual

Reimplemented from Ms::Element.

Member Data Documentation

◆ _clefTypes

ClefTypeList Ms::Clef::_clefTypes { ClefType::INVALID }
private

◆ _showCourtesy

bool Ms::Clef::_showCourtesy = true
private

◆ _small

bool Ms::Clef::_small = false
private

◆ symId

SymId Ms::Clef::symId
private

The documentation for this class was generated from the following files: