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