Holds a set of named marker points along a one-dimensional axis. More...
#include <juce_MarkerList.h>
Classes | |
class | Listener |
A class for receiving events when changes are made to a MarkerList. More... | |
class | Marker |
Represents a marker in a MarkerList. More... | |
struct | MarkerListHolder |
A base class for objects that want to provide a MarkerList. More... | |
class | ValueTreeWrapper |
Forms a wrapper around a ValueTree that can be used for storing a MarkerList. More... | |
Public Member Functions | |
MarkerList () | |
Creates an empty marker list. More... | |
MarkerList (const MarkerList &) | |
Creates a copy of another marker list. More... | |
~MarkerList () | |
Destructor. More... | |
void | addListener (Listener *listener) |
Registers a listener that will be called when the markers are changed. More... | |
const Marker * | getMarker (const String &name) const noexcept |
Returns a named marker, or nullptr if no such name is found. More... | |
const Marker * | getMarker (int index) const noexcept |
Returns one of the markers in the list, by its index. More... | |
double | getMarkerPosition (const Marker &marker, Component *parentComponent) const |
Evaluates the given marker and returns its absolute position. More... | |
int | getNumMarkers () const noexcept |
Returns the number of markers in the list. More... | |
void | markersHaveChanged () |
Synchronously calls markersChanged() on all the registered listeners. More... | |
bool | operator!= (const MarkerList &) const noexcept |
Returns true if not all the markers in these two lists match exactly. More... | |
MarkerList & | operator= (const MarkerList &) |
Copies another marker list to this one. More... | |
bool | operator== (const MarkerList &) const noexcept |
Returns true if all the markers in these two lists match exactly. More... | |
void | removeListener (Listener *listener) |
Deregisters a previously-registered listener. More... | |
void | removeMarker (const String &name) |
Deletes the marker with the given name. More... | |
void | removeMarker (int index) |
Deletes the marker at the given list index. More... | |
void | setMarker (const String &name, const RelativeCoordinate &position) |
Sets the position of a marker. More... | |
Private Member Functions | |
Marker * | getMarkerByName (const String &name) const noexcept |
Private Attributes | |
ListenerList< Listener > | listeners |
OwnedArray< Marker > | markers |
Holds a set of named marker points along a one-dimensional axis.
This class is used to store sets of X and Y marker points in components.
@tags{GUI}
juce::MarkerList::MarkerList | ( | ) |
Creates an empty marker list.
juce::MarkerList::MarkerList | ( | const MarkerList & | ) |
Creates a copy of another marker list.
juce::MarkerList::~MarkerList | ( | ) |
Destructor.
void juce::MarkerList::addListener | ( | Listener * | listener | ) |
Registers a listener that will be called when the markers are changed.
Returns a named marker, or nullptr if no such name is found.
Note that name comparisons are case-sensitive.
Returns one of the markers in the list, by its index.
double juce::MarkerList::getMarkerPosition | ( | const Marker & | marker, |
Component * | parentComponent | ||
) | const |
Evaluates the given marker and returns its absolute position.
The parent component must be supplied in case the marker's expression refers to the size of its parent component.
|
noexcept |
Returns the number of markers in the list.
void juce::MarkerList::markersHaveChanged | ( | ) |
Synchronously calls markersChanged() on all the registered listeners.
|
noexcept |
Returns true if not all the markers in these two lists match exactly.
MarkerList& juce::MarkerList::operator= | ( | const MarkerList & | ) |
Copies another marker list to this one.
|
noexcept |
Returns true if all the markers in these two lists match exactly.
void juce::MarkerList::removeListener | ( | Listener * | listener | ) |
Deregisters a previously-registered listener.
void juce::MarkerList::removeMarker | ( | const String & | name | ) |
Deletes the marker with the given name.
void juce::MarkerList::removeMarker | ( | int | index | ) |
Deletes the marker at the given list index.
void juce::MarkerList::setMarker | ( | const String & | name, |
const RelativeCoordinate & | position | ||
) |
Sets the position of a marker.
If the name already exists, then the existing marker is moved; if it doesn't exist, then a new marker is added.
|
private |
|
private |