sciplot  0.3.1
A modern C++ plotting library powered by gnuplot
TextSpecsOf< DerivedSpecs > Class Template Reference

The class used to attach text options to a type. More...

#include <TextSpecsOf.hpp>

Inheritance diagram for TextSpecsOf< DerivedSpecs >:
[legend]
Collaboration diagram for TextSpecsOf< DerivedSpecs >:
[legend]

Public Member Functions

 TextSpecsOf ()
 Construct a default TextSpecsOf instance.
 
auto textColor (std::string color) -> DerivedSpecs &
 Set the color of the text (e.g., "blue", "#404040")
 
auto enhanced (bool value=true) -> DerivedSpecs &
 Set the enhanced mode of the text. More...
 
auto repr () const -> std::string
 Convert this TextSpecsOf object into a gnuplot formatted string.
 
- Public Member Functions inherited from FontSpecsOf< DerivedSpecs >
 FontSpecsOf ()
 Construct a default FontSpecsOf instance.
 
auto fontName (std::string name) -> DerivedSpecs &
 Set the name of the font (e.g., Helvetica, Georgia, Times).
 
auto fontSize (std::size_t size) -> DerivedSpecs &
 Set the point size of the font (e.g., 10, 12, 16).
 
- Public Member Functions inherited from Specs< DerivedSpecs >
virtual ~Specs ()=default
 Pure virtual destructor (this class is an abstract base class).
 
 operator std::string () const
 Return a string representation of this object of some class that derives from specs.
 
auto derived () -> DerivedSpecs &
 Return a reference to the specs object of class derived from this.
 
auto derived () const -> const DerivedSpecs &
 Return a const reference to the specs object of class derived from this.
 

Detailed Description

template<typename DerivedSpecs>
class sciplot::TextSpecsOf< DerivedSpecs >

The class used to attach text options to a type.

Member Function Documentation

◆ enhanced()

auto enhanced ( bool  value = true) -> DerivedSpecs&

Set the enhanced mode of the text.

The enhanced text mode allows superscript text to be represented as a^x, subscript text with a_x, and combined superscript and subscript text with a@^b_{cd}. For more details, read "Enhanced text mode" section of the Gnuplot manual.


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