Verovio
Source code documentation
vrv::TextListInterface Class Reference

This class is an pseudo interface for elements maintaining a flat list of children LayerElement for processing. More...

#include <object.h>

Inheritance diagram for vrv::TextListInterface:
vrv::ObjectListInterface vrv::Annot vrv::CpMark vrv::Dir vrv::Dynam vrv::Harm vrv::Label vrv::LabelAbbr vrv::MNum vrv::Ornam vrv::RepeatMark vrv::Syl

Public Member Functions

std::u32string GetText () const
 Returns a contatenated version of all the text children.
 
void GetTextLines (std::vector< std::u32string > &lines) const
 Fill an array of lines with concatenated content of each line.
 
- Public Member Functions inherited from vrv::ObjectListInterface
 ObjectListInterface (const ObjectListInterface &listInterface)
 
ObjectListInterface & operator= (const ObjectListInterface &listInterface)
 
int GetListIndex (const Object *listElement) const
 Look for the Object in the list and return its position (-1 if not found)
 
void ResetList () const
 Reset the list of children and call FilterList().
 
const Object * GetListFirst (const Object *startFrom, const ClassId classId=UNSPECIFIED) const
 Gets the first item of type elementType starting at startFrom.
 
Object * GetListFirst (const Object *startFrom, const ClassId classId=UNSPECIFIED)
 
const Object * GetListFirstBackward (const Object *startFrom, const ClassId classId=UNSPECIFIED) const
 
Object * GetListFirstBackward (const Object *startFrom, const ClassId classId=UNSPECIFIED)
 
const Object * GetListPrevious (const Object *listElement) const
 Returns the previous object in the list (NULL if not found)
 
Object * GetListPrevious (const Object *listElement)
 
const Object * GetListNext (const Object *listElement) const
 Returns the next object in the list (NULL if not found)
 
Object * GetListNext (const Object *listElement)
 
const ListOfConstObjects & GetList () const
 Return the list. More...
 
ListOfObjects GetList ()
 
bool HasEmptyList () const
 Convenience functions that check if the list is up-to-date If not, the list is updated before returning the result.
 
int GetListSize () const
 
const Object * GetListFront () const
 
Object * GetListFront ()
 
const Object * GetListBack () const
 
Object * GetListBack ()
 

Protected Member Functions

void FilterList (ListOfConstObjects &childList) const override
 Filter the list for a specific class. More...
 

Detailed Description

This class is an pseudo interface for elements maintaining a flat list of children LayerElement for processing.

The list is a flatten list of pointers to children elements. It is not an abstract class but should not be instanciate directly.

Member Function Documentation

◆ FilterList()

void vrv::TextListInterface::FilterList ( ListOfConstObjects &  childList) const
overrideprotectedvirtual

Filter the list for a specific class.

For example, keep only notes in Beam

Reimplemented from vrv::ObjectListInterface.


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