wx.calendar.CalendarCtrl

Inheritance diagram for wx.calendar.CalendarCtrl:

Description

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 wx.calendar.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 wx.calendar.CalendarDateAttr class.

An item without custom attributes is drawn with the default colours and font and without border, but setting custom attributes with SetAttr 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 wx.DateTime using SetHoliday 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 wx.calendar.EVT_CALENDAR_MONTH event handler.

See also

wx.CalendarDateAttr, wx.calendar.CalendarEvent

Derived From

• wx.Control
• wx.Window
• wx.EvtHandler
• wx.Object

Window Styles

Window Style	Description
wx.calendar.CAL_SUNDAY_FIRST	Show Sunday as the first day in the week
wx.calendar.CAL_MONDAY_FIRST	Show Monday as the first day in the week
wx.calendar.CAL_SHOW_HOLIDAYS	Highlight holidays in the calendar
wx.calendar.CAL_NO_YEAR_CHANGE	Disable the year changing
wx.calendar.CAL_NO_MONTH_CHANGE	Disable the month (and, implicitly, the year) changing
wx.calendar.CAL_SHOW_SURROUNDING_WEEKS	Show the neighbouring weeks in the previous and next months
wx.calendar.CAL_SEQUENTIAL_MONTH_SELECTION	Use alternative, more compact, style for the month and year selection controls.

Event Handling

To process input from a calendar control, use these event handler macros to direct input to member functions that take a wx.calendar.CalendarEvent argument.

Event Name	Description
wx.calendar.EVT_CALENDAR(id, func)	A day was double clicked in the calendar.
wx.calendar.EVT_CALENDAR_SEL_CHANGED(id, func)	The selected date changed.
wx.calendar.EVT_CALENDAR_DAY(id, func)	The selected day changed.
wx.calendar.EVT_CALENDAR_MONTH(id, func)	The selected month changed.
wx.calendar.EVT_CALENDAR_YEAR(id, func)	The selected year changed.
wx.calendar.EVT_CALENDAR_WEEKDAY_CLICKED(id, func)	User clicked on the week day header.

Note

Note that changing the selected date will result in either of wx.calendar.EVT_CALENDAR_DAY, MONTH or YEAR events and wx.calendar.EVT_CALENDAR_SEL_CHANGED one.

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

• __init__
• Create
• EnableHolidayDisplay
• EnableMonthChange
• EnableYearChange
• GetAttr
• GetDate
• GetHeaderColourBg
• GetHeaderColourFg
• GetHighlightColourBg
• GetHighlightColourFg
• GetHolidayColourBg
• GetHolidayColourFg
• GetLowerDateLimit
• GetMonthControl
• GetUpperDateLimit
• GetYearControl
• HitTest
• PyGetDate
• PyGetLowerDateLimit
• PyGetUpperDateLimit
• PySetDate
• PySetDateRange
• PySetLowerDateLimit
• PySetUpperDateLimit
• ResetAttr
• SetAttr
• SetDate
• SetDateRange
• SetHeaderColours
• SetHighlightColours
• SetHoliday
• SetHolidayColours
• SetLowerDateLimit
• SetUpperDateLimit

Properties Summary

• Date
• HeaderColourBg
• HeaderColourFg
• HighlightColourBg
• HighlightColourFg
• HolidayColourBg
• HolidayColourFg
• LowerDateLimit
• MonthControl
• UpperDateLimit
• YearControl

Class API

Methods

__init__(parent, id=-1, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.calendar.CAL_SHOW_HOLIDAYS|wx.WANTS_CHARS, name=CalendarNameStr)

Create and show a calendar control.

Parameters:

• parent (wx.Window)
• id (int)
• date (wx.DateTime)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• name (string)

Returns:

wx.calendar.CalendarCtrl

---

Create(parent, id=-1, date=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.calendar.CAL_SHOW_HOLIDAYS|wx.WANTS_CHARS, name=CalendarNameStr)

Creates the control. See wx.Window for the meaning of the parameters and the control overview for the possible styles.

Parameters:

• parent (wx.Window)
• id (int)
• date (wx.DateTime)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• name (string)

Returns:

bool

---

EnableHolidayDisplay(display=True)

This function should be used instead of changing wx.calendar.CAL_SHOW_HOLIDAYS style bit directly. It enables or disables the special highlighting of the holidays.

Parameters:

• display (bool)

---

EnableMonthChange(enable=True)

This function should be used instead of changing wx.calendar.CAL_NO_MONTH_CHANGE style bit. It allows or disallows the user to change the month interactively.

Parameters:

• enable (bool)

Note

Note that if the month can not be changed, the year can not be changed neither.

---

EnableYearChange(enable=True)

This function should be used instead of changing wx.calendar.CAL_NO_YEAR_CHANGE style bit directly. It allows or disallows the user to change the year interactively.

Parameters:

• enable (bool)

---

GetAttr(day)

Returns the attribute for the given date (should be in the range 1...31).

The returned pointer may be None.

Parameters:

• day (long)

Returns:

wx.calendar.CalendarDateAttr

---

GetDate()

Gets the currently selected date.

Returns:

wx.DateTime

---

GetHeaderColourBg()

