JUCE: ARADocumentListener Class Reference

JUCE

Public Member Functions | List of all members
ARADocumentListener Class Reference
juce_audio_processors » utilities

A base class for listeners that want to know about changes to an ARADocument object. More...

`#include <juce_ARAModelObjects.h>`

Inheritance diagram for ARADocumentListener:

## Public Member Functions
virtual | ~ARADocumentListener ()=default
| Destructor. More...
virtual ARA_DISABLE_UNREFERENCED_PARAMETER_WARNING_BEGIN void | willBeginEditing (ARADocument *document)
| Called before the document enters an editing state. More...
virtual void | didEndEditing (ARADocument *document)
| Called after the document exits an editing state. More...
virtual void | willNotifyModelUpdates (ARADocument *document)
| Called before sending model updates do the host. More...
virtual void | didNotifyModelUpdates (ARADocument *document)
| Called after sending model updates do the host. More...
virtual void | willUpdateDocumentProperties (ARADocument *document, ARA::PlugIn::PropertiesPtr< ARA::ARADocumentProperties > newProperties)
| Called before the document's properties are updated. More...
virtual void | didUpdateDocumentProperties (ARADocument *document)
| Called after the document's properties are updated. More...
virtual void | didAddMusicalContextToDocument (ARADocument *document, ARAMusicalContext *musicalContext)
| Called after a musical context is added to the document. More...
virtual void | willRemoveMusicalContextFromDocument (ARADocument *document, ARAMusicalContext *musicalContext)
| Called before a musical context is removed from the document. More...
virtual void | didReorderMusicalContextsInDocument (ARADocument *document)
| Called after the musical contexts are reordered in an ARA document. More...
virtual void | didAddRegionSequenceToDocument (ARADocument *document, ARARegionSequence *regionSequence)
| Called after a region sequence is added to the document. More...
virtual void | willRemoveRegionSequenceFromDocument (ARADocument *document, ARARegionSequence *regionSequence)
| Called before a region sequence is removed from the document. More...
virtual void | didReorderRegionSequencesInDocument (ARADocument *document)
| Called after the region sequences are reordered in an ARA document. More...
virtual void | didAddAudioSourceToDocument (ARADocument *document, ARAAudioSource *audioSource)
| Called after an audio source is added to the document. More...
virtual void | willRemoveAudioSourceFromDocument (ARADocument *document, ARAAudioSource *audioSource)
| Called before an audio source is removed from the document. More...
virtual void | willDestroyDocument (ARADocument *document)
| Called before the document is destroyed by the ARA host. More...

## Detailed Description

A base class for listeners that want to know about changes to an ARADocument object.

Use ARADocument::addListener() to register your listener with an ARADocument.

## Constructor & Destructor Documentation

## ◆ ~ARADocumentListener()

virtual ARADocumentListener::~ARADocumentListener | ( |  | ) |
| virtualdefault

Destructor.

## Member Function Documentation

## ◆ willBeginEditing()

virtual ARA_DISABLE_UNREFERENCED_PARAMETER_WARNING_BEGIN void ARADocumentListener::willBeginEditing | ( | ARADocument * | document | ) |
| virtual

Called before the document enters an editing state.

Parameters

  document | The document about to enter an editing state.

References ignoreUnused().

## ◆ didEndEditing()

virtual void ARADocumentListener::didEndEditing | ( | ARADocument * | document | ) |
| virtual

Called after the document exits an editing state.

Parameters

  document | The document about exit an editing state.

References ignoreUnused().

## ◆ willNotifyModelUpdates()

virtual void ARADocumentListener::willNotifyModelUpdates | ( | ARADocument * | document | ) |
| virtual

Called before sending model updates do the host.

Parameters

  document | The document whose model updates are about to be sent.

References ignoreUnused().

## ◆ didNotifyModelUpdates()

virtual void ARADocumentListener::didNotifyModelUpdates | ( | ARADocument * | document | ) |
| virtual

Called after sending model updates do the host.

Parameters

  document | The document whose model updates have just been sent.

References ignoreUnused().

## ◆ willUpdateDocumentProperties()

