* don't depend on hildon when it's not there
[modest] / src / modest-tny-header-tree-view.h
index 3d4c7b5..33f27be 100644 (file)
@@ -1,5 +1,31 @@
-/* modest-tny-header-tree-view.h */
-/* insert (c)/licensing information) */
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 
 #ifndef __MODEST_TNY_HEADER_TREE_VIEW_H__
 #define __MODEST_TNY_HEADER_TREE_VIEW_H__
@@ -16,7 +42,7 @@ G_BEGIN_DECLS
 /* convenience macros */
 #define MODEST_TYPE_TNY_HEADER_TREE_VIEW             (modest_tny_header_tree_view_get_type())
 #define MODEST_TNY_HEADER_TREE_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_HEADER_TREE_VIEW,ModestTnyHeaderTreeView))
-#define MODEST_TNY_HEADER_TREE_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_HEADER_TREE_VIEW,GObject))
+#define MODEST_TNY_HEADER_TREE_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_HEADER_TREE_VIEW,ModestTnyHeaderTreeViewClass))
 #define MODEST_IS_TNY_HEADER_TREE_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_HEADER_TREE_VIEW))
 #define MODEST_IS_TNY_HEADER_TREE_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_HEADER_TREE_VIEW))
 #define MODEST_TNY_HEADER_TREE_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_HEADER_TREE_VIEW,ModestTnyHeaderTreeViewClass))
@@ -35,9 +61,40 @@ struct _ModestTnyHeaderTreeViewClass {
        void (*message_selected) (ModestTnyHeaderTreeView* self,
                                  TnyMsgIface *msg,
                                  gpointer user_data);
+
+       /* msg == NULL implies that the operation is finished, ie.
+        * the progress indictation can be hidden */
+       void (*status_update) (ModestTnyHeaderTreeView* self,
+                              const gchar* msg,
+                              gint status,
+                              gpointer user_data);
 };
 
 
+enum {
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_FROM,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_TO,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_SUBJECT,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_SENT_DATE,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_RECEIVED_DATE,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_MSGTYPE,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_ATTACH,
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_COMPACT_HEADER,
+
+       MODEST_TNY_HEADER_TREE_VIEW_COLUMN_NUM
+};
+typedef guint ModestTnyHeaderTreeViewColumn;
+
+enum {
+       MODEST_TNY_HEADER_TREE_VIEW_STYLE_NORMAL,
+       MODEST_TNY_HEADER_TREE_VIEW_STYLE_COMPACT,
+       
+       MODEST_TNY_HEADER_TREE_VIEW_STYLE_NUM
+};
+typedef guint ModestTnyHeaderTreeViewStyle;
+
+
+
 /**
  * modest_tny_header_tree_view_get_type:
  * 
@@ -51,13 +108,17 @@ GType        modest_tny_header_tree_view_get_type    (void) G_GNUC_CONST;
 /**
  * modest_tny_header_tree_view_new:
  * @folder: a TnyMsgFolderIface object
+ * @columns: a list of ModestTnyHeaderTreeViewColumn
+ * @style: a ModestTnyHeaderTreeViewColumn with the style of this listview
+ *  (  MODEST_TNY_HEADER_TREE_VIEW_STYLE_NORMAL or MODEST_TNY_HEADER_TREE_VIEW_STYLE_COMPACT)
  * 
  * create a new ModestTnyHeaderTreeView instance, based on a folder iface
- *  
+ *   
  * Returns: a new GtkWidget (a GtkTreeView-subclass)
  */
-GtkWidget*   modest_tny_header_tree_view_new        (TnyMsgFolderIface *folder);
-
+GtkWidget*   modest_tny_header_tree_view_new        (TnyMsgFolderIface *folder,
+                                                    GSList *columns,
+                                                    ModestTnyHeaderTreeViewStyle style);
 
 /**
  * modest_tny_header_tree_view_set_folder:
@@ -71,7 +132,55 @@ GtkWidget*   modest_tny_header_tree_view_new        (TnyMsgFolderIface *folder);
 gboolean     modest_tny_header_tree_view_set_folder (ModestTnyHeaderTreeView *self,
                                                      TnyMsgFolderIface *folder);
 
+
+/**
+ * modest_tny_header_tree_view_set_columns:
+ * @self: a ModestTnyHeaderTreeView instance
+ * @columns: a list of ModestTnyHeaderTreeViewColumn
+ * 
+ * set the columns for this ModestTnyHeaderTreeView
+ *  
+ * Returns: TRUE if it succeeded, FALSE otherwise
+ */
+gboolean     modest_tny_header_tree_view_set_columns (ModestTnyHeaderTreeView *self,
+                                                     GSList *columns);
+/**
+ * modest_tny_header_tree_view_get_columns:
+ * @self: a ModestTnyHeaderTreeView instance
+ * @folder: a TnyMsgFolderIface object
+ * 
+ * get the columns for this ModestTnyHeaderTreeView
+ *  
+ * Returns: list of columms, or NULL in case of no columns or error
+ */
+const GSList*   modest_tny_header_tree_view_get_columns (ModestTnyHeaderTreeView *self);
+       
+
+/**
+ * modest_tny_header_tree_view_set_style:
+ * @self: a ModestTnyHeaderTreeView instance
+ * @style: the style for this tree view
+ * 
+ * set the folder for this ModestTnyHeaderTreeView
+ *  
+ * Returns: TRUE if it succeeded, FALSE otherwise
+ */
+gboolean   modest_tny_header_tree_view_set_style (ModestTnyHeaderTreeView *self,
+                                                 ModestTnyHeaderTreeViewStyle style);
+
+/**
+ * modest_tny_header_tree_view_set_folder:
+ * @self: a ModestTnyHeaderTreeView instance
+ * @folder: a TnyMsgFolderIface object
+ * 
+ * set the folder for this ModestTnyHeaderTreeView
+ *  
+ * Returns: TRUE if it succeeded, FALSE otherwise
+ */
+ModestTnyHeaderTreeViewStyle   modest_tny_header_tree_view_get_style (ModestTnyHeaderTreeView *self);
+
 G_END_DECLS
 
+
 #endif /* __MODEST_TNY_HEADER_TREE_VIEW_H__ */