1 /* Copyright (c) 2008 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_HILDON2_WINDOW_H__
31 #define __MODEST_HILDON2_WINDOW_H__
33 #include <widgets/modest-window.h>
34 #include <widgets/modest-account-view.h>
35 #include <modest-dimming-rule.h>
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))
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))
48 typedef struct _ModestHildon2Window ModestHildon2Window;
49 typedef struct _ModestHildon2WindowClass ModestHildon2WindowClass;
51 struct _ModestHildon2Window {
55 struct _ModestHildon2WindowClass {
56 ModestWindowClass parent_class;
58 void (*pack_toolbar_func) (ModestHildon2Window *self, GtkPackType pack_type, GtkWidget *toolbar);
59 void (*edit_mode_changed) (ModestHildon2Window *self, gint edit_mode, gboolean enabled);
62 typedef void (*ModestHildon2AppMenuCallback) (GObject *control, gpointer userdata);
63 typedef gboolean (*ModestHildon2EditModeCallback) (ModestHildon2Window *self);
65 #define APP_MENU_CALLBACK(x) ((ModestHildon2AppMenuCallback) (x))
66 #define EDIT_MODE_CALLBACK(x) ((ModestHildon2EditModeCallback) (x))
68 /* edit mode id for no edit mode */
69 #define MODEST_HILDON2_WINDOW_EDIT_MODE_NONE -1
72 * modest_hildon2_window_get_type:
74 * get the GType for the ModestHildon2Window class
76 * Returns: a GType for ModestHildon2Window
78 GType modest_hildon2_window_get_type (void) G_GNUC_CONST;
81 * modest_hildon2_window_add_to_menu:
82 * @self: a #ModestHildon2Window
83 * @label: the label of the button added to menu
84 * @callback: a #ModestHildon2AppMenuCallback
85 * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
87 * creates a button in the window #HildonAppMenu, with label @label.
88 * It will call @callback, and will configure @dimming_callback for
92 modest_hildon2_window_add_to_menu (ModestHildon2Window *self,
94 const gchar *accelerator,
95 ModestHildon2AppMenuCallback callback,
96 ModestDimmingCallback dimming_callback);
99 * modest_hildon2_window_add_button_to_menu:
100 * @self: a #ModestHildon2Window
101 * @button: a #GtkButton
102 * @dimming_callback: a #ModestDimmingCallback or %NULL for no dimming rule
104 * adds a previously configured button @button to the window #HildonAppMenu.
105 * It will configure @dimming_callback for dimming. User should previously
106 * attach the proper signal handler for @button.
109 modest_hildon2_window_add_button_to_menu (ModestHildon2Window *self,
111 ModestDimmingCallback dimming_callback);
114 * modest_hildon2_window_pack_toolbar:
115 * @self: a #ModestHildon2Window
116 * @pack_type: a #GtkPackType
117 * @toolbar: a toolbar widget
119 * packs a toolbar (widget @toolbar) in @self with @pack_type
121 void modest_hildon2_window_pack_toolbar (ModestHildon2Window *self,
122 GtkPackType pack_type,
125 void modest_hildon2_window_register_edit_mode (ModestHildon2Window *self,
127 const gchar *description,
129 GtkTreeView *tree_view,
130 GtkSelectionMode mode,
131 ModestHildon2EditModeCallback action);
133 void modest_hildon2_window_set_edit_mode (ModestHildon2Window *self,
135 void modest_hildon2_window_unset_edit_mode (ModestHildon2Window *self);