gtkcalendar.h 7.44 KB
Newer Older
1
/* GTK - The GTK+ Toolkit
2 3 4 5 6 7
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GTK Calendar Widget
 * Copyright (C) 1998 Cesar Miquel and Shawn T. Amundson
 *
 * This library is free software; you can redistribute it and/or
8
 * modify it under the terms of the GNU Lesser General Public
9 10 11 12 13
 * 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
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 19 20
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
21 22

/*
23
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
24 25
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
26
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 28
 */

29 30 31 32
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

33 34 35 36 37
#ifndef __GTK_CALENDAR_H__
#define __GTK_CALENDAR_H__

#include <gdk/gdk.h>
#include <gtk/gtkwidget.h>
38

Manish Singh's avatar
Manish Singh committed
39 40 41
/* Not needed, retained for compatibility -Yosh */
#include <gtk/gtksignal.h>

42

43
G_BEGIN_DECLS
44

Tim Janik's avatar
Tim Janik committed
45
#define GTK_TYPE_CALENDAR                  (gtk_calendar_get_type ())
Manish Singh's avatar
Manish Singh committed
46 47 48 49 50
#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))
51 52 53


typedef struct _GtkCalendar	       GtkCalendar;
54 55
typedef struct _GtkCalendarClass       GtkCalendarClass;

56 57
typedef struct _GtkCalendarPrivate     GtkCalendarPrivate;

58 59 60 61 62 63 64 65 66 67 68 69 70 71
/**
 * 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_WEEK_START_MONDAY: Since GTK+ 2.4, this option is deprecated and ignored by GTK+.
 * The information on which day the calendar week starts is derived from the locale.
 * @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.
 */
72 73
typedef enum
{
74 75 76 77
  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,
78
  GTK_CALENDAR_WEEK_START_MONDAY	= 1 << 4,
79
  GTK_CALENDAR_SHOW_DETAILS		= 1 << 5
80 81
} GtkCalendarDisplayOptions;

82 83 84 85 86 87 88 89 90 91 92 93 94 95
/**
 * 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.16
 *
96 97
 * Return value: Newly allocated string with Pango markup with details
 * for the specified day, or %NULL.
98
 */
99 100 101 102 103
typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
                                         guint        year,
                                         guint        month,
                                         guint        day,
                                         gpointer     user_data);
104

105 106 107
struct _GtkCalendar
{
  GtkWidget widget;
108
  
Tim Janik's avatar
Tim Janik committed
109 110
  GtkStyle  *GSEAL (header_style);
  GtkStyle  *GSEAL (label_style);
111
  
Tim Janik's avatar
Tim Janik committed
112 113 114
  gint GSEAL (month);
  gint GSEAL (year);
  gint GSEAL (selected_day);
115
  
Tim Janik's avatar
Tim Janik committed
116 117
  gint GSEAL (day_month[6][7]);
  gint GSEAL (day[6][7]);
118
  
Tim Janik's avatar
Tim Janik committed
119 120 121 122
  gint GSEAL (num_marked_dates);
  gint GSEAL (marked_date[31]);
  GtkCalendarDisplayOptions  GSEAL (display_flags);
  GdkColor GSEAL (marked_date_color[31]);
123
  
Tim Janik's avatar
Tim Janik committed
124 125
  GdkGC *GSEAL (gc);			/* unused */
  GdkGC *GSEAL (xor_gc);		/* unused */
126

Tim Janik's avatar
Tim Janik committed
127 128
  gint GSEAL (focus_row);
  gint GSEAL (focus_col);
129

Tim Janik's avatar
Tim Janik committed
130 131
  gint GSEAL (highlight_row);
  gint GSEAL (highlight_col);
132
  
Tim Janik's avatar
Tim Janik committed
133 134
  GtkCalendarPrivate *GSEAL (priv);
  gchar GSEAL (grow_space [32]);
135 136 137 138 139 140

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
141 142 143 144 145
};

struct _GtkCalendarClass
{
  GtkWidgetClass parent_class;
146
  
147
  /* Signal handlers */
148 149 150 151 152 153 154
  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);
155
  
156 157 158
};


Manish Singh's avatar
Manish Singh committed
159
GType	   gtk_calendar_get_type	(void) G_GNUC_CONST;
160 161
GtkWidget* gtk_calendar_new		(void);

162
gboolean   gtk_calendar_select_month	(GtkCalendar *calendar, 
163 164 165 166 167
					 guint	      month,
					 guint	      year);
void	   gtk_calendar_select_day	(GtkCalendar *calendar,
					 guint	      day);

168
gboolean   gtk_calendar_mark_day	(GtkCalendar *calendar,
169
					 guint	      day);
170
gboolean   gtk_calendar_unmark_day	(GtkCalendar *calendar,
171 172 173 174
					 guint	      day);
void	   gtk_calendar_clear_marks	(GtkCalendar *calendar);


175 176 177 178 179
void	   gtk_calendar_set_display_options (GtkCalendar    	      *calendar,
					     GtkCalendarDisplayOptions flags);
GtkCalendarDisplayOptions
           gtk_calendar_get_display_options (GtkCalendar   	      *calendar);
#ifndef GTK_DISABLE_DEPRECATED
180 181
void	   gtk_calendar_display_options (GtkCalendar		  *calendar,
					 GtkCalendarDisplayOptions flags);
182
#endif
183

184 185 186 187
void	   gtk_calendar_get_date	(GtkCalendar *calendar, 
					 guint	     *year,
					 guint	     *month,
					 guint	     *day);
188 189 190 191 192 193 194 195 196 197 198 199 200 201

void       gtk_calendar_set_detail_func (GtkCalendar           *calendar,
                                         GtkCalendarDetailFunc  func,
                                         gpointer               data,
                                         GDestroyNotify         destroy);

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);

202
#ifndef GTK_DISABLE_DEPRECATED
203 204
void	   gtk_calendar_freeze		(GtkCalendar *calendar);
void	   gtk_calendar_thaw		(GtkCalendar *calendar);
205
#endif
206

207
G_END_DECLS
208 209

#endif /* __GTK_CALENDAR_H__ */