aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-cell-date-edit.h
blob: c1253f30c9daa65a94549f6539566900625f894e (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/*
 * Author :
 *  Damon Chaplin <damon@ximian.com>
 *
 * Copyright 2001, Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 * USA
 */

/*
 * ECellDateEdit - a subclass of ECellPopup used to show a date with a popup
 * window to edit it.
 */

#ifndef _E_CELL_DATE_EDIT_H_
#define _E_CELL_DATE_EDIT_H_

#include <time.h>
#include <table/e-cell-popup.h>

#define E_CELL_DATE_EDIT_TYPE        (e_cell_date_edit_get_type ())
#define E_CELL_DATE_EDIT(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), E_CELL_DATE_EDIT_TYPE, ECellDateEdit))
#define E_CELL_DATE_EDIT_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST ((k), E_CELL_DATE_EDIT_TYPE, ECellDateEditClass))
#define E_IS_CELL_DATE_EDIT(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), E_CELL_DATE_EDIT_TYPE))
#define E_IS_CELL_DATE_EDIT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_CELL_DATE_EDIT_TYPE))


typedef struct _ECellDateEdit ECellDateEdit;
typedef struct _ECellDateEditClass ECellDateEditClass;

/* The type of the callback function optionally used to get the current time.
 */
typedef struct tm (*ECellDateEditGetTimeCallback) (ECellDateEdit *ecde,
                           gpointer   data);

struct _ECellDateEdit {
    ECellPopup parent;

    GtkWidget *popup_window;
    GtkWidget *calendar;
    GtkWidget *time_entry;
    GtkWidget *time_list;

    GtkWidget *now_button;
    GtkWidget *today_button;
    GtkWidget *none_button;

    /* This is the range of hours we show in the time list. */
    gint lower_hour;
    gint upper_hour;

    /* TRUE if we use 24-hour format for the time list and entry. */
    gboolean use_24_hour_format;

    /* This is TRUE if we need to rebuild the list of times. */
    gboolean need_time_list_rebuild;

    /* The freeze count for rebuilding the time list. We only rebuild when
       this is 0. */
    gint freeze_count;

    ECellDateEditGetTimeCallback time_callback;
    gpointer time_callback_data;
    GtkDestroyNotify time_callback_destroy;
};

struct _ECellDateEditClass {
    ECellPopupClass parent_class;
};


GtkType    e_cell_date_edit_get_type        (void);
ECell     *e_cell_date_edit_new         (void);


/* These freeze and thaw the rebuilding of the time list. They are useful when
   setting several properties which result in rebuilds of the list, e.g. the
   lower_hour, upper_hour and use_24_hour_format properties. */
void       e_cell_date_edit_freeze      (ECellDateEdit  *ecde);
void       e_cell_date_edit_thaw        (ECellDateEdit  *ecde);


/* Sets a callback to use to get the current time. This is useful if the
   application needs to use its own timezone data rather than rely on the
   Unix timezone. */
void       e_cell_date_edit_set_get_time_callback(ECellDateEdit *ecde,
                          ECellDateEditGetTimeCallback cb,
                          gpointer   data,
                          GtkDestroyNotify destroy);


#endif /* _E_CELL_DATE_EDIT_H_ */