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