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