aboutsummaryrefslogblamecommitdiffstats
path: root/widgets/misc/e-cell-date-edit.h
blob: 67af112c94045c14d5a57c66cab058c4107ca56d (plain) (tree)































                                                                            
                 








                                                                                                           








                                                                             


                                

                              

                             




                                                                  


                        
                                                                        
                                    






                                                                              
 





                                                   
                                     
  





                                                       





                                                                              









                                                                                  
                                 
/* -*- 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 the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * 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 <gal/e-table/e-cell-popup.h>

#define E_CELL_DATE_EDIT_TYPE        (e_cell_date_edit_get_type ())
#define E_CELL_DATE_EDIT(o)          (GTK_CHECK_CAST ((o), E_CELL_DATE_EDIT_TYPE, ECellDateEdit))
#define E_CELL_DATE_EDIT_CLASS(k)    (GTK_CHECK_CLASS_CAST((k), E_CELL_DATE_EDIT_TYPE, ECellDateEditClass))
#define E_IS_CELL_DATE_EDIT(o)       (GTK_CHECK_TYPE ((o), E_CELL_DATE_EDIT_TYPE))
#define E_IS_CELL_DATE_EDIT_CLASS(k) (GTK_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_ */