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