aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-util.h
blob: d4f29c9c34699f4d17768edae1e76aa97a8293ac (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
 * 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:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef E_UTIL_H
#define E_UTIL_H

#include <sys/types.h>
#include <gtk/gtk.h>
#include <limits.h>
#include <gconf/gconf-client.h>

#include <e-util/e-marshal.h>
#include <e-util/e-util-enums.h>

/* e_get_user_data_dir() used to live here, so #include its new home
 * for backward-compatibility (not that we really care about that). */
#include <libedataserver/e-data-server-util.h>

G_BEGIN_DECLS

typedef enum {
    E_FOCUS_NONE,
    E_FOCUS_CURRENT,
    E_FOCUS_START,
    E_FOCUS_END
} EFocus;

typedef void (*ETypeFunc) (GType type, gpointer user_data);

const gchar *   e_get_gnome2_user_dir       (void);
const gchar *   e_get_accels_filename       (void);
void        e_show_uri          (GtkWindow *parent,
                         const gchar *uri);
void        e_display_help          (GtkWindow *parent,
                         const gchar *link_id);
GtkAction * e_lookup_action         (GtkUIManager *ui_manager,
                         const gchar *action_name);
GtkActionGroup *e_lookup_action_group       (GtkUIManager *ui_manager,
                         const gchar *group_name);
GtkWidget * e_builder_get_widget        (GtkBuilder *builder,
                         const gchar *widget_name);
void        e_load_ui_builder_definition    (GtkBuilder *builder,
                         const gchar *basename);
gint        e_action_compare_by_label   (GtkAction *action1,
                         GtkAction *action2);
void        e_action_group_remove_all_actions
                        (GtkActionGroup *action_group);
GtkRadioAction *e_radio_action_get_current_action
                        (GtkRadioAction *radio_action);
void        e_categories_add_change_hook    (GHookFunc func,
                         gpointer object);
void        e_type_traverse         (GType parent_type,
                         ETypeFunc func,
                         gpointer user_data);

gchar *     e_str_without_underscores   (const gchar *string);
gint        e_str_compare           (gconstpointer x,
                         gconstpointer y);
gint        e_str_case_compare      (gconstpointer x,
                         gconstpointer y);
gint        e_collate_compare       (gconstpointer x,
                         gconstpointer y);
gint        e_int_compare                   (gconstpointer x,
                         gconstpointer y);
guint32     e_color_to_value        (GdkColor *color);

/* This only makes a filename safe for usage as a filename.
 * It still may have shell meta-characters in it. */
gchar *     e_format_number         (gint number);

typedef gint    (*ESortCompareFunc)     (gconstpointer first,
                         gconstpointer second,
                         gpointer closure);

void        e_bsearch           (gconstpointer key,
                         gconstpointer base,
                         gsize nmemb,
                         gsize size,
                         ESortCompareFunc compare,
                         gpointer closure,
                         gsize *start,
                         gsize *end);

gsize       e_strftime_fix_am_pm        (gchar *str,
                         gsize max,
                         const gchar *fmt,
                         const struct tm *tm);
gsize       e_utf8_strftime_fix_am_pm   (gchar *str,
                         gsize max,
                         const gchar *fmt,
                         const struct tm *tm);
const gchar *   e_get_month_name        (GDateMonth month,
                         gboolean abbreviated);
const gchar *   e_get_weekday_name      (GDateWeekday weekday,
                         gboolean abbreviated);

/* String to/from double conversion functions */
gdouble     e_flexible_strtod       (const gchar *nptr,
                         gchar **endptr);

/* 29 bytes should enough for all possible values that
 * g_ascii_dtostr can produce with the %.17g format.
 * Then add 10 for good measure */
#define E_ASCII_DTOSTR_BUF_SIZE (DBL_DIG + 12 + 10)
gchar *     e_ascii_dtostr          (gchar *buffer,
                         gint buf_len,
                         const gchar *format,
                         gdouble d);

cairo_font_options_t *
        get_font_options        (void);

gboolean    e_file_lock_create      (void);
void        e_file_lock_destroy     (void);
gboolean    e_file_lock_exists      (void);

gchar *     e_util_guess_mime_type      (const gchar *filename,
                                                 gboolean localfile);

GSList *    e_util_get_category_filter_options
                        (void);

void        e_util_set_source_combo_box_list
                        (GtkWidget *source_combo_box,
                         const gchar *source_gconf_path);

/* Useful GBinding transformation functions */
gboolean    e_binding_transform_color_to_string
                        (GBinding *binding,
                         const GValue *source_value,
                         GValue *target_value,
                         gpointer user_data);
gboolean    e_binding_transform_string_to_color
                        (GBinding *binding,
                         const GValue *source_value,
                         GValue *target_value,
                         gpointer user_data);

G_END_DECLS

#endif /* E_UTIL_H */