Files
evolution/e-util/e-cell-date-edit.h
Matthew Barnes d09d8de870 Consolidate base utility libraries into libeutil.
Evolution consists of entirely too many small utility libraries, which
increases linking and loading time, places a burden on higher layers of
the application (e.g. modules) which has to remember to link to all the
small in-tree utility libraries, and makes it difficult to generate API
documentation for these utility libraries in one Gtk-Doc module.

Merge the following utility libraries under the umbrella of libeutil,
and enforce a single-include policy on libeutil so we can reorganize
the files as desired without disrupting its pseudo-public API.

   libemail-utils/libemail-utils.la
   libevolution-utils/libevolution-utils.la
   filter/libfilter.la
   widgets/e-timezone-dialog/libetimezonedialog.la
   widgets/menus/libmenus.la
   widgets/misc/libemiscwidgets.la
   widgets/table/libetable.la
   widgets/text/libetext.la

This also merges libedataserverui from the Evolution-Data-Server module,
since Evolution is its only consumer nowadays, and I'd like to make some
improvements to those APIs without concern for backward-compatibility.

And finally, start a Gtk-Doc module for libeutil.  It's going to be a
project just getting all the symbols _listed_ much less _documented_.
But the skeletal structure is in place and I'm off to a good start.
2012-12-12 14:33:43 -05:00

125 lines
3.6 KiB
C

/*
*
* 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)
*
*/
/*
* ECellDateEdit - a subclass of ECellPopup used to show a date with a popup
* window to edit it.
*/
#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif
#ifndef _E_CELL_DATE_EDIT_H_
#define _E_CELL_DATE_EDIT_H_
#include <time.h>
#include <e-util/e-cell-popup.h>
/* Standard GObject macros */
#define E_TYPE_CELL_DATE_EDIT \
(e_cell_date_edit_get_type ())
#define E_CELL_DATE_EDIT(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_CELL_DATE_EDIT, ECellDateEdit))
#define E_CELL_DATE_EDIT_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_CELL_DATE_EDIT, ECellDateEditClass))
#define E_IS_CELL_DATE_EDIT(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_CELL_DATE_EDIT))
#define E_IS_CELL_DATE_EDIT_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_CELL_DATE_EDIT))
#define E_CELL_DATE_EDIT_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_CELL_DATE_EDIT, ECellDateEditClass))
G_BEGIN_DECLS
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_tree_view;
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;
GDestroyNotify time_callback_destroy;
};
struct _ECellDateEditClass {
ECellPopupClass parent_class;
};
GType e_cell_date_edit_get_type (void) G_GNUC_CONST;
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,
GDestroyNotify destroy);
G_END_DECLS
#endif /* _E_CELL_DATE_EDIT_H_ */