solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Add holiday authority overview

Browse source 
Closes #24240.
This commit is contained in:
Blake-Madden 2024-01-22 21:04:08 -05:00 • committed by Vadim Zeitlin
parent 9e61385878
commit 509f853757
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/doxygen/overviews/datetime.h
View file

@ -201,9 +201,20 @@ these functions too, so they are subject to the same limitations.
@section overview_datetime_holidays wxDateTime and Holidays
@section overview_datetime_holidays Holidays
@todo WRITE THIS DOC PARAGRAPH.
The wxDateTimeHolidayAuthority-derived classes help determine whether a
given date is a holiday and are used by all functions working with "work days".
In this context, a holiday is an event which results in a day off from work.
Multiple holiday authorities can be combined by passing them to
wxDateTimeHolidayAuthority::AddAuthority(), and a date can be verified as a holiday
by calling wxDateTimeHolidayAuthority::IsHoliday().
Holiday authorities are available for weekends (loaded by default) and
Catholic/Christian holy days of obligation.
Custom holiday authorities can also be created by deriving from wxDateTimeHolidayAuthority
and defining DoIsHoliday() and DoGetHolidaysInRange().