Gtk-- Reference: Gtk::Calendar

Class Index | Cross Index | Namespace Index

# Class Gtk::Calendar

Display a calendar and/or allow the user to select a date.
Contained in: Gtk
Derived from: Gtk::Widget
Derived by: none

#include <gtk--/calendar.h>

### public function member index:
`` | `Calendar` | `()`;
``void`` | `clear_marks` | `()`;
``signal` `void`` | `day_selected` | `()`;
``signal` `void`` | `day_selected_double_click` | `()`;
``void`` | `display_options` | `(`GtkCalendarDisplayOptions` `flags`)`;
``void`` | `freeze` | `()`;
``void`` | `get_date` | `(`guint`* `year`, `guint`* `month`, `guint`* `day`) `const``;
``GtkCalendar`*` | `gtkobj` | `()`;
``const` `GtkCalendar`*` | `gtkobj` | `() `const``;
``static` `bool`` | `isA` | `(`Object`* `object`)`;
``gint`` | `mark_day` | `(`guint` `day`)`;
``signal` `void`` | `month_changed` | `()`;
``signal` `void`` | `next_month` | `()`;
``signal` `void`` | `next_year` | `()`;
``signal` `void`` | `prev_month` | `()`;
``signal` `void`` | `prev_year` | `()`;
``void`` | `select_day` | `(`guint` `day`)`;
``gint`` | `select_month` | `(`guint` `month`, `guint` `year`)`;
``void`` | `thaw` | `()`;
``gint`` | `unmark_day` | `(`guint` `day`)`;
``virtual`` | `~Calendar` | `()`;
### protected function member index:
``virtual` `void`` | `day_selected_double_click_impl` | `()`;
``virtual` `void`` | `day_selected_impl` | `()`;
``virtual` `void`` | `month_changed_impl` | `()`;
``virtual` `void`` | `next_month_impl` | `()`;
``virtual` `void`` | `next_year_impl` | `()`;
``virtual` `void`` | `prev_month_impl` | `()`;
``virtual` `void`` | `prev_year_impl` | `()`;

## Description:

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

The month and year currently displayed can be altered with `select_month`. The exact day can be selected from the displayed month using `select_day`.

The way in which the calendar itself is displayed can be altered using `display_options`.

The selected date can be retrieved from a GtkCalendar using `get_date`.

If performing many 'mark' operations, the calendar can be frozen to prevent flicker, using `freeze`, and 'thawed' again using `thaw`.

## Function Member Descriptions:

Gtk::Calendar::Calendar - Constructor.

`` `Calendar``()`;
Gtk::Calendar::day_selected - Emitted when the user selects a day.

``signal` `void`` `day_selected``()`;
``virtual` `void`` `day_selected_impl``()`;
Gtk::Calendar::freeze - Locks the display of the calendar until it is thawed with `thaw`.

``void`` `freeze``()`;
Gtk::Calendar::gtkobj - Returns the underlaying gtk+ object.

``GtkCalendar`*` `gtkobj``()`;
Gtk::Calendar::isA - Returns true if object is this type.

``static` `bool`` `isA``(`Object`* `object`)`;
Gtk::Calendar::month_changed - Emitted when the user clicks a button to change the selected month on a calendar.

``signal` `void`` `month_changed``()`;
``virtual` `void`` `month_changed_impl``()`;
Gtk::Calendar::select_day - Selects a day from the current month.

``void`` `select_day``(`guint` `day`)`;

> day : The day number to select.

Gtk::Calendar::select_month - Shifts the calendar to a different month.

``gint`` `select_month``(`guint` `month`, `guint` `year`)`;

> month: A month number.

> year: The year the month is in.

Gtk::Calendar::thaw - Defrosts a calendar; all the changes made since the last `freeze` are displayed.

``void`` `thaw``()`;