Rustpy-xlsxwriter

Added

- Added support for worksheet protection via the [`Worksheet::protect()`],
[`Worksheet::protect_with_password()`] and [`Worksheet::protect_with_options()`].

See also the section on [Worksheet protection] in the user guide.

- Add option to make the xlsx file read-only when opened by Excel via the
[`Workbook::read_only_recommended()`] method.


[Worksheet protection]: https://rustxlsxwriter.github.io/worksheet/protection.html
[`Worksheet::protect()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.protect
[`Worksheet::protect_with_options()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.protect_with_options
[`Workbook::read_only_recommended()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/workbook/struct.Workbook.html#method.read_only_recommended
[`Worksheet::protect_with_password()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.protect_with_password

Added

- Added support for setting document metadata properties such as Author and
Creation Date. For more details see [`DocProperties`] and
[`workbook::set_properties()`].

[`DocProperties`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.DocProperties.html
[`workbook::set_properties()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/workbook/struct.Workbook.html#method.set_properties

Changed

- Change date/time parameters to references in [`Worksheet::write_datetime()`],
`worksheet.write_date()` and `worksheet.write_time()` for consistency.

[`Worksheet::write_datetime()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.write_datetime

Added

- Improved fitting algorithm for [`Worksheet::autofit()`]. See also the
[app_autofit] sample application.

Changed

- The `worksheet.set_autofit()` method has been renamed to `worksheet.autofit()`
for consistency with the other language versions of this library.

Added

- Added support for created defined variable names at a workbook and worksheet
level via [`Workbook::define_name()`].

See also [Using defined names] in the user guide.

- Added initial support for autofilters via [`Worksheet::autofilter()`].

Note, adding filter criteria isn't currently supported. That will be added in
an upcoming version. See also [Adding Autofilters] in the user guide.

[Adding Autofilters]: https://rustxlsxwriter.github.io/examples/autofilter.html
[Using defined names]: https://rustxlsxwriter.github.io/examples/defined_names.html
[`Worksheet::autofilter()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.autofilter
[`Workbook::define_name()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/workbook/struct.Workbook.html#method.define_name

Added

- Added support for "rich" strings with multiple font formats via
[`Worksheet::write_rich_string()`] and [`Worksheet::write_rich_string_with_format()`].
For example strings like "This is **bold** and this is *italic*".

See also the [Rich strings example] in the user guide.

[Rich strings example]: https://rustxlsxwriter.github.io/examples/rich_strings.html
[`Worksheet::write_rich_string_with_format()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.write_rich_string_with_format
[`Worksheet::write_rich_string()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.write_rich_string

Fixed

- Fixes issue where header image files became corrupt during incremental saves.
Also fixes similar issues in some formatting code.