1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 /* modest-tny-folder-tree-view.h */
33 #ifndef __MODEST_TNY_FOLDER_TREE_VIEW_H__
34 #define __MODEST_TNY_FOLDER_TREE_VIEW_H__
36 #include <tny-account-tree-model.h>
37 #include <tny-account-store-iface.h>
38 #include <glib-object.h>
42 /* convenience macros */
43 #define MODEST_TYPE_TNY_FOLDER_TREE_VIEW (modest_tny_folder_tree_view_get_type())
44 #define MODEST_TNY_FOLDER_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeView))
45 #define MODEST_TNY_FOLDER_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeViewClass))
46 #define MODEST_IS_TNY_FOLDER_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
47 #define MODEST_IS_TNY_FOLDER_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
48 #define MODEST_TNY_FOLDER_TREE_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeViewClass))
50 typedef struct _ModestTnyFolderTreeView ModestTnyFolderTreeView;
51 typedef struct _ModestTnyFolderTreeViewClass ModestTnyFolderTreeViewClass;
53 struct _ModestTnyFolderTreeView {
55 /* insert public members, if any */
58 struct _ModestTnyFolderTreeViewClass {
59 GtkTreeViewClass parent_class;
61 /* emitted when a folder is clicked */
62 void (*folder_selected) (ModestTnyFolderTreeView* self,
63 TnyMsgFolderIface *folder,
66 gboolean (*update_model) (ModestTnyFolderTreeView *self,
67 TnyAccountStoreIface *iface);
73 * modest_tny_folder_tree_view_get_type:
75 * get the GType for ModestTnyFolderTreeView
79 GType modest_tny_folder_tree_view_get_type (void) G_GNUC_CONST;
83 * modest_tny_folder_tree_view_new:
84 * @iface: a TnyAccountStoreIface object
86 * create a new ModestTnyFolderTreeView instance, based on an account store
88 * Returns: a new GtkWidget (a GtkTreeView-subclass)
91 GtkWidget* modest_tny_folder_tree_view_new (TnyAccountStoreIface *iface);
95 * modest_tny_folder_tree_view_is_empty:
96 * @self: a ModestTnyFolderTreeView instance
98 * check to see of the view is empty. Note that when it is empty,
99 * there will still be one item, telling "(empty)" or similar
101 * Returns: TRUE if the tree view is empty, FALSE otherwise
103 gboolean modest_tny_folder_tree_view_is_empty (ModestTnyFolderTreeView *self);
107 * modest_tny_folder_tree_view_update_model:
108 * @self: a #ModestTnyFolderTreeView instance
109 * @iface: a #TnyAccountStoreIface instance
111 * Update the thee model from a given account store.
113 * Returns: TRUE on success, FALSE otherwise
115 gboolean modest_tny_folder_tree_view_update_model(ModestTnyFolderTreeView *self,
116 TnyAccountStoreIface *iface);
121 #endif /* __MODEST_TNY_FOLDER_TREE_VIEW_H__ */