1 /* Copyright (c) 2006,2007 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 #ifndef __MODEST_MAIN_WINDOW_H__
32 #define __MODEST_MAIN_WINDOW_H__
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>
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))
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))
52 typedef struct _ModestMainWindow ModestMainWindow;
53 typedef struct _ModestMainWindowClass ModestMainWindowClass;
55 struct _ModestMainWindow {
59 struct _ModestMainWindowClass {
60 ModestWindowClass parent_class;
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
68 typedef enum _ModestMainWindowStyle {
69 MODEST_MAIN_WINDOW_STYLE_SIMPLE,
70 MODEST_MAIN_WINDOW_STYLE_SPLIT
71 } ModestMainWindowStyle;
74 * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
75 * MODEST_MAIN_WINDOW_FOLDER_CONTENTS_STYLE_HEADERS
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 } ModestMainWindowContentsStyle;
84 typedef enum _ModestToolBarModes {
86 TOOLBAR_MODE_TRANSFER,
90 * modest_main_window_get_type:
92 * get the GType for the ModestMainWindow class
94 * Returns: a GType for ModestMainWindow
96 GType modest_main_window_get_type (void) G_GNUC_CONST;
100 * modest_main_window_new
102 * instantiates a new ModestMainWindow widget
104 * Returns: a new ModestMainWindow, or NULL in case of error
106 ModestWindow* modest_main_window_new (void);
109 * we could use the GType instead, but that would require
110 * that there only on widget of a certain type; that is
111 * true now, but might not be. Therefore, these types
114 MODEST_MAIN_WINDOW_WIDGET_TYPE_HEADER_VIEW,
115 MODEST_MAIN_WINDOW_WIDGET_TYPE_FOLDER_VIEW,
116 MODEST_MAIN_WINDOW_WIDGET_TYPE_MSG_PREVIEW,
118 MODEST_MAIN_WINDOW_WIDGET_TYPE_NUM,
119 } ModestMainWindowWidgetType;
123 * modest_main_window_get_child_widget
125 * get a child window for this window
127 * Returns: a child window or NULL
129 GtkWidget* modest_main_window_get_child_widget (ModestMainWindow *self,
130 ModestMainWindowWidgetType widget_type);
134 * modest_main_window_set_style:
135 * @self: the #ModestMainWindow
136 * @style: a #ModestMainWindowStyle that will be set
138 * sets the style of the main window, a splitview with folders at
139 * the left and messages at the right, or the simple view, with just
142 void modest_main_window_set_style (ModestMainWindow *self,
143 ModestMainWindowStyle style);
146 * modest_main_window_get_style:
149 * gets the current show style of the main window
151 * Return value: the current #ModestWindowStyle
153 ModestMainWindowStyle modest_main_window_get_style (ModestMainWindow *self);
156 * modest_main_window_set_contents_style:
157 * @self: the #ModestMainWindow
158 * @style: a #ModestMainWindowContentsStyle that will be set. Either headers or details.
160 * Shows either the folder details, or the header list of the current
163 void modest_main_window_set_contents_style (ModestMainWindow *self,
164 ModestMainWindowContentsStyle style);
167 * modest_main_window_get_contents_style:
168 * @self: the #ModestMainWindow
170 * Gets the currently selected #ModestMainWindowContentsStyle
172 * Returns: the #ModestMainWindowContentsStyle of the main window
174 ModestMainWindowContentsStyle modest_main_window_get_contents_style (ModestMainWindow *self);
179 * modest_main_window_notify_send_receive_initied:
180 * @self: the #ModestMainWindow
182 * Determines if send&receive operaiton is currently in
185 * Returns: TRUE if send$receive operaton is in
186 * progress, FALSE otherwise.
188 gboolean modest_main_window_send_receive_in_progress (ModestMainWindow *self);
191 * modest_main_window_notify_send_receive_initied:
192 * @self: the #ModestMainWindow
194 * Notifies main window that send/receive operaiton was just started.
196 void modest_main_window_notify_send_receive_initied (ModestMainWindow *self);
199 * modest_main_window_notify_send_receive_completed:
200 * @self: the #ModestMainWindow
202 * Notifies main window that send/receive operaiton was completed.
204 void modest_main_window_notify_send_receive_completed (ModestMainWindow *self);
207 gboolean modest_main_window_on_msg_view_window_msg_changed (ModestMsgViewWindow *view_window,
209 GtkTreeRowReference *row_reference,
210 ModestMainWindow *self);
213 * modest_main_window_transfer_mode_enabled:
214 * @window: a #ModestMainWindow
216 * Determines if some transfer operation is in progress.
218 * Returns: TRUE if transfer mode is enabled, FASE otherwise.
220 gboolean modest_main_window_transfer_mode_enabled (ModestMainWindow *self);
222 gboolean modest_main_window_screen_is_on (ModestMainWindow *self);
226 #endif /* __MODEST_MAIN_WINDOW_H__ */