Gtk.Calendar¶

Example¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`clear_marks` ()
	`get_date` ()
	`get_day` ()
	`get_day_is_marked` (day)
	`get_month` ()
	`get_show_day_names` ()
	`get_show_heading` ()
	`get_show_week_numbers` ()
	`get_year` ()
	`mark_day` (day)
	`select_day` (date)
	`set_date` (date)
	`set_day` (day)
	`set_month` (month)
	`set_show_day_names` (value)
	`set_show_heading` (value)
	`set_show_week_numbers` (value)
	`set_year` (year)
	`unmark_day` (day)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Gtk.Widget (35), Gtk.Accessible (1)

Name	Type	Flags	Short Description
`date`	`GLib.DateTime`	r/w/en
`day`	`int`	r/w/en	`deprecated`
`month`	`int`	r/w/en	`deprecated`
`show-day-names`	`bool`	r/w/en
`show-heading`	`bool`	r/w/en
`show-week-numbers`	`bool`	r/w/en
`year`	`int`	r/w/en	`deprecated`

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Short Description
`day-selected`	Emitted when the user selects a day.
`next-month`	Emitted when the user switches to the next month.
`next-year`	Emitted when user switches to the next year.
`prev-month`	Emitted when the user switches to the previous month.
`prev-year`	Emitted when user switches to the previous year.

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Gtk.Calendar(**kwargs)¶

Bases:: Gtk.Widget
Abstract:: No

Displays a Gregorian calendar, one month at a time.

A GtkCalendar can be created with [ctor`Gtk`.Calendar.new].

The selected date can be retrieved from a GtkCalendar using [method`Gtk`.Calendar.get_date]. It can be altered with [method`Gtk`.Calendar.set_date].

To place a visual marker on a particular day, use [method`Gtk`.Calendar.mark_day] and to remove the marker, [method`Gtk`.Calendar.unmark_day]. Alternative, all marks can be cleared with [method`Gtk`.Calendar.clear_marks].

Users should be aware that, although the Gregorian calendar is the legal calendar in most countries, it was adopted progressively between 1582 and 1929. Display before these dates is likely to be historically incorrect.

Shortcuts and Gestures

GtkCalendar supports the following gestures:

Scrolling up or down will switch to the previous or next month.
Date strings can be dropped for setting the current day.

CSS nodes

`` calendar.view ├── header │ ├── button │ ├── stack.month │ ├── button │ ├── button │ ├── label.year │ ╰── button ╰── grid

╰── label[.day-name][.week-number][.day-number][.other-month][.today]

``

GtkCalendar has a main node with name calendar. It contains a subnode called header containing the widgets for switching between years and months.

The grid subnode contains all day labels, including week numbers on the left (marked with the .week-number css class) and day names on top (marked with the .day-name css class).

Day labels that belong to the previous or next month get the .other-month style class. The label of the current day get the .today style class.

Marked day labels get the :selected state assigned.

classmethod new()[source]¶

Returns:: a newly GtkCalendar widget
Return type:: Gtk.Widget

Creates a new calendar, with the current date being selected.

clear_marks()[source]¶: Remove all visual markers.

get_date()[source]¶

Returns:: the GDateTime representing the selected date
Return type:: GLib.DateTime

Returns a GDateTime representing the shown year, month and the selected day.

The returned date is in the local time zone.

get_day()[source]¶

Returns:: the day of the selected date.
Return type:: int

Gets the day of the selected date.

New in version 4.14.

get_day_is_marked(day)[source]¶

Parameters:: day (int) – the day number between 1 and 31.
Returns:: whether the day is marked.
Return type:: bool

Returns if the day of the self is already marked.

get_month()[source]¶

Returns:: The month of the selected date (as a number between 0 and 11).
Return type:: int

Gets the month of the selected date.

New in version 4.14.

get_show_day_names()[source]¶

Returns:: Whether the calendar shows day names.
Return type:: bool

Returns whether self is currently showing the names of the week days.

This is the value of the [property`Gtk`.Calendar:show-day-names] property.

get_show_heading()[source]¶

Returns:: Whether the calendar is showing a heading.
Return type:: bool

Returns whether self is currently showing the heading.

This is the value of the [property`Gtk`.Calendar:show-heading] property.

get_show_week_numbers()[source]¶

Returns:: Whether the calendar is showing week numbers.
Return type:: bool

Returns whether self is showing week numbers right now.

This is the value of the [property`Gtk`.Calendar:show-week-numbers] property.

