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__
35 #endif /*HAVE_CONFIG_H*/
37 #include <glib-object.h>
43 * admittedly, the ifdefs for gtk and maemo are rather ugly; still
44 * this way is probably the easiest to maintain
46 #ifdef MODEST_TOOLKIT_GTK
47 typedef GtkVBox ModestWindowParent;
48 typedef GtkVBoxClass ModestWindowParentClass;
50 #ifdef MODEST_TOOLKIT_HILDON2
51 #include <hildon/hildon-stackable-window.h>
52 typedef HildonStackableWindow ModestWindowParent;
53 typedef HildonStackableWindowClass ModestWindowParentClass;
55 #include <hildon/hildon-window.h>
56 typedef HildonWindow ModestWindowParent;
57 typedef HildonWindowClass ModestWindowParentClass;
60 #ifndef GTK_STOCK_FULLSCREEN
61 #define GTK_STOCK_FULLSCREEN ""
62 #endif /*GTK_STOCK_FULLSCREEN*/
64 #endif /*!MODEST_TOOLKIT_GTK */
66 /* Dimmed state variables */
67 typedef struct _DimmedState {
69 guint already_opened_msg;
70 gboolean any_marked_as_deleted;
71 gboolean all_marked_as_deleted;
72 gboolean any_marked_as_seen;
73 gboolean all_marked_as_seen;
74 gboolean any_marked_as_cached;
75 gboolean all_marked_as_cached;
76 gboolean any_has_attachments;
77 gboolean all_has_attachments;
78 gboolean sent_in_progress;
79 gboolean all_selected;
82 /* convenience macros */
83 #define MODEST_TYPE_WINDOW (modest_window_get_type())
84 #define MODEST_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
85 #define MODEST_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
86 #define MODEST_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
87 #define MODEST_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
88 #define MODEST_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
90 typedef struct _ModestWindow ModestWindow;
91 typedef struct _ModestWindowClass ModestWindowClass;
93 typedef void (*ModestWindowMenuCallback) (GObject *control, gpointer userdata);
94 typedef gboolean (*ModestDimmingCallback) (ModestWindow *self, gpointer user_data);
96 #define MODEST_WINDOW_MENU_CALLBACK(x) ((ModestWindowMenuCallback) (x))
97 #define MODEST_DIMMING_CALLBACK(x) ((ModestDimmingCallback) (x))
99 struct _ModestWindow {
100 ModestWindowParent parent;
103 struct _ModestWindowClass {
104 ModestWindowParentClass parent_class;
106 /* virtual methods */
107 void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
108 gdouble (*get_zoom_func) (ModestWindow *self);
109 gboolean (*zoom_plus_func) (ModestWindow *self);
110 gboolean (*zoom_minus_func) (ModestWindow *self);
111 void (*show_toolbar_func) (ModestWindow *self, gboolean show_toolbar);
112 void (*save_state_func) (ModestWindow *self);
113 void (*disconnect_signals_func) (ModestWindow *self);
114 void (*show_progress_func) (ModestWindow *self, gboolean show);
115 void (*add_toolbar_func) (ModestWindow *self, GtkToolbar *toolbar);
116 void (*set_title_func) (ModestWindow *self, const gchar *title);
117 void (*add_to_menu_func) (ModestWindow *self,
119 const gchar *accelerator,
120 ModestWindowMenuCallback callback,
121 ModestDimmingCallback dimming_callback);
122 void (*add_item_to_menu_func) (ModestWindow *self,
124 ModestDimmingCallback dimming_callback);
128 * modest_window_get_type:
130 * get the #GType for #ModestWindow
134 GType modest_window_get_type (void) G_GNUC_CONST;
138 * modest_window_get_active_account:
139 * @self: a modest window instance
141 * get the name of the active account
143 * Returns: the active account name as a constant string
145 const gchar* modest_window_get_active_account (ModestWindow *self);
150 * modest_window_set_active_account:
151 * @self: a modest window instance
152 * @active_account: a new active account name for this window
154 * set the active account for this window.
155 * NOTE: this must be a valid, non-pseudo account.
158 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
161 * modest_window_get_active_mailbox:
162 * @self: a modest window instance
164 * get the name of the active mailbox
166 * Returns: the active mailbox as a constant string
168 const gchar* modest_window_get_active_mailbox (ModestWindow *self);
173 * modest_window_set_active_account:
174 * @self: a modest window instance
175 * @active_mailbox: a new active mailbox name for this window
177 * set the active mailbox for this window.
180 void modest_window_set_active_mailbox (ModestWindow *self, const gchar *active_mailbox);
183 * modest_window_set_zoom:
184 * @window: a #ModestWindow instance
185 * @zoom: the zoom level (1.0 is no zoom)
187 * sets the zoom level of the window
189 void modest_window_set_zoom (ModestWindow *window,
193 * modest_window_get_zoom:
194 * @window: a #ModestWindow instance
196 * gets the zoom of the window
198 * Returns: the current zoom value (1.0 is no zoom)
200 gdouble modest_window_get_zoom (ModestWindow *window);
203 * modest_window_zoom_plus:
204 * @window: a #ModestWindow
206 * increases one level the zoom.
208 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
210 gboolean modest_window_zoom_plus (ModestWindow *window);
213 * modest_window_zoom_minus:
214 * @window: a #ModestWindow
216 * decreases one level the zoom.
218 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
220 gboolean modest_window_zoom_minus (ModestWindow *window);
224 * modest_window_show_toolbar:
226 * @view_toolbar: whether or not the toolbar should be shown
228 * shows/hides the window toolbar
230 void modest_window_show_toolbar (ModestWindow *window,
231 gboolean show_toolbar);
234 * modest_window_save_state:
237 * Ask the window to save its settings for loading again later.
238 * This actually invokes the save_setting_func vfunc, which
239 * derived windows should implement.
241 void modest_window_save_state (ModestWindow *window);
245 * modest_window_set_dimming_state:
246 * @window: a #ModestWindow instance object
247 * @state: the #DimmedState state at specific time
249 * Set basic dimming variables from selected headers at
253 modest_window_set_dimming_state (ModestWindow *window,
257 * modest_window_set_dimming_state:
258 * @window: a #ModestWindow instance object
260 * Set basic dimming variables from selected headers at
263 * @Returns: a #DimmedState state saved previously.
266 modest_window_get_dimming_state (ModestWindow *window);
270 * modest_window_get_action:
271 * @window: a #ModestWindow instance object
272 * @action_path: the full path of required action.
274 * Get an action from ui manager, using @action_path parameter,
275 * which represent the full path to the required action into UIManager
278 GtkAction * modest_window_get_action (ModestWindow *window, const gchar *action_path);
281 * modest_window_get_action_widget:
282 * @window: a #ModestWindow instance object
283 * @action_path: the full path of required action.
285 * Get action widget from ui manager, using @action_path parameter,
286 * which represent the full path to the required action into UIManager
289 GtkWidget *modest_window_get_action_widget (ModestWindow *window,
290 const gchar *action_path);
293 * modest_window_check_dimming_rules:
294 * @self: a #ModestWindow instance object
296 * Calls UI Dimming Manager of @self window to check all dimming rules.
299 void modest_window_check_dimming_rules (ModestWindow *self);
302 * modest_window_check_dimming_rules:
303 * @self: a #ModestWindow instance object
304 * @group: a #ModestWindow instance object
306 * Calls UI Dimming Manager of @self window to check @group_name specific
310 void modest_window_check_dimming_rules_group (ModestWindow *self,
311 const gchar *group_name);
315 * modest_window_enable_dimming:
316 * @self: a #ModestWindow instance object
318 * Enables UI dimming rules checking.
321 void modest_window_enable_dimming (ModestWindow *self);
325 * modest_window_disable_dimming:
326 * @self: a #ModestWindow instance object
328 * Disables UI dimming rules checking.
331 void modest_window_disable_dimming (ModestWindow *self);
334 void modest_window_disconnect_signals (ModestWindow *self);
336 void modest_window_show_progress (ModestWindow *self, gboolean show_progress);
338 void modest_window_add_toolbar (ModestWindow *self, GtkToolbar *toolbar);
340 void modest_window_set_title (ModestWindow *self, const gchar *title);
343 * modest_window_add_to_menu:
344 * @self: a #ModestWindow
345 * @label: the label of the button added to menu
346 * @callback: a #ModestWindowMenuCallback
347 * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
349 * creates a menu item in the window @self, with label @label.
350 * It will call @callback, and will configure @dimming_callback for
353 void modest_window_add_to_menu (ModestWindow *self,
355 const gchar *accelerator,
356 ModestWindowMenuCallback callback,
357 ModestDimmingCallback dimming_callback);
360 * modest_window_add_item_to_menu:
361 * @self: a #ModestWindow
362 * @item: a #GtkWidget (a #GtkButton in hildon, a #GtkMenuItem in gtk)
363 * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
365 * adds a previously configured item @item to the window menu.
366 * It will configure @dimming_callback for dimming. User should previously
367 * attach the proper signal handler for @button.
370 modest_window_add_item_to_menu (ModestWindow *self,
372 ModestDimmingCallback dimming_callback);
376 #endif /* __MODEST_WINDOW_H__ */