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