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

   1 /* Copyright (c) 2006, 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 #ifndef __MODEST_WINDOW_H__
  31 #define __MODEST_WINDOW_H__
  32
  33 #include <glib-object.h>
  34 #include <tny-account-store.h>
  35
  36 G_BEGIN_DECLS
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif /*HAVE_CONFIG_H*/
  41
  42 #include <gtk/gtk.h>
  43
  44 /*
  45  * admittedly, the ifdefs for gtk and maemo are rather ugly; still
  46  * this way is probably the easiest to maintain
  47  */
  48 #ifdef MODEST_PLATFORM_GNOME
  49 #include <gtk/gtkwindow.h>
  50 typedef GtkWindow      ModestWindowParent;
  51 typedef GtkWindowClass ModestWindowParentClass;
  52 #endif /* MODEST_PLATFORM_GNOME */
  53
  54 #ifdef MODEST_PLATFORM_MAEMO
  55 #include <hildon-widgets/hildon-window.h>
  56 typedef HildonWindow      ModestWindowParent;
  57 typedef HildonWindowClass ModestWindowParentClass;
  58
  59 #ifndef GTK_STOCK_FULLSCREEN
  60 #define GTK_STOCK_FULLSCREEN ""
  61 #endif /*GTK_STOCK_FULLSCREEN*/
  62
  63 #endif /*MODEST_PLATFORM_MAEMO */
  64
  65 /* convenience macros */
  66 #define MODEST_TYPE_WINDOW             (modest_window_get_type())
  67 #define MODEST_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
  68 #define MODEST_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
  69 #define MODEST_IS_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
  70 #define MODEST_IS_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
  71 #define MODEST_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
  72
  73 typedef struct _ModestWindow      ModestWindow;
  74 typedef struct _ModestWindowClass ModestWindowClass;
  75
  76 struct _ModestWindow {
  77          ModestWindowParent parent;
  78 };
  79
  80 struct _ModestWindowClass {
  81         ModestWindowParentClass parent_class;
  82
  83         /* virtual methods */
  84         void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
  85         gdouble (*get_zoom_func) (ModestWindow *self);
  86         gboolean (*zoom_plus_func) (ModestWindow *self);
  87         gboolean (*zoom_minus_func) (ModestWindow *self);
  88         void (*show_toolbar_func) (ModestWindow *self, gboolean show_toolbar);
  89 };
  90
  91 /**
  92  * modest_window_get_type:
  93  *
  94  * get the #GType for #ModestWindow
  95  *
  96  * Returns: the type
  97  */
  98 GType        modest_window_get_type    (void) G_GNUC_CONST;
  99
 100
 101 /**
 102  * modest_window_get_active_account:
 103  * @self: a modest window instance
 104  *
 105  * get the name of the active account
 106  *
 107  * Returns: the active account name as a constant string
 108  */
 109 const gchar* modest_window_get_active_account (ModestWindow *self);
 110
 111
 112
 113 /**
 114  * modest_window_set_active_account:
 115  * @self: a modest window instance
 116  * @active_account: a new active account name for this window
 117  *
 118  * set the active account for this window
 119  *
 120  */
 121 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
 122
 123 /**
 124  * modest_window_set_zoom:
 125  * @window: a #ModestWindow instance
 126  * @zoom: the zoom level (1.0 is no zoom)
 127  *
 128  * sets the zoom level of the window
 129  */
 130 void            modest_window_set_zoom    (ModestWindow *window,
 131                                            gdouble value);
 132
 133 /**
 134  * modest_window_get_zoom:
 135  * @window: a #ModestWindow instance
 136  *
 137  * gets the zoom of the window
 138  *
 139  * Returns: the current zoom value (1.0 is no zoom)
 140  */
 141 gdouble         modest_window_get_zoom    (ModestWindow *window);
 142
 143 /**
 144  * modest_window_zoom_plus:
 145  * @window: a #ModestWindow
 146  *
 147  * increases one level the zoom.
 148  *
 149  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 150  */
 151 gboolean modest_window_zoom_plus (ModestWindow *window);
 152
 153 /**
 154  * modest_window_zoom_minus:
 155  * @window: a #ModestWindow
 156  *
 157  * decreases one level the zoom.
 158  *
 159  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 160  */
 161 gboolean modest_window_zoom_minus (ModestWindow *window);
 162
 163
 164 /**
 165  * modest_window_show_toolbar:
 166  * @window:
 167  * @view_toolbar: whether or not the toolbar should be shown
 168  *
 169  * shows/hides the window toolbar
 170  **/
 171 void     modest_window_show_toolbar (ModestWindow *window,
 172                                      gboolean show_toolbar);
 173
 174 G_END_DECLS
 175
 176 #endif /* __MODEST_WINDOW_H__ */