1 /* Copyright (c) 2006, 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.
30 #ifndef __MODEST_WINDOW_H__
31 #define __MODEST_WINDOW_H__
33 #include <glib-object.h>
34 #include <tny-account-store.h>
40 #endif /*HAVE_CONFIG_H*/
45 * admittedly, the ifdefs for gtk and maemo are rather ugly; still
46 * this way is probably the easiest to maintain
48 #ifdef MODEST_PLATFORM_GNOME
49 #include <gtk/gtkwindow.h>
50 typedef GtkWindow ModestWindowParent;
51 typedef GtkWindowClass ModestWindowParentClass;
52 #endif /* MODEST_PLATFORM_GNOME */
54 #ifdef MODEST_PLATFORM_MAEMO
55 #ifdef MODEST_HAVE_HILDON0_WIDGETS
56 #include <hildon-widgets/hildon-window.h>
58 #include <hildon/hildon-window.h>
59 #endif /*MODEST_HAVE_HILDON0_WIDGETS*/
60 typedef HildonWindow ModestWindowParent;
61 typedef HildonWindowClass ModestWindowParentClass;
63 #ifndef GTK_STOCK_FULLSCREEN
64 #define GTK_STOCK_FULLSCREEN ""
65 #endif /*GTK_STOCK_FULLSCREEN*/
67 #endif /*MODEST_PLATFORM_MAEMO */
69 /* Dimmed state variables */
70 typedef struct _DimmedState {
72 guint already_opened_msg;
73 gboolean any_marked_as_deleted;
74 gboolean all_marked_as_deleted;
75 gboolean any_marked_as_seen;
76 gboolean all_marked_as_seen;
77 gboolean any_marked_as_cached;
78 gboolean all_marked_as_cached;
79 gboolean any_has_attachments;
80 gboolean all_has_attachments;
81 gboolean sent_in_progress;
82 gboolean all_selected;
85 /* convenience macros */
86 #define MODEST_TYPE_WINDOW (modest_window_get_type())
87 #define MODEST_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
88 #define MODEST_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
89 #define MODEST_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
90 #define MODEST_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
91 #define MODEST_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
93 typedef struct _ModestWindow ModestWindow;
94 typedef struct _ModestWindowClass ModestWindowClass;
96 struct _ModestWindow {
97 ModestWindowParent parent;
100 struct _ModestWindowClass {
101 ModestWindowParentClass parent_class;
103 /* virtual methods */
104 void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
105 gdouble (*get_zoom_func) (ModestWindow *self);
106 gboolean (*zoom_plus_func) (ModestWindow *self);
107 gboolean (*zoom_minus_func) (ModestWindow *self);
108 void (*show_toolbar_func) (ModestWindow *self, gboolean show_toolbar);
109 void (*save_state_func) (ModestWindow *self);
110 void (*disconnect_signals_func) (ModestWindow *self);
114 * modest_window_get_type:
116 * get the #GType for #ModestWindow
120 GType modest_window_get_type (void) G_GNUC_CONST;
124 * modest_window_get_active_account:
125 * @self: a modest window instance
127 * get the name of the active account
129 * Returns: the active account name as a constant string
131 const gchar* modest_window_get_active_account (ModestWindow *self);
136 * modest_window_set_active_account:
137 * @self: a modest window instance
138 * @active_account: a new active account name for this window
140 * set the active account for this window.
141 * NOTE: this must be a valid, non-pseudo account.
144 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
147 * modest_window_set_zoom:
148 * @window: a #ModestWindow instance
149 * @zoom: the zoom level (1.0 is no zoom)
151 * sets the zoom level of the window
153 void modest_window_set_zoom (ModestWindow *window,
157 * modest_window_get_zoom:
158 * @window: a #ModestWindow instance
160 * gets the zoom of the window
162 * Returns: the current zoom value (1.0 is no zoom)
164 gdouble modest_window_get_zoom (ModestWindow *window);
167 * modest_window_zoom_plus:
168 * @window: a #ModestWindow
170 * increases one level the zoom.
172 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
174 gboolean modest_window_zoom_plus (ModestWindow *window);
177 * modest_window_zoom_minus:
178 * @window: a #ModestWindow
180 * decreases one level the zoom.
182 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
184 gboolean modest_window_zoom_minus (ModestWindow *window);
188 * modest_window_show_toolbar:
190 * @view_toolbar: whether or not the toolbar should be shown
192 * shows/hides the window toolbar
194 void modest_window_show_toolbar (ModestWindow *window,
195 gboolean show_toolbar);
198 * modest_window_save_state:
201 * Ask the window to save its settings for loading again later.
202 * This actually invokes the save_setting_func vfunc, which
203 * derived windows should implement.
205 void modest_window_save_state (ModestWindow *window);
209 * modest_window_set_dimming_state:
210 * @window: a #ModestWindow instance object
211 * @state: the #DimmedState state at specific time
213 * Set basic dimming variables from selected headers at
217 modest_window_set_dimming_state (ModestWindow *window,
221 * modest_window_set_dimming_state:
222 * @window: a #ModestWindow instance object
224 * Set basic dimming variables from selected headers at
227 * @Returns: a #DimmedState state saved previously.
230 modest_window_get_dimming_state (ModestWindow *window);
234 * modest_window_get_action:
235 * @window: a #ModestWindow instance object
236 * @action_path: the full path of required action.
238 * Get an action from ui manager, using @action_path parameter,
239 * which represent the full path to the required action into UIManager
242 GtkAction * modest_window_get_action (ModestWindow *window, const gchar *action_path);
245 * modest_window_get_action_widget:
246 * @window: a #ModestWindow instance object
247 * @action_path: the full path of required action.
249 * Get action widget from ui manager, using @action_path parameter,
250 * which represent the full path to the required action into UIManager
253 GtkWidget *modest_window_get_action_widget (ModestWindow *window,
254 const gchar *action_path);
257 * modest_window_check_dimming_rules:
258 * @self: a #ModestWindow instance object
260 * Calls UI Dimming Manager of @self window to check all dimming rules.
263 void modest_window_check_dimming_rules (ModestWindow *self);
266 * modest_window_check_dimming_rules:
267 * @self: a #ModestWindow instance object
268 * @group: a #ModestWindow instance object
270 * Calls UI Dimming Manager of @self window to check @group_name specific
274 void modest_window_check_dimming_rules_group (ModestWindow *self,
275 const gchar *group_name);
279 * modest_window_enable_dimming:
280 * @self: a #ModestWindow instance object
282 * Enables UI dimming rules checking.
285 void modest_window_enable_dimming (ModestWindow *self);
289 * modest_window_disable_dimming:
290 * @self: a #ModestWindow instance object
292 * Disables UI dimming rules checking.
295 void modest_window_disable_dimming (ModestWindow *self);
298 void modest_window_disconnect_signals (ModestWindow *self);
303 #endif /* __MODEST_WINDOW_H__ */