juce::MarkerList Class Reference

#include <juce_MarkerList.h>

Classes
class	Marker
class	Listener
struct	MarkerListHolder
class	ValueTreeWrapper

Public Member Functions
	MarkerList ()
	MarkerList (const MarkerList &)
MarkerList &	operator= (const MarkerList &)
	~MarkerList ()
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
void	addListener (Listener *listener)
void	removeListener (Listener *listener)
void	markersHaveChanged ()

Private Member Functions
Marker *	getMarkerByName (const String &name) const noexcept

Private Attributes
OwnedArray< Marker >	markers
ListenerList< Listener >	listeners

Detailed Description

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.

See also

Component::getMarkers().

@tags{GUI}

Constructor & Destructor Documentation

MarkerList() [1/2]

juce::MarkerList::MarkerList

(

)

Creates an empty marker list.

MarkerList() [2/2]

juce::MarkerList::MarkerList

(

const MarkerList &

other

)

Creates a copy of another marker list.

~MarkerList()

juce::MarkerList::~MarkerList

(

)

Destructor.

Member Function Documentation

addListener()

void juce::MarkerList::addListener

(

Listener *

listener

)

Registers a listener that will be called when the markers are changed.

getMarker() [1/2]

const MarkerList::Marker * juce::MarkerList::getMarker ( const String & name ) const

noexcept

Returns a named marker, or nullptr if no such name is found. Note that name comparisons are case-sensitive.

getMarker() [2/2]

const MarkerList::Marker * juce::MarkerList::getMarker ( int index ) const

noexcept

Returns one of the markers in the list, by its index.

getMarkerByName()

MarkerList::Marker * juce::MarkerList::getMarkerByName ( const String & name ) const

privatenoexcept

getMarkerPosition()

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.

getNumMarkers()

int juce::MarkerList::getNumMarkers ( ) const

noexcept

Returns the number of markers in the list.

markersHaveChanged()

void juce::MarkerList::markersHaveChanged

(

)

Synchronously calls markersChanged() on all the registered listeners.

operator!=()

bool juce::MarkerList::operator!= ( const MarkerList & other ) const

noexcept

Returns true if not all the markers in these two lists match exactly.

operator=()

MarkerList & juce::MarkerList::operator=

(

const MarkerList &

other

)

Copies another marker list to this one.

operator==()

bool juce::MarkerList::operator== ( const MarkerList & other ) const

noexcept

Returns true if all the markers in these two lists match exactly.

removeListener()

void juce::MarkerList::removeListener

(

Listener *

listener

)

Deregisters a previously-registered listener.

removeMarker() [1/2]

void juce::MarkerList::removeMarker

(

const String &

name

)

Deletes the marker with the given name.

removeMarker() [2/2]

void juce::MarkerList::removeMarker

(

int

index

)

Deletes the marker at the given list index.

setMarker()

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.

Member Data Documentation

listeners

ListenerList<Listener> juce::MarkerList::listeners

private

markers

OwnedArray<Marker> juce::MarkerList::markers

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/positioning/juce_MarkerList.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/positioning/juce_MarkerList.cpp