GtkCalendar {RGtk2}R Documentation

GtkCalendar

Description

Displays a calendar and allows the user to select a date

Methods and Functions

gtkCalendarNew(show = TRUE)
gtkCalendarSelectMonth(object, month, year)
gtkCalendarSelectDay(object, day)
gtkCalendarMarkDay(object, day)
gtkCalendarUnmarkDay(object, day)
gtkCalendarClearMarks(object)
gtkCalendarGetDisplayOptions(object)
gtkCalendarSetDisplayOptions(object, flags)
gtkCalendarDisplayOptions(object, flags)
gtkCalendarGetDate(object)
gtkCalendarFreeze(object)
gtkCalendarThaw(object)
gtkCalendar(show = TRUE)

Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkCalendar

Interfaces

GtkCalendar implements GtkBuildable and AtkImplementorIface.

Detailed Description

GtkCalendar is a widget that displays a calendar, one month at a time. It can be created with gtkCalendarNew.

The month and year currently displayed can be altered with gtkCalendarSelectMonth. The exact day can be selected from the displayed month using gtkCalendarSelectDay.

To place a visual marker on a particular day, use gtkCalendarMarkDay and to remove the marker, gtkCalendarUnmarkDay. Alternative, all marks can be cleared with gtkCalendarClearMarks.

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

The selected date can be retrieved from a GtkCalendar using gtkCalendarGetDate.

Structures

GtkCalendar
num_marked_dates is an integer containing the number of days that have a mark over them.

marked_date is a list containing the day numbers that currently have a mark over them.

month, year, and selected_day contain the currently visible month, year, and selected day respectively.

All of these fields should be considered read only, and everything in this struct should only be modified using the functions provided below.

Convenient Construction

gtkCalendar is the equivalent of gtkCalendarNew.

Enums and Flags

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

show-heading
Specifies that the month and year should be displayed.
show-day-names
Specifies that three letter day descriptions should be present.
no-month-change
Prevents the user from switching months with the calendar.
show-week-numbers
Displays each week numbers of the current year, down the left side of the calendar.
week-start-monday
Since GTK+ 2.4, this option is deprecated and ignored by GTK+. The information on which day the calendar week starts is derived from the locale.

Signals

The (calendar, user.data)
Emitted when the user selects a day.

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
undocumented

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
Emitted when the user clicks a button to change the selected month on a calendar.

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
undocumented

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
undocumented

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
undocumented

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

The (calendar, user.data)
undocumented

calendar
[GtkCalendar] the object which received the signal.
user.data
[R object] user data set when the signal handler was connected.

Properties

day [integer : Read / Write]

The selected day (as a number between 1 and 31, or 0 to unselect the currently selected day). Allowed values: [0,31] Default value: 0

month [integer : Read / Write]

The selected month (as a number between 0 and 11). Allowed values: [0,11] Default value: 0

no-month-change [logical : Read / Write]

Determines whether the selected month can be changed.

Default value: FALSE Since 2.4

show-day-names [logical : Read / Write]

Determines whether day names are displayed.

Default value: TRUE Since 2.4

show-heading [logical : Read / Write]

Determines whether a heading is displayed.

Default value: TRUE Since 2.4

show-week-numbers [logical : Read / Write]

Determines whether week numbers are displayed.

Default value: FALSE Since 2.4

year [integer : Read / Write]

The selected year. Allowed values: >= 0 Default value: 0

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/gtk/GtkCalendar.html


[Package RGtk2 version 2.12.5-3 Index]