Canorus 0.0
Public Member Functions | Private Attributes | List of all members
CABookMark Class Reference

A bookmark shortcut. More...

#include <bookmark.h>

Inheritance diagram for CABookMark:
Inheritance graph
[legend]

Public Member Functions

 CABookMark (const QString text, CAMusElement *m)
 
virtual ~CABookMark ()
 
const QString text ()
 
void setText (const QString t)
 
CABookMark * clone (CAMusElement *elt=0)
 
int compare (CAMusElement *elt)
 
- Public Member Functions inherited from CAMark
 CAMark (CAMarkType type, CAMusElement *associatedElt, int timeStart=-1, int timeLength=-1)
 
 CAMark (CAMarkType type, CAContext *context, int timeStart, int timeLength)
 
virtual ~CAMark ()
 
virtual CAMark * clone (CAContext *context)
 
virtual CAMark * clone (CAMusElement *elt=0)
 
virtual int compare (CAMusElement *elt)
 
CAMusElement * associatedElement ()
 
void setAssociatedElement (CAMusElement *elt)
 
CAMarkType markType ()
 
void setMarkType (CAMarkType type)
 
bool isCommon ()
 
- Public Member Functions inherited from CAMusElement
 CAMusElement (CAContext *context, int timeStart, int timeLength=0)
 
virtual ~CAMusElement ()
 
virtual CAMusElement * clone (CAContext *context=0)=0
 
virtual int compare (CAMusElement *elt)=0
 
CAMusElementType musElementType ()
 
CAContext * context ()
 
void setContext (CAContext *context)
 
virtual int timeStart () const
 
void setTimeStart (int time)
 
virtual int timeLength () const
 
void setTimeLength (int length)
 
int timeEnd ()
 
virtual int realTimeStart ()
 
virtual int realTimeLength ()
 
int realTimeEnd ()
 
const QString name ()
 
void setName (const QString name)
 
const bool isVisible ()
 
void setVisible (const bool v)
 
const QColor color ()
 
void setColor (const QColor c)
 
const QList< CAMark * > markList ()
 
void addMark (CAMark *mark)
 
void addMarks (QList< CAMark * > marks)
 
void removeMark (CAMark *mark)
 
const QList< CANoteCheckerError * > & noteCheckerErrorList ()
 
void addNoteCheckerError (CANoteCheckerError *nce)
 
void removeNoteCheckerError (CANoteCheckerError *nce)
 
bool isPlayable ()
 

Private Attributes

QString _text
 

Additional Inherited Members

- Public Types inherited from CAMark
enum  CAMarkType {
  Undefined = -1 , Text , Tempo , Ritardando ,
  Dynamic , Crescendo , Pedal , InstrumentChange ,
  BookMark , RehersalMark , Fermata , RepeatMark ,
  Articulation , Fingering
}
 
- Public Types inherited from CAMusElement
enum  CAMusElementType {
  Undefined = 0 , Note , Rest , MidiNote ,
  Barline , Clef , TimeSignature , KeySignature ,
  Slur , Tuplet , Syllable , FunctionMark ,
  FiguredBassMark , Mark
}
 
- Static Public Member Functions inherited from CAMark
static const QString markTypeToString (CAMarkType t)
 
static CAMarkType markTypeFromString (const QString s)
 
- Static Public Member Functions inherited from CAMusElement
static const QString musElementTypeToString (CAMusElementType)
 
static CAMusElementType musElementTypeFromString (const QString)
 
- Protected Member Functions inherited from CAMark
void setCommon (bool c)
 
- Protected Member Functions inherited from CAMusElement
void setMusElementType (CAMusElementType type)
 
- Protected Attributes inherited from CAMusElement
CAMusElementType _musElementType
 
QList< CAMark * > _markList
 
QList< CANoteCheckerError * > _noteCheckerErrorList
 
CAContext * _context
 
int _timeStart
 
int _timeLength
 
bool _visible
 
QColor _color
 
QString _name
 

Detailed Description

A bookmark shortcut.

Copyright (c) 2007, Matevž Jekovec, Canorus development team All Rights Reserved. See AUTHORS for a complete list of authors.

Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.GPL for details.

Copyright (c) 2007, Matevž Jekovec, Canorus development team All Rights Reserved. See AUTHORS for a complete list of authors.

Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.GPL for details.

Arbitrary text above or below any element with a shortcut key.

Constructor & Destructor Documentation

◆ CABookMark()

CABookMark::CABookMark ( const QString  text,
CAMusElement *  m 
)

References setText().

Referenced by clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~CABookMark()

CABookMark::~CABookMark ( )
virtual

Member Function Documentation

◆ clone()

CABookMark * CABookMark::clone ( CAMusElement *  elt = 0)
virtual

Reimplemented from CAMark.

References CABookMark(), and text().

Here is the call graph for this function:

◆ compare()

int CABookMark::compare ( CAMusElement *  elt)
virtual

Compares the music element with the given elt and returns number of differences in their properties. Returns 0, if the music elements are exact; -1 if the music element type differs; otherwise number greater than 0.

This method is usually used when opening a score document where music elements are written in various voices (eg. barlines), but are eventually merged and written only once per staff.

Reimplemented from CAMark.

References CAMark::BookMark, CAMusElement::Mark, CAMark::markType(), CAMusElement::musElementType(), and text().

Here is the call graph for this function:

◆ setText()

void CABookMark::setText ( const QString  t)
inline

References _text.

Referenced by CABookMark().

Here is the caller graph for this function:

◆ text()

const QString CABookMark::text ( )
inline

References _text.

Referenced by clone(), compare(), and CACanorusMLExport::exportMarks().

Here is the caller graph for this function:

Member Data Documentation

◆ _text

QString CABookMark::_text
private

Referenced by setText(), and text().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.3