unioffice/spreadsheet/sheetview.go

// Copyright 2017 Baliance. 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 by contacting sales@baliance.com.

package spreadsheet

import (
	"baliance.com/gooxml"
	"baliance.com/gooxml/schema/soo/sml"
)

// SheetView is a view of a sheet. There is typically one per sheet, though more
// are supported.
type SheetView struct {
	x *sml.CT_SheetView
}

// X returns the inner wrapped XML type.
func (s SheetView) X() *sml.CT_SheetView {
	return s.x
}

// SetState sets the sheet view state (frozen/split/frozen-split)
func (s SheetView) SetState(st sml.ST_PaneState) {
	s.ensurePane()
	s.x.Pane.StateAttr = st
}

func (s SheetView) ensurePane() {
	if s.x.Pane == nil {
		s.x.Pane = sml.NewCT_Pane()
		s.x.Pane.ActivePaneAttr = sml.ST_PaneBottomLeft
	}
}

// SetXSplit sets the column split point
func (s SheetView) SetXSplit(v float64) {
	s.ensurePane()
	s.x.Pane.XSplitAttr = gooxml.Float64(v)
}

// SetYSplit sets the row split point
func (s SheetView) SetYSplit(v float64) {
	s.ensurePane()
	s.x.Pane.YSplitAttr = gooxml.Float64(v)

}

// SetTopLeft sets the top left visible cell after the split.
func (s SheetView) SetTopLeft(cellRef string) {
	s.ensurePane()
	s.x.Pane.TopLeftCellAttr = &cellRef
}

// SetZoom controls the zoom level of the sheet and is measured in percent. The
// default value is 100.
func (s SheetView) SetZoom(pct uint32) {
	s.x.ZoomScaleAttr = &pct
}

// SetShowRuler controls the visibility of the ruler
func (s SheetView) SetShowRuler(b bool) {
	// default is true
	if !b {
		s.x.ShowRulerAttr = gooxml.Bool(false)
	} else {
		s.x.ShowRulerAttr = nil
	}
}