Pileus Git - ~andy/gtk/blob - gtk/gtkcalendar.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * GTK Calendar Widget
   5  * Copyright (C) 1998 Cesar Miquel and Shawn T. Amundson
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free
  19  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 /*
  23  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  24  * file for a list of people on the GTK+ Team.  See the ChangeLog
  25  * files for a list of changes.  These files are distributed with
  26  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  27  */
  28
  29 #ifndef __GTK_CALENDAR_H__
  30 #define __GTK_CALENDAR_H__
  31
  32 #include <gdk/gdk.h>
  33 #include <gtk/gtkwidget.h>
  34
  35 /* Not needed, retained for compatibility -Yosh */
  36 #include <gtk/gtksignal.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 #define GTK_TYPE_CALENDAR                  (gtk_calendar_get_type ())
  42 #define GTK_CALENDAR(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CALENDAR, GtkCalendar))
  43 #define GTK_CALENDAR_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CALENDAR, GtkCalendarClass))
  44 #define GTK_IS_CALENDAR(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CALENDAR))
  45 #define GTK_IS_CALENDAR_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CALENDAR))
  46 #define GTK_CALENDAR_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CALENDAR, GtkCalendarClass))
  47
  48
  49 typedef struct _GtkCalendar            GtkCalendar;
  50 typedef struct _GtkCalendarClass       GtkCalendarClass;
  51
  52 typedef struct _GtkCalendarPrivate     GtkCalendarPrivate;
  53
  54 typedef enum
  55 {
  56   GTK_CALENDAR_SHOW_HEADING             = 1 << 0,
  57   GTK_CALENDAR_SHOW_DAY_NAMES           = 1 << 1,
  58   GTK_CALENDAR_NO_MONTH_CHANGE          = 1 << 2,
  59   GTK_CALENDAR_SHOW_WEEK_NUMBERS        = 1 << 3,
  60   GTK_CALENDAR_WEEK_START_MONDAY        = 1 << 4
  61 } GtkCalendarDisplayOptions;
  62
  63 /**
  64  * GtkCalendarDetailFunc:
  65  * @calendar: a #GtkCalendar.
  66  * @year: the year for which details are needed.
  67  * @month: the month for which details are needed.
  68  * @day: the day of @month for which details are needed.
  69  * @user_data: the data passed with gtk_calendar_set_detail_func().
  70  *
  71  * This kind of functions provide Pango markup with detail information for the
  72  * specified day. Examples for such details are holidays or appointments. The
  73  * function returns %NULL when no information is available.
  74  *
  75  * Since: 2.16
  76  *
  77  * Return value: Pango markup with details for the specified day, or %NULL.
  78  */
  79 typedef G_CONST_RETURN gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
  80                                                         guint        year,
  81                                                         guint        month,
  82                                                         guint        day,
  83                                                         gpointer     user_data);
  84
  85 struct _GtkCalendar
  86 {
  87   GtkWidget widget;
  88
  89   GtkStyle  *header_style;
  90   GtkStyle  *label_style;
  91
  92   gint month;
  93   gint year;
  94   gint selected_day;
  95
  96   gint day_month[6][7];
  97   gint day[6][7];
  98
  99   gint num_marked_dates;
 100   gint marked_date[31];
 101   GtkCalendarDisplayOptions  display_flags;
 102   GdkColor marked_date_color[31];
 103
 104   GdkGC *gc;                    /* unused */
 105   GdkGC *xor_gc;                /* unused */
 106
 107   gint focus_row;
 108   gint focus_col;
 109
 110   gint highlight_row;
 111   gint highlight_col;
 112
 113   GtkCalendarPrivate *priv;
 114   gchar grow_space [32];
 115
 116   /* Padding for future expansion */
 117   void (*_gtk_reserved1) (void);
 118   void (*_gtk_reserved2) (void);
 119   void (*_gtk_reserved3) (void);
 120   void (*_gtk_reserved4) (void);
 121 };
 122
 123 struct _GtkCalendarClass
 124 {
 125   GtkWidgetClass parent_class;
 126
 127   /* Signal handlers */
 128   void (* month_changed)                (GtkCalendar *calendar);
 129   void (* day_selected)                 (GtkCalendar *calendar);
 130   void (* day_selected_double_click)    (GtkCalendar *calendar);
 131   void (* prev_month)                   (GtkCalendar *calendar);
 132   void (* next_month)                   (GtkCalendar *calendar);
 133   void (* prev_year)                    (GtkCalendar *calendar);
 134   void (* next_year)                    (GtkCalendar *calendar);
 135
 136 };
 137
 138
 139 GType      gtk_calendar_get_type        (void) G_GNUC_CONST;
 140 GtkWidget* gtk_calendar_new             (void);
 141
 142 gboolean   gtk_calendar_select_month    (GtkCalendar *calendar,
 143                                          guint        month,
 144                                          guint        year);
 145 void       gtk_calendar_select_day      (GtkCalendar *calendar,
 146                                          guint        day);
 147
 148 gboolean   gtk_calendar_mark_day        (GtkCalendar *calendar,
 149                                          guint        day);
 150 gboolean   gtk_calendar_unmark_day      (GtkCalendar *calendar,
 151                                          guint        day);
 152 void       gtk_calendar_clear_marks     (GtkCalendar *calendar);
 153
 154
 155 void       gtk_calendar_set_display_options (GtkCalendar              *calendar,
 156                                              GtkCalendarDisplayOptions flags);
 157 GtkCalendarDisplayOptions
 158            gtk_calendar_get_display_options (GtkCalendar              *calendar);
 159 #ifndef GTK_DISABLE_DEPRECATED
 160 void       gtk_calendar_display_options (GtkCalendar              *calendar,
 161                                          GtkCalendarDisplayOptions flags);
 162 #endif
 163
 164 void       gtk_calendar_get_date        (GtkCalendar *calendar,
 165                                          guint       *year,
 166                                          guint       *month,
 167                                          guint       *day);
 168
 169 void       gtk_calendar_set_detail_func (GtkCalendar           *calendar,
 170                                          GtkCalendarDetailFunc  func,
 171                                          gpointer               data,
 172                                          GDestroyNotify         destroy);
 173
 174 void       gtk_calendar_set_detail_width_chars (GtkCalendar    *calendar,
 175                                                 gint            chars);
 176 void       gtk_calendar_set_detail_height_rows (GtkCalendar    *calendar,
 177                                                 gint            rows);
 178
 179 gint       gtk_calendar_get_detail_width_chars (GtkCalendar    *calendar);
 180 gint       gtk_calendar_get_detail_height_rows (GtkCalendar    *calendar);
 181
 182 #ifndef GTK_DISABLE_DEPRECATED
 183 void       gtk_calendar_freeze          (GtkCalendar *calendar);
 184 void       gtk_calendar_thaw            (GtkCalendar *calendar);
 185 #endif
 186
 187 G_END_DECLS
 188
 189 #endif /* __GTK_CALENDAR_H__ */