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 struct _ModestFolderView      ModestFolderView;
  49 typedef struct _ModestFolderViewClass ModestFolderViewClass;
  50
  51 struct _ModestFolderView {
  52          GtkTreeView parent;
  53         /* insert public members, if any */
  54 };
  55
  56 struct _ModestFolderViewClass {
  57         GtkTreeViewClass parent_class;
  58
  59         /* emitted when a folder is selected or unselected */
  60         void (*folder_selection_changed) (ModestFolderView* self,
  61                                           TnyFolder *folder,
  62                                           gboolean selected,
  63                                           gpointer user_data);
  64
  65         gboolean (*update_model) (ModestFolderView *self,
  66                                   TnyAccountStore *account_store);
  67 };
  68
  69
  70
  71 /* FIXME: move these to TnyMail */
  72 enum {
  73
  74         TNY_FOLDER_TYPE_NOTES = TNY_FOLDER_TYPE_ROOT + 1, /* urgh */
  75         TNY_FOLDER_TYPE_DRAFTS,
  76         TNY_FOLDER_TYPE_CONTACTS,
  77         TNY_FOLDER_TYPE_CALENDAR
  78 };
  79
  80
  81 /**
  82  * modest_folder_view_get_type:
  83  *
  84  * get the GType for ModestFolderView
  85  *
  86  * Returns: the GType
  87  */
  88 GType        modest_folder_view_get_type    (void) G_GNUC_CONST;
  89
  90
  91
  92 /**
  93  * modest_folder_view_new:
  94  * @account_store: a ModestTnyAccountStore instance
  95  * @query: a folder store query for the folders to watch
  96  *
  97  * create a new ModestFolderView instance, based on an account store
  98  *
  99  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 100  */
 101 GtkWidget* modest_folder_view_new         (ModestTnyAccountStore *account_store,
 102                                            TnyFolderStoreQuery *query);
 103
 104 /**
 105  * modest_folder_view_set_title:
 106  * @self: a ModestFolderView instance
 107  * @title: the new title
 108  *
 109  * set the title for the folder view; if title is NULL, the title column
 110  * header will be hidden
 111  */
 112 void  modest_folder_view_set_title (ModestFolderView *self, const gchar *title);
 113
 114
 115
 116 /**
 117  * modest_folder_view_is_empty:
 118  * @self: a ModestFolderView instance
 119  *
 120  * check to see of the view is empty. Note that when it is empty,
 121  * there will still be one item, telling "(empty)" or similar
 122  *
 123  * Returns: TRUE if the tree view is empty, FALSE otherwise
 124  */
 125 gboolean     modest_folder_view_is_empty    (ModestFolderView *self);
 126
 127
 128 /**
 129  * modest_folder_view_guess_folder_type:
 130  * @folder: a tnymail folder
 131  *
 132  * guess the type of the folder, this is a class method so it does not need
 133  * an ModestFolderView instance
 134  *
 135  * Returns: the folder type, or -1 in case of error
 136  */
 137 TnyFolderType  modest_folder_view_guess_folder_type    (TnyFolder *folder);
 138
 139
 140
 141 /* FIXME: this is ugly */
 142 const gchar* modest_folder_view_get_selected_account (ModestFolderView *self);
 143
 144 G_END_DECLS
 145
 146 #endif /* __MODEST_FOLDER_VIEW_H__ */