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_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
  37 #include <gtk/gtkwidget.h>
  38
  39
  40 G_BEGIN_DECLS
  41
  42 #define GTK_TYPE_CALENDAR                  (gtk_calendar_get_type ())
  43 #define GTK_CALENDAR(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CALENDAR, GtkCalendar))
  44 #define GTK_CALENDAR_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CALENDAR, GtkCalendarClass))
  45 #define GTK_IS_CALENDAR(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CALENDAR))
  46 #define GTK_IS_CALENDAR_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CALENDAR))
  47 #define GTK_CALENDAR_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CALENDAR, GtkCalendarClass))
  48
  49
  50 typedef struct _GtkCalendar            GtkCalendar;
  51 typedef struct _GtkCalendarClass       GtkCalendarClass;
  52
  53 typedef struct _GtkCalendarPrivate     GtkCalendarPrivate;
  54
  55 /**
  56  * GtkCalendarDisplayOptions:
  57  * @GTK_CALENDAR_SHOW_HEADING: Specifies that the month and year should be displayed.
  58  * @GTK_CALENDAR_SHOW_DAY_NAMES: Specifies that three letter day descriptions should be present.
  59  * @GTK_CALENDAR_NO_MONTH_CHANGE: Prevents the user from switching months with the calendar.
  60  * @GTK_CALENDAR_SHOW_WEEK_NUMBERS: Displays each week numbers of the current year, down the
  61  * left side of the calendar.
  62  * @GTK_CALENDAR_SHOW_DETAILS: Just show an indicator, not the full details
  63  * text when details are provided. See gtk_calendar_set_detail_func().
  64  *
  65  * These options can be used to influence the display and behaviour of a #GtkCalendar.
  66  */
  67 typedef enum
  68 {
  69   GTK_CALENDAR_SHOW_HEADING             = 1 << 0,
  70   GTK_CALENDAR_SHOW_DAY_NAMES           = 1 << 1,
  71   GTK_CALENDAR_NO_MONTH_CHANGE          = 1 << 2,
  72   GTK_CALENDAR_SHOW_WEEK_NUMBERS        = 1 << 3,
  73   GTK_CALENDAR_SHOW_DETAILS             = 1 << 5
  74 } GtkCalendarDisplayOptions;
  75
  76 /**
  77  * GtkCalendarDetailFunc:
  78  * @calendar: a #GtkCalendar.
  79  * @year: the year for which details are needed.
  80  * @month: the month for which details are needed.
  81  * @day: the day of @month for which details are needed.
  82  * @user_data: the data passed with gtk_calendar_set_detail_func().
  83  *
  84  * This kind of functions provide Pango markup with detail information for the
  85  * specified day. Examples for such details are holidays or appointments. The
  86  * function returns %NULL when no information is available.
  87  *
  88  * Since: 2.14
  89  *
  90  * Return value: Newly allocated string with Pango markup with details
  91  * for the specified day, or %NULL.
  92  */
  93 typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
  94                                          guint        year,
  95                                          guint        month,
  96                                          guint        day,
  97                                          gpointer     user_data);
  98
  99 struct _GtkCalendar
 100 {
 101   GtkWidget widget;
 102
 103   GtkCalendarPrivate *priv;
 104 };
 105
 106 struct _GtkCalendarClass
 107 {
 108   GtkWidgetClass parent_class;
 109
 110   /* Signal handlers */
 111   void (* month_changed)                (GtkCalendar *calendar);
 112   void (* day_selected)                 (GtkCalendar *calendar);
 113   void (* day_selected_double_click)    (GtkCalendar *calendar);
 114   void (* prev_month)                   (GtkCalendar *calendar);
 115   void (* next_month)                   (GtkCalendar *calendar);
 116   void (* prev_year)                    (GtkCalendar *calendar);
 117   void (* next_year)                    (GtkCalendar *calendar);
 118
 119   /* Padding for future expansion */
 120   void (*_gtk_reserved1) (void);
 121   void (*_gtk_reserved2) (void);
 122   void (*_gtk_reserved3) (void);
 123   void (*_gtk_reserved4) (void);
 124 };
 125
 126
 127 GType      gtk_calendar_get_type        (void) G_GNUC_CONST;
 128 GtkWidget* gtk_calendar_new             (void);
 129
 130 void       gtk_calendar_select_month    (GtkCalendar *calendar,
 131                                          guint        month,
 132                                          guint        year);
 133 void       gtk_calendar_select_day      (GtkCalendar *calendar,
 134                                          guint        day);
 135
 136 void       gtk_calendar_mark_day        (GtkCalendar *calendar,
 137                                          guint        day);
 138 void       gtk_calendar_unmark_day      (GtkCalendar *calendar,
 139                                          guint        day);
 140 void       gtk_calendar_clear_marks     (GtkCalendar *calendar);
 141
 142
 143 void       gtk_calendar_set_display_options (GtkCalendar              *calendar,
 144                                              GtkCalendarDisplayOptions flags);
 145 GtkCalendarDisplayOptions
 146            gtk_calendar_get_display_options (GtkCalendar              *calendar);
 147 void       gtk_calendar_get_date        (GtkCalendar *calendar,
 148                                          guint       *year,
 149                                          guint       *month,
 150                                          guint       *day);
 151
 152 void       gtk_calendar_set_detail_func (GtkCalendar           *calendar,
 153                                          GtkCalendarDetailFunc  func,
 154                                          gpointer               data,
 155                                          GDestroyNotify         destroy);
 156
 157 void       gtk_calendar_set_detail_width_chars (GtkCalendar    *calendar,
 158                                                 gint            chars);
 159 void       gtk_calendar_set_detail_height_rows (GtkCalendar    *calendar,
 160                                                 gint            rows);
 161
 162 gint       gtk_calendar_get_detail_width_chars (GtkCalendar    *calendar);
 163 gint       gtk_calendar_get_detail_height_rows (GtkCalendar    *calendar);
 164
 165 gboolean   gtk_calendar_get_day_is_marked      (GtkCalendar    *calendar,
 166                                                 guint           day);
 167
 168 G_END_DECLS
 169
 170 #endif /* __GTK_CALENDAR_H__ */