Rename SetLegacyDrawingHF to AddHeaderFooterImage

[imirkin]

Question: should HeaderFooterGraphics be renamed to something, or OK as-is?

PR Details

Rename SetLegacyDrawingHF to SetHeaderFooterImage.

Motivation and Context

This is being done per request from @xuri. Probably fits in better with the overall naming convention.

How Has This Been Tested

go test passes. Given that this was generated with sed -i, no further testing has been done.

Types of changes

• Docs change / refactoring / dependency upgrade
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.20%. Comparing base (b7375bc) to head (8e79403).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2023   +/-   ##
=======================================
  Coverage   99.20%   99.20%           
=======================================
  Files          32       32           
  Lines       29880    29947   +67     
=======================================
+ Hits        29642    29709   +67     
  Misses        158      158           
  Partials       80       80           

Flag	Coverage Δ
unittests	99.20% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[imirkin]

BTW, it looks like it may be possible to set multiple images somehow:

https://github.com/jmcnamara/XlsxWriter/blob/main/xlsxwriter/worksheet.py#L4244

Perhaps multiple shapes in the VML? No idea, I wasn't able to follow this code. I don't need this myself, but perhaps an improvement for later.

[xuri]

The name HeaderFooterGraphics is fine, but I think we need to add new Position field in this data type, acceptable value is LH, CH, RH, LF, CF, RF, LHFIRST, CHFIRST, RHFIRST, LFFIRST, CFFIRST, RFFIRST for add multiple shapes in the VML. I will tried to update based on this PR in some time.

[imirkin]

Well there's still only one drawing allowed, so probably have to set them all at once. Otherwise you have to edit the vml.

[xuri]

Yep, support append VML shapes (just like form controls) to allow call SetHeaderFooterImage multiple times, that's would be better.

[xuri]

I made some changes based on your branch, now support append VML shapes by call AddHeaderFooterImage multiple times.