Orcus
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_fill_style Class Referenceabstract

#include <import_interface_styles.hpp>

Public Member Functions

virtual void set_pattern_type (fill_pattern_t fp)=0
 
virtual void set_fg_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_bg_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual size_t commit ()=0
 

Detailed Description

Interface for importing fill style items.

Member Function Documentation

◆ commit()

virtual size_t orcus::spreadsheet::iface::import_fill_style::commit ( )
pure virtual

Commit the fill style in the current buffer.

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

◆ set_bg_color()

virtual void orcus::spreadsheet::iface::import_fill_style::set_bg_color ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
pure virtual

Set the background color of a fill. Note that this color will be ignored for a solid fill type.

Parameters
alphaalpha component ranging from 0 (fully transparent) to 255 (fully opaque).
redred component ranging from 0 to 255.
greengreen component ranging from 0 to 255.
blueblue component ranging from 0 to 255.

◆ set_fg_color()

virtual void orcus::spreadsheet::iface::import_fill_style::set_fg_color ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
pure virtual

Set the foreground color of a fill. Note that for a solid fill type, the foreground color will be used.

Parameters
alphaalpha component ranging from 0 (fully transparent) to 255 (fully opaque).
redred component ranging from 0 to 255.
greengreen component ranging from 0 to 255.
blueblue component ranging from 0 to 255.

◆ set_pattern_type()

virtual void orcus::spreadsheet::iface::import_fill_style::set_pattern_type ( fill_pattern_t  fp)
pure virtual

Set the type of fill pattern.

Parameters
fpfill pattern type.