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 /**
  55  * GtkCalendarDisplayOptions:
  56  * @GTK_CALENDAR_SHOW_HEADING: Specifies that the month and year should be displayed.
  57  * @GTK_CALENDAR_SHOW_DAY_NAMES: Specifies that three letter day descriptions should be present.
  58  * @GTK_CALENDAR_NO_MONTH_CHANGE: Prevents the user from switching months with the calendar.
  59  * @GTK_CALENDAR_SHOW_WEEK_NUMBERS: Displays each week numbers of the current year, down the
  60  * left side of the calendar.
  61  * @GTK_CALENDAR_WEEK_START_MONDAY: Since GTK+ 2.4, this option is deprecated and ignored by GTK+.
  62  * The information on which day the calendar week starts is derived from the locale.
  63  * @GTK_CALENDAR_SHOW_DETAILS: Just show an indicator, not the full details
  64  * text when details are provided. See gtk_calendar_set_detail_func().
  65  *
  66  * These options can be used to influence the display and behaviour of a #GtkCalendar.
  67  */
  68 typedef enum
  69 {
  70   GTK_CALENDAR_SHOW_HEADING             = 1 << 0,
  71   GTK_CALENDAR_SHOW_DAY_NAMES           = 1 << 1,
  72   GTK_CALENDAR_NO_MONTH_CHANGE          = 1 << 2,
  73   GTK_CALENDAR_SHOW_WEEK_NUMBERS        = 1 << 3,
  74   GTK_CALENDAR_WEEK_START_MONDAY        = 1 << 4,
  75   GTK_CALENDAR_SHOW_DETAILS             = 1 << 5,
  76 } GtkCalendarDisplayOptions;
  77
  78 /**
  79  * GtkCalendarDetailFunc:
  80  * @calendar: a #GtkCalendar.
  81  * @year: the year for which details are needed.
  82  * @month: the month for which details are needed.
  83  * @day: the day of @month for which details are needed.
  84  * @user_data: the data passed with gtk_calendar_set_detail_func().
  85  *
  86  * This kind of functions provide Pango markup with detail information for the
  87  * specified day. Examples for such details are holidays or appointments. The
  88  * function returns %NULL when no information is available.
  89  *
  90  * Since: 2.16
  91  *
  92  * Return value: Newly allocated string with Pango markup with details
  93  * for the specified day, or %NULL.
  94  */
  95 typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
  96                                          guint        year,
  97                                          guint        month,
  98                                          guint        day,
  99                                          gpointer     user_data);
 100
 101 struct _GtkCalendar
 102 {
 103   GtkWidget widget;
 104
 105   GtkStyle  *header_style;
 106   GtkStyle  *label_style;
 107
 108   gint month;
 109   gint year;
 110   gint selected_day;
 111
 112   gint day_month[6][7];
 113   gint day[6][7];
 114
 115   gint num_marked_dates;
 116   gint marked_date[31];
 117   GtkCalendarDisplayOptions  display_flags;
 118   GdkColor marked_date_color[31];
 119
 120   GdkGC *gc;                    /* unused */
 121   GdkGC *xor_gc;                /* unused */
 122
 123   gint focus_row;
 124   gint focus_col;
 125
 126   gint highlight_row;
 127   gint highlight_col;
 128
 129   GtkCalendarPrivate *priv;
 130   gchar grow_space [32];
 131
 132   /* Padding for future expansion */
 133   void (*_gtk_reserved1) (void);
 134   void (*_gtk_reserved2) (void);
 135   void (*_gtk_reserved3) (void);
 136   void (*_gtk_reserved4) (void);
 137 };
 138
 139 struct _GtkCalendarClass
 140 {
 141   GtkWidgetClass parent_class;
 142
 143   /* Signal handlers */
 144   void (* month_changed)                (GtkCalendar *calendar);
 145   void (* day_selected)                 (GtkCalendar *calendar);
 146   void (* day_selected_double_click)    (GtkCalendar *calendar);
 147   void (* prev_month)                   (GtkCalendar *calendar);
 148   void (* next_month)                   (GtkCalendar *calendar);
 149   void (* prev_year)                    (GtkCalendar *calendar);
 150   void (* next_year)                    (GtkCalendar *calendar);
 151
 152 };
 153
 154
 155 GType      gtk_calendar_get_type        (void) G_GNUC_CONST;
 156 GtkWidget* gtk_calendar_new             (void);
 157
 158 gboolean   gtk_calendar_select_month    (GtkCalendar *calendar,
 159                                          guint        month,
 160                                          guint        year);
 161 void       gtk_calendar_select_day      (GtkCalendar *calendar,
 162                                          guint        day);
 163
 164 gboolean   gtk_calendar_mark_day        (GtkCalendar *calendar,
 165                                          guint        day);
 166 gboolean   gtk_calendar_unmark_day      (GtkCalendar *calendar,
 167                                          guint        day);
 168 void       gtk_calendar_clear_marks     (GtkCalendar *calendar);
 169
 170
 171 void       gtk_calendar_set_display_options (GtkCalendar              *calendar,
 172                                              GtkCalendarDisplayOptions flags);
 173 GtkCalendarDisplayOptions
 174            gtk_calendar_get_display_options (GtkCalendar              *calendar);
 175 #ifndef GTK_DISABLE_DEPRECATED
 176 void       gtk_calendar_display_options (GtkCalendar              *calendar,
 177                                          GtkCalendarDisplayOptions flags);
 178 #endif
 179
 180 void       gtk_calendar_get_date        (GtkCalendar *calendar,
 181                                          guint       *year,
 182                                          guint       *month,
 183                                          guint       *day);
 184
 185 void       gtk_calendar_set_detail_func (GtkCalendar           *calendar,
 186                                          GtkCalendarDetailFunc  func,
 187                                          gpointer               data,
 188                                          GDestroyNotify         destroy);
 189
 190 void       gtk_calendar_set_detail_width_chars (GtkCalendar    *calendar,
 191                                                 gint            chars);
 192 void       gtk_calendar_set_detail_height_rows (GtkCalendar    *calendar,
 193                                                 gint            rows);
 194
 195 gint       gtk_calendar_get_detail_width_chars (GtkCalendar    *calendar);
 196 gint       gtk_calendar_get_detail_height_rows (GtkCalendar    *calendar);
 197
 198 #ifndef GTK_DISABLE_DEPRECATED
 199 void       gtk_calendar_freeze          (GtkCalendar *calendar);
 200 void       gtk_calendar_thaw            (GtkCalendar *calendar);
 201 #endif
 202
 203 G_END_DECLS
 204
 205 #endif /* __GTK_CALENDAR_H__ */