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