* Fixes NB#78357, new mail sound is played now with IMAP IDLE events
[modest] / src / widgets / modest-main-window.h
index aca4c33..8c7462e 100644 (file)
 #ifndef __MODEST_MAIN_WINDOW_H__
 #define __MODEST_MAIN_WINDOW_H__
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif /*HAVE_CONFIG_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>
+#include <widgets/modest-msg-view-window.h>
 
 G_BEGIN_DECLS
 
@@ -54,42 +54,172 @@ typedef struct _ModestMainWindowClass ModestMainWindowClass;
 
 struct _ModestMainWindow {
        ModestWindow parent;
-       /* insert public members, if any */
 };
 
 struct _ModestMainWindowClass {
        ModestWindowClass parent_class;
-       /* insert signal callback declarations, eg. */
-       /* void (* my_event) (ModestMainWindow* obj); */
 };
 
-/* 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,
+       MODEST_MAIN_WINDOW_CONTENTS_STYLE_EMPTY,
+} 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_MAIN_WINDOW_WIDGET_TYPE_HEADER_VIEW,
+       MODEST_MAIN_WINDOW_WIDGET_TYPE_FOLDER_VIEW,
+       MODEST_MAIN_WINDOW_WIDGET_TYPE_MSG_PREVIEW,
+       
+       MODEST_MAIN_WINDOW_WIDGET_TYPE_NUM,
+} ModestMainWindowWidgetType;
+
+
+/**
+ * modest_main_window_get_child_widget
+ * 
+ * get a child window for this window
+ *
+ * Returns: a child window or NULL
+ */
+GtkWidget* modest_main_window_get_child_widget (ModestMainWindow *self,
+                                               ModestMainWindowWidgetType widget_type);
+
+
+/**
+ * modest_main_window_set_style:
+ * @self: the #ModestMainWindow
+ * @style: a #ModestMainWindowStyle that will be set
+ * 
+ * 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
+ * 
+ * Return value: the current #ModestWindowStyle
+ **/
+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);
 
 /**
- * modest_main_window_get_widget_factory:
- * @edit_window: a #ModestMainWindow
+ * modest_main_window_get_contents_style:
+ * @self: the #ModestMainWindow
  * 
- * gets the #ModestWidgetFactory associated with the main window
+ * Gets the currently selected #ModestMainWindowContentsStyle
  * 
- * Returns: the widget factory
+ * Returns: the #ModestMainWindowContentsStyle of the main window
  **/
-ModestWidgetFactory *   modest_main_window_get_widget_factory    (ModestMainWindow *main_window);
+ModestMainWindowContentsStyle modest_main_window_get_contents_style (ModestMainWindow *self);
+
+
 
 /**
- * modest_main_window_get_account_store:
- * @edit_window: a #ModestMainWindow
+ * modest_main_window_notify_send_receive_initied:
+ * @self: the #ModestMainWindow
  * 
- * gets the account store associated with the main window
+ * Determines if send&receive operaiton is currently in 
+ * progress.
+ *
+ * Returns: TRUE if send$receive operaton is in 
+ * progress, FALSE otherwise.
+ **/
+gboolean  modest_main_window_send_receive_in_progress       (ModestMainWindow *self);
+
+/**
+ * modest_main_window_notify_send_receive_initied:
+ * @self: the #ModestMainWindow
+ * 
+ * Notifies main window that send/receive operaiton was just started. 
+ **/
+void      modest_main_window_notify_send_receive_initied    (ModestMainWindow *self);
+
+/**
+ * modest_main_window_notify_send_receive_completed:
+ * @self: the #ModestMainWindow
  * 
- * Returns: the account store
+ * Notifies main window that send/receive operaiton was completed. 
  **/
-TnyAccountStore *       modest_main_window_get_account_store     (ModestMainWindow *main_window);
+void      modest_main_window_notify_send_receive_completed  (ModestMainWindow *self);
+
+
+gboolean  modest_main_window_on_msg_view_window_msg_changed (ModestMsgViewWindow *view_window,
+                                                            GtkTreeModel *model,
+                                                            GtkTreeRowReference *row_reference,
+                                                            ModestMainWindow *self);
+
+/**
+ * modest_main_window_transfer_mode_enabled:
+ * @window: a #ModestMainWindow
+ *
+ * Determines if some transfer operation is in progress.
+ *
+ * Returns: TRUE if transfer mode is enabled, FASE otherwise.
+*/
+gboolean  modest_main_window_transfer_mode_enabled (ModestMainWindow *self);
 
+gboolean  modest_main_window_screen_is_on (ModestMainWindow *self);
 
 G_END_DECLS