virtual void ARADocumentListener::willUpdateDocumentProperties | ( | ARADocument * | document,
|  | ARA::PlugIn::PropertiesPtr< ARA::ARADocumentProperties > | newProperties
| ) |  |
| virtual

Called before the document's properties are updated.

Parameters

  document | The document whose properties will be updated.
  newProperties | The document properties that will be assigned to `document`.

References ignoreUnused().

## ◆ didUpdateDocumentProperties()

virtual void ARADocumentListener::didUpdateDocumentProperties | ( | ARADocument * | document | ) |
| virtual

Called after the document's properties are updated.

Parameters

  document | The document whose properties were updated.

References ignoreUnused().

## ◆ didAddMusicalContextToDocument()

virtual void ARADocumentListener::didAddMusicalContextToDocument | ( | ARADocument * | document,
|  | ARAMusicalContext * | musicalContext
| ) |  |
| virtual

Called after a musical context is added to the document.

Parameters

  document | The document that `musicalContext` was added to.
  musicalContext | The musical context that was added to `document`.

References ignoreUnused().

## ◆ willRemoveMusicalContextFromDocument()

virtual void ARADocumentListener::willRemoveMusicalContextFromDocument | ( | ARADocument * | document,
|  | ARAMusicalContext * | musicalContext
| ) |  |
| virtual

Called before a musical context is removed from the document.

Parameters

  document | The document that `musicalContext` will be removed from.
  musicalContext | The musical context that will be removed from `document`.

References ignoreUnused().

## ◆ didReorderMusicalContextsInDocument()

virtual void ARADocumentListener::didReorderMusicalContextsInDocument | ( | ARADocument * | document | ) |
| virtual

Called after the musical contexts are reordered in an ARA document.

Musical contexts are sorted by their order index - this callback signals a change in this ordering within the document.

Parameters

  document | The document with reordered musical contexts.

References ignoreUnused().

## ◆ didAddRegionSequenceToDocument()

virtual void ARADocumentListener::didAddRegionSequenceToDocument | ( | ARADocument * | document,
|  | ARARegionSequence * | regionSequence
| ) |  |
| virtual

Called after a region sequence is added to the document.

Parameters

  document | The document that `regionSequence` was added to.
  regionSequence | The region sequence that was added to `document`.

References ignoreUnused().

## ◆ willRemoveRegionSequenceFromDocument()

virtual void ARADocumentListener::willRemoveRegionSequenceFromDocument | ( | ARADocument * | document,
|  | ARARegionSequence * | regionSequence
| ) |  |
| virtual

Called before a region sequence is removed from the document.

Parameters

  document | The document that `regionSequence` will be removed from.
  regionSequence | The region sequence that will be removed from `document`.

References ignoreUnused().

## ◆ didReorderRegionSequencesInDocument()

virtual void ARADocumentListener::didReorderRegionSequencesInDocument | ( | ARADocument * | document | ) |
| virtual

Called after the region sequences are reordered in an ARA document.

Region sequences are sorted by their order index - this callback signals a change in this ordering within the document.

Parameters

  document | The document with reordered region sequences.

References ignoreUnused().

## ◆ didAddAudioSourceToDocument()

virtual void ARADocumentListener::didAddAudioSourceToDocument | ( | ARADocument * | document,
|  | ARAAudioSource * | audioSource
| ) |  |
| virtual

Called after an audio source is added to the document.

Parameters

  document | The document that `audioSource` was added to.
  audioSource | The audio source that was added to `document`.

References ignoreUnused().

## ◆ willRemoveAudioSourceFromDocument()

virtual void ARADocumentListener::willRemoveAudioSourceFromDocument | ( | ARADocument * | document,
|  | ARAAudioSource * | audioSource
| ) |  |
| virtual

Called before an audio source is removed from the document.

Parameters

  document | The document that `audioSource` will be removed from .
  audioSource | The audio source that will be removed from `document`.

References ignoreUnused().

## ◆ willDestroyDocument()

virtual void ARADocumentListener::willDestroyDocument | ( | ARADocument * | document | ) |
| virtual

Called before the document is destroyed by the ARA host.

Parameters

  document | The document that will be destroyed.

References ignoreUnused().

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

- juce_ARAModelObjects.h