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_HILDON_VERSION_0
56 #include <hildon-widgets/hildon-window.h>
58 #include <hildon/hildon-window.h>
59 #endif /*MODEST_HILDON_VERSION_0*/
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 /* convenience macros */
70 #define MODEST_TYPE_WINDOW (modest_window_get_type())
71 #define MODEST_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
72 #define MODEST_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
73 #define MODEST_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
74 #define MODEST_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
75 #define MODEST_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
77 typedef struct _ModestWindow ModestWindow;
78 typedef struct _ModestWindowClass ModestWindowClass;
80 struct _ModestWindow {
81 ModestWindowParent parent;
84 struct _ModestWindowClass {
85 ModestWindowParentClass parent_class;
88 void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
89 gdouble (*get_zoom_func) (ModestWindow *self);
90 gboolean (*zoom_plus_func) (ModestWindow *self);
91 gboolean (*zoom_minus_func) (ModestWindow *self);
92 void (*show_toolbar_func) (ModestWindow *self, gboolean show_toolbar);
94 void (*save_state_func) (ModestWindow *self);
98 * modest_window_get_type:
100 * get the #GType for #ModestWindow
104 GType modest_window_get_type (void) G_GNUC_CONST;
108 * modest_window_get_active_account:
109 * @self: a modest window instance
111 * get the name of the active account
113 * Returns: the active account name as a constant string
115 const gchar* modest_window_get_active_account (ModestWindow *self);
120 * modest_window_set_active_account:
121 * @self: a modest window instance
122 * @active_account: a new active account name for this window
124 * set the active account for this window
127 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
130 * modest_window_set_zoom:
131 * @window: a #ModestWindow instance
132 * @zoom: the zoom level (1.0 is no zoom)
134 * sets the zoom level of the window
136 void modest_window_set_zoom (ModestWindow *window,
140 * modest_window_get_zoom:
141 * @window: a #ModestWindow instance
143 * gets the zoom of the window
145 * Returns: the current zoom value (1.0 is no zoom)
147 gdouble modest_window_get_zoom (ModestWindow *window);
150 * modest_window_zoom_plus:
151 * @window: a #ModestWindow
153 * increases one level the zoom.
155 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
157 gboolean modest_window_zoom_plus (ModestWindow *window);
160 * modest_window_zoom_minus:
161 * @window: a #ModestWindow
163 * decreases one level the zoom.
165 * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
167 gboolean modest_window_zoom_minus (ModestWindow *window);
171 * modest_window_show_toolbar:
173 * @view_toolbar: whether or not the toolbar should be shown
175 * shows/hides the window toolbar
177 void modest_window_show_toolbar (ModestWindow *window,
178 gboolean show_toolbar);
181 * modest_window_save_state:
184 * Ask the window to save its settings for loading again later.
185 * This actually invokes the save_setting_func vfunc, which
186 * derived windows should implement.
188 void modest_window_save_state (ModestWindow *window);
192 #endif /* __MODEST_WINDOW_H__ */