git.maemo.org Git - modest/blob - src/widgets/modest-folder-view.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 #ifndef __MODEST_FOLDER_VIEW_H__
  31 #define __MODEST_FOLDER_VIEW_H__
  32
  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>
  37 #include <modest-tny-folder.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_FOLDER_VIEW             (modest_folder_view_get_type())
  43 #define MODEST_FOLDER_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderView))
  44 #define MODEST_FOLDER_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
  45 #define MODEST_IS_FOLDER_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_VIEW))
  46 #define MODEST_IS_FOLDER_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_VIEW))
  47 #define MODEST_FOLDER_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
  48
  49 typedef enum _ModestFolderViewStyle {
  50         MODEST_FOLDER_VIEW_STYLE_SHOW_ALL,
  51         MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
  52 } ModestFolderViewStyle;
  53
  54 typedef enum _ModestFolderViewCellStyle {
  55         MODEST_FOLDER_VIEW_CELL_STYLE_DEFAULT,
  56         MODEST_FOLDER_VIEW_CELL_STYLE_COMPACT
  57 } ModestFolderViewCellStyle;
  58
  59 typedef enum _ModestFolderViewFilter {
  60         MODEST_FOLDER_VIEW_FILTER_NONE = 0,
  61         MODEST_FOLDER_VIEW_FILTER_CAN_HAVE_FOLDERS = 1 << 0,
  62         MODEST_FOLDER_VIEW_FILTER_HIDE_MANDATORY_FOLDERS = 1 << 1,
  63         MODEST_FOLDER_VIEW_FILTER_RENAMEABLE = 1 << 2,
  64         MODEST_FOLDER_VIEW_FILTER_MOVEABLE = 1 << 3,
  65         MODEST_FOLDER_VIEW_FILTER_DELETABLE = 1 << 4,
  66         MODEST_FOLDER_VIEW_FILTER_HIDE_ACCOUNTS = 1 << 5,
  67         MODEST_FOLDER_VIEW_FILTER_HIDE_FOLDERS = 1 << 6,
  68 } ModestFolderViewFilter;
  69
  70 typedef struct _ModestFolderView      ModestFolderView;
  71 typedef struct _ModestFolderViewClass ModestFolderViewClass;
  72
  73 struct _ModestFolderView {
  74          GtkTreeView parent;
  75         /* insert public members, if any */
  76 };
  77
  78 struct _ModestFolderViewClass {
  79         GtkTreeViewClass parent_class;
  80
  81         /* emitted when a folder is selected or unselected */
  82         void     (*folder_selection_changed) (ModestFolderView* self,
  83                                               TnyFolderStore *folder,
  84                                               gboolean selected,
  85                                               gpointer user_data);
  86
  87         void     (*folder_display_name_changed) (ModestFolderView* self,
  88                                                  const gchar *display_name,
  89                                                  gpointer user_data);
  90
  91         void     (*folder_activated) (ModestFolderView *self,
  92                                       TnyFolderStore *folder,
  93                                       gpointer userdata);
  94
  95         void     (*visible_account_changed) (ModestFolderView* self,
  96                                              const gchar *account_id,
  97                                              gpointer user_data);
  98 };
  99
 100 /**
 101  * modest_folder_view_get_type:
 102  *
 103  * get the GType for ModestFolderView
 104  *
 105  * Returns: the GType
 106  */
 107 GType        modest_folder_view_get_type        (void) G_GNUC_CONST;
 108
 109
 110
 111 /**
 112  * modest_folder_view_new:
 113  * @query: a #TnyFolderStoreQuery that specifies the folders to show
 114  *
 115  * create a new #ModestFolderView instance
 116  *
 117  * Returns: a new #GtkWidget (a #GtkTreeView subclass)
 118  */
 119 GtkWidget*    modest_folder_view_new            (TnyFolderStoreQuery *query);
 120
 121 /**
 122  * modest_folder_view_set_title:
 123  * @self: a ModestFolderView instance
 124  * @title: the new title
 125  *
 126  * set the title for the folder view; if title is NULL, the title column
 127  * header will be hidden
 128  */
 129 void          modest_folder_view_set_title       (ModestFolderView *self,
 130                                                   const gchar *title);
 131
 132
 133 /**
 134  * modest_folder_view_get_selected:
 135  * @self: a #ModestFolderView
 136  *
 137  * gets a new reference to the #TnyFolderStore that is already
 138  * selected. The caller must free this reference
 139  *
 140  * Returns: the selected #TnyFolderStore or NULL if none is selected
 141  **/
 142 TnyFolderStore*    modest_folder_view_get_selected    (ModestFolderView *self);
 143
 144
 145 /**
 146  * modest_folder_view_update_model:
 147  * @self: a #ModestFolderView
 148  *
 149  * refresh the current model
 150  *
 151  * Returns: TRUE if the model was succesfully updated
 152  **/
 153 gboolean      modest_folder_view_update_model    (ModestFolderView *self,
 154                                                   TnyAccountStore *account_store);
 155
 156 /**
 157  * modest_folder_view_set_style:
 158  * @self: a #ModestFolderView
 159  * @style: a #ModestFolderViewStyle
 160  *
 161  * Sets the folder view style. There are currently two available,
 162  * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
 163  * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
 164  * account the mmc and only one of the available active server
 165  * accounts
 166
 167  **/
 168 void         modest_folder_view_set_style         (ModestFolderView *self,
 169                                                    ModestFolderViewStyle style);
 170
 171 /**
 172  * modest_folder_view_set_account_id_of_visible_server_account:
 173  * @self: a #ModestFolderView
 174  * @account_id: the remote server account id
 175  *
 176  * sets the server account id (value returned by tny_account_get_id())
 177  * to the string passed as argument. The remote server with the
 178  * specified id will be the unique visible account if the folder view
 179  * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
 180  **/
 181 void         modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
 182                                                                           const gchar *account_id);
 183
 184 /**
 185  * modest_folder_view_get_account_id_of_visible_server_account:
 186  * @self: a #ModestFolderView
 187  *
 188  * gets the account id of the currently visible server account id
 189  *
 190  * Return value: the visible server account id or NULL if none set
 191  **/
 192 const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
 193
 194
 195 void         modest_folder_view_select_first_inbox_or_local  (ModestFolderView *self);
 196
 197 /**
 198  * modest_folder_view_copy_selection:
 199  * @self: a #ModestFolderView
 200  *
 201  * Stores a #TnyList of selected folders in the own clibpoard of
 202  * @self folder view.
 203  **/
 204 void modest_folder_view_copy_selection (ModestFolderView *folder_view);
 205
 206 /**
 207  * modest_folder_view_cut_selection:
 208  * @self: a #ModestFolderView
 209  *
 210  * Stores a #TnyList of selected folders in the own clibpoard of
 211  * @self folder view and filter them into folders tree model to
 212  * hide these rows in treeview.
 213  **/
 214 void modest_folder_view_cut_selection (ModestFolderView *folder_view);
 215
 216
 217 /**
 218  * modest_folder_view_select_folder
 219  * @self: a #ModestFolderView
 220  * @folder: a #TnyFolder
 221  * @after_change: should we select first change to the view (TRUE), or just now (FALSE)
 222  *
 223  * select the given TnyFolder in the folder;
 224  * return TRUE if it succeeded, FALSE otherwise.
 225  **/
 226 gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *folder, gboolean after_change);
 227
 228 /**
 229  * modest_folder_view_paste_selection:
 230  * @self: a #ModestFolderView
 231  * @folders: ouput parameter with a #TnyList of folders which will be returned.
 232  * @delete: output parameter with indication about delete or not the selected folders.
 233  *
 234  * Gets the selected folders to copy/cut.
 235  **/
 236 void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
 237
 238 /*
 239  * modest_folder_view_show_non_move_folders:
 240  * @self: a #ModestFolderView
 241  * @show: show or hide the folders
 242  *
 243  * Whether to show folders where no messages can be moved to
 244  **/
 245 void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
 246
 247 /*
 248  * modest_folder_view_copy_model:
 249  * @folder_view_src: a #ModestFolderView
 250  * @folder_view_dst: a #ModestFolderView
 251  *
 252  * Get model from @folder_view_src and builds a new
 253  * #GtkTreeFilterModel object for that model. This copied
 254  * model will be asigned to @folder_view_dst.
 255  **/
 256 void modest_folder_view_copy_model (ModestFolderView *folder_view_src, ModestFolderView *folder_view_dst);
 257
 258 /*
 259  * modest_folder_disable_next_folder_selection:
 260  * @folder_view: a #ModestFolderView
 261  *
 262  * Checks if folder_to_select private field is set and
 263  * unref it in this case, assigning it to NULL to avoid
 264  * next call to on_row_inserted_maybe_select_folder does
 265  * not select any folder.
 266  *
 267  **/
 268 void modest_folder_view_disable_next_folder_selection (ModestFolderView *self);
 269
 270 /**
 271  * modest_folder_view_set_cell_style:
 272  * @self: a #ModestFolderView
 273  * @cell_style: a #ModestFolderViewCellStyle
 274  *
 275  * Sets the way cells are shown
 276  */
 277 void modest_folder_view_set_cell_style (ModestFolderView *self,
 278                                         ModestFolderViewCellStyle cell_style);
 279
 280 /**
 281  * modest_folder_view_set_filter:
 282  * @self: a #ModestFolderView
 283  * @filter: a filter mask to be applied to files
 284  *
 285  * sets the special filter to be applied (affects visibility of items).
 286  * It's a mask, and filters applied are applied with an AND.
 287  */
 288 void modest_folder_view_set_filter (ModestFolderView *self,
 289                                     ModestFolderViewFilter filter);
 290
 291 /**
 292  * modest_folder_view_unset_filter:
 293  * @self: a #ModestFolderView
 294  * @filter: a filter mask to be unapplied to files
 295  *
 296  * Unsets the special filter to be applied (affects visibility of
 297  * items).  It's a mask, and filters applied are applied with an AND.
 298  */
 299 void modest_folder_view_unset_filter (ModestFolderView *self,
 300                                       ModestFolderViewFilter filter);
 301
 302 gboolean modest_folder_view_any_folder_fulfils_rules (ModestFolderView *self,
 303                                                       ModestTnyFolderRules rules);
 304
 305 /**
 306  * modest_folder_view_set_list_to_move:
 307  * @self: a #ModestFolderView
 308  * @list: a #TnyList, or %NULL for unsetting the current list.
 309  *
 310  * list of folders or messages we're moving. This has some effects on
 311  * "show_non_move_to".
 312  */
 313 void modest_folder_view_set_list_to_move (ModestFolderView *self,
 314                                           TnyList *list);
 315
 316 G_END_DECLS
 317
 318 #endif /* __MODEST_FOLDER_VIEW_H__ */