Calendar

Class

class tkcalendar.Calendar(master=None, **kw)

Bases: tkinter.ttk.Frame

Calendar widget.

__init__(master=None, **kw)

Construct a Calendar with parent master.

Standard Options

cursor : str

cursor to display when the pointer is in the widget

font : str or Tkinter Font

font of the calendar

borderwidth : int

width of the border around the calendar

state : str

“normal” or “disabled” (unresponsive widget)

Widget-specific Options

year : int

intinitially displayed year, default is current year.

month : int

initially displayed month, default is current month.

day : int

initially selected day, if month or year is given but not day, no initial selection, otherwise, default is today.

firstweekday : str

first day of the week: “monday” or “sunday”

weekenddays : list

days to be displayed as week-end days given as a list of integers corresponding to the number of the day in the week (e.g. [6, 7] for the last two days of the week).

mindate : datetime.date or datetime.datetime (default is None)

minimum allowed date

maxdate : datetime.date or datetime.datetime (default is None)

maximum allowed date

showweeknumbers : bool

whether to display week numbers (default is True).

showothermonthdays : bool

whether to display the last days of the previous month and the first of the next month (default is True).

locale : str

locale to use, e.g. ‘en_US’

date_pattern : str

date pattern used to format the date as a string. The default pattern used is babel’s short date format in the Calendar’s locale.

A valid pattern is a combination of ‘d’, ‘m’ and ‘y’ separated by non letter characters to indicate how and in which order the year, month and day should be displayed.

d	‘d’ for the day of month number without padding, ‘dd’ for a two-digit day
m	‘m’ for the month number without padding, ‘mm’ for a two-digit month
y	‘yy’ for the two last digits of the year, any other number of ‘y’s for the full year with an extra padding of zero if it has less digits than the number of ‘y’s.

Examples for datetime.date(2019, 7, 1)

• ‘y-mm-dd’ → ‘2019-07-01’
• ‘m/d/yy’ → ‘7/1/19’

selectmode : str

“none” or “day” (default): whether the user can change the selected day with a mouse click.

textvariable : StringVar

connect the currently selected date to the variable.

Style Options

background : str

background color of calendar border and month/year name

foreground : str

foreground color of month/year name

disabledbackground : str

background color of calendar border and month/year name in disabled state

disabledforeground : str

foreground color of month/year name in disabled state

bordercolor : str

day border color

headersbackground : str

background color of day names and week numbers

headersforeground : str

foreground color of day names and week numbers

selectbackground : str

background color of selected day

selectforeground : str

foreground color of selected day

disabledselectbackground : str

background color of selected day in disabled state

disabledselectforeground : str

foreground color of selected day in disabled state

normalbackground : str

background color of normal week days

normalforeground : str

foreground color of normal week days

weekendbackground : str

background color of week-end days

weekendforeground : str

foreground color of week-end days

othermonthforeground : str

foreground color of normal week days belonging to the previous/next month

othermonthbackground : str

background color of normal week days belonging to the previous/next month

othermonthweforeground : str

foreground color of week-end days belonging to the previous/next month

othermonthwebackground : str

background color of week-end days belonging to the previous/next month

disableddaybackground : str

background color of days in disabled state

disableddayforeground : str

foreground color of days in disabled state

Tooltip Options (for calevents)

tooltipforeground : str

tooltip text color

tooltipbackground : str

tooltip background color

tooltipalpha : float

tooltip opacity between 0 and 1

tooltipdelay : int

delay in ms before displaying the tooltip

calevent_cget(ev_id, option)

Return value of given option for the event ev_id.

calevent_configure(ev_id, **kw)

Configure the event ev_id.

Keyword options: date, text, tags (see calevent_create options).

calevent_create(date, text, tags=[])

Add new event in calendar and return event id.

Options:

date : datetime.date or datetime.datetime

event date

text : str

text to put in the tooltip associated to date.

tags : list

list of tags to apply to the event. The last tag determines the way the event is displayed. If there are several events on the same day, the lowest one (on the tooltip list) which has tags determines the colors of the day.

calevent_lower(ev_id, below=None)

Lower event ev_id in tooltip event list.

below : str

put ev_id below given one, if below is None, put it at the bottom of tooltip event list.

The day’s colors are determined by the last tag of the lowest event which has tags.

calevent_raise(ev_id, above=None)

Raise event ev_id in tooltip event list.

above : str

put ev_id above given one, if above is None, put it on top of tooltip event list.

The day’s colors are determined by the last tag of the lowest event which has tags.

calevent_remove(*ev_ids, **kw)

Remove events from calendar.

Arguments: event ids to remove or ‘all’ to remove them all.

Keyword arguments: tag, date.

They are taken into account only if no id is given. Remove all events with given tag on given date. If only date is given, remove all events on date and if only tag is given, remove all events with tag.

configure(cnf={}, **kw)

Configure resources of a widget.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method keys().

format_date(date=None)

Convert date (datetime.date) to a string in the locale.

get_calevents(date=None, tag=None)

Return event ids of events with given tag and on given date.

If only date is given, return event ids of all events on date. If only tag is given, return event ids of all events with tag. If both options are None, return all event ids.

get_date()

Return selected date as string.

get_displayed_month()

Return the currently displayed month in the form of a (month, year) tuple.

keys()

Return a list of all resource names of this widget.

see(date)

Display the month in which date is.

date : datetime.date or datetime.datetime

date to be made visible

selection_clear()

Clear the selection.

selection_get()

Return currently selected date (datetime.date instance).

Always return None if selectmode == “none”.

selection_set(date)

Set the selection to date.

date : datetime.date, datetime.datetime or str

date to be made visible. If given as a string, it should be in the format corresponding to the calendar locale.

Do nothing if selectmode == “none”.

tag_cget(tag, option)

Return the value of the tag’s option.

tag_config(tag, **kw)

Configure tag.

Keyword options: foreground, background (of the day in the calendar)

tag_delete(tag)

Delete given tag.

Delete tag properties and remove tag from all events.

tag_names()

Return tuple of existing tags.

Virtual Events

• A <<CalendarSelected>> event is generated each time the user selects a day with the mouse.
• A <<CalendarMonthChanged>> event is generated each time the user changes the displayed month.

Calendar Events

Special events (e.g. birthdays, ..) can be managed using the calevent_..() methods. The way they are displayed in the calendar is determined with tags. An id is attributed to each event upon creation and can be used to edit the event (ev_id argument).