2007-05-23 Murray Cumming <murrayc@murrayc.com>
[modest] / src / widgets / modest-main-window.h
index a77688f..6a4b130 100644 (file)
 #ifndef __MODEST_MAIN_WINDOW_H__
 #define __MODEST_MAIN_WINDOW_H__
 
-#include "modest-widget-factory.h"
-#include "modest-window.h"
+#include <gtk/gtkwidget.h>
+#include <widgets/modest-window.h>
+#include <widgets/modest-header-view.h>
+#include <widgets/modest-folder-view.h>
+#include <widgets/modest-msg-view.h>
+
 
 G_BEGIN_DECLS
 
@@ -56,34 +60,119 @@ struct _ModestMainWindowClass {
        ModestWindowClass parent_class;
 };
 
-/* member functions */
+/*
+ * MODEST_MAIN_WINDOW_STYLE_SIMPLE: shows only the header list
+ * MODEST_MAIN_WINDOW_STYLE_SPLIT: shows a right pane with the folder
+ * tree and a left pane with the header list
+ */
+typedef enum _ModestMainWindowStyle {
+       MODEST_MAIN_WINDOW_STYLE_SIMPLE,
+       MODEST_MAIN_WINDOW_STYLE_SPLIT
+} ModestMainWindowStyle;
+
+/*
+ * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
+ * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
+ */
+typedef enum _ModestMainWindowContentsStyle {
+       MODEST_MAIN_WINDOW_CONTENTS_STYLE_HEADERS,
+       MODEST_MAIN_WINDOW_CONTENTS_STYLE_DETAILS,
+} ModestMainWindowContentsStyle;
+
+/* toolbar modes  */
+typedef enum _ModestToolBarModes {
+       TOOLBAR_MODE_NORMAL,
+       TOOLBAR_MODE_TRANSFER,  
+} ModestToolBarModes;
+
+/**
+ * modest_main_window_get_type:
+ * 
+ * get the GType for the ModestMainWindow class
+ *
+ * Returns: a GType for ModestMainWindow
+ */
 GType modest_main_window_get_type (void) G_GNUC_CONST;
 
 
-ModestWindow* modest_main_window_new (ModestWidgetFactory *factory,
-                                     TnyAccountStore *account_store);
+/**
+ * modest_main_window_new
+ * 
+ * instantiates a new ModestMainWindow widget
+ *
+ * Returns: a new ModestMainWindow, or NULL in case of error
+ */
+ModestWindow* modest_main_window_new (void);
+
+/*
+ * we could use the GType instead, but that would require
+ * that there only on widget of a certain type; that is
+ * true now, but might not be. Therefore, these types
+ */
+typedef enum {
+       MODEST_WIDGET_TYPE_HEADER_VIEW,
+       MODEST_WIDGET_TYPE_FOLDER_VIEW,
+       MODEST_WIDGET_TYPE_MSG_PREVIEW,
+       
+       MODEST_WIDGET_TYPE_NUM,
+} ModestWidgetType;
+
 
 /**
- * modest_main_window_get_widget_factory:
- * @edit_window: a #ModestMainWindow
+ * modest_main_window_get_child_widget
  * 
- * gets a new reference to the #ModestWidgetFactory associated with
- * the main window
+ * get a child window for this window
+ *
+ * Returns: a child window or NULL
+ */
+GtkWidget* modest_main_window_get_child_widget (ModestMainWindow *self,
+                                               ModestWidgetType widget_type);
+
+/**
+ * modest_main_window_close_all:
+ * @self: 
  * 
- * Returns: the widget factory
+ * this function will ask the user about if the user wants to close
+ * all the windows or just the main one
+ * 
+ * Returns: TRUE if the user selected to close all the windows, otherwise FALSE
  **/
-ModestWidgetFactory *   modest_main_window_get_widget_factory    (ModestMainWindow *main_window);
+gboolean   modest_main_window_close_all        (ModestMainWindow *self);
+
 
 /**
- * modest_main_window_get_account_store:
- * @edit_window: a #ModestMainWindow
+ * modest_main_window_set_style:
+ * @self: the #ModestMainWindow
+ * @style: a #ModestMainWindowStyle that will be set
  * 
- * gets a new reference to the account store associated with the main
- * window
+ * sets the style of the main window, a splitview with folders at
+ * the left and messages at the right, or the simple view, with just
+ * messages.
+ **/
+void       modest_main_window_set_style        (ModestMainWindow *self, 
+                                               ModestMainWindowStyle style);
+
+/**
+ * modest_main_window_get_style:
+ * @self: 
+ * 
+ * gets the current show style of the main window
  * 
- * Returns: the account store
+ * Return value: the current #ModestWindowStyle
  **/
-TnyAccountStore *       modest_main_window_get_account_store     (ModestMainWindow *main_window);
+ModestMainWindowStyle       modest_main_window_get_style        (ModestMainWindow *self);
+
+/**
+ * modest_main_window_set_contents_style:
+ * @self: the #ModestMainWindow
+ * @style: a #ModestMainWindowContentsStyle that will be set. Either headers or details.
+ * 
+ * Shows either the folder details, or the header list of the current
+ * selected folder.
+ **/
+void       modest_main_window_set_contents_style       (ModestMainWindow *self, 
+                                                       ModestMainWindowContentsStyle style);
+
 
 G_END_DECLS