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