OpenXLSX 1.9.1
Loading...
Searching...
No Matches
Public Member Functions
OpenXLSX::XLRichTextRun Class Reference

A class representing a single run of rich text. More...

#include <XLRichText.hpp>

Public Member Functions

 XLRichTextRun ()=default
 
 XLRichTextRun (const std::string &text)
 
const std::string & text () const
 
XLRichTextRun & setText (const std::string &text)
 
std::optional< std::string > fontName () const
 
XLRichTextRun & setFontName (const std::string &name)
 
std::optional< size_t > fontSize () const
 
XLRichTextRun & setFontSize (size_t size)
 
std::optional< XLColor > fontColor () const
 
XLRichTextRun & setFontColor (const XLColor &color)
 
std::optional< bool > bold () const
 
XLRichTextRun & setBold (bool bold=true)
 
std::optional< bool > italic () const
 
XLRichTextRun & setItalic (bool italic=true)
 
std::optional< bool > underline () const
 
XLRichTextRun & setUnderline (bool underline=true)
 
std::optional< XLUnderlineStyle > underlineStyle () const
 
XLRichTextRun & setUnderlineStyle (XLUnderlineStyle style)
 
std::optional< bool > strikethrough () const
 
XLRichTextRun & setStrikethrough (bool strikethrough=true)
 
std::optional< XLVerticalAlignRunStyle > vertAlign () const
 
XLRichTextRun & setVertAlign (XLVerticalAlignRunStyle align)
 
XLRichTextRun & setSuperscript (bool enable=true)
 
XLRichTextRun & setSubscript (bool enable=true)
 

Detailed Description

A class representing a single run of rich text.

Constructor & Destructor Documentation

◆ XLRichTextRun() [1/2]

OpenXLSX::XLRichTextRun::XLRichTextRun ( )
default

◆ XLRichTextRun() [2/2]

OpenXLSX::XLRichTextRun::XLRichTextRun ( const std::string &  text)
inlineexplicit

Member Function Documentation

◆ bold()

std::optional< bool > OpenXLSX::XLRichTextRun::bold ( ) const
inline

◆ fontColor()

std::optional< XLColor > OpenXLSX::XLRichTextRun::fontColor ( ) const
inline

◆ fontName()

std::optional< std::string > OpenXLSX::XLRichTextRun::fontName ( ) const
inline

◆ fontSize()

std::optional< size_t > OpenXLSX::XLRichTextRun::fontSize ( ) const
inline

◆ italic()

std::optional< bool > OpenXLSX::XLRichTextRun::italic ( ) const
inline

◆ setBold()

XLRichTextRun & OpenXLSX::XLRichTextRun::setBold ( bool  bold = true)
inline

◆ setFontColor()

XLRichTextRun & OpenXLSX::XLRichTextRun::setFontColor ( const XLColor &  color)
inline

◆ setFontName()

XLRichTextRun & OpenXLSX::XLRichTextRun::setFontName ( const std::string &  name)
inline

◆ setFontSize()

XLRichTextRun & OpenXLSX::XLRichTextRun::setFontSize ( size_t  size)
inline

◆ setItalic()

XLRichTextRun & OpenXLSX::XLRichTextRun::setItalic ( bool  italic = true)
inline

◆ setStrikethrough()

XLRichTextRun & OpenXLSX::XLRichTextRun::setStrikethrough ( bool  strikethrough = true)
inline

◆ setSubscript()

XLRichTextRun & OpenXLSX::XLRichTextRun::setSubscript ( bool  enable = true)
inline

◆ setSuperscript()

XLRichTextRun & OpenXLSX::XLRichTextRun::setSuperscript ( bool  enable = true)
inline

◆ setText()

XLRichTextRun & OpenXLSX::XLRichTextRun::setText ( const std::string &  text)
inline

◆ setUnderline()

XLRichTextRun & OpenXLSX::XLRichTextRun::setUnderline ( bool  underline = true)
inline

◆ setUnderlineStyle()

XLRichTextRun & OpenXLSX::XLRichTextRun::setUnderlineStyle ( XLUnderlineStyle  style)
inline

◆ setVertAlign()

XLRichTextRun & OpenXLSX::XLRichTextRun::setVertAlign ( XLVerticalAlignRunStyle  align)
inline

◆ strikethrough()

std::optional< bool > OpenXLSX::XLRichTextRun::strikethrough ( ) const
inline

◆ text()

const std::string & OpenXLSX::XLRichTextRun::text ( ) const
inline

◆ underline()

std::optional< bool > OpenXLSX::XLRichTextRun::underline ( ) const
inline

◆ underlineStyle()

std::optional< XLUnderlineStyle > OpenXLSX::XLRichTextRun::underlineStyle ( ) const
inline

◆ vertAlign()

std::optional< XLVerticalAlignRunStyle > OpenXLSX::XLRichTextRun::vertAlign ( ) const
inline
The documentation for this class was generated from the following file: