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