juce_MarkerList.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  MarkerList
{
public:
    //==============================================================================
    MarkerList();
    MarkerList (const MarkerList&);
    MarkerList& operator= (const MarkerList&);
    ~MarkerList();
 
    //==============================================================================
    class JUCE_API  Marker
    {
    public:
        Marker (const Marker&);
        Marker (const String& name, const RelativeCoordinate& position);

        String name;

        RelativeCoordinate position;

        bool operator== (const Marker&) const noexcept;
        bool operator!= (const Marker&) const noexcept;
    };
 
    //==============================================================================
    int getNumMarkers() const noexcept;

    const Marker* getMarker (int index) const noexcept;

    const Marker* getMarker (const String& name) const noexcept;

    double getMarkerPosition (const Marker& marker, Component* parentComponent) const;

    void setMarker (const String& name, const RelativeCoordinate& position);

    void removeMarker (int index);

    void removeMarker (const String& name);

    bool operator== (const MarkerList&) const noexcept;
    bool operator!= (const MarkerList&) const noexcept;
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        virtual ~Listener() = default;

        virtual void markersChanged (MarkerList* markerList) = 0;

        virtual void markerListBeingDeleted (MarkerList* markerList);
    };

    void addListener (Listener* listener);

    void removeListener (Listener* listener);

    void markersHaveChanged();
 
    //==============================================================================
    struct MarkerListHolder
    {
        virtual ~MarkerListHolder() = default;

        virtual MarkerList* getMarkers (bool xAxis) = 0;
    };
 
    //==============================================================================
    class ValueTreeWrapper
    {
    public:
        ValueTreeWrapper (const ValueTree& state);
 
        ValueTree& getState() noexcept      { return state; }
        int getNumMarkers() const;
        ValueTree getMarkerState (int index) const;
        ValueTree getMarkerState (const String& name) const;
        bool containsMarker (const ValueTree& state) const;
        MarkerList::Marker getMarker (const ValueTree& state) const;
        void setMarker (const MarkerList::Marker& marker, UndoManager* undoManager);
        void removeMarker (const ValueTree& state, UndoManager* undoManager);
 
        void applyTo (MarkerList& markerList);
        void readFrom (const MarkerList& markerList, UndoManager* undoManager);
 
        static const Identifier markerTag, nameProperty, posProperty;
 
    private:
        ValueTree state;
    };
 
private:
    //==============================================================================
    OwnedArray<Marker> markers;
    ListenerList<Listener> listeners;
 
    Marker* getMarkerByName (const String& name) const noexcept;
 
    JUCE_LEAK_DETECTOR (MarkerList)
};
 
} // namespace juce