| gtkchinesecalendar Reference Manual | ||||
|---|---|---|---|---|
GtkChineseCalendarGtkChineseCalendar — Displays a chinese calendar and allows the user to select a date |
GtkChineseCalendarPrivate;
enum GtkChineseCalendarDisplayOptions;
GtkChineseCalendar;
GtkWidget* gtk_chinese_calendar_new (void);
gboolean gtk_chinese_calendar_select_month (GtkChineseCalendar *calendar,
guint month,
guint year);
void gtk_chinese_calendar_select_day (GtkChineseCalendar *calendar,
guint day);
gboolean gtk_chinese_calendar_mark_day (GtkChineseCalendar *calendar,
guint day);
gboolean gtk_chinese_calendar_unmark_day (GtkChineseCalendar *calendar,
guint day);
void gtk_chinese_calendar_clear_marks (GtkChineseCalendar *calendar);
void gtk_chinese_calendar_set_display_options
(GtkChineseCalendar *calendar,
GtkChineseCalendarDisplayOptions flags);
GtkChineseCalendarDisplayOptions gtk_chinese_calendar_get_display_options
(GtkChineseCalendar *calendar);
void gtk_chinese_calendar_display_options
(GtkChineseCalendar *calendar,
GtkChineseCalendarDisplayOptions flags);
void gtk_chinese_calendar_get_date (GtkChineseCalendar *calendar,
guint *year,
guint *month,
guint *day);
void gtk_chinese_calendar_freeze (GtkChineseCalendar *calendar);
void gtk_chinese_calendar_thaw (GtkChineseCalendar *calendar);
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkChineseCalendar
"day" gint : Read / Write "month" gint : Read / Write "no-month-change" gboolean : Read / Write "show-day-names" gboolean : Read / Write "show-heading" gboolean : Read / Write "show-lunar-date" gboolean : Read / Write "show-week-numbers" gboolean : Read / Write "year" gint : Read / Write
"day-selected" : Run First "day-selected-double-click" : Run First "month-changed" : Run First "next-month" : Run First "next-year" : Run First "prev-month" : Run First "prev-year" : Run First
GtkChineseCalendar is a widget that displays a chinese calendar, one month at a time.
It can be created with gtk_chinese_calendar_new().
The month and year currently displayed can be altered with
gtk_chinese_calendar_select_month(). The exact day can be selected from the displayed
month using gtk_chinese_calendar_select_day().
To place a visual marker on a particular day, use gtk_chinese_calendar_mark_day()
and to remove the marker, gtk_chinese_calendar_unmark_day().
Alternative, all marks can be cleared with gtk_chinese_calendar_clear_marks().
The way in which the calendar itself is displayed can be altered using
gtk_chinese_calendar_set_display_options().
The selected date can be retrieved from a GtkChineseCalendar using
gtk_chinese_calendar_get_date().
typedef enum
{
GTK_CHINESE_CALENDAR_SHOW_HEADING = 1 << 0,
GTK_CHINESE_CALENDAR_SHOW_DAY_NAMES = 1 << 1,
GTK_CHINESE_CALENDAR_NO_MONTH_CHANGE = 1 << 2,
GTK_CHINESE_CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
GTK_CHINESE_CALENDAR_WEEK_START_MONDAY = 1 << 4,
GTK_CHINESE_CALENDAR_SHOW_LUNAR_DATE = 1 << 5
} GtkChineseCalendarDisplayOptions;
GtkWidget* gtk_chinese_calendar_new (void);
Creates a new calendar, with the current date being selected.
Returns : |
a newly GtkChineseCalendar widget |
gboolean gtk_chinese_calendar_select_month (GtkChineseCalendar *calendar, guint month, guint year);
Shifts the calendar to a different month.
|
a GtkChineseCalendar |
|
a month number between 0 and 11. |
|
the year the month is in. |
Returns : |
TRUE, always
|
void gtk_chinese_calendar_select_day (GtkChineseCalendar *calendar, guint day);
Selects a day from the current month.
|
a GtkChineseCalendar. |
|
the day number between 1 and 31, or 0 to unselect the currently selected day. |
gboolean gtk_chinese_calendar_mark_day (GtkChineseCalendar *calendar, guint day);
Places a visual marker on a particular day.
|
a GtkChineseCalendar |
|
the day number to mark between 1 and 31. |
Returns : |
TRUE, always
|
gboolean gtk_chinese_calendar_unmark_day (GtkChineseCalendar *calendar, guint day);
Removes the visual marker from a particular day.
|
a GtkChineseCalendar. |
|
the day number to unmark between 1 and 31. |
Returns : |
TRUE, always
|
void gtk_chinese_calendar_clear_marks (GtkChineseCalendar *calendar);
Remove all visual markers.
|
a GtkChineseCalendar |
void gtk_chinese_calendar_set_display_options
(GtkChineseCalendar *calendar,
GtkChineseCalendarDisplayOptions flags);
Sets display options (whether to display the heading and the month headings).
|
a GtkChineseCalendar |
|
the display options to set |
Since 2.4
GtkChineseCalendarDisplayOptions gtk_chinese_calendar_get_display_options (GtkChineseCalendar *calendar);
Returns the current display options of calendar.
|
a GtkChineseCalendar |
Returns : |
the display options. |
Since 2.4
void gtk_chinese_calendar_display_options
(GtkChineseCalendar *calendar,
GtkChineseCalendarDisplayOptions flags);
gtk_chinese_calendar_display_options has been deprecated since version 2.4 and should not be used in newly-written code. Use gtk_chinese_calendar_set_display_options() instead
Sets display options (whether to display the heading and the month headings).
|
a GtkChineseCalendar. |
|
the display options to set. |
void gtk_chinese_calendar_get_date (GtkChineseCalendar *calendar, guint *year, guint *month, guint *day);
Obtains the selected date from a GtkChineseCalendar.
|
a GtkChineseCalendar |
|
location to store the year number, or NULL
|
|
location to store the month number (between 0 and 11), or NULL
|
|
location to store the day number (between 1 and 31), or NULL
|
void gtk_chinese_calendar_freeze (GtkChineseCalendar *calendar);
gtk_chinese_calendar_freeze has been deprecated since version 2.8 and should not be used in newly-written code.
Does nothing. Previously locked the display of the calendar until
it was thawed with gtk_chinese_calendar_thaw().
|
a GtkChineseCalendar |
void gtk_chinese_calendar_thaw (GtkChineseCalendar *calendar);
gtk_chinese_calendar_thaw has been deprecated since version 2.8 and should not be used in newly-written code.
Does nothing. Previously defrosted a calendar; all the changes made
since the last gtk_chinese_calendar_freeze() were displayed.
|
a GtkChineseCalendar |
"day" property"day" gint : 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" property"month" gint : Read / Write
The selected month (as a number between 0 and 11).
Allowed values: [0,11]
Default value: 0
"no-month-change" property"no-month-change" gboolean : Read / Write
Determines whether the selected month can be changed.
Default value: FALSE
Since 2.4
"show-day-names" property"show-day-names" gboolean : Read / Write
Determines whether day names are displayed.
Default value: TRUE
Since 2.4
"show-heading" property"show-heading" gboolean : Read / Write
Determines whether a heading is displayed.
Default value: TRUE
Since 2.4
"show-lunar-date" property"show-lunar-date" gboolean : Read / Write
Determines whether chinese lunar date are displayed.
Default value: FALSE
"show-week-numbers" property"show-week-numbers" gboolean : Read / Write
Determines whether week numbers are displayed.
Default value: FALSE
Since 2.4
"day-selected" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"day-selected-double-click" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"month-changed" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"next-month" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"next-year" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"prev-month" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"prev-year" signalvoid user_function (GtkChineseCalendar *chinesecalendar, gpointer user_data) : Run First
|
the object which received the signal. |
|
user data set when the signal handler was connected. |