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.
30 #ifndef __MODEST_FOLDER_VIEW_H__
31 #define __MODEST_FOLDER_VIEW_H__
33 #include <tny-gtk-account-tree-model.h>
34 #include <tny-account-store.h>
35 #include <glib-object.h>
39 /* convenience macros */
40 #define MODEST_TYPE_FOLDER_VIEW (modest_folder_view_get_type())
41 #define MODEST_FOLDER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderView))
42 #define MODEST_FOLDER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
43 #define MODEST_IS_FOLDER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_VIEW))
44 #define MODEST_IS_FOLDER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_VIEW))
45 #define MODEST_FOLDER_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
47 typedef struct _ModestFolderView ModestFolderView;
48 typedef struct _ModestFolderViewClass ModestFolderViewClass;
50 struct _ModestFolderView {
52 /* insert public members, if any */
55 struct _ModestFolderViewClass {
56 GtkTreeViewClass parent_class;
58 /* emitted when a folder is clicked */
59 void (*folder_selected) (ModestFolderView* self,
63 gboolean (*update_model) (ModestFolderView *self,
64 TnyAccountStore *account_store);
69 * modest_folder_view_get_type:
71 * get the GType for ModestFolderView
75 GType modest_folder_view_get_type (void) G_GNUC_CONST;
79 * modest_folder_view_new:
80 * @iface: a ModestTnyAccountStore instance
82 * create a new ModestFolderView instance, based on an account store
84 * Returns: a new GtkWidget (a GtkTreeView-subclass)
86 GtkWidget* modest_folder_view_new (ModestTnyAccountStore *account_store,
87 TnyFolderStoreQuery *query);
91 * modest_folder_view_is_empty:
92 * @self: a ModestFolderView instance
94 * check to see of the view is empty. Note that when it is empty,
95 * there will still be one item, telling "(empty)" or similar
97 * Returns: TRUE if the tree view is empty, FALSE otherwise
99 gboolean modest_folder_view_is_empty (ModestFolderView *self);
102 const gchar* modest_folder_view_get_selected_account (ModestFolderView *self);
106 #endif /* __MODEST_FOLDER_VIEW_H__ */