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 struct _ModestFolderView      ModestFolderView;
  54 typedef struct _ModestFolderViewClass ModestFolderViewClass;
  55
  56 struct _ModestFolderView {
  57          GtkTreeView parent;
  58         /* insert public members, if any */
  59 };
  60
  61 struct _ModestFolderViewClass {
  62         GtkTreeViewClass parent_class;
  63
  64         /* emitted when a folder is selected or unselected */
  65         void     (*folder_selection_changed) (ModestFolderView* self,
  66                                               TnyFolder *folder,
  67                                               gboolean selected,
  68                                               gpointer user_data);
  69
  70         void     (*folder_display_name_changed) (ModestFolderView* self,
  71                                                  const gchar *display_name,
  72                                                  gpointer user_data);
  73 };
  74
  75 /**
  76  * modest_folder_view_get_type:
  77  *
  78  * get the GType for ModestFolderView
  79  *
  80  * Returns: the GType
  81  */
  82 GType        modest_folder_view_get_type        (void) G_GNUC_CONST;
  83
  84
  85
  86 /**
  87  * modest_folder_view_new:
  88  * @query: a #TnyFolderStoreQuery that specifies the folders to show
  89  *
  90  * create a new #ModestFolderView instance
  91  *
  92  * Returns: a new #GtkWidget (a #GtkTreeView subclass)
  93  */
  94 GtkWidget*    modest_folder_view_new            (TnyFolderStoreQuery *query);
  95
  96 /**
  97  * modest_folder_view_set_title:
  98  * @self: a ModestFolderView instance
  99  * @title: the new title
 100  *
 101  * set the title for the folder view; if title is NULL, the title column
 102  * header will be hidden
 103  */
 104 void          modest_folder_view_set_title       (ModestFolderView *self,
 105                                                   const gchar *title);
 106
 107
 108 /**
 109  * modest_folder_view_get_selected:
 110  * @self: a #ModestFolderView
 111  *
 112  * gets a new reference to the #TnyFolderStore that is already
 113  * selected. The caller must free this reference
 114  *
 115  * Returns: the selected #TnyFolderStore or NULL if none is selected
 116  **/
 117 TnyFolderStore*    modest_folder_view_get_selected    (ModestFolderView *self);
 118
 119
 120 /**
 121  * modest_folder_view_update_model:
 122  * @self: a #ModestFolderView
 123  *
 124  * refresh the current model
 125  *
 126  * Returns: TRUE if the model was succesfully updated
 127  **/
 128 gboolean      modest_folder_view_update_model    (ModestFolderView *self,
 129                                                   TnyAccountStore *account_store);
 130
 131 /**
 132  * modest_folder_view_get_selected_display_name:
 133  * @self: a #ModestFolderView
 134  *
 135  * returns a the display name of the currently selected
 136  * #TnyFolder. Note that it could be different to the name returned by
 137  * the #TnyFolder that could be get using
 138  * modest_folder_view_get_selected, because it for example could
 139  * contain the unread messages between brackets
 140  *
 141  * Returns: the display name of the currently selected #TnyFolder or
 142  * NULL if none is selected
 143  **/
 144 const gchar* modest_folder_view_get_selected_display_name (ModestFolderView *self);
 145
 146
 147 /**
 148  * modest_folder_view_set_style:
 149  * @self: a #ModestFolderView
 150  * @style: a #ModestFolderViewStyle
 151  *
 152  * Sets the folder view style. There are currently two available,
 153  * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
 154  * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
 155  * account the mmc and only one of the available active server
 156  * accounts
 157
 158  **/
 159 void         modest_folder_view_set_style         (ModestFolderView *self,
 160                                                    ModestFolderViewStyle style);
 161
 162 /**
 163  * modest_folder_view_set_account_id_of_visible_server_account:
 164  * @self: a #ModestFolderView
 165  * @account_id: the remote server account id
 166  *
 167  * sets the server account id (value returned by tny_account_get_id())
 168  * to the string passed as argument. The remote server with the
 169  * specified id will be the unique visible account if the folder view
 170  * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
 171  **/
 172 void         modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
 173                                                                           const gchar *account_id);
 174
 175 /**
 176  * modest_folder_view_get_account_id_of_visible_server_account:
 177  * @self: a #ModestFolderView
 178  *
 179  * gets the account id of the currently visible server account id
 180  *
 181  * Return value: the visible server account id or NULL if none set
 182  **/
 183 const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
 184
 185 G_END_DECLS
 186
 187 #endif /* __MODEST_FOLDER_VIEW_H__ */