Oxyscripts - PHP Development, tutorials, articles, news, programming, scripts and forums.

GtkCalendar

A calendar offering dates that can be selected and marked.

Object Hierarchy

GtkObject
`-- GtkWidget
`-- GtkCalendar

Direct subclasses

None.

Description

A GtkCalendar is a widget consisting of a grid container displaying a calendar, with an optional label allowing month/year navigation and an optional header giving abbreviated day names.

Both the day and the month names are supplied by the system locale, and cannot be overwritten. Unfortunately, under win32 there are severe problems with internationalization in the GDK source currently used by PHP-GTK. Non-standard ISO8859-1/2 characters cannot be drawn in this widget as a result of a wide character conversion failure under Windows. Multibyte characters are not recognised, and as they are supplied directly by the system to the widget there is no option to convert them using PHP. This issue is gradually being addressed by the PHP-GTK development team on a widget-by-widget basis.

Assuming that your locale and your operating system will allow you to use this widget's headers, the only other point to keep in mind is that a marked date is differentiated from the other dates by being drawn on a slightly bigger base rectangle, making it appear bold while actually using the same font as the rest of the widget. This is less effective in some fonts than in others, and can become a very negligable distinction.

Constructor

GtkCalendar (void);
-- Creates a calendar widget.

Methods

select_month()
Determines the month and year displayed.
select_day()
Determines the selected day.
mark_day()
Marks the given day.
unmark_day()
Unmarks the given day, if marked.
clear_marks()
Clears all marked dates.
display_options()
Sets flags determining the appearance of the calendar.
get_date()
Returns currently selected date.
freeze()
Freezes the display to allow updates.
thaw()
Thaws the display following updates.

Signals

"month-changed"
Emitted whenever the displayed month is changed.
"day-selected"
Emitted when a day is selected.
"day-selected-double-click"
Emitted when the mouse is clicked twice on a day.
"prev-month"
Emitted when user chooses to go back one month.
"next-month"
Emitted when user chooses to go forward one month.
"prev-year"
Emitted when user chooses to go back one year.
"next-year"
Emitted when user chooses to go forward one year.

Properties

month:
Currently selected month.
year:
Currently selected year.
selected_day:
Currently selected day.
num_marked_dates:
Number of marked dates held.
marked_date:
Array of marked dates.