git.maemo.org Git - modest/blob - src/modest-tny-folder-tree-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_TNY_FOLDER_TREE_VIEW_H__
  31 #define __MODEST_TNY_FOLDER_TREE_VIEW_H__
  32
  33 #include <tny-account-tree-model.h>
  34 #include <tny-account-store-iface.h>
  35 #include <glib-object.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /* convenience macros */
  40 #define MODEST_TYPE_TNY_FOLDER_TREE_VIEW             (modest_tny_folder_tree_view_get_type())
  41 #define MODEST_TNY_FOLDER_TREE_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeView))
  42 #define MODEST_TNY_FOLDER_TREE_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeViewClass))
  43 #define MODEST_IS_TNY_FOLDER_TREE_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
  44 #define MODEST_IS_TNY_FOLDER_TREE_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
  45 #define MODEST_TNY_FOLDER_TREE_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeViewClass))
  46
  47 typedef struct _ModestTnyFolderTreeView      ModestTnyFolderTreeView;
  48 typedef struct _ModestTnyFolderTreeViewClass ModestTnyFolderTreeViewClass;
  49
  50 struct _ModestTnyFolderTreeView {
  51          GtkTreeView parent;
  52         /* insert public members, if any */
  53 };
  54
  55 struct _ModestTnyFolderTreeViewClass {
  56         GtkTreeViewClass parent_class;
  57
  58         /* emitted when a folder is clicked */
  59         void (*folder_selected) (ModestTnyFolderTreeView* self,
  60                                  TnyMsgFolderIface *folder,
  61                                  gpointer user_data);
  62
  63         gboolean (*update_model) (ModestTnyFolderTreeView *self,
  64                                   TnyAccountStoreIface *iface);
  65
  66 };
  67
  68
  69 /**
  70  * modest_tny_folder_tree_view_get_type:
  71  *
  72  * get the GType for ModestTnyFolderTreeView
  73  *
  74  * Returns: the GType
  75  */
  76 GType        modest_tny_folder_tree_view_get_type    (void) G_GNUC_CONST;
  77
  78
  79 /**
  80  * modest_tny_folder_tree_view_new:
  81  * @iface: a TnyAccountStoreIface object
  82  *
  83  * create a new ModestTnyFolderTreeView instance, based on an account store
  84  *
  85  * Returns: a new GtkWidget (a GtkTreeView-subclass)
  86  */
  87
  88 GtkWidget*   modest_tny_folder_tree_view_new         (TnyAccountStoreIface *iface);
  89
  90
  91 /**
  92  * modest_tny_folder_tree_view_is_empty:
  93  * @self: a ModestTnyFolderTreeView instance
  94  *
  95  * check to see of the view is empty. Note that when it is empty,
  96  * there will still be one item, telling "(empty)" or similar
  97  *
  98  * Returns: TRUE if the tree view is empty, FALSE otherwise
  99  */
 100 gboolean     modest_tny_folder_tree_view_is_empty    (ModestTnyFolderTreeView *self);
 101
 102
 103 /**
 104  * modest_tny_folder_tree_view_update_model:
 105  * @self: a #ModestTnyFolderTreeView instance
 106  * @iface: a #TnyAccountStoreIface instance
 107  *
 108  * Update the thee model from a given account store.
 109  *
 110  * Returns: TRUE on success, FALSE otherwise
 111  */
 112 gboolean     modest_tny_folder_tree_view_update_model(ModestTnyFolderTreeView *self,
 113                                                       TnyAccountStoreIface *iface);
 114
 115
 116 G_END_DECLS
 117
 118 #endif /* __MODEST_TNY_FOLDER_TREE_VIEW_H__ */
 119