.. _moduleEditorial:

music21.editorial
=================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.editorial

Editorial
---------

.. autoclass:: music21.editorial.Editorial

.. rubric:: :class:`~music21.editorial.Editorial` bases

- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.editorial.Editorial` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.editorial.Editorial` methods

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.editorial.Editorial` instance variables

.. attribute:: Editorial.comments

	
	a list of :class:`~music21.editorial.Comment` objects that represent any comments
	about the object.
	

.. attribute:: Editorial.ficta

	a :class:`~music21.pitch.Accidental` object that specifies musica
	ficta for the note.  Will only be displayed in LilyPond and then only if
	there is no Accidental object on the note itself

.. attribute:: Editorial.footnotes

	
	a list of :class:`~music21.editorial.Comment` objects that represent annotations
	for the object.  These have specific meanings in MusicXML.
	

.. attribute:: Editorial.harmonicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the harmonic interval between this object and a single other object, or None
	(useful for storing information post analysis)

.. attribute:: Editorial.melodicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the melodic interval to the next object in this Part/Voice/Stream, etc.

.. attribute:: Editorial.misc

	
	DEPRECATED! To be removed in v.7.
	
	A dict to hold anything you might like to store.
	
	Note that this is deprecated since editorials subclass dict objects, therefore
	they can be used for anything else without needing the "misc" attribute.
	

Comment
-------

.. autoclass:: music21.editorial.Comment

.. rubric:: :class:`~music21.editorial.Comment` bases

- :class:`~music21.prebase.ProtoM21Object`
- :class:`~music21.style.StyleMixin`
- :class:`~music21.common.objects.SlottedObjectMixin`

.. rubric:: :class:`~music21.editorial.Comment` read-only properties

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

Read-only properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.hasEditorialInformation`
   - :attr:`~music21.style.StyleMixin.hasStyleInformation`

.. rubric:: :class:`~music21.editorial.Comment` read/write properties

Read/write properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.editorial`
   - :attr:`~music21.style.StyleMixin.style`

.. rubric:: :class:`~music21.editorial.Comment` methods

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`
