import_underline

Defined in header: <orcus/spreadsheet/import_interface_underline.hpp>

class import_underline

Interface for importing underline attributes of a text.

Public Functions

~import_underline()
virtual void set_style(underline_style_t e) = 0

Set the style of an underline.

Parameters:

e – underline style of a font.

virtual void set_thickness(underline_thickness_t e) = 0

Set the thickness of an underline.

Parameters:

e – Thickness of the underline.

virtual void set_spacing(underline_spacing_t e) = 0

Set the spacing of an underline with respect to the text it is applied to.

Parameters:

e – Spacing of an underline.

virtual void set_count(underline_count_t e) = 0

Set the number of vertically-stacked lines in an underline.

Parameters:

e – Number of vertically-stacked lines in an underline.

virtual void set_color(color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue) = 0

Specify the color of an underline in ARGB format.

Note

If this value is not explicitly set, the font color should be used.

Parameters:

  • alpha – alpha component of the color.

  • red – red component of the color.

  • green – green component of the color.

  • blue – blue component of the color.

virtual void commit() = 0

Commit the underline attributes in the current buffer.