aboutsummaryrefslogtreecommitdiffstats
path: root/mail/em-folder-tree.h
blob: cca5432306b6e3dbf8588768c027c7ad4f39d002 (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
/*
 *
 * 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:
 *      Jeffrey Stedfast <fejj@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef EM_FOLDER_TREE_H
#define EM_FOLDER_TREE_H

#include <gtk/gtk.h>
#include <camel/camel-store.h>
#include <mail/em-folder-tree-model.h>

/* Standard GObject macros */
#define EM_TYPE_FOLDER_TREE \
    (em_folder_tree_get_type ())
#define EM_FOLDER_TREE(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), EM_TYPE_FOLDER_TREE, EMFolderTree))
#define EM_FOLDER_TREE_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), EM_TYPE_FOLDER_TREE, EMFolderTreeClass))
#define EM_IS_FOLDER_TREE(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE  \
    ((obj), EM_TYPE_FOLDER_TREE))
#define EM_IS_FOLDER_TREE_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), EM_TYPE_FOLDER_TREE))
#define EM_FOLDER_TREE_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), EM_TYPE_FOLDER_TREE, EMFolderTreeClass))

G_BEGIN_DECLS

typedef struct _EMFolderTree EMFolderTree;
typedef struct _EMFolderTreeClass EMFolderTreeClass;
typedef struct _EMFolderTreePrivate EMFolderTreePrivate;

/* not sure this api is the best, but its the easiest to implement and will cover what we need */
#define EMFT_EXCLUDE_NOSELECT CAMEL_FOLDER_NOSELECT
#define EMFT_EXCLUDE_NOINFERIORS CAMEL_FOLDER_NOINFERIORS
#define EMFT_EXCLUDE_VIRTUAL CAMEL_FOLDER_VIRTUAL
#define EMFT_EXCLUDE_SYSTEM CAMEL_FOLDER_SYSTEM
#define EMFT_EXCLUDE_VTRASH CAMEL_FOLDER_VTRASH

typedef gboolean    (*EMFTExcludeFunc)  (EMFolderTree *folder_tree,
                         GtkTreeModel *model,
                         GtkTreeIter *iter,
                         gpointer user_data);

struct _EMFolderTree {
    GtkTreeView parent;
    EMFolderTreePrivate *priv;
};

struct _EMFolderTreeClass {
    GtkTreeViewClass parent_class;

    /* signals */
    void        (*folder_activated) (EMFolderTree *folder_tree,
                         const gchar *full_name,
                         const gchar *uri);
    void        (*folder_selected)  (EMFolderTree *folder_tree,
                         const gchar *full_name,
                         const gchar *uri,
                         guint32 flags);
    void        (*popup_event)      (EMFolderTree *folder_tree);
};

GType       em_folder_tree_get_type     (void);
GtkWidget * em_folder_tree_new      (void);
void        em_folder_tree_enable_drag_and_drop
                        (EMFolderTree *folder_tree);
void        em_folder_tree_set_excluded (EMFolderTree *folder_tree,
                         guint32 flags);
void        em_folder_tree_set_excluded_func(EMFolderTree *folder_tree,
                         EMFTExcludeFunc exclude,
                         gpointer data);
void        em_folder_tree_set_selected_list(EMFolderTree *folder_tree,
                         GList *list,
                         gboolean expand_only);
GList *     em_folder_tree_get_selected_uris(EMFolderTree *folder_tree);
GList *     em_folder_tree_get_selected_paths
                        (EMFolderTree *folder_tree);
void        em_folder_tree_set_selected (EMFolderTree *folder_tree,
                         const gchar *uri,
                         gboolean expand_only);
void        em_folder_tree_select_next_path (EMFolderTree *folder_tree,
                         gboolean skip_read_folders);
void        em_folder_tree_select_prev_path (EMFolderTree *folder_tree,
                         gboolean skip_read_folders);
void        em_folder_tree_edit_selected    (EMFolderTree *folder_tree);
gchar *     em_folder_tree_get_selected_uri (EMFolderTree *folder_tree);
gchar *     em_folder_tree_get_selected_path(EMFolderTree *folder_tree);
CamelFolder *   em_folder_tree_get_selected_folder
                        (EMFolderTree *folder_tree);
CamelFolderInfo *
        em_folder_tree_get_selected_folder_info
                        (EMFolderTree *folder_tree);
gboolean    em_folder_tree_create_folder    (EMFolderTree *folder_tree,
                         const gchar *full_name,
                         const gchar *uri);
void        em_folder_tree_set_skip_double_click
                        (EMFolderTree *folder_tree,
                         gboolean skip);

G_END_DECLS

#endif /* EM_FOLDER_TREE_H */