unioffice/color/color.go

// Copyright 2017 FoxyUtils ehf. All rights reserved.
//
// Use of this source code is governed by the terms of the Affero GNU General
// Public License version 3.0 as published by the Free Software Foundation and
// appearing in the file LICENSE included in the packaging of this file. A
// commercial license can be purchased on https://unidoc.io.

package color

import (
	"github.com/unidoc/unioffice"
)

// Color is a 24 bit color that can be converted to
// internal ECMA-376 formats as needed.
type Color struct {
	r, g, b, a uint8
	isAuto     bool
}

// RGB constructs a new RGB color with a given red, green and blue value.
func RGB(r, g, b uint8) Color {
	return Color{r, g, b, 255, false}
}

// RGBA constructs a new RGBA color with a given red, green, blue and alpha
// value.
func RGBA(r, g, b, a uint8) Color {
	return Color{r, g, b, a, false}
}

// IsAuto returns true if the color is the 'Auto' type.  If the
// field doesn't support an Auto color, then black is used.
func (c Color) IsAuto() bool {
	return c.isAuto
}

// AsRGBString is used by the various wrappers to return a pointer
// to a string containing a six digit hex RGB value.
func (c Color) AsRGBString() *string {
	return unioffice.Stringf("%02x%02x%02x", c.r, c.g, c.b)
}

// AsRGBAString is used by the various wrappers to return a pointer
// to a string containing a six digit hex RGB value.
func (c Color) AsRGBAString() *string {
	return unioffice.Stringf("%02x%02x%02x%02x", c.a, c.r, c.g, c.b)
}