get_year()[source]¶

Returns:: the year of the selected date.
Return type:: int

Gets the year of the selected date.

New in version 4.14.

mark_day(day)[source]¶

Parameters:: day (int) – the day number to mark between 1 and 31.

Places a visual marker on a particular day of the current month.

select_day(date)[source]¶

Parameters:: date (GLib.DateTime) – a GDateTime representing the day to select

Switches to date's year and month and select its day.

Deprecated since version 4.20: Use [method`Calendar`.set_date] instead.

set_date(date)[source]¶

Parameters:: date (GLib.DateTime) – a GDateTime representing the day to select

Switches to date's year and month and selects its day.

New in version 4.20.

set_day(day)[source]¶

Parameters:: day (int) – The desired day for the selected date (as a number between 1 and 31).

Sets the day for the selected date.

The new date must be valid. For example, setting the day to 31 when the month is February will fail.

New in version 4.14.

set_month(month)[source]¶

Parameters:: month (int) – The desired month for the selected date (as a number between 0 and 11).

Sets the month for the selected date.

The new date must be valid. For example, setting the month to 1 (February) when the day is 31 will fail.

New in version 4.14.

set_show_day_names(value)[source]¶

Parameters:: value (bool) – Whether to show day names above the day numbers

Sets whether the calendar shows day names.

set_show_heading(value)[source]¶

Parameters:: value (bool) – Whether to show the heading in the calendar

Sets whether the calendar should show a heading.

The heading contains the current year and month as well as buttons for changing both.

set_show_week_numbers(value)[source]¶

Parameters:: value (bool) – whether to show week numbers alongside the days

Sets whether week numbers are shown in the calendar.

set_year(year)[source]¶

Parameters:: year (int) – The desired year for the selected date (within [struct`GLib`.DateTime] limits, i.e. from 0001 to 9999).

Sets the year for the selected date.

The new date must be valid. For example, setting the year to 2023 when the date is February 29 will fail.

New in version 4.14.

unmark_day(day)[source]¶

Parameters:: day (int) – the day number to unmark between 1 and 31.

Removes the visual marker from a particular day.

Signal Details¶

Gtk.Calendar.signals.day_selected(calendar)¶

Signal Name:: day-selected
Flags:: RUN_FIRST
Parameters:: calendar (Gtk.Calendar) – The object which received the signal

Emitted when the user selects a day.

Gtk.Calendar.signals.next_month(calendar)¶

Signal Name:: next-month
Flags:: RUN_FIRST
Parameters:: calendar (Gtk.Calendar) – The object which received the signal

Emitted when the user switches to the next month.

Gtk.Calendar.signals.next_year(calendar)¶

Signal Name:: next-year
Flags:: RUN_FIRST
Parameters:: calendar (Gtk.Calendar) – The object which received the signal

Emitted when user switches to the next year.

Gtk.Calendar.signals.prev_month(calendar)¶

Signal Name:: prev-month
Flags:: RUN_FIRST
Parameters:: calendar (Gtk.Calendar) – The object which received the signal

Emitted when the user switches to the previous month.

Gtk.Calendar.signals.prev_year(calendar)¶

Signal Name:: prev-year
Flags:: RUN_FIRST
Parameters:: calendar (Gtk.Calendar) – The object which received the signal

Emitted when user switches to the previous year.

Property Details¶

Gtk.Calendar.props.date¶

Name:: date
Type:: GLib.DateTime
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The selected date.

This property gets initially set to the current date.

Gtk.Calendar.props.day¶

Name:: day
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The selected day (as a number between 1 and 31).

Deprecated since version 4.20: This property will be removed in GTK 5. Use [property`Calendar`:date] instead.

Gtk.Calendar.props.month¶

Name:: month
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The selected month (as a number between 0 and 11).

This property gets initially set to the current month.

Deprecated since version 4.20: This property will be removed in GTK 5. Use [property`Calendar`:date] instead.

Gtk.Calendar.props.show_day_names¶

Name:: show-day-names
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Determines whether day names are displayed.

Gtk.Calendar.props.show_heading¶

Name:: show-heading
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Determines whether a heading is displayed.

Gtk.Calendar.props.show_week_numbers¶

Name:: show-week-numbers
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Determines whether week numbers are displayed.

Gtk.Calendar.props.year¶

Name:: year
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The selected year.

This property gets initially set to the current year.

Deprecated since version 4.20: This property will be removed in GTK 5. Use [property`Calendar`:date] instead.