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