git.maemo.org Git - modest/blob - src/widgets/modest-main-window.h

   1 /* Copyright (c) 2006,2007 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
  31 #ifndef __MODEST_MAIN_WINDOW_H__
  32 #define __MODEST_MAIN_WINDOW_H__
  33
  34 #include <gtk/gtkwidget.h>
  35 #include <widgets/modest-window.h>
  36 #include <widgets/modest-header-view.h>
  37 #include <widgets/modest-folder-view.h>
  38 #include <widgets/modest-msg-view.h>
  39 #include <widgets/modest-msg-view-window.h>
  40
  41 G_BEGIN_DECLS
  42
  43 /* convenience macros */
  44 #define MODEST_TYPE_MAIN_WINDOW             (modest_main_window_get_type())
  45 #define MODEST_MAIN_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIN_WINDOW,ModestMainWindow))
  46 #define MODEST_MAIN_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIN_WINDOW,ModestWindow))
  47
  48 #define MODEST_IS_MAIN_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIN_WINDOW))
  49 #define MODEST_IS_MAIN_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIN_WINDOW))
  50 #define MODEST_MAIN_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIN_WINDOW,ModestMainWindowClass))
  51
  52 typedef struct _ModestMainWindow      ModestMainWindow;
  53 typedef struct _ModestMainWindowClass ModestMainWindowClass;
  54
  55 struct _ModestMainWindow {
  56         ModestWindow parent;
  57 };
  58
  59 struct _ModestMainWindowClass {
  60         ModestWindowClass parent_class;
  61 };
  62
  63 /*
  64  * MODEST_MAIN_WINDOW_STYLE_SIMPLE: shows only the header list
  65  * MODEST_MAIN_WINDOW_STYLE_SPLIT: shows a right pane with the folder
  66  * tree and a left pane with the header list
  67  */
  68 typedef enum _ModestMainWindowStyle {
  69         MODEST_MAIN_WINDOW_STYLE_SIMPLE,
  70         MODEST_MAIN_WINDOW_STYLE_SPLIT
  71 } ModestMainWindowStyle;
  72
  73 /*
  74  * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
  75  * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
  76  */
  77 typedef enum _ModestMainWindowContentsStyle {
  78         MODEST_MAIN_WINDOW_CONTENTS_STYLE_HEADERS,
  79         MODEST_MAIN_WINDOW_CONTENTS_STYLE_DETAILS,
  80         MODEST_MAIN_WINDOW_CONTENTS_STYLE_EMPTY,
  81         MODEST_MAIN_WINDOW_CONTENTS_STYLE_FOLDERS,
  82 } ModestMainWindowContentsStyle;
  83
  84 /* toolbar modes  */
  85 typedef enum _ModestToolBarModes {
  86         TOOLBAR_MODE_NORMAL,
  87         TOOLBAR_MODE_TRANSFER,
  88 } ModestToolBarModes;
  89
  90 /**
  91  * modest_main_window_get_type:
  92  *
  93  * get the GType for the ModestMainWindow class
  94  *
  95  * Returns: a GType for ModestMainWindow
  96  */
  97 GType modest_main_window_get_type (void) G_GNUC_CONST;
  98
  99
 100 /**
 101  * modest_main_window_new
 102  *
 103  * instantiates a new ModestMainWindow widget
 104  *
 105  * Returns: a new ModestMainWindow, or NULL in case of error
 106  */
 107 ModestWindow* modest_main_window_new (void);
 108
 109 /*
 110  * we could use the GType instead, but that would require
 111  * that there only on widget of a certain type; that is
 112  * true now, but might not be. Therefore, these types
 113  */
 114 typedef enum {
 115         MODEST_MAIN_WINDOW_WIDGET_TYPE_HEADER_VIEW,
 116         MODEST_MAIN_WINDOW_WIDGET_TYPE_FOLDER_VIEW,
 117         MODEST_MAIN_WINDOW_WIDGET_TYPE_MSG_PREVIEW,
 118
 119         MODEST_MAIN_WINDOW_WIDGET_TYPE_NUM,
 120 } ModestMainWindowWidgetType;
 121
 122
 123 /**
 124  * modest_main_window_get_child_widget
 125  *
 126  * get a child window for this window
 127  *
 128  * Returns: a child window or NULL
 129  */
 130 GtkWidget* modest_main_window_get_child_widget (ModestMainWindow *self,
 131                                                 ModestMainWindowWidgetType widget_type);
 132
 133
 134 /**
 135  * modest_main_window_set_style:
 136  * @self: the #ModestMainWindow
 137  * @style: a #ModestMainWindowStyle that will be set
 138  *
 139  * sets the style of the main window, a splitview with folders at
 140  * the left and messages at the right, or the simple view, with just
 141  * messages.
 142  **/
 143 void       modest_main_window_set_style        (ModestMainWindow *self,
 144                                                 ModestMainWindowStyle style);
 145
 146 /**
 147  * modest_main_window_get_style:
 148  * @self:
 149  *
 150  * gets the current show style of the main window
 151  *
 152  * Return value: the current #ModestWindowStyle
 153  **/
 154 ModestMainWindowStyle       modest_main_window_get_style        (ModestMainWindow *self);
 155
 156 /**
 157  * modest_main_window_set_contents_style:
 158  * @self: the #ModestMainWindow
 159  * @style: a #ModestMainWindowContentsStyle that will be set. Either headers or details.
 160  *
 161  * Shows either the folder details, or the header list of the current
 162  * selected folder.
 163  **/
 164 void       modest_main_window_set_contents_style       (ModestMainWindow *self,
 165                                                         ModestMainWindowContentsStyle style);
 166
 167 /**
 168  * modest_main_window_get_contents_style:
 169  * @self: the #ModestMainWindow
 170  *
 171  * Gets the currently selected #ModestMainWindowContentsStyle
 172  *
 173  * Returns: the #ModestMainWindowContentsStyle of the main window
 174  **/
 175 ModestMainWindowContentsStyle modest_main_window_get_contents_style (ModestMainWindow *self);
 176
 177
 178
 179 /**
 180  * modest_main_window_notify_send_receive_initied:
 181  * @self: the #ModestMainWindow
 182  *
 183  * Determines if send&receive operaiton is currently in
 184  * progress.
 185  *
 186  * Returns: TRUE if send$receive operaton is in
 187  * progress, FALSE otherwise.
 188  **/
 189 gboolean  modest_main_window_send_receive_in_progress       (ModestMainWindow *self);
 190
 191 /**
 192  * modest_main_window_notify_send_receive_initied:
 193  * @self: the #ModestMainWindow
 194  *
 195  * Notifies main window that send/receive operaiton was just started.
 196  **/
 197 void      modest_main_window_notify_send_receive_initied    (ModestMainWindow *self);
 198
 199 /**
 200  * modest_main_window_notify_send_receive_completed:
 201  * @self: the #ModestMainWindow
 202  *
 203  * Notifies main window that send/receive operaiton was completed.
 204  **/
 205 void      modest_main_window_notify_send_receive_completed  (ModestMainWindow *self);
 206
 207
 208 gboolean  modest_main_window_on_msg_view_window_msg_changed (ModestMsgViewWindow *view_window,
 209                                                              GtkTreeModel *model,
 210                                                              GtkTreeRowReference *row_reference,
 211                                                              ModestMainWindow *self);
 212
 213 /**
 214  * modest_main_window_transfer_mode_enabled:
 215  * @window: a #ModestMainWindow
 216  *
 217  * Determines if some transfer operation is in progress.
 218  *
 219  * Returns: TRUE if transfer mode is enabled, FASE otherwise.
 220 */
 221 gboolean  modest_main_window_transfer_mode_enabled (ModestMainWindow *self);
 222
 223 gboolean  modest_main_window_screen_is_on (ModestMainWindow *self);
 224
 225 G_END_DECLS
 226
 227 #endif /* __MODEST_MAIN_WINDOW_H__ */