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 #ifdef HAVE_CONFIG_H
  34 #include <config.h>
  35 #endif /*HAVE_CONFIG_H*/
  36
  37 #include <glib-object.h>
  38 #include <gtk/gtk.h>
  39
  40 G_BEGIN_DECLS
  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_TOOLKIT_GTK
  47 typedef GtkVBox      ModestWindowParent;
  48 typedef GtkVBoxClass ModestWindowParentClass;
  49 #else
  50 #ifdef MODEST_TOOLKIT_HILDON2
  51 #include <hildon/hildon-stackable-window.h>
  52 typedef HildonStackableWindow      ModestWindowParent;
  53 typedef HildonStackableWindowClass ModestWindowParentClass;
  54 #else
  55 #include <hildon/hildon-window.h>
  56 typedef HildonWindow      ModestWindowParent;
  57 typedef HildonWindowClass ModestWindowParentClass;
  58 #endif
  59
  60 #ifndef GTK_STOCK_FULLSCREEN
  61 #define GTK_STOCK_FULLSCREEN ""
  62 #endif /*GTK_STOCK_FULLSCREEN*/
  63
  64 #endif /*!MODEST_TOOLKIT_GTK */
  65
  66 /* Dimmed state variables */
  67 typedef struct _DimmedState {
  68         guint    n_selected;
  69         guint    already_opened_msg;
  70         gboolean any_marked_as_deleted;
  71         gboolean all_marked_as_deleted;
  72         gboolean any_marked_as_seen;
  73         gboolean all_marked_as_seen;
  74         gboolean any_marked_as_cached;
  75         gboolean all_marked_as_cached;
  76         gboolean any_has_attachments;
  77         gboolean all_has_attachments;
  78         gboolean sent_in_progress;
  79         gboolean all_selected;
  80 } DimmedState;
  81
  82 /* convenience macros */
  83 #define MODEST_TYPE_WINDOW             (modest_window_get_type())
  84 #define MODEST_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW,ModestWindow))
  85 #define MODEST_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW,GObject))
  86 #define MODEST_IS_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW))
  87 #define MODEST_IS_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW))
  88 #define MODEST_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW,ModestWindowClass))
  89
  90 typedef struct _ModestWindow      ModestWindow;
  91 typedef struct _ModestWindowClass ModestWindowClass;
  92
  93 typedef void (*ModestWindowMenuCallback) (GObject *control, gpointer userdata);
  94 typedef gboolean (*ModestDimmingCallback) (ModestWindow *self, gpointer user_data);
  95
  96 #define MODEST_WINDOW_MENU_CALLBACK(x) ((ModestWindowMenuCallback) (x))
  97 #define MODEST_DIMMING_CALLBACK(x) ((ModestDimmingCallback) (x))
  98
  99 struct _ModestWindow {
 100          ModestWindowParent parent;
 101 };
 102
 103 struct _ModestWindowClass {
 104         ModestWindowParentClass parent_class;
 105
 106         /* virtual methods */
 107         void (*set_zoom_func) (ModestWindow *self, gdouble zoom);
 108         gdouble (*get_zoom_func) (ModestWindow *self);
 109         gboolean (*zoom_plus_func) (ModestWindow *self);
 110         gboolean (*zoom_minus_func) (ModestWindow *self);
 111         void (*show_toolbar_func) (ModestWindow *self, gboolean show_toolbar);
 112         void (*save_state_func) (ModestWindow *self);
 113         void (*disconnect_signals_func) (ModestWindow *self);
 114         void (*show_progress_func) (ModestWindow *self, gboolean show);
 115         void (*add_toolbar_func) (ModestWindow *self, GtkToolbar *toolbar);
 116         void (*set_title_func) (ModestWindow *self, const gchar *title);
 117         void (*add_to_menu_func) (ModestWindow *self,
 118                                   const gchar *label,
 119                                   const gchar *accelerator,
 120                                   ModestWindowMenuCallback callback,
 121                                   ModestDimmingCallback dimming_callback);
 122 };
 123
 124 /**
 125  * modest_window_get_type:
 126  *
 127  * get the #GType for #ModestWindow
 128  *
 129  * Returns: the type
 130  */
 131 GType        modest_window_get_type    (void) G_GNUC_CONST;
 132
 133
 134 /**
 135  * modest_window_get_active_account:
 136  * @self: a modest window instance
 137  *
 138  * get the name of the active account
 139  *
 140  * Returns: the active account name as a constant string
 141  */
 142 const gchar* modest_window_get_active_account (ModestWindow *self);
 143
 144
 145
 146 /**
 147  * modest_window_set_active_account:
 148  * @self: a modest window instance
 149  * @active_account: a new active account name for this window
 150  *
 151  * set the active account for this window.
 152  * NOTE: this must be a valid, non-pseudo account.
 153  *
 154  */
 155 void modest_window_set_active_account (ModestWindow *self, const gchar *active_account);
 156
 157 /**
 158  * modest_window_get_active_mailbox:
 159  * @self: a modest window instance
 160  *
 161  * get the name of the active mailbox
 162  *
 163  * Returns: the active mailbox as a constant string
 164  */
 165 const gchar* modest_window_get_active_mailbox (ModestWindow *self);
 166
 167
 168
 169 /**
 170  * modest_window_set_active_account:
 171  * @self: a modest window instance
 172  * @active_mailbox: a new active mailbox name for this window
 173  *
 174  * set the active mailbox for this window.
 175  *
 176  */
 177 void modest_window_set_active_mailbox (ModestWindow *self, const gchar *active_mailbox);
 178
 179 /**
 180  * modest_window_set_zoom:
 181  * @window: a #ModestWindow instance
 182  * @zoom: the zoom level (1.0 is no zoom)
 183  *
 184  * sets the zoom level of the window
 185  */
 186 void            modest_window_set_zoom    (ModestWindow *window,
 187                                            gdouble value);
 188
 189 /**
 190  * modest_window_get_zoom:
 191  * @window: a #ModestWindow instance
 192  *
 193  * gets the zoom of the window
 194  *
 195  * Returns: the current zoom value (1.0 is no zoom)
 196  */
 197 gdouble         modest_window_get_zoom    (ModestWindow *window);
 198
 199 /**
 200  * modest_window_zoom_plus:
 201  * @window: a #ModestWindow
 202  *
 203  * increases one level the zoom.
 204  *
 205  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 206  */
 207 gboolean modest_window_zoom_plus (ModestWindow *window);
 208
 209 /**
 210  * modest_window_zoom_minus:
 211  * @window: a #ModestWindow
 212  *
 213  * decreases one level the zoom.
 214  *
 215  * Returns: %TRUE if successful, %FALSE if increasing zoom is not available
 216  */
 217 gboolean modest_window_zoom_minus (ModestWindow *window);
 218
 219
 220 /**
 221  * modest_window_show_toolbar:
 222  * @window:
 223  * @view_toolbar: whether or not the toolbar should be shown
 224  *
 225  * shows/hides the window toolbar
 226  **/
 227 void     modest_window_show_toolbar (ModestWindow *window,
 228                                      gboolean show_toolbar);
 229
 230 /**
 231  * modest_window_save_state:
 232  * @window:
 233  *
 234  * Ask the window to save its settings for loading again later.
 235  * This actually invokes the save_setting_func vfunc, which
 236  * derived windows should implement.
 237  **/
 238 void     modest_window_save_state (ModestWindow *window);
 239
 240
 241 /**
 242  * modest_window_set_dimming_state:
 243  * @window: a #ModestWindow instance object
 244  * @state: the #DimmedState state at specific time
 245  *
 246  * Set basic dimming variables from selected headers at
 247  * specific moment.
 248  **/
 249 void
 250 modest_window_set_dimming_state (ModestWindow *window,
 251                                  DimmedState *state);
 252
 253 /**
 254  * modest_window_set_dimming_state:
 255  * @window: a #ModestWindow instance object
 256  *
 257  * Set basic dimming variables from selected headers at
 258  * specific moment.
 259  *
 260  * @Returns: a  #DimmedState state saved previously.
 261  **/
 262 const DimmedState *
 263 modest_window_get_dimming_state (ModestWindow *window);
 264
 265
 266 /**
 267  * modest_window_get_action:
 268  * @window: a #ModestWindow instance object
 269  * @action_path: the full path of required action.
 270  *
 271  * Get an action from ui manager, using @action_path parameter,
 272  * which represent the full path to the required action into UIManager
 273  * xml definition.
 274  **/
 275 GtkAction * modest_window_get_action (ModestWindow *window, const gchar *action_path);
 276
 277 /**
 278  * modest_window_get_action_widget:
 279  * @window: a #ModestWindow instance object
 280  * @action_path: the full path of required action.
 281  *
 282  * Get action widget from ui manager, using @action_path parameter,
 283  * which represent the full path to the required action into UIManager
 284  * xml definition.
 285  **/
 286 GtkWidget *modest_window_get_action_widget (ModestWindow *window,
 287                                             const gchar *action_path);
 288
 289 /**
 290  * modest_window_check_dimming_rules:
 291  * @self: a #ModestWindow instance object
 292  *
 293  * Calls UI Dimming Manager of @self window to check all dimming rules.
 294  *
 295  **/
 296 void modest_window_check_dimming_rules (ModestWindow *self);
 297
 298 /**
 299  * modest_window_check_dimming_rules:
 300  * @self: a #ModestWindow instance object
 301  * @group: a #ModestWindow instance object
 302  *
 303  * Calls UI Dimming Manager of @self window to check @group_name specific
 304  * dimming rules.
 305  *
 306  **/
 307 void modest_window_check_dimming_rules_group (ModestWindow *self,
 308                                               const gchar *group_name);
 309
 310
 311 /**
 312  * modest_window_enable_dimming:
 313  * @self: a #ModestWindow instance object
 314  *
 315  * Enables UI dimming rules checking.
 316  *
 317  **/
 318 void modest_window_enable_dimming (ModestWindow *self);
 319
 320
 321 /**
 322  * modest_window_disable_dimming:
 323  * @self: a #ModestWindow instance object
 324  *
 325  * Disables UI dimming rules checking.
 326  *
 327  **/
 328 void modest_window_disable_dimming (ModestWindow *self);
 329
 330
 331 void modest_window_disconnect_signals (ModestWindow *self);
 332
 333 void modest_window_show_progress (ModestWindow *self, gboolean show_progress);
 334
 335 void modest_window_add_toolbar (ModestWindow *self, GtkToolbar *toolbar);
 336
 337 void modest_window_set_title (ModestWindow *self, const gchar *title);
 338
 339 /**
 340  * modest_window_add_to_menu:
 341  * @self: a #ModestWindow
 342  * @label: the label of the button added to menu
 343  * @callback: a #ModestWindowMenuCallback
 344  * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
 345  *
 346  * creates a menu item in the window @self, with label @label.
 347  * It will call @callback, and will configure @dimming_callback for
 348  * dimming.
 349  */
 350 void modest_window_add_to_menu (ModestWindow *self,
 351                                 const gchar *label,
 352                                 const gchar *accelerator,
 353                                 ModestWindowMenuCallback callback,
 354                                 ModestDimmingCallback dimming_callback);
 355
 356
 357
 358 G_END_DECLS
 359
 360 #endif /* __MODEST_WINDOW_H__ */