Verovio
Source code documentation
vrv::Option Class Referenceabstract

This class is a base class of each styling parameter. More...

#include <options.h>

Inheritance diagram for vrv::Option:
vrv::OptionArray vrv::OptionBool vrv::OptionDbl vrv::OptionInt vrv::OptionIntMap vrv::OptionJson vrv::OptionStaffrel vrv::OptionString

Public Member Functions

virtual void CopyTo (Option *option)=0
 
void SetKey (const std::string &key)
 
std::string GetKey () const
 
virtual bool SetValueBool (bool value)
 
virtual bool SetValueDbl (double value)
 
virtual bool SetValueArray (const std::vector< std::string > &values)
 
virtual bool SetValue (const std::string &value)
 
virtual std::string GetStrValue () const =0
 
virtual std::string GetDefaultStrValue () const =0
 
virtual void Reset ()=0
 
virtual bool IsSet () const =0
 
void SetInfo (const std::string &title, const std::string &description)
 
std::string GetTitle () const
 
std::string GetDescription () const
 
void SetShortOption (char shortOption, bool isCmdOnly)
 
char GetShortOption () const
 
bool IsCmdOnly () const
 
virtual bool IsArgumentRequired () const
 
jsonxx::Object ToJson () const
 Return a JSON object for the option.
 

Static Public Attributes

static const std::map< int, std::string > s_breaks
 Static maps used my OptionIntMap objects. More...
 
static const std::map< int, std::string > s_condense
 
static const std::map< int, std::string > s_durationEq
 
static const std::map< int, std::string > s_elision
 
static const std::map< int, std::string > s_fontFallback
 
static const std::map< int, std::string > s_footer
 
static const std::map< int, std::string > s_header
 
static const std::map< int, std::string > s_ligatureOblique
 
static const std::map< int, std::string > s_multiRestStyle
 
static const std::map< int, std::string > s_pedalStyle
 
static const std::map< int, std::string > s_systemDivider
 
static const std::map< int, std::string > s_smuflTextFont
 

Protected Attributes

std::string m_title
 
std::string m_description
 

Detailed Description

This class is a base class of each styling parameter.

Member Data Documentation

◆ s_breaks

const std::map<int, std::string> vrv::Option::s_breaks
static

Static maps used my OptionIntMap objects.

Set in OptIntMap::Init


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