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 struct _ModestFolderView ModestFolderView;
54 typedef struct _ModestFolderViewClass ModestFolderViewClass;
56 struct _ModestFolderView {
58 /* insert public members, if any */
61 struct _ModestFolderViewClass {
62 GtkTreeViewClass parent_class;
64 /* emitted when a folder is selected or unselected */
65 void (*folder_selection_changed) (ModestFolderView* self,
66 TnyFolderStore *folder,
70 void (*folder_display_name_changed) (ModestFolderView* self,
71 const gchar *display_name,
76 * modest_folder_view_get_type:
78 * get the GType for ModestFolderView
82 GType modest_folder_view_get_type (void) G_GNUC_CONST;
87 * modest_folder_view_new:
88 * @query: a #TnyFolderStoreQuery that specifies the folders to show
90 * create a new #ModestFolderView instance
92 * Returns: a new #GtkWidget (a #GtkTreeView subclass)
94 GtkWidget* modest_folder_view_new (TnyFolderStoreQuery *query);
97 * modest_folder_view_set_title:
98 * @self: a ModestFolderView instance
99 * @title: the new title
101 * set the title for the folder view; if title is NULL, the title column
102 * header will be hidden
104 void modest_folder_view_set_title (ModestFolderView *self,
109 * modest_folder_view_get_selected:
110 * @self: a #ModestFolderView
112 * gets a new reference to the #TnyFolderStore that is already
113 * selected. The caller must free this reference
115 * Returns: the selected #TnyFolderStore or NULL if none is selected
117 TnyFolderStore* modest_folder_view_get_selected (ModestFolderView *self);
121 * modest_folder_view_update_model:
122 * @self: a #ModestFolderView
124 * refresh the current model
126 * Returns: TRUE if the model was succesfully updated
128 gboolean modest_folder_view_update_model (ModestFolderView *self,
129 TnyAccountStore *account_store);
132 * modest_folder_view_set_style:
133 * @self: a #ModestFolderView
134 * @style: a #ModestFolderViewStyle
136 * Sets the folder view style. There are currently two available,
137 * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
138 * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
139 * account the mmc and only one of the available active server
143 void modest_folder_view_set_style (ModestFolderView *self,
144 ModestFolderViewStyle style);
147 * modest_folder_view_set_account_id_of_visible_server_account:
148 * @self: a #ModestFolderView
149 * @account_id: the remote server account id
151 * sets the server account id (value returned by tny_account_get_id())
152 * to the string passed as argument. The remote server with the
153 * specified id will be the unique visible account if the folder view
154 * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
156 void modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
157 const gchar *account_id);
160 * modest_folder_view_get_account_id_of_visible_server_account:
161 * @self: a #ModestFolderView
163 * gets the account id of the currently visible server account id
165 * Return value: the visible server account id or NULL if none set
167 const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
170 void modest_folder_view_select_first_inbox_or_local (ModestFolderView *self);
173 * modest_folder_view_copy_selection:
174 * @self: a #ModestFolderView
176 * Stores a #TnyList of selected folders in the own clibpoard of
179 void modest_folder_view_copy_selection (ModestFolderView *folder_view);
182 * modest_folder_view_cut_selection:
183 * @self: a #ModestFolderView
185 * Stores a #TnyList of selected folders in the own clibpoard of
186 * @self folder view and filter them into folders tree model to
187 * hide these rows in treeview.
189 void modest_folder_view_cut_selection (ModestFolderView *folder_view);
193 * modest_folder_view_select_folder
194 * @self: a #ModestFolderView
195 * @folder: a #TnyFolder
196 * @after_change: should we select first change to the view (TRUE), or just now (FALSE)
198 * select the given TnyFolder in the folder;
199 * return TRUE if it succeeded, FALSE otherwise.
201 gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *folder, gboolean after_change);
204 * modest_folder_view_paste_selection:
205 * @self: a #ModestFolderView
206 * @folders: ouput parameter with a #TnyList of folders which will be returned.
207 * @delete: output parameter with indication about delete or not the selected folders.
209 * Gets the selected folders to copy/cut.
211 void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
214 * modest_folder_view_show_non_move_folders:
215 * @self: a #ModestFolderView
216 * @show: show or hide the folders
218 * Whether to show folders where no messages can be moved to
220 void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
223 * modest_folder_view_copy_model:
224 * @folder_view_src: a #ModestFolderView
225 * @folder_view_dst: a #ModestFolderView
227 * Get model from @folder_view_src and builds a new
228 * #GtkTreeFilterModel object for that model. This copied
229 * model will be asigned to @folder_view_dst.
231 void modest_folder_view_copy_model (ModestFolderView *folder_view_src, ModestFolderView *folder_view_dst);
234 * modest_folder_disable_next_folder_selection:
235 * @folder_view: a #ModestFolderView
237 * Checks if folder_to_select private field is set and
238 * unref it in this case, assigning it to NULL to avoid
239 * next call to on_row_inserted_maybe_select_folder does
240 * not select any folder.
243 void modest_folder_view_disable_next_folder_selection (ModestFolderView *self);
247 #endif /* __MODEST_FOLDER_VIEW_H__ */