aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-calendar.h
blob: c281e7436bfd6a5a61bb47a9ad53c0c2e778ad83 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Damon Chaplin <damon@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef _E_CALENDAR_H_
#define _E_CALENDAR_H_

#include <gtk/gtk.h>
#include <misc/e-canvas.h>
#include "e-calendar-item.h"

G_BEGIN_DECLS

/*
 * ECalendar - displays a table of monthly calendars, allowing highlighting
 * and selection of one or more days. Like GtkCalendar with more features.
 * Most of the functionality is in the ECalendarItem canvas item, though
 * we also add GnomeCanvasWidget buttons to go to the previous/next month and
 * to got to the current day.
 */

/* Standard GObject macros */
#define E_TYPE_CALENDAR \
    (e_calendar_get_type ())
#define E_CALENDAR(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_CALENDAR, ECalendar))
#define E_CALENDAR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_CALENDAR, ECalendarClass))
#define E_IS_CALENDAR(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_CALENDAR))
#define E_IS_CALENDAR_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_CALENDAR))
#define E_CALENDAR_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_CALENDAR, ECalendarClass))


typedef struct _ECalendar       ECalendar;
typedef struct _ECalendarClass  ECalendarClass;

struct _ECalendar
{
    ECanvas canvas;

    ECalendarItem *calitem;

    GnomeCanvasItem *prev_item;
    GnomeCanvasItem *next_item;

    gint min_rows;
    gint min_cols;

    gint max_rows;
    gint max_cols;

    /* These are all used when the prev/next buttons are held down.
       moving_forward is TRUE if we are moving forward in time, i.e. the
       next button is pressed. */
    gint timeout_id;
    gint timeout_delay;
    gboolean moving_forward;
};

struct _ECalendarClass
{
    ECanvasClass parent_class;
};


GType          e_calendar_get_type      (void);
GtkWidget* e_calendar_new       (void);

void       e_calendar_set_minimum_size  (ECalendar  *cal,
                     gint        rows,
                     gint        cols);
void       e_calendar_set_maximum_size  (ECalendar  *cal,
                     gint        rows,
                     gint        cols);

/* Returns the border size on each side of the month displays. */
void       e_calendar_get_border_size   (ECalendar  *cal,
                     gint       *top,
                     gint       *bottom,
                     gint       *left,
                     gint       *right);

void       e_calendar_set_focusable (ECalendar *cal, gboolean focusable);

G_END_DECLS

#endif /* _E_CALENDAR_H_ */