The calendar control allows the user to pick a date. For this,
it displays a window containing several parts: a control at the top to pick the month
and the year (either or both of them may be disabled), and a month
area below them which shows all the days in the month. The user can move the
current selection using the keyboard and select the date (generating
EVT_CALENDAR
event) by pressing <Return>
or double clicking it.
It has advanced possibilities for the customization of its display. All global
settings (such as colours and fonts used) can, of course, be changed. But
also, the display style for each day in the month can be set independently
using CalendarDateAttr class.
An item without custom attributes is drawn with the default colours and
font and without border, but setting custom attributes with
set_attr allows to modify its appearance. Just
create a custom attribute object and set it for the day you want to be
displayed specially (note that the control will take ownership of the pointer,
i.e. it will delete it itself). A day may be marked as being a holiday, even
if it is not recognized as one by DateTime using
set_holiday method.
As the attributes are specified for each day, they may change when the month
is changed, so you will often want to update them in
EVT_CALENDAR_MONTH
event handler.
CAL_SUNDAY_FIRST |
Show Sunday as the first day in the week |
CAL_MONDAY_FIRST |
Show Monday as the first day in the week |
CAL_SHOW_HOLIDAYS |
Highlight holidays in the calendar |
CAL_NO_YEAR_CHANGE |
Disable the year changing |
CAL_NO_MONTH_CHANGE |
Disable the month (and, implicitly, the year) changing |
CAL_SHOW_SURROUNDING_WEEKS |
Show the neighbouring weeks in the previous and next months |
CAL_SEQUENTIAL_MONTH_SELECTION |
Use alternative, more compact, style for the month and year selection controls. |
The default calendar style is CAL_SHOW_HOLIDAYS
.
To process input from a calendar control, use these event handler macros to
direct input to member functions that take a
CalendarEvent argument.
evt_calendar(id) { | event | … } | A day was double clicked in the calendar. |
evt_calendar_sel_changed(id) { | event | … } | The selected date changed. |
evt_calendar_day(id) { | event | … } | The selected day changed. |
evt_calendar_month(id) { | event | … } | The selected month changed. |
evt_calendar_year(id) { | event | … } | The selected year changed. |
evt_calendar_weekday_clicked(id) { | event | … } | User clicked on the week day header |
Note that changing the selected date will result in either of
EVT_CALENDAR_DAY
, MONTH
or YEAR
events and
EVT_CALENDAR_SEL_CHANGED
one.
The following are the possible return values for
hit_test method:
Does the same as Create method.
Creates the control. See Window for the meaning of
the parameters and the control overview for the possible styles.
Destroys the control.
Sets the current date.
Gets the currently selected date.
This function should be used instead of changing CAL_NO_YEAR_CHANGE
style bit directly. It allows or disallows the user to change the year
interactively.
This function should be used instead of changing
CAL_NO_MONTH_CHANGE
style bit. It allows or disallows the user to
change the month interactively. Note that if the month can not be changed, the
year can not be changed neither.
This function should be used instead of changing CAL_SHOW_HOLIDAYS
style bit directly. It enables or disables the special highlighting of the
holidays.
Set the colours used for painting the weekdays at the top of the control.
Gets the foreground colour of the header part of the calendar window.
Gets the background colour of the header part of the calendar window.
Set the colours to be used for highlighting the currently selected date.
Gets the foreground highlight colour.
Gets the background highlight colour.
Sets the colours to be used for the holidays highlighting (only used if the
window style includes CAL_SHOW_HOLIDAYS
flag).
Return the foreground colour currently used for holiday highlighting.
Return the background colour currently used for holiday highlighting.
Returns the attribute for the given date (should be in the range $1$).
The returned pointer may be NULL
.
Associates the attribute with the specified date (in the range $1$).
If the pointer is NULL
, the items attribute is cleared.
Marks the specified day as being a holiday in the current month.
Clears any attributes associated with the given day (in the range
$1$).
Returns one of CAL_HITTEST_XXX
constants and fills either date or
wd pointer with the corresponding value depending on the hit test code.
[This page automatically generated from the Textile source at 2023-06-03 08:07:30 +0000]