openshot-audio  0.1.7
Classes | Public Member Functions | List of all members
juce::MarkerList Class Reference

#include <juce_gui_basics.h>

Classes

class  Listener
 
class  Marker
 
class  ValueTreeWrapper
 

Public Member Functions

 MarkerList ()
 
 MarkerList (const MarkerList &)
 
MarkerListoperator= (const MarkerList &)
 
 ~MarkerList ()
 
int getNumMarkers () const noexcept
 
const MarkergetMarker (int index) const noexcept
 
const MarkergetMarker (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 ()
 

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().

Constructor & Destructor Documentation

◆ MarkerList() [1/2]

MarkerList::MarkerList ( )

Creates an empty marker list.

◆ MarkerList() [2/2]

MarkerList::MarkerList ( const MarkerList other)

Creates a copy of another marker list.

◆ ~MarkerList()

MarkerList::~MarkerList ( )

Destructor.

Member Function Documentation

◆ addListener()

void MarkerList::addListener ( Listener listener)

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

◆ getMarker() [1/2]

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

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

◆ getMarker() [2/2]

const MarkerList::Marker * 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.

◆ getMarkerPosition()

double 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 MarkerList::getNumMarkers ( ) const
noexcept

Returns the number of markers in the list.

◆ markersHaveChanged()

void MarkerList::markersHaveChanged ( )

Synchronously calls markersChanged() on all the registered listeners.

◆ operator!=()

bool MarkerList::operator!= ( const MarkerList other) const
noexcept

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

◆ operator=()

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

Copies another marker list to this one.

◆ operator==()

bool MarkerList::operator== ( const MarkerList other) const
noexcept

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

◆ removeListener()

void MarkerList::removeListener ( Listener listener)

Deregisters a previously-registered listener.

◆ removeMarker() [1/2]

void MarkerList::removeMarker ( int  index)

Deletes the marker at the given list index.

◆ removeMarker() [2/2]

void MarkerList::removeMarker ( const String name)

Deletes the marker with the given name.

◆ setMarker()

void 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.


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