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