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