* Copyright (C) 1998 Cesar Miquel and Shawn T. Amundson
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the Free
- * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#ifndef __GTK_CALENDAR_H__
#define __GTK_CALENDAR_H__
-#include <gdk/gdk.h>
-#include <gtk/gtksignal.h>
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
#include <gtk/gtkwidget.h>
-#include <gtk/gtkfeatures.h>
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-#define GTK_CALENDAR(obj) GTK_CHECK_CAST (obj, gtk_calendar_get_type (), GtkCalendar)
-#define GTK_CALENDAR_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_calendar_get_type (), GtkCalendarClass)
-#define GTK_IS_CALENDAR(obj) GTK_CHECK_TYPE (obj, gtk_calendar_get_type ())
+G_BEGIN_DECLS
+
+#define GTK_TYPE_CALENDAR (gtk_calendar_get_type ())
+#define GTK_CALENDAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CALENDAR, GtkCalendar))
+#define GTK_CALENDAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CALENDAR, GtkCalendarClass))
+#define GTK_IS_CALENDAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CALENDAR))
+#define GTK_IS_CALENDAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CALENDAR))
+#define GTK_CALENDAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CALENDAR, GtkCalendarClass))
+
-typedef struct _GtkCalendar GtkCalendar;
+typedef struct _GtkCalendar GtkCalendar;
typedef struct _GtkCalendarClass GtkCalendarClass;
+typedef struct _GtkCalendarPrivate GtkCalendarPrivate;
+
+/**
+ * GtkCalendarDisplayOptions:
+ * @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().
+ *
+ * These options can be used to influence the display and behaviour of a #GtkCalendar.
+ */
typedef enum
{
- GTK_CALENDAR_SHOW_HEADING = 1 << 0,
- GTK_CALENDAR_SHOW_DAY_NAMES = 1 << 1,
- GTK_CALENDAR_NO_MONTH_CHANGE = 1 << 2,
- GTK_CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
- GTK_CALENDAR_WEEK_START_MONDAY = 1 << 4
+ GTK_CALENDAR_SHOW_HEADING = 1 << 0,
+ GTK_CALENDAR_SHOW_DAY_NAMES = 1 << 1,
+ GTK_CALENDAR_NO_MONTH_CHANGE = 1 << 2,
+ GTK_CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
+ GTK_CALENDAR_SHOW_DETAILS = 1 << 5
} GtkCalendarDisplayOptions;
+/**
+ * GtkCalendarDetailFunc:
+ * @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().
+ *
+ * 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.
+ *
+ * Since: 2.14
+ *
+ * Return value: Newly allocated string with Pango markup with details
+ * for the specified day, or %NULL.
+ */
+typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
+ guint year,
+ guint month,
+ guint day,
+ gpointer user_data);
+
struct _GtkCalendar
{
- /* This widget is derived from GtkWidget */
GtkWidget widget;
-
- GdkWindow *header_win, *day_name_win, *main_win, *week_win;
- gint header_h, day_name_h, main_h;
-
- GtkStyle *header_style;
- GtkStyle *label_style;
-
- gint month;
- gint year;
- gint selected_day;
-
- gint day_month[6][7];
- gint day[6][7];
-
- gint num_marked_dates;
- gint marked_date[31];
- GtkCalendarDisplayOptions display_flags;
- GdkColor marked_date_color[31];
-
- /* Header Information */
- GdkWindow *arrow_win[4];
- gint arrow_state[4];
- gint arrow_width;
- gint max_month_width;
- gint max_year_width;
-
- /* Other info */
- gint calstarty, calnumrows;
-
- /* Style parameters for this widget */
- GdkGC *gc;
- GdkCursor *cross;
-
- gint day_width;
- gint week_width;
- GdkRectangle header_button[4];
- GdkRectangle rect_days[6][7];
-
- gint highlight_row;
- gint highlight_col;
-
- gint min_day_width;
- gint max_day_char_width;
- gint max_day_char_ascent;
- gint max_day_char_descent;
- gint max_label_char_ascent;
- gint max_label_char_descent;
- gint max_week_char_width;
- /* flags */
- unsigned int dirty_header:1;
- unsigned int dirty_day_names:1;
- unsigned int dirty_main:1;
- unsigned int dirty_week:1;
- unsigned int frozen;
-
- gint week_num_w;
- gint font_width_day_name, font_width_day;
- char grow_space [32];
+
+ GtkCalendarPrivate *priv;
};
struct _GtkCalendarClass
{
GtkWidgetClass parent_class;
-
+
/* Signal handlers */
- void (* gtk_calendar_month_changed) (GtkCalendarClass *);
- void (* gtk_calendar_day_selected) (GtkCalendarClass *);
- void (* gtk_calendar_day_selected_double_click) (GtkCalendarClass *);
- void (* gtk_calendar_prev_month) (GtkCalendarClass *);
- void (* gtk_calendar_next_month) (GtkCalendarClass *);
- void (* gtk_calendar_prev_year) (GtkCalendarClass *);
- void (* gtk_calendar_next_year) (GtkCalendarClass *);
-
+ void (* month_changed) (GtkCalendar *calendar);
+ void (* day_selected) (GtkCalendar *calendar);
+ void (* day_selected_double_click) (GtkCalendar *calendar);
+ void (* prev_month) (GtkCalendar *calendar);
+ void (* next_month) (GtkCalendar *calendar);
+ void (* prev_year) (GtkCalendar *calendar);
+ void (* next_year) (GtkCalendar *calendar);
+
+ /* Padding for future expansion */
+ void (*_gtk_reserved1) (void);
+ void (*_gtk_reserved2) (void);
+ void (*_gtk_reserved3) (void);
+ void (*_gtk_reserved4) (void);
};
-guint gtk_calendar_get_type (void);
-GtkWidget* gtk_calendar_new (void);
+GType gtk_calendar_get_type (void) G_GNUC_CONST;
+GtkWidget* gtk_calendar_new (void);
+
+void gtk_calendar_select_month (GtkCalendar *calendar,
+ guint month,
+ guint year);
+void gtk_calendar_select_day (GtkCalendar *calendar,
+ guint day);
+
+void gtk_calendar_mark_day (GtkCalendar *calendar,
+ guint day);
+void gtk_calendar_unmark_day (GtkCalendar *calendar,
+ guint day);
+void gtk_calendar_clear_marks (GtkCalendar *calendar);
+
+
+void gtk_calendar_set_display_options (GtkCalendar *calendar,
+ GtkCalendarDisplayOptions flags);
+GtkCalendarDisplayOptions
+ gtk_calendar_get_display_options (GtkCalendar *calendar);
+void gtk_calendar_get_date (GtkCalendar *calendar,
+ guint *year,
+ guint *month,
+ guint *day);
-gint gtk_calendar_select_month (GtkCalendar *calendar,
- gint month, gint year);
-void gtk_calendar_select_day (GtkCalendar *calendar, gint day);
+void gtk_calendar_set_detail_func (GtkCalendar *calendar,
+ GtkCalendarDetailFunc func,
+ gpointer data,
+ GDestroyNotify destroy);
-gint gtk_calendar_mark_day (GtkCalendar *calendar, gint day);
-gint gtk_calendar_unmark_day (GtkCalendar *calendar, gint day);
-void gtk_calendar_clear_marks (GtkCalendar *calendar);
+void gtk_calendar_set_detail_width_chars (GtkCalendar *calendar,
+ gint chars);
+void gtk_calendar_set_detail_height_rows (GtkCalendar *calendar,
+ gint rows);
+gint gtk_calendar_get_detail_width_chars (GtkCalendar *calendar);
+gint gtk_calendar_get_detail_height_rows (GtkCalendar *calendar);
-void gtk_calendar_display_options (GtkCalendar *calendar,
- GtkCalendarDisplayOptions flags);
+gboolean gtk_calendar_get_day_is_marked (GtkCalendar *calendar,
+ guint day);
-void gtk_calendar_get_date (GtkCalendar *calendar,
- gint *year, gint *month, gint *day);
-void gtk_calendar_freeze (GtkCalendar *calendar);
-void gtk_calendar_thaw (GtkCalendar *calendar);
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
#endif /* __GTK_CALENDAR_H__ */