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         void     (*activity_changed) (ModestFolderView* self,
 102                                       gboolean activity,
 103                                       gpointer user_data);
 104 };
 105
 106 /**
 107  * modest_folder_view_get_type:
 108  *
 109  * get the GType for ModestFolderView
 110  *
 111  * Returns: the GType
 112  */
 113 GType        modest_folder_view_get_type        (void) G_GNUC_CONST;
 114
 115
 116
 117 /**
 118  * modest_folder_view_new:
 119  * @query: a #TnyFolderStoreQuery that specifies the folders to show
 120  *
 121  * create a new #ModestFolderView instance
 122  *
 123  * Returns: a new #GtkWidget (a #GtkTreeView subclass)
 124  */
 125 GtkWidget*    modest_folder_view_new            (TnyFolderStoreQuery *query);
 126
 127 /**
 128  * modest_folder_view_new_full:
 129  * @query: a #TnyFolderStoreQuery that specifies the folders to show
 130  * @do_refresh: do auto refresh on loading (may be slow)
 131  *
 132  * create a new #ModestFolderView instance
 133  *
 134  * Returns: a new #GtkWidget (a #GtkTreeView subclass)
 135  */
 136 GtkWidget*    modest_folder_view_new_full            (TnyFolderStoreQuery *query, gboolean do_refresh);
 137
 138 /**
 139  * modest_folder_view_set_title:
 140  * @self: a ModestFolderView instance
 141  * @title: the new title
 142  *
 143  * set the title for the folder view; if title is NULL, the title column
 144  * header will be hidden
 145  */
 146 void          modest_folder_view_set_title       (ModestFolderView *self,
 147                                                   const gchar *title);
 148
 149
 150 /**
 151  * modest_folder_view_get_selected:
 152  * @self: a #ModestFolderView
 153  *
 154  * gets a new reference to the #TnyFolderStore that is already
 155  * selected. The caller must free this reference
 156  *
 157  * Returns: the selected #TnyFolderStore or NULL if none is selected
 158  **/
 159 TnyFolderStore*    modest_folder_view_get_selected    (ModestFolderView *self);
 160
 161
 162 /**
 163  * modest_folder_view_update_model:
 164  * @self: a #ModestFolderView
 165  *
 166  * refresh the current model
 167  *
 168  * Returns: TRUE if the model was succesfully updated
 169  **/
 170 gboolean      modest_folder_view_update_model    (ModestFolderView *self,
 171                                                   TnyAccountStore *account_store);
 172
 173 /**
 174  * modest_folder_view_set_style:
 175  * @self: a #ModestFolderView
 176  * @style: a #ModestFolderViewStyle
 177  *
 178  * Sets the folder view style. There are currently two available,
 179  * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
 180  * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
 181  * account the mmc and only one of the available active server
 182  * accounts
 183
 184  **/
 185 void         modest_folder_view_set_style         (ModestFolderView *self,
 186                                                    ModestFolderViewStyle style);
 187
 188 /**
 189  * modest_folder_view_set_account_id_of_visible_server_account:
 190  * @self: a #ModestFolderView
 191  * @account_id: the remote server account id
 192  *
 193  * sets the server account id (value returned by tny_account_get_id())
 194  * to the string passed as argument. The remote server with the
 195  * specified id will be the unique visible account if the folder view
 196  * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
 197  **/
 198 void         modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
 199                                                                           const gchar *account_id);
 200
 201 /**
 202  * modest_folder_view_set_visible_mailbox:
 203  * @self: a #ModestFolderView
 204  * @account_id: the remote account mailbox to show
 205  *
 206  * if set an account id to filter, this filters also to show only
 207  * folders of a specific mailbox.
 208  **/
 209 void         modest_folder_view_set_mailbox (ModestFolderView *self,
 210                                              const gchar *mailbox);
 211
 212 /**
 213  * modest_folder_view_get_mailbox:
 214  * @self: a #ModestFolderView
 215  *
 216  * Return the current mailbox set for filtering in folder view
 217  *
 218  * Returns: a string, or %NULL
 219  */
 220 const gchar *modest_folder_view_get_mailbox (ModestFolderView *self);
 221
 222 /**
 223  * modest_folder_view_get_account_id_of_visible_server_account:
 224  * @self: a #ModestFolderView
 225  *
 226  * gets the account id of the currently visible server account id
 227  *
 228  * Return value: the visible server account id or NULL if none set
 229  **/
 230 const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
 231
 232
 233 void         modest_folder_view_select_first_inbox_or_local  (ModestFolderView *self);
 234
 235 /**
 236  * modest_folder_view_copy_selection:
 237  * @self: a #ModestFolderView
 238  *
 239  * Stores a #TnyList of selected folders in the own clibpoard of
 240  * @self folder view.
 241  **/
 242 void modest_folder_view_copy_selection (ModestFolderView *folder_view);
 243
 244 /**
 245  * modest_folder_view_cut_selection:
 246  * @self: a #ModestFolderView
 247  *
 248  * Stores a #TnyList of selected folders in the own clibpoard of
 249  * @self folder view and filter them into folders tree model to
 250  * hide these rows in treeview.
 251  **/
 252 void modest_folder_view_cut_selection (ModestFolderView *folder_view);
 253
 254
 255 /**
 256  * modest_folder_view_select_folder
 257  * @self: a #ModestFolderView
 258  * @folder: a #TnyFolder
 259  * @after_change: should we select first change to the view (TRUE), or just now (FALSE)
 260  *
 261  * select the given TnyFolder in the folder;
 262  * return TRUE if it succeeded, FALSE otherwise.
 263  **/
 264 gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *folder, gboolean after_change);
 265
 266 /**
 267  * modest_folder_view_paste_selection:
 268  * @self: a #ModestFolderView
 269  * @folders: ouput parameter with a #TnyList of folders which will be returned.
 270  * @delete: output parameter with indication about delete or not the selected folders.
 271  *
 272  * Gets the selected folders to copy/cut.
 273  **/
 274 void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
 275
 276 /*
 277  * modest_folder_view_show_non_move_folders:
 278  * @self: a #ModestFolderView
 279  * @show: show or hide the folders
 280  *
 281  * Whether to show folders where no messages can be moved to
 282  **/
 283 void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
 284
 285 /*
 286  * modest_folder_view_copy_model:
 287  * @folder_view_src: a #ModestFolderView
 288  * @folder_view_dst: a #ModestFolderView
 289  *
 290  * Get model from @folder_view_src and builds a new
 291  * #GtkTreeFilterModel object for that model. This copied
 292  * model will be asigned to @folder_view_dst.
 293  **/
 294 void modest_folder_view_copy_model (ModestFolderView *folder_view_src, ModestFolderView *folder_view_dst);
 295
 296 /*
 297  * modest_folder_disable_next_folder_selection:
 298  * @folder_view: a #ModestFolderView
 299  *
 300  * Checks if folder_to_select private field is set and
 301  * unref it in this case, assigning it to NULL to avoid
 302  * next call to on_row_inserted_maybe_select_folder does
 303  * not select any folder.
 304  *
 305  **/
 306 void modest_folder_view_disable_next_folder_selection (ModestFolderView *self);
 307
 308 /**
 309  * modest_folder_view_set_cell_style:
 310  * @self: a #ModestFolderView
 311  * @cell_style: a #ModestFolderViewCellStyle
 312  *
 313  * Sets the way cells are shown
 314  */
 315 void modest_folder_view_set_cell_style (ModestFolderView *self,
 316                                         ModestFolderViewCellStyle cell_style);
 317
 318 /**
 319  * modest_folder_view_set_filter:
 320  * @self: a #ModestFolderView
 321  * @filter: a filter mask to be applied to files
 322  *
 323  * sets the special filter to be applied (affects visibility of items).
 324  * It's a mask, and filters applied are applied with an AND.
 325  */
 326 void modest_folder_view_set_filter (ModestFolderView *self,
 327                                     ModestFolderViewFilter filter);
 328
 329 /**
 330  * modest_folder_view_unset_filter:
 331  * @self: a #ModestFolderView
 332  * @filter: a filter mask to be unapplied to files
 333  *
 334  * Unsets the special filter to be applied (affects visibility of
 335  * items).  It's a mask, and filters applied are applied with an AND.
 336  */
 337 void modest_folder_view_unset_filter (ModestFolderView *self,
 338                                       ModestFolderViewFilter filter);
 339
 340 gboolean modest_folder_view_any_folder_fulfils_rules (ModestFolderView *self,
 341                                                       ModestTnyFolderRules rules);
 342
 343 /**
 344  * modest_folder_view_set_list_to_move:
 345  * @self: a #ModestFolderView
 346  * @list: a #TnyList, or %NULL for unsetting the current list.
 347  *
 348  * list of folders or messages we're moving. This has some effects on
 349  * "show_non_move_to".
 350  */
 351 void modest_folder_view_set_list_to_move (ModestFolderView *self,
 352                                           TnyList *list);
 353
 354 /**
 355  * modest_folder_view_show_message_count:
 356  * @self: a #ModestFolderView
 357  * @show: a #gboolean
 358  *
 359  * Set if the message count should be shown or not
 360  */
 361 void modest_folder_view_show_message_count (ModestFolderView *self,
 362                                             gboolean show);
 363
 364 /**
 365  * modest_folder_view_get_activity:
 366  * @self: a #ModestFolderView
 367  *
 368  * tells if widget is retrieving information
 369  *
 370  * Returns: %TRUE if retrieving, %FALSE otherwise
 371  */
 372 gboolean modest_folder_view_get_activity (ModestFolderView *self);
 373
 374 /**
 375  * modest_folder_view_get_model_tny_list:
 376  * @self: a #ModestFolderView
 377  *
 378  * obtains the #TnyList model containing the accounts in the folder view.
 379  *
 380  * Returns: a caller owner #TnyList
 381  */
 382 TnyList *modest_folder_view_get_model_tny_list (ModestFolderView *self);
 383
 384 #ifdef MODEST_TOOLKIT_HILDON2
 385 /**
 386  * modest_folder_view_setup_live_search:
 387  * @self: a #ModestAccountView
 388  *
 389  * obtains a properly set up #HildonLiveSearch for @self
 390  *
 391  * Returns: a #HildonLiveSearch
 392  */
 393 GtkWidget *modest_folder_view_setup_live_search (ModestFolderView *self);
 394 #endif
 395
 396
 397 G_END_DECLS
 398
 399 #endif /* __MODEST_FOLDER_VIEW_H__ */