format.go

package goxlsxwriter

/*
#cgo LDFLAGS: -L. -lxlsxwriter
#include <xlsxwriter.h>
*/
import "C"
import "unsafe"

// UNDERLINE_* constants are to be used with SetUnderline().
const (
	// Single underline.
	UNDERLINE_SINGLE int = C.LXW_UNDERLINE_SINGLE

	// Double underline.
	UNDERLINE_DOUBLE int = C.LXW_UNDERLINE_DOUBLE

	// Single accounting underline.
	UNDERLINE_SINGLE_ACCOUNTING int = C.LXW_UNDERLINE_SINGLE_ACCOUNTING

	// Double accounting line.
	UNDERLINE_DOUBLE_ACCOUNTING int = C.LXW_UNDERLINE_DOUBLE_ACCOUNTING
)

// PATTERN_* constants are to be used with SetPattern().
const (
	// Solid.
	PATTERN_SOLID int = C.LXW_PATTERN_SOLID

	// Medium gray.
	PATTERN_MEDIUM_GRAY int = C.LXW_PATTERN_MEDIUM_GRAY

	// Dark gray.
	PATTERN_DARK_GRAY int = C.LXW_PATTERN_DARK_GRAY

	// Light gray.
	PATTERN_LIGHT_GRAY int = C.LXW_PATTERN_LIGHT_GRAY

	// Dark horizontal line.
	PATTERN_DARK_HORIZONTAL int = C.LXW_PATTERN_DARK_HORIZONTAL

	// Dark vertical line.
	PATTERN_DARK_VERTICAL int = C.LXW_PATTERN_DARK_VERTICAL

	// Dark diagonal stripe.
	PATTERN_DARK_DOWN int = C.LXW_PATTERN_DARK_DOWN

	// Reverse dark diagonal stripe.
	PATTERN_DARK_UP int = C.LXW_PATTERN_DARK_UP

	// Dark grid.
	PATTERN_DARK_GRID int = C.LXW_PATTERN_DARK_GRID

	// Dark trellis.
	PATTERN_DARK_TRELLIS int = C.LXW_PATTERN_DARK_TRELLIS

	// Light horizontal line.
	PATTERN_LIGHT_HORIZONTAL int = C.LXW_PATTERN_LIGHT_HORIZONTAL

	// Light vertical line.
	PATTERN_LIGHT_VERTICAL int = C.LXW_PATTERN_LIGHT_VERTICAL

	// Light diagonal stripe.
	PATTERN_LIGHT_DOWN int = C.LXW_PATTERN_LIGHT_DOWN

	// Reverse light diagonal stripe.
	PATTERN_LIGHT_UP int = C.LXW_PATTERN_LIGHT_UP

	// Light grid.
	PATTERN_LIGHT_GRID int = C.LXW_PATTERN_LIGHT_GRID

	// Light trellis.
	PATTERN_LIGHT_TRELLIS int = C.LXW_PATTERN_LIGHT_TRELLIS

	// 12.5% gray.
	PATTERN_GRAY_125 int = C.LXW_PATTERN_GRAY_125

	// 6.25% gray.
	PATTERN_GRAY_0625 int = C.LXW_PATTERN_GRAY_0625
)

// Format represents an Excel style used to apply formatting to cells.
type Format struct {
	CFormat *C.struct_lxw_format
}

// NewFormat creates and returns a new instance of Format.
func NewFormat(workbook *Workbook) *Format {
	cFormat := C.workbook_add_format(workbook.CWorkbook)

	format := &Format{
		CFormat: cFormat,
	}

	return format
}

// SetFontName sets the format's font face.
func (f *Format) SetFontName(fontName string) {
	cFontName := C.CString(fontName)
	defer C.free(unsafe.Pointer(cFontName))

	C.format_set_font_name(f.CFormat, cFontName)
}

// SetFontSize sets the font size.
func (f *Format) SetFontSize(size int) {
	cSize := (C.double)(size)

	C.format_set_font_size(f.CFormat, cSize)
}

// SetFontColor sets the font color.
func (f *Format) SetFontColor(color int) {
	cColor := (C.lxw_color_t)(color)

	C.format_set_font_color(f.CFormat, cColor)
}

// SetBold sets the font to be bold.
func (f *Format) SetBold() {
	C.format_set_bold(f.CFormat)
}

// SetItalic sets the font to be italic.
func (f *Format) SetItalic() {
	C.format_set_italic(f.CFormat)
}

// SetUnderline sets the font to be underline using the
// specified UNDERLINE_* style.
func (f *Format) SetUnderline(style int) {
	cStyle := (C.uint8_t)(style)

	C.format_set_underline(f.CFormat, cStyle)
}

// SetPattern sets the pattern to the specific PATTERN_* pattern.
func (f *Format) SetPattern(pattern int) {
	cPattern := (C.uint8_t)(pattern)

	C.format_set_pattern(f.CFormat, cPattern)
}

// SetBackgroundColor sets the background color.
func (f *Format) SetBackgroundColor(color int) {
	cColor := (C.lxw_color_t)(color)

	C.format_set_bg_color(f.CFormat, cColor)
}

// SetNumericalFormat sets the numerical format.
// It controls whether a number is displayed as an integer,
// a floating point number, a date, a currency value or some other
// user defined format (e.g., "d mmm yyyy").
func (f *Format) SetNumericalFormat(numberFormat string) {
	cNumberFormat := C.CString(numberFormat)
	defer C.free(unsafe.Pointer(cNumberFormat))

	C.format_set_num_format(f.CFormat, cNumberFormat)
}