Gets the background colour of the header part of the calendar window.

Returns:

wx.Colour

See also

SetHeaderColours

---

GetHeaderColourFg()

Gets the foreground colour of the header part of the calendar window.

Returns:

wx.Colour

See also

SetHeaderColours

---

GetHighlightColourBg()

Gets the background highlight colour.

Returns:

wx.Colour

See also

SetHighlightColours

---

GetHighlightColourFg()

Gets the foreground highlight colour.

Returns:

wx.Colour

See also

SetHighlightColours

---

GetHolidayColourBg()

Return the background colour currently used for holiday highlighting.

Returns:

wx.Colour

See also

SetHolidayColours

---

GetHolidayColourFg()

Return the foreground colour currently used for holiday highlighting.

Returns:

wx.Colour

See also

SetHolidayColours

---

GetLowerDateLimit()

Get the range in which selection can occur.

Returns:

wx.DateTime

---

GetMonthControl()

Get the currently shown control for month.

Returns:

wx.Control

---

GetUpperDateLimit()

Get the range in which selection can occur.

Returns:

wx.DateTime

---

GetYearControl()

Get the currently shown control for year.

Returns:

wx.Control

---

HitTest(pos)

Returns 3-tuple with information about the given position on the calendar control.

Parameters:

• pos (wx.Point): The position to test.

The first value of the tuple is a result code and determines the validity of the remaining two values. The result codes are:

HitTest Result Flags	Description
wx.calendar.CAL_HITTEST_NOWHERE	Hit outside of anything.
wx.calendar.CAL_HITTEST_HEADER	Hit on the header, weekday is valid.
wx.calendar.CAL_HITTEST_DAY	Hit on a day in the calendar, date is set.

Returns:

(result, date, weekday)

---

PyGetDate()

Same as GetDate, but returns a datetime.date object.

Returns:

datetime.date

---

PyGetLowerDateLimit()

Same as GetLowerDateLimit, but returns a datetime.date object.

Returns:

datetime.date

---

PyGetUpperDateLimit()

Same as GetUpperDateLimit, but returns a datetime.date object.

Returns:

datetime.date

---

PySetDate(date)

Same as SetDate, but takes a datetime.date object in input.

Parameters:

• date (datetime.date)

---

PySetDateRange(lowerdate, upperdate)

Same as SetDateRange, but takes a datetime.datetime or datetime.date objects in input.

Parameters:

• lowerdate (datetime.date)
• upperdate (datetime.date)

---

PySetLowerDateLimit(date)

Same as SetLowerDateLimit, but takes a datetime.datetime or datetime.date object in input.

Parameters:

• date (datetime.date)

---

PySetUpperDateLimit(date)

Same as SetUpperDateLimit, but takes a datetime.datetime or datetime.date object in input.

Parameters:

• date (datetime.date)

---

ResetAttr(day)

Clears any attributes associated with the given day (in the range 1...31).

Parameters:

• day (long)

---

SetAttr(day, attr)

Associates the attribute with the specified date (in the range 1...31). If the pointer is None, the items attribute is cleared.

Parameters:

• day (long)
• attr (wx.calendar.CalendarDateAttr)

---

SetDate(date)

Sets the current date.

Parameters:

• date (wx.DateTime)

---

SetDateRange(lowerdate=wx.DefaultDateTime, upperdate=wx.DefaultDateTime)

Set the range in which selection can occur.

Parameters:

• lowerdate (wx.DateTime)
• upperdate (wx.DateTime)

Returns:

bool

---

SetHeaderColours(colFg, colBg)

Set the colours used for painting the weekdays at the top of the control.

Parameters:

• colFg (wx.Colour)
• colBg (wx.Colour)

---

SetHighlightColours(colFg, colBg)

Set the colours to be used for highlighting the currently selected date.

Parameters:

• colFg (wx.Colour)
• colBg (wx.Colour)

---

SetHoliday(day)

Marks the specified day as being a holiday in the current month.

Parameters:

• day (long)

---

SetHolidayColours(colFg, colBg)

Sets the colours to be used for the holidays highlighting (only used if the window style includes wx.calendar.CAL_SHOW_HOLIDAYS flag).

Parameters:

• colFg (wx.Colour)
• colBg (wx.Colour)

---

SetLowerDateLimit(date=wx.DefaultDateTime)

set the range in which selection can occur

Parameters:

• date (wx.DateTime)

Returns:

bool

---

SetUpperDateLimit(date=wx.DefaultDateTime)

set the range in which selection can occur

Parameters:

• date (wx.DateTime)

Returns:

bool

---

Properties

Date

See GetDate and SetDate

HeaderColourBg

See GetHeaderColourBg

HeaderColourFg

See GetHeaderColourFg

HighlightColourBg

See GetHighlightColourBg

HighlightColourFg

See GetHighlightColourFg

HolidayColourBg

See GetHolidayColourBg

HolidayColourFg

See GetHolidayColourFg

LowerDateLimit

See GetLowerDateLimit and SetLowerDateLimit

MonthControl

See GetMonthControl

UpperDateLimit

See GetUpperDateLimit and SetUpperDateLimit

YearControl

See GetYearControl