GtkCalendar

GtkCalendar — Displays a calendar and allows the user to select a date

Properties

gint day Read / Write
gint detail-height-rows Read / Write
gint detail-width-chars Read / Write
gint month Read / Write
gboolean no-month-change Read / Write
gboolean show-day-names Read / Write
gboolean show-details Read / Write
gboolean show-heading Read / Write
gboolean show-week-numbers Read / Write
gint year Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkCalendar

Implemented Interfaces

GtkCalendar implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

Description

GtkCalendar is a widget that displays a Gregorian calendar, one month at a time. It can be created with gtk_calendar_new().

The month and year currently displayed can be altered with gtk_calendar_select_month(). The exact day can be selected from the displayed month using gtk_calendar_select_day().

To place a visual marker on a particular day, use gtk_calendar_mark_day() and to remove the marker, gtk_calendar_unmark_day(). Alternative, all marks can be cleared with gtk_calendar_clear_marks().

The way in which the calendar itself is displayed can be altered using gtk_calendar_set_display_options().

The selected date can be retrieved from a GtkCalendar using 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.

Functions

GtkCalendarDetailFunc ()

gchar *
(*GtkCalendarDetailFunc) (GtkCalendar *calendar,
                          guint year,
                          guint month,
                          guint day,
                          gpointer user_data);

This kind of functions provide Pango markup with detail information for the specified day. Examples for such details are holidays or appointments. The function returns NULL when no information is available.

Parameters

calendar

a GtkCalendar.

 

year

the year for which details are needed.

 

month

the month for which details are needed.

 

day

the day of month for which details are needed.

 

user_data

the data passed with gtk_calendar_set_detail_func().

 

Returns

Newly allocated string with Pango markup with details for the specified day or NULL.

[nullable][transfer full]

Since: 2.14


gtk_calendar_new ()

GtkWidget *
gtk_calendar_new (void);

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

Returns

a newly GtkCalendar widget


gtk_calendar_select_month ()

void
gtk_calendar_select_month (GtkCalendar *calendar,
                           guint month,
                           guint year);

Shifts the calendar to a different month.

Parameters

calendar

a GtkCalendar

 

month

a month number between 0 and 11.

 

year

the year the month is in.

 

gtk_calendar_select_day ()

void
gtk_calendar_select_day (GtkCalendar *calendar,
                         guint day);

Selects a day from the current month.

Parameters

calendar

a GtkCalendar.

 

day

the day number between 1 and 31, or 0 to unselect the currently selected day.

 

gtk_calendar_mark_day ()

void
gtk_calendar_mark_day (GtkCalendar *calendar,
                       guint day);

Places a visual marker on a particular day.

Parameters

calendar

a GtkCalendar

 

day

the day number to mark between 1 and 31.

 

gtk_calendar_unmark_day ()

void
gtk_calendar_unmark_day (GtkCalendar *calendar,
                         guint day);

Removes the visual marker from a particular day.

Parameters

calendar

a GtkCalendar.

 

day

the day number to unmark between 1 and 31.

 

gtk_calendar_get_day_is_marked ()

gboolean
gtk_calendar_get_day_is_marked (GtkCalendar *calendar,
                                guint day);

Returns if the day of the calendar is already marked.

Parameters

calendar

a GtkCalendar

 

day

the day number between 1 and 31.

 

Returns

whether the day is marked.

Since: 3.0


gtk_calendar_clear_marks ()

void
gtk_calendar_clear_marks (GtkCalendar *calendar);

Remove all visual markers.

Parameters

calendar

a GtkCalendar

 

gtk_calendar_get_display_options ()

GtkCalendarDisplayOptions
gtk_calendar_get_display_options (GtkCalendar *calendar);

Returns the current display options of calendar .

Parameters

calendar

a GtkCalendar

 

Returns

the display options.

Since: 2.4


gtk_calendar_set_display_options ()

void
gtk_calendar_set_display_options (GtkCalendar *calendar,
                                  GtkCalendarDisplayOptions flags);

Sets display options (whether to display the heading and the month headings).

Parameters

calendar

a GtkCalendar

 

flags

the display options to set

 

Since: 2.4


gtk_calendar_get_date ()

void
gtk_calendar_get_date (GtkCalendar *calendar,
                       guint *year,
                       guint *month,
                       guint *day);

Obtains the selected date from a GtkCalendar.

Parameters

calendar

a GtkCalendar

 

year

location to store the year as a decimal number (e.g. 2011), or NULL.

[out][allow-none]

month

location to store the month number (between 0 and 11), or NULL.

[out][allow-none]

day

location to store the day number (between 1 and 31), or NULL.

[out][allow-none]

gtk_calendar_set_detail_func ()

void
gtk_calendar_set_detail_func (GtkCalendar *calendar,
                              GtkCalendarDetailFunc func,
                              gpointer data,
                              GDestroyNotify destroy);

Installs a function which provides Pango markup with detail information for each day. Examples for such details are holidays or appointments. That information is shown below each day when “show-details” is set. A tooltip containing with full detail information is provided, if the entire text should not fit into the details area, or if “show-details” is not set.

The size of the details area can be restricted by setting the “detail-width-chars” and “detail-height-rows” properties.

Parameters

calendar

a GtkCalendar.

 

func

a function providing details for each day.

 

data

data to pass to func invokations.

 

destroy

a function for releasing data .

 

Since: 2.14


gtk_calendar_get_detail_width_chars ()

gint
gtk_calendar_get_detail_width_chars (GtkCalendar *calendar);

Queries the width of detail cells, in characters. See “detail-width-chars”.

Parameters

calendar

a GtkCalendar.

 

Returns

The width of detail cells, in characters.

Since: 2.14


gtk_calendar_set_detail_width_chars ()

void
gtk_calendar_set_detail_width_chars (GtkCalendar *calendar,
                                     gint chars);

Updates the width of detail cells. See “detail-width-chars”.

Parameters

calendar

a GtkCalendar.

 

chars

detail width in characters.

 

Since: 2.14


gtk_calendar_get_detail_height_rows ()

gint
gtk_calendar_get_detail_height_rows (GtkCalendar *calendar);

Queries the height of detail cells, in rows. See “detail-width-chars”.

Parameters

calendar

a GtkCalendar.

 

Returns

The height of detail cells, in rows.

Since: 2.14


gtk_calendar_set_detail_height_rows ()

void
gtk_calendar_set_detail_height_rows (GtkCalendar *calendar,
                                     gint rows);

Updates the height of detail cells. See “detail-height-rows”.

Parameters

calendar

a GtkCalendar.

 

rows

detail height in rows.

 

Since: 2.14

Types and Values

struct GtkCalendar

struct GtkCalendar;

enum GtkCalendarDisplayOptions

These options can be used to influence the display and behaviour of a GtkCalendar.

Members

GTK_CALENDAR_SHOW_HEADING

Specifies that the month and year should be displayed.

 

GTK_CALENDAR_SHOW_DAY_NAMES

Specifies that three letter day descriptions should be present.

 

GTK_CALENDAR_NO_MONTH_CHANGE

Prevents the user from switching months with the calendar.

 

GTK_CALENDAR_SHOW_WEEK_NUMBERS

Displays each week numbers of the current year, down the left side of the calendar.

 

GTK_CALENDAR_SHOW_DETAILS

Just show an indicator, not the full details text when details are provided. See gtk_calendar_set_detail_func().

 

Property Details

The “day” property

  “day”                      gint

The selected day (as a number between 1 and 31, or 0 to unselect the currently selected day). This property gets initially set to the current day.

Flags: Read / Write

Allowed values: [0,31]

Default value: 0


The “detail-height-rows” property

  “detail-height-rows”       gint

Height of a detail cell, in rows. A value of 0 allows any width. See gtk_calendar_set_detail_func().

Flags: Read / Write

Allowed values: [0,127]

Default value: 0

Since: 2.14


The “detail-width-chars” property

  “detail-width-chars”       gint

Width of a detail cell, in characters. A value of 0 allows any width. See gtk_calendar_set_detail_func().

Flags: Read / Write

Allowed values: [0,127]

Default value: 0

Since: 2.14


The “month” property

  “month”                    gint

The selected month (as a number between 0 and 11). This property gets initially set to the current month.

Flags: Read / Write

Allowed values: [0,11]

Default value: 0


The “no-month-change” property

  “no-month-change”          gboolean

Determines whether the selected month can be changed.

Flags: Read / Write

Default value: FALSE

Since: 2.4


The “show-day-names” property

  “show-day-names”           gboolean

Determines whether day names are displayed.

Flags: Read / Write

Default value: TRUE

Since: 2.4


The “show-details” property

  “show-details”             gboolean

Determines whether details are shown directly in the widget, or if they are available only as tooltip. When this property is set days with details are marked.

Flags: Read / Write

Default value: TRUE

Since: 2.14


The “show-heading” property

  “show-heading”             gboolean

Determines whether a heading is displayed.

Flags: Read / Write

Default value: TRUE

Since: 2.4


The “show-week-numbers” property

  “show-week-numbers”        gboolean

Determines whether week numbers are displayed.

Flags: Read / Write

Default value: FALSE

Since: 2.4


The “year” property

  “year”                     gint

The selected year. This property gets initially set to the current year.

Flags: Read / Write

Allowed values: [0,4194303]

Default value: 0

Style Property Details

The “horizontal-separation” style property

  “horizontal-separation”    gint

Separation between week headers and main area.

Flags: Read

Allowed values: >= 0

Default value: 4


The “inner-border” style property

  “inner-border”             gint

The spacing around the day/week headers and main area.

Flags: Read

Allowed values: >= 0

Default value: 4


The “vertical-separation” style property

  “vertical-separation”      gint

Space between day headers and main area.

Flags: Read

Allowed values: >= 0

Default value: 4

Signal Details

The “day-selected” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when the user selects a day.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “day-selected-double-click” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when the user double-clicks a day.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “month-changed” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when the user clicks a button to change the selected month on a calendar.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “next-month” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when the user switched to the next month.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “next-year” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when user switched to the next year.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “prev-month” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when the user switched to the previous month.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “prev-year” signal

void
user_function (GtkCalendar *calendar,
               gpointer     user_data)

Emitted when user switched to the previous year.

Parameters

calendar

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First