Calendar

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_calendar_get_type ()" ) ]
public sealed class Calendar : Widget, Accessible, Buildable, ConstraintTarget

`GtkCalendar` is a widget that displays a Gregorian calendar, one month at a time.

![An example GtkCalendar](calendar.png)

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

The date that is currently displayed can be altered with [method@Gtk.Calendar.select_day].

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].

The selected date can be retrieved from a `GtkCalendar` using [method@Gtk.Calendar.get_date].

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.

CSS nodes

``` calendar.view ├── header │ ├── button │ ├── stack.month │ ├── button │ ├── button │ ├── label.year │ ╰── button ╰── grid ╰── label.day-name.day-number[.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 GtkCalendar:selected state assigned.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public int day { get; set; }
The selected day (as a number between 1 and 31).
public int month { get; set; }
The selected month (as a number between 0 and 11).
public bool show_day_names { get; set; }
Determines whether day names are displayed.
public bool show_heading { get; set; }
Determines whether a heading is displayed.
public bool show_week_numbers { get; set; }
Determines whether week numbers are displayed.
public int year { get; set; }
The selected year.

Creation methods:

public Calendar ()
Creates a new calendar, with the current date being selected.

Methods:

public void clear_marks ()
Remove all visual markers.
public DateTime get_date ()
Returns a `GDateTime` representing the shown year, month and the selected day.
public int get_day ()
Gets the day of the selected date.
public bool get_day_is_marked (uint day)
Returns if the day of the this is already marked.
public int get_month ()
Gets the month of the selected date.
public bool get_show_day_names ()
Returns whether this is currently showing the names of the week days.
public bool get_show_heading ()
Returns whether this is currently showing the heading.
public bool get_show_week_numbers ()
Returns whether this is showing week numbers right now.
public int get_year ()
Gets the year of the selected date.
public void mark_day (uint day)
Places a visual marker on a particular day of the current month.
public void select_day (DateTime date)
Switches to date's year and month and select its day.
public void set_day (int day)
Sets the day for the selected date.
public void set_month (int month)
Sets the month for the selected date.
public void set_show_day_names (bool value)
Sets whether the calendar shows day names.
public void set_show_heading (bool value)
Sets whether the calendar should show a heading.
public void set_show_week_numbers (bool value)
Sets whether week numbers are shown in the calendar.
public void set_year (int year)
Sets the year for the selected date.
public void unmark_day (uint day)
Removes the visual marker from a particular day.

Signals:

public signal void day_selected ()
Emitted when the user selects a day.
public signal void next_month ()
Emitted when the user switched to the next month.
public signal void next_year ()
Emitted when user switched to the next year.
public signal void prev_month ()
Emitted when the user switched to the previous month.
public signal void prev_year ()
Emitted when user switched to the previous year.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable