Orcus
Loading...
Searching...
No Matches
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_font_style Class Referenceabstract

#include <import_interface_styles.hpp>

Public Member Functions

virtual void set_bold (bool b)=0
 
virtual void set_bold_asian (bool b)=0
 
virtual void set_bold_complex (bool b)=0
 
virtual void set_italic (bool b)=0
 
virtual void set_italic_asian (bool b)=0
 
virtual void set_italic_complex (bool b)=0
 
virtual void set_name (std::string_view s)=0
 
virtual void set_name_asian (std::string_view s)=0
 
virtual void set_name_complex (std::string_view s)=0
 
virtual void set_size (double point)=0
 
virtual void set_size_asian (double point)=0
 
virtual void set_size_complex (double point)=0
 
virtual void set_underline (underline_t e)=0
 
virtual void set_underline_width (underline_width_t e)=0
 
virtual void set_underline_mode (underline_mode_t e)=0
 
virtual void set_underline_type (underline_type_t e)=0
 
virtual void set_underline_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_strikethrough_style (strikethrough_style_t s)=0
 
virtual void set_strikethrough_type (strikethrough_type_t s)=0
 
virtual void set_strikethrough_width (strikethrough_width_t s)=0
 
virtual void set_strikethrough_text (strikethrough_text_t s)=0
 
virtual std::size_t commit ()=0
 

Detailed Description

Interface for importing font style items. The following font style properties store different values for western, asian and complex scripts:

Member Function Documentation

◆ commit()

virtual std::size_t orcus::spreadsheet::iface::import_font_style::commit ( )
pure virtual

Commit the font style in the current buffer.

Returns
index of the committed font style, to be passed on to the import_xf::set_font() method as its argument.

◆ set_bold()

virtual void orcus::spreadsheet::iface::import_font_style::set_bold ( bool b)
pure virtual

Set the font weight to either normal or bold, for western script.

Parameters
bwhether the font has normal (false) or bold weight (true).

◆ set_bold_asian()

virtual void orcus::spreadsheet::iface::import_font_style::set_bold_asian ( bool b)
pure virtual

Set the font weight to either normal or bold, for asian script.

Parameters
bwhether the font has normal (false) or bold weight (true).

◆ set_bold_complex()

virtual void orcus::spreadsheet::iface::import_font_style::set_bold_complex ( bool b)
pure virtual

Set the font weight to either normal or bold, for complex script.

Parameters
bwhether the font has normal (false) or bold weight (true).

◆ set_color()

virtual void orcus::spreadsheet::iface::import_font_style::set_color ( color_elem_t alpha,
color_elem_t red,
color_elem_t green,
color_elem_t blue )
pure virtual

Specify the color of font in ARGB format.

Parameters
alphaalpha component of the color.
redred component of the color.
greengreen component of the color.
blueblue component of the color.

◆ set_italic()

virtual void orcus::spreadsheet::iface::import_font_style::set_italic ( bool b)
pure virtual

Set the font style to either normal or italic, for western script.

Parameters
bwhether the font has normal (false) or italic style (true).

◆ set_italic_asian()

virtual void orcus::spreadsheet::iface::import_font_style::set_italic_asian ( bool b)
pure virtual

Set the font style to either normal or italic, for asian script.

Parameters
bwhether the font has normal (false) or italic style (true).

◆ set_italic_complex()

virtual void orcus::spreadsheet::iface::import_font_style::set_italic_complex ( bool b)
pure virtual

Set the font style to either normal or italic, for complex script.

Parameters
bwhether the font has normal (false) or italic style (true).

◆ set_name()

virtual void orcus::spreadsheet::iface::import_font_style::set_name ( std::string_view s)
pure virtual

Set the name of a font, for western script.

Parameters
sfont name.

◆ set_name_asian()

virtual void orcus::spreadsheet::iface::import_font_style::set_name_asian ( std::string_view s)
pure virtual

Set the name of a font, for asian script.

Parameters
sfont name.

◆ set_name_complex()

virtual void orcus::spreadsheet::iface::import_font_style::set_name_complex ( std::string_view s)
pure virtual

Set the name of a font, for complex script.

Parameters
sfont name.

◆ set_size()

virtual void orcus::spreadsheet::iface::import_font_style::set_size ( double point)
pure virtual

Set the size of a font in points, for western script.

Parameters
pointfont size in points.

◆ set_size_asian()

virtual void orcus::spreadsheet::iface::import_font_style::set_size_asian ( double point)
pure virtual

Set the size of a font in points, for asian script.

Parameters
pointfont size in points.

◆ set_size_complex()

virtual void orcus::spreadsheet::iface::import_font_style::set_size_complex ( double point)
pure virtual

Set the size of a font in points, for complex script.

Parameters
pointfont size in points.

◆ set_strikethrough_style()

virtual void orcus::spreadsheet::iface::import_font_style::set_strikethrough_style ( strikethrough_style_t s)
pure virtual

Set the strikethrough style of a font.

Parameters
sstrikethrough style of a font.

◆ set_strikethrough_text()

virtual void orcus::spreadsheet::iface::import_font_style::set_strikethrough_text ( strikethrough_text_t s)
pure virtual

Set the text to use as a strikethrough.

Parameters
stext to use as a strikethrough.

◆ set_strikethrough_type()

virtual void orcus::spreadsheet::iface::import_font_style::set_strikethrough_type ( strikethrough_type_t s)
pure virtual

Set whether the strikethrough of a font consists of a single line or a double line.

Parameters
swhether the strikethrough of a font consists of a single line or a double line.

◆ set_strikethrough_width()

virtual void orcus::spreadsheet::iface::import_font_style::set_strikethrough_width ( strikethrough_width_t s)
pure virtual

Set the width of the strikethrough of a font.

Parameters
sthe width of the strikethrough of a font.

◆ set_underline()

virtual void orcus::spreadsheet::iface::import_font_style::set_underline ( underline_t e)
pure virtual

Set the underline type of a font.

Parameters
eunderline type of a font.

◆ set_underline_color()

virtual void orcus::spreadsheet::iface::import_font_style::set_underline_color ( color_elem_t alpha,
color_elem_t red,
color_elem_t green,
color_elem_t blue )
pure virtual

Specify the color of an underline in ARGB format.

Parameters
alphaalpha component of the color.
redred component of the color.
greengreen component of the color.
blueblue component of the color.
Note
If this value is not explicitly set, the font color should be used.

◆ set_underline_mode()

virtual void orcus::spreadsheet::iface::import_font_style::set_underline_mode ( underline_mode_t e)
pure virtual

Set whether the underline of a font is continuous over the gaps, or skip the gaps.

Parameters
ewhether the underline of a font is continuous over the gaps or skip the gaps.

◆ set_underline_type()

virtual void orcus::spreadsheet::iface::import_font_style::set_underline_type ( underline_type_t e)
pure virtual

Set whether the underline of a font consists of a single line, or a double line.

Parameters
ewhether the underline of a font consists of a single line, or a double line.
Todo
Look into merging this with set_underline().

◆ set_underline_width()

virtual void orcus::spreadsheet::iface::import_font_style::set_underline_width ( underline_width_t e)
pure virtual

Set the width of the underline of a font.

Parameters
ewidth of the underline of a font.