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