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 /*
  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 #endif /*MODEST_PLATFORM_MAEMO */
  57
  58 /* convenience macros */
  59 #define MODEST_TYPE_WINDOW             (modest_window_get_type())
  60 #define MODEST_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
  61 #define MODEST_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
  62 #define MODEST_IS_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
  63 #define MODEST_IS_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
  64 #define MODEST_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
  65
  66 typedef struct _ModestWindow      ModestWindow;
  67 typedef struct _ModestWindowClass ModestWindowClass;
  68
  69 struct _ModestWindow {
  70          ModestWindowParent parent;
  71 };
  72
  73 struct _ModestWindowClass {
  74         ModestWindowParentClass parent_class;
  75
  76         /* virtual methods */
  77         void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
  78         gdouble (*get_zoom_func) (ModestWindow *self);
  79         gboolean (*zoom_plus_func) (ModestWindow *self);
  80         gboolean (*zoom_minus_func) (ModestWindow *self);
  81 };
  82
  83 /**
  84  * modest_window_get_type:
  85  *
  86  * get the #GType for #ModestWindow
  87  *
  88  * Returns: the type
  89  */
  90 GType        modest_window_get_type    (void) G_GNUC_CONST;
  91
  92
  93 /**
  94  * modest_window_get_active_account:
  95  * @self: a modest window instance
  96  *
  97  * get the name of the active account
  98  *
  99  * Returns: the active account name as a constant string
 100  */
 101 const gchar* modest_window_get_active_account (ModestWindow *self);
 102
 103
 104
 105 /**
 106  * modest_window_set_active_account:
 107  * @self: a modest window instance
 108  * @active_account: a new active account name for this window
 109  *
 110  * set the active account for this window
 111  *
 112  */
 113 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
 114
 115 /**
 116  * modest_window_set_zoom:
 117  * @window: a #ModestWindow instance
 118  * @zoom: the zoom level (1.0 is no zoom)
 119  *
 120  * sets the zoom level of the window
 121  */
 122 void            modest_window_set_zoom    (ModestWindow *window,
 123                                            gdouble value);
 124
 125 /**
 126  * modest_window_get_zoom:
 127  * @window: a #ModestWindow instance
 128  *
 129  * gets the zoom of the window
 130  *
 131  * Returns: the current zoom value (1.0 is no zoom)
 132  */
 133 gdouble         modest_window_get_zoom    (ModestWindow *window);
 134
 135 /**
 136  * modest_window_zoom_plus:
 137  * @window: a #ModestWindow
 138  *
 139  * increases one level the zoom.
 140  *
 141  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 142  */
 143 gboolean modest_window_zoom_plus (ModestWindow *window);
 144
 145 /**
 146  * modest_window_zoom_minus:
 147  * @window: a #ModestWindow
 148  *
 149  * decreases one level the zoom.
 150  *
 151  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 152  */
 153 gboolean modest_window_zoom_minus (ModestWindow *window);
 154
 155 G_END_DECLS
 156
 157 #endif /* __MODEST_WINDOW_H__ */