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 <glib-object.h>
34 #include <tny-gtk-account-list-model.h>
35 #include <tny-account-store.h>
36 #include <modest-tny-account-store.h>
40 /* convenience macros */
41 #define MODEST_TYPE_FOLDER_VIEW (modest_folder_view_get_type())
42 #define MODEST_FOLDER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderView))
43 #define MODEST_FOLDER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
44 #define MODEST_IS_FOLDER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_VIEW))
45 #define MODEST_IS_FOLDER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_VIEW))
46 #define MODEST_FOLDER_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
48 typedef enum _ModestFolderViewStyle {
49 MODEST_FOLDER_VIEW_STYLE_SHOW_ALL,
50 MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
51 } ModestFolderViewStyle;
53 typedef enum _ModestFolderViewCellStyle {
54 MODEST_FOLDER_VIEW_CELL_STYLE_DEFAULT,
55 MODEST_FOLDER_VIEW_CELL_STYLE_COMPACT
56 } ModestFolderViewCellStyle;
58 typedef enum _ModestFolderViewFilter {
59 MODEST_FOLDER_VIEW_FILTER_NONE = 0,
60 MODEST_FOLDER_VIEW_FILTER_CAN_HAVE_FOLDERS = 1 << 0,
61 MODEST_FOLDER_VIEW_FILTER_HIDE_MANDATORY_FOLDERS = 1 << 1,
62 MODEST_FOLDER_VIEW_FILTER_RENAMEABLE = 1 << 2,
63 MODEST_FOLDER_VIEW_FILTER_MOVEABLE = 1 << 3,
64 MODEST_FOLDER_VIEW_FILTER_DELETABLE = 1 << 4,
65 } ModestFolderViewFilter;
67 typedef struct _ModestFolderView ModestFolderView;
68 typedef struct _ModestFolderViewClass ModestFolderViewClass;
70 struct _ModestFolderView {
72 /* insert public members, if any */
75 struct _ModestFolderViewClass {
76 GtkTreeViewClass parent_class;
78 /* emitted when a folder is selected or unselected */
79 void (*folder_selection_changed) (ModestFolderView* self,
80 TnyFolderStore *folder,
84 void (*folder_display_name_changed) (ModestFolderView* self,
85 const gchar *display_name,
88 void (*folder_activated) (ModestFolderView *self,
89 TnyFolderStore *folder,
94 * modest_folder_view_get_type:
96 * get the GType for ModestFolderView
100 GType modest_folder_view_get_type (void) G_GNUC_CONST;
105 * modest_folder_view_new:
106 * @query: a #TnyFolderStoreQuery that specifies the folders to show
108 * create a new #ModestFolderView instance
110 * Returns: a new #GtkWidget (a #GtkTreeView subclass)
112 GtkWidget* modest_folder_view_new (TnyFolderStoreQuery *query);
115 * modest_folder_view_set_title:
116 * @self: a ModestFolderView instance
117 * @title: the new title
119 * set the title for the folder view; if title is NULL, the title column
120 * header will be hidden
122 void modest_folder_view_set_title (ModestFolderView *self,
127 * modest_folder_view_get_selected:
128 * @self: a #ModestFolderView
130 * gets a new reference to the #TnyFolderStore that is already
131 * selected. The caller must free this reference
133 * Returns: the selected #TnyFolderStore or NULL if none is selected
135 TnyFolderStore* modest_folder_view_get_selected (ModestFolderView *self);
139 * modest_folder_view_update_model:
140 * @self: a #ModestFolderView
142 * refresh the current model
144 * Returns: TRUE if the model was succesfully updated
146 gboolean modest_folder_view_update_model (ModestFolderView *self,
147 TnyAccountStore *account_store);
150 * modest_folder_view_set_style:
151 * @self: a #ModestFolderView
152 * @style: a #ModestFolderViewStyle
154 * Sets the folder view style. There are currently two available,
155 * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
156 * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
157 * account the mmc and only one of the available active server
161 void modest_folder_view_set_style (ModestFolderView *self,
162 ModestFolderViewStyle style);
165 * modest_folder_view_set_account_id_of_visible_server_account:
166 * @self: a #ModestFolderView
167 * @account_id: the remote server account id
169 * sets the server account id (value returned by tny_account_get_id())
170 * to the string passed as argument. The remote server with the
171 * specified id will be the unique visible account if the folder view
172 * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
174 void modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
175 const gchar *account_id);
178 * modest_folder_view_get_account_id_of_visible_server_account:
179 * @self: a #ModestFolderView
181 * gets the account id of the currently visible server account id
183 * Return value: the visible server account id or NULL if none set
185 const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
188 void modest_folder_view_select_first_inbox_or_local (ModestFolderView *self);
191 * modest_folder_view_copy_selection:
192 * @self: a #ModestFolderView
194 * Stores a #TnyList of selected folders in the own clibpoard of
197 void modest_folder_view_copy_selection (ModestFolderView *folder_view);
200 * modest_folder_view_cut_selection:
201 * @self: a #ModestFolderView
203 * Stores a #TnyList of selected folders in the own clibpoard of
204 * @self folder view and filter them into folders tree model to
205 * hide these rows in treeview.
207 void modest_folder_view_cut_selection (ModestFolderView *folder_view);
211 * modest_folder_view_select_folder
212 * @self: a #ModestFolderView
213 * @folder: a #TnyFolder
214 * @after_change: should we select first change to the view (TRUE), or just now (FALSE)
216 * select the given TnyFolder in the folder;
217 * return TRUE if it succeeded, FALSE otherwise.
219 gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *folder, gboolean after_change);
222 * modest_folder_view_paste_selection:
223 * @self: a #ModestFolderView
224 * @folders: ouput parameter with a #TnyList of folders which will be returned.
225 * @delete: output parameter with indication about delete or not the selected folders.
227 * Gets the selected folders to copy/cut.
229 void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
232 * modest_folder_view_show_non_move_folders:
233 * @self: a #ModestFolderView
234 * @show: show or hide the folders
236 * Whether to show folders where no messages can be moved to
238 void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
241 * modest_folder_view_copy_model:
242 * @folder_view_src: a #ModestFolderView
243 * @folder_view_dst: a #ModestFolderView
245 * Get model from @folder_view_src and builds a new
246 * #GtkTreeFilterModel object for that model. This copied
247 * model will be asigned to @folder_view_dst.
249 void modest_folder_view_copy_model (ModestFolderView *folder_view_src, ModestFolderView *folder_view_dst);
252 * modest_folder_disable_next_folder_selection:
253 * @folder_view: a #ModestFolderView
255 * Checks if folder_to_select private field is set and
256 * unref it in this case, assigning it to NULL to avoid
257 * next call to on_row_inserted_maybe_select_folder does
258 * not select any folder.
261 void modest_folder_view_disable_next_folder_selection (ModestFolderView *self);
264 * modest_folder_view_set_cell_style:
265 * @self: a #ModestFolderView
266 * @cell_style: a #ModestFolderViewCellStyle
268 * Sets the way cells are shown
270 void modest_folder_view_set_cell_style (ModestFolderView *self,
271 ModestFolderViewCellStyle cell_style);
274 * modest_folder_view_filter:
275 * @self: a #ModestFolderView
276 * @filter: a filter mask to be applied to files
278 * sets the special filter to be applied (affects visibility of items).
279 * It's a mask, and filters applied are applied with an AND.
281 void modest_folder_view_set_filter (ModestFolderView *self,
282 ModestFolderViewFilter filter);
286 #endif /* __MODEST_FOLDER_VIEW_H__ */