tkcalendar 1.5.1

Syntax

Calendar(master=None, **kw)

Widget keyword options

• 标准选项

  cursor :str

  cursor to display when the pointer is in the widget

  font :str such as “Arial 20 bold” or a Tkinter Font instance

  font of the calendar

  borderwidth :int

  width of the border around the calendar

  state :str

  “normal” or “disabled” (unresponsive widget)

• 小部件特定选项：

  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 :“monday” or “sunday”

  first day of the week

  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 (default is True)

  whether to display week numbers.

  showothermonthdays :bool (default is True)

  whether to display the last days of the previous month and the first of the next month.

  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 ^{tt1}$’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 ^{tt2}$

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

  selectmode :“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.

• 样式选项：

  background :

  background color of calendar border and month/year name

  foreground :

  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 :

  day border color

  headersbackground :

  background color of day names and week numbers

  headersforeground :

  foreground color of day names and week numbers

  selectbackground :

  background color of selected day

  selectforeground :

  foreground color of selected day

  disabledselectbackground :

  background color of selected day in disabled state

  disabledselectforeground :

  foreground color of selected day in disabled state

  normalbackground :

  background color of normal week days

  normalforeground :

  foreground color of normal week days

  weekendbackground :

  background color of week-end days

  weekendforeground :

  foreground color of week-end days

  othermonthforeground :

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

  othermonthbackground :

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

  othermonthweforeground :

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

  othermonthwebackground :

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

  disableddaybackground :

  background color of days in disabled state

  disableddayforeground :

  foreground color of days in disabled state

• 工具提示选项（用于日历事件）：

  tooltipforeground :

  tooltip text color

  tooltipbackground :

  tooltip background color

  tooltipalpha :float

  tooltip opacity between 0 and 1

  tooltipdelay :int

  delay in ms before displaying the tooltip

Virtual Events

• A ^{tt3}$ event is generated each time the user selects a day with the mouse.
• A ^{tt4}$ event is generated each time the user changes the displayed month.

Widget methods

• Standard methods:

  • methods common to all tkinter widgets (more details here)
  • methods common to all ttk widgets (more details here)

• 特定于小部件的方法：

  calevent_cget(ev_id, option) :

  Return value of given option for the event ev_id.

  calevent_configure(ev_id, **kw) :

  Return value of given option for the event ev_id.

  calevent_create(date, text, tags=[]) :

  Add new event in calendar and return event id.

  Options:

  date: ^{tt5}$ or ^{tt6}$ instance.

  text: text to put in the tooltip associated to date.

  tags: 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=无）：

  工具提示事件列表中的

  下事件{em1}$ev_id。

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

  一天的颜色由具有标记的最低事件的最后一个标记确定。

  Calevent_raise（ev_id，above=无）：

  工具提示事件列表中的引发事件{em1}$ev_id。

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

  一天的颜色由具有标记的最低事件的最后一个标记确定。

  calevent_remove（*ev_ids，**kw）：

  从日历中删除事件。

  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.

  获取日期（）：

  如果selectMode为“day”，则返回与 Calendarlocale，否则返回""。

  获取日历事件（日期=无，标记=无）：

  返回具有给定标记和给定日期的事件的事件ID。

  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.

  显示月份：

  以（月，年）元组的形式返回当前显示的月份。

  见（日期）：

  显示date所在的月份。

  date: ^{tt5}$ or ^{tt6}$ instance.

  选择清除（）：

  清除选择。

  选择获取（）：

  如果selectMode是“day”，则将所选日期返回为datetime.date 实例，否则返回None。

  选择集（self，date）：

  如果selectMode是“day”，则将选择设置为date，其中date可以是datetime.date 实例或与^{tt7}中的日期格式"%x"对应的字符串$ 地点。如果selectMode是"none"，则不执行任何操作。

  标记cget（标记，选项）：

  返回标记选项的值。

  标签配置（自，标签，**kw）：

  配置{em1}$tag。

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

  删除标记（tag）：

  删除给定标记并将其从所有事件中移除。

  标记名（）：

  > p>返回现有标记的元组。

Syntax

DateEntry(master=None, **kw)

Widget keyword options

• Keyword options of ^{tt7}$ to configure the drop-down calendar

• Keyword options of ^{tt18}$

  By default, ‘validate’ is set to ‘focusout’ and ‘validatecommand’ is configured so that each time the widget looses focus, if the content is not a valid date (in locale format ‘%x’), it is reset to the previous valid date.

  The widget style is set to ‘DateEntry’. A custom style inheritting from ‘DateEntry’ can be created by naming it ‘<style name>.DateEntry’

• 虚拟事件

  A ^{tt19}$ event is generated each time the user selects a date.

Widget methods

• Standard methods:

  • methods common to all tkinter widgets (more details here)
  • methods common to all ttk widgets (more details here)
  • methods of the ^{tt20}$ widget (more details here)

• 特定于小部件的方法：

  drop_down() :

  Display or withdraw the drop-down calendar depending on its current state.

  get_date() :

  Return the selected date as a ^{tt5}$ instance.

  set_date(self, date) :

  Set the value of the DateEntry to date where date can be either a ^{tt5}$ instance or a string corresponding to the date format “%x” in the Calendar locale.