gtkcalendar.h 6.65 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP 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
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19
 */
20 21

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

28 29 30
#ifndef __GTK_CALENDAR_H__
#define __GTK_CALENDAR_H__

31

32 33 34 35
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

36
#include <gtk/gtkwidget.h>
37

38

39
G_BEGIN_DECLS
40

Tim Janik's avatar
Tim Janik committed
41
#define GTK_TYPE_CALENDAR                  (gtk_calendar_get_type ())
Manish Singh's avatar
Manish Singh committed
42 43 44 45 46
#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))
47 48 49


typedef struct _GtkCalendar	       GtkCalendar;
50 51
typedef struct _GtkCalendarClass       GtkCalendarClass;

52 53
typedef struct _GtkCalendarPrivate     GtkCalendarPrivate;

54 55 56 57 58 59 60 61 62 63 64 65
/**
 * 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_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.
 */
66 67
typedef enum
{
68 69 70 71
  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,
72
  GTK_CALENDAR_SHOW_DETAILS		= 1 << 5
73 74
} GtkCalendarDisplayOptions;

75 76 77 78 79 80 81 82 83 84 85 86
/**
 * 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.
 *
87
 * Since: 2.14
88
 *
89 90
 * Returns: (nullable) (transfer full): Newly allocated string with Pango markup
 *     with details for the specified day or %NULL.
91
 */
92 93 94 95 96
typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
                                         guint        year,
                                         guint        month,
                                         guint        day,
                                         gpointer     user_data);
97

98 99 100
struct _GtkCalendar
{
  GtkWidget widget;
101 102

  GtkCalendarPrivate *priv;
103 104 105 106 107
};

struct _GtkCalendarClass
{
  GtkWidgetClass parent_class;
108
  
109
  /* Signal handlers */
110 111 112 113 114 115 116
  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);
117 118 119 120 121 122

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
123 124 125
};


126
GDK_AVAILABLE_IN_ALL
Manish Singh's avatar
Manish Singh committed
127
GType	   gtk_calendar_get_type	(void) G_GNUC_CONST;
128
GDK_AVAILABLE_IN_ALL
129 130
GtkWidget* gtk_calendar_new		(void);

131
GDK_AVAILABLE_IN_ALL
132
void       gtk_calendar_select_month	(GtkCalendar *calendar,
133 134
					 guint	      month,
					 guint	      year);
135
GDK_AVAILABLE_IN_ALL
136 137 138
void	   gtk_calendar_select_day	(GtkCalendar *calendar,
					 guint	      day);

139
GDK_AVAILABLE_IN_ALL
140
void       gtk_calendar_mark_day	(GtkCalendar *calendar,
141
					 guint	      day);
142
GDK_AVAILABLE_IN_ALL
143
void       gtk_calendar_unmark_day	(GtkCalendar *calendar,
144
					 guint	      day);
145
GDK_AVAILABLE_IN_ALL
146 147 148
void	   gtk_calendar_clear_marks	(GtkCalendar *calendar);


149
GDK_AVAILABLE_IN_ALL
150 151
void	   gtk_calendar_set_display_options (GtkCalendar    	      *calendar,
					     GtkCalendarDisplayOptions flags);
152
GDK_AVAILABLE_IN_ALL
153 154
GtkCalendarDisplayOptions
           gtk_calendar_get_display_options (GtkCalendar   	      *calendar);
155
GDK_AVAILABLE_IN_ALL
156 157 158 159
void	   gtk_calendar_get_date	(GtkCalendar *calendar, 
					 guint	     *year,
					 guint	     *month,
					 guint	     *day);
160

161
GDK_AVAILABLE_IN_ALL
162 163 164 165 166
void       gtk_calendar_set_detail_func (GtkCalendar           *calendar,
                                         GtkCalendarDetailFunc  func,
                                         gpointer               data,
                                         GDestroyNotify         destroy);

167
GDK_AVAILABLE_IN_ALL
168 169
void       gtk_calendar_set_detail_width_chars (GtkCalendar    *calendar,
                                                gint            chars);
170
GDK_AVAILABLE_IN_ALL
171 172 173
void       gtk_calendar_set_detail_height_rows (GtkCalendar    *calendar,
                                                gint            rows);

174
GDK_AVAILABLE_IN_ALL
175
gint       gtk_calendar_get_detail_width_chars (GtkCalendar    *calendar);
176
GDK_AVAILABLE_IN_ALL
177 178
gint       gtk_calendar_get_detail_height_rows (GtkCalendar    *calendar);

179
GDK_AVAILABLE_IN_ALL
180 181 182
gboolean   gtk_calendar_get_day_is_marked      (GtkCalendar    *calendar,
                                                guint           day);

183
G_END_DECLS
184 185

#endif /* __GTK_CALENDAR_H__ */