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
  66 /**
  67  * modest_folder_view_get_type:
  68  *
  69  * get the GType for ModestFolderView
  70  *
  71  * Returns: the GType
  72  */
  73 GType        modest_folder_view_get_type        (void) G_GNUC_CONST;
  74
  75
  76
  77 /**
  78  * modest_folder_view_new:
  79  * @query: a #TnyFolderStoreQuery that specifies the folders to show
  80  *
  81  * create a new #ModestFolderView instance
  82  *
  83  * Returns: a new #GtkWidget (a #GtkTreeView subclass)
  84  */
  85 GtkWidget*    modest_folder_view_new            (TnyFolderStoreQuery *query);
  86
  87 /**
  88  * modest_folder_view_set_title:
  89  * @self: a ModestFolderView instance
  90  * @title: the new title
  91  *
  92  * set the title for the folder view; if title is NULL, the title column
  93  * header will be hidden
  94  */
  95 void          modest_folder_view_set_title       (ModestFolderView *self,
  96                                                   const gchar *title);
  97
  98
  99 /**
 100  * modest_folder_view_get_selected:
 101  * @self: a #ModestFolderView
 102  *
 103  * returns a new reference to the #TnyFolder that is already selected
 104  *
 105  * Returns: the selected folder or NULL if none is selected
 106  **/
 107 TnyFolder*    modest_folder_view_get_selected    (ModestFolderView *self);
 108
 109
 110 /**
 111  * modest_folder_view_update_model:
 112  * @self: a #ModestFolderView
 113  *
 114  * refresh the current model
 115  *
 116  * Returns: TRUE if the model was succesfully updated
 117  **/
 118 gboolean      modest_folder_view_update_model    (ModestFolderView *self,
 119                                                   TnyAccountStore *account_store);
 120
 121 /**
 122  * modest_folder_view_get_selected_display_name:
 123  * @self: a #ModestFolderView
 124  *
 125  * returns a the display name of the currently selected
 126  * #TnyFolder. Note that it could be different to the name returned by
 127  * the #TnyFolder that could be get using
 128  * modest_folder_view_get_selected, because it for example could
 129  * contain the unread messages between brackets
 130  *
 131  * Returns: the display name of the currently selected #TnyFolder or
 132  * NULL if none is selected
 133  **/
 134 const gchar* modest_folder_view_get_selected_display_name (ModestFolderView *self);
 135
 136 G_END_DECLS
 137
 138 #endif /* __MODEST_FOLDER_VIEW_H__ */