* initial code dump into SVN; needs some work
[modest] / src / modest-tny-folder-tree-view.h
diff --git a/src/modest-tny-folder-tree-view.h b/src/modest-tny-folder-tree-view.h
new file mode 100644 (file)
index 0000000..5b27bb0
--- /dev/null
@@ -0,0 +1,76 @@
+/* modest-tny-folder-tree-view.h */
+/* insert (c)/licensing information) */
+
+#ifndef __MODEST_TNY_FOLDER_TREE_VIEW_H__
+#define __MODEST_TNY_FOLDER_TREE_VIEW_H__
+
+#include <tny-account-tree-model.h>
+#include <tny-account-store-iface.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+/* convenience macros */
+#define MODEST_TYPE_TNY_FOLDER_TREE_VIEW             (modest_tny_folder_tree_view_get_type())
+#define MODEST_TNY_FOLDER_TREE_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeView))
+#define MODEST_TNY_FOLDER_TREE_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,GObject))
+#define MODEST_IS_TNY_FOLDER_TREE_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
+#define MODEST_IS_TNY_FOLDER_TREE_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_FOLDER_TREE_VIEW))
+#define MODEST_TNY_FOLDER_TREE_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_FOLDER_TREE_VIEW,ModestTnyFolderTreeViewClass))
+
+typedef struct _ModestTnyFolderTreeView      ModestTnyFolderTreeView;
+typedef struct _ModestTnyFolderTreeViewClass ModestTnyFolderTreeViewClass;
+
+struct _ModestTnyFolderTreeView {
+        GtkTreeView parent;
+       /* insert public members, if any */
+};
+
+struct _ModestTnyFolderTreeViewClass {
+       GtkTreeViewClass parent_class;
+
+       /* emitted when a folder is clicked */
+       void (*folder_selected) (ModestTnyFolderTreeView* self,
+                                TnyMsgFolderIface *folder,
+                                gpointer user_data);
+};
+
+
+/**
+ * modest_tny_folder_tree_view_get_type:
+ * 
+ * get the GType for ModestTnyFolderTreeView
+ *  
+ * Returns: the GType
+ */
+GType        modest_tny_folder_tree_view_get_type    (void) G_GNUC_CONST;
+
+
+/**
+ * modest_tny_folder_tree_view_new:
+ * @iface: a TnyAccountStoreIface object
+ * 
+ * create a new ModestTnyFolderTreeView instance, based on an account store
+ *  
+ * Returns: a new GtkWidget (a GtkTreeView-subclass)
+ */
+
+GtkWidget*   modest_tny_folder_tree_view_new         (TnyAccountStoreIface *iface);
+
+
+/**
+ * modest_tny_folder_tree_view_is_empty:
+ * @self: a ModestTnyFolderTreeView instance
+ * 
+ * check to see of the view is empty. Note that when it is empty,
+ * there will still be one item, telling "(empty)" or similar
+ *  
+ * Returns: TRUE if the tree view is empty, FALSE otherwise
+ */
+gboolean     modest_tny_folder_tree_view_is_empty    (ModestTnyFolderTreeView *self);
+
+
+G_END_DECLS
+
+#endif /* __MODEST_TNY_FOLDER_TREE_VIEW_H__ */
+