From 53a495563a2b9acf09ae45eae05d5f33aa242a87 Mon Sep 17 00:00:00 2001 From: xuri Date: Thu, 29 Sep 2022 22:00:21 +0800 Subject: This closes #1358, made a refactor with breaking changes, see details: This made a refactor with breaking changes: Motivation and Context When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was: - There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure. - Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories - Nested properties cannot proceed modify easily Introduce 5 new export data types: `HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions` Rename 4 exported data types: - Rename `PivotTableOption` to `PivotTableOptions` - Rename `FormatHeaderFooter` to `HeaderFooterOptions` - Rename `FormatSheetProtection` to `SheetProtectionOptions` - Rename `SparklineOption` to `SparklineOptions` Remove 54 exported types: `AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale` Remove 2 exported constants: `OrientationPortrait` and `OrientationLandscape` Change 8 functions: - Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error` - Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)` - Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error` - Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)` - Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error` - Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)` - Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error` - Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)` Introduce new function to instead of existing functions: - New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption --- workbook.go | 125 ++++++++++++++---------------------------------------------- 1 file changed, 28 insertions(+), 97 deletions(-) (limited to 'workbook.go') diff --git a/workbook.go b/workbook.go index dbe212a..937c9ca 100644 --- a/workbook.go +++ b/workbook.go @@ -21,26 +21,38 @@ import ( "strings" ) -// WorkbookPrOption is an option of a view of a workbook. See SetWorkbookPrOptions(). -type WorkbookPrOption interface { - setWorkbookPrOption(pr *xlsxWorkbookPr) +// SetWorkbookProps provides a function to sets workbook properties. +func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error { + wb := f.workbookReader() + if wb.WorkbookPr == nil { + wb.WorkbookPr = new(xlsxWorkbookPr) + } + if opts == nil { + return nil + } + if opts.Date1904 != nil { + wb.WorkbookPr.Date1904 = *opts.Date1904 + } + if opts.FilterPrivacy != nil { + wb.WorkbookPr.FilterPrivacy = *opts.FilterPrivacy + } + if opts.CodeName != nil { + wb.WorkbookPr.CodeName = *opts.CodeName + } + return nil } -// WorkbookPrOptionPtr is a writable WorkbookPrOption. See GetWorkbookPrOptions(). -type WorkbookPrOptionPtr interface { - WorkbookPrOption - getWorkbookPrOption(pr *xlsxWorkbookPr) +// GetWorkbookProps provides a function to gets workbook properties. +func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error) { + wb, opts := f.workbookReader(), WorkbookPropsOptions{} + if wb.WorkbookPr != nil { + opts.Date1904 = boolPtr(wb.WorkbookPr.Date1904) + opts.FilterPrivacy = boolPtr(wb.WorkbookPr.FilterPrivacy) + opts.CodeName = stringPtr(wb.WorkbookPr.CodeName) + } + return opts, nil } -type ( - // Date1904 is an option used for WorkbookPrOption, that indicates whether - // to use a 1900 or 1904 date system when converting serial date-times in - // the workbook to dates - Date1904 bool - // FilterPrivacy is an option used for WorkbookPrOption - FilterPrivacy bool -) - // setWorkbook update workbook property of the spreadsheet. Maximum 31 // characters are allowed in sheet title. func (f *File) setWorkbook(name string, sheetID, rid int) { @@ -116,84 +128,3 @@ func (f *File) workBookWriter() { f.saveFileList(f.getWorkbookPath(), replaceRelationshipsBytes(f.replaceNameSpaceBytes(f.getWorkbookPath(), output))) } } - -// SetWorkbookPrOptions provides a function to sets workbook properties. -// -// Available options: -// -// Date1904(bool) -// FilterPrivacy(bool) -// CodeName(string) -func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error { - wb := f.workbookReader() - pr := wb.WorkbookPr - if pr == nil { - pr = new(xlsxWorkbookPr) - wb.WorkbookPr = pr - } - for _, opt := range opts { - opt.setWorkbookPrOption(pr) - } - return nil -} - -// setWorkbookPrOption implements the WorkbookPrOption interface. -func (o Date1904) setWorkbookPrOption(pr *xlsxWorkbookPr) { - pr.Date1904 = bool(o) -} - -// setWorkbookPrOption implements the WorkbookPrOption interface. -func (o FilterPrivacy) setWorkbookPrOption(pr *xlsxWorkbookPr) { - pr.FilterPrivacy = bool(o) -} - -// setWorkbookPrOption implements the WorkbookPrOption interface. -func (o CodeName) setWorkbookPrOption(pr *xlsxWorkbookPr) { - pr.CodeName = string(o) -} - -// GetWorkbookPrOptions provides a function to gets workbook properties. -// -// Available options: -// -// Date1904(bool) -// FilterPrivacy(bool) -// CodeName(string) -func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error { - wb := f.workbookReader() - pr := wb.WorkbookPr - for _, opt := range opts { - opt.getWorkbookPrOption(pr) - } - return nil -} - -// getWorkbookPrOption implements the WorkbookPrOption interface and get the -// date1904 of the workbook. -func (o *Date1904) getWorkbookPrOption(pr *xlsxWorkbookPr) { - if pr == nil { - *o = false - return - } - *o = Date1904(pr.Date1904) -} - -// getWorkbookPrOption implements the WorkbookPrOption interface and get the -// filter privacy of the workbook. -func (o *FilterPrivacy) getWorkbookPrOption(pr *xlsxWorkbookPr) { - if pr == nil { - *o = false - return - } - *o = FilterPrivacy(pr.FilterPrivacy) -} - -// getWorkbookPrOption implements the WorkbookPrOption interface and get the -// code name of the workbook. -func (o *CodeName) getWorkbookPrOption(pr *xlsxWorkbookPr) { - if pr == nil { - *o = "" - return - } - *o = CodeName(pr.CodeName) -} -- cgit v1.2.1