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

   1 /* Copyright (c) 2008 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_HILDON2_WINDOW_H__
  31 #define __MODEST_HILDON2_WINDOW_H__
  32
  33 #include <widgets/modest-window.h>
  34 #include <widgets/modest-account-view.h>
  35 #include <modest-dimming-rule.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /* convenience macros */
  40 #define MODEST_TYPE_HILDON2_WINDOW             (modest_hildon2_window_get_type())
  41 #define MODEST_HILDON2_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HILDON2_WINDOW,ModestHildon2Window))
  42 #define MODEST_HILDON2_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HILDON2_WINDOW,ModestWindow))
  43
  44 #define MODEST_IS_HILDON2_WINDOW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HILDON2_WINDOW))
  45 #define MODEST_IS_HILDON2_WINDOW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HILDON2_WINDOW))
  46 #define MODEST_HILDON2_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HILDON2_WINDOW,ModestHildon2WindowClass))
  47
  48 typedef struct _ModestHildon2Window      ModestHildon2Window;
  49 typedef struct _ModestHildon2WindowClass ModestHildon2WindowClass;
  50
  51 struct _ModestHildon2Window {
  52         ModestWindow parent;
  53 };
  54
  55 struct _ModestHildon2WindowClass {
  56         ModestWindowClass parent_class;
  57 };
  58
  59 typedef void (*ModestHildon2AppMenuCallback) (GObject *control, gpointer userdata);
  60
  61 #define APP_MENU_CALLBACK(x) ((ModestHildon2AppMenuCallback) (x))
  62
  63 /**
  64  * modest_hildon2_window_get_type:
  65  *
  66  * get the GType for the ModestHildon2Window class
  67  *
  68  * Returns: a GType for ModestHildon2Window
  69  */
  70 GType modest_hildon2_window_get_type (void) G_GNUC_CONST;
  71
  72 /**
  73  * modest_hildon2_window_add_to_menu:
  74  * @self: a #ModestHildon2Window
  75  * @label: the label of the button added to menu
  76  * @callback: a #ModestHildon2AppMenuCallback
  77  * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
  78  *
  79  * creates a button in the window #HildonAppMenu, with label @label.
  80  * It will call @callback, and will configure @dimming_callback for
  81  * dimming.
  82  */
  83 void
  84 modest_hildon2_window_add_to_menu (ModestHildon2Window *self,
  85                                    gchar *label,
  86                                    ModestHildon2AppMenuCallback callback,
  87                                    ModestDimmingCallback dimming_callback);
  88
  89 /**
  90  * modest_hildon2_window_add_button_to_menu:
  91  * @self: a #ModestHildon2Window
  92  * @button: a #GtkButton
  93  * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
  94  *
  95  * adds a previously configured button @button to the window #HildonAppMenu.
  96  * It will configure @dimming_callback for dimming. User should previously
  97  * attach the proper signal handler for @button.
  98  */
  99 void
 100 modest_hildon2_window_add_button_to_menu (ModestHildon2Window *self,
 101                                           GtkButton *button,
 102                                           ModestDimmingCallback dimming_callback);
 103
 104
 105
 106 G_END_DECLS
 107
 108 #endif