1 /* Copyright (c) 2006, 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 #include "modest-dimming-rules-group.h"
31 #include "modest-dimming-rules-group-priv.h"
32 #include "modest-dimming-rule.h"
33 #include "modest-platform.h"
34 #include "modest-ui-dimming-rules.h"
36 static void modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass);
37 static void modest_dimming_rules_group_init (ModestDimmingRulesGroup *obj);
38 static void modest_dimming_rules_group_finalize (GObject *obj);
39 static void modest_dimming_rules_group_dispose (GObject *obj);
41 #ifndef MODEST_TOOLKIT_GTK
42 static void _insensitive_press_callback (GtkWidget *widget, gpointer user_data);
45 static void on_window_destroy (gpointer data,
48 static void _add_rule (ModestDimmingRulesGroup *self,
49 ModestDimmingRule *rule,
50 ModestWindow *window);
52 typedef struct _ModestDimmingRulesGroupPrivate ModestDimmingRulesGroupPrivate;
53 struct _ModestDimmingRulesGroupPrivate {
56 gboolean notifications_enabled;
57 GHashTable *rules_map;
59 gboolean window_weak_ref;
63 #define MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
64 MODEST_TYPE_DIMMING_RULES_GROUP, \
65 ModestDimmingRulesGroupPrivate))
68 static GObjectClass *parent_class = NULL;
70 static void _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data);
71 static void _execute_widget_dimming_rule (gpointer data, gpointer user_data);
74 modest_dimming_rules_group_get_type (void)
76 static GType my_type = 0;
78 static const GTypeInfo my_info = {
79 sizeof(ModestDimmingRulesGroupClass),
81 NULL, /* base finalize */
82 (GClassInitFunc) modest_dimming_rules_group_class_init,
83 NULL, /* class finalize */
84 NULL, /* class data */
85 sizeof(ModestDimmingRulesGroup),
87 (GInstanceInitFunc) modest_dimming_rules_group_init,
90 my_type = g_type_register_static (G_TYPE_OBJECT,
91 "ModestDimmingRulesGroup",
98 modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass)
100 GObjectClass *gobject_class;
101 gobject_class = (GObjectClass*) klass;
103 parent_class = g_type_class_peek_parent (klass);
104 gobject_class->finalize = modest_dimming_rules_group_finalize;
105 gobject_class->dispose = modest_dimming_rules_group_dispose;
107 g_type_class_add_private (gobject_class, sizeof(ModestDimmingRulesGroupPrivate));
111 modest_dimming_rules_group_init (ModestDimmingRulesGroup *obj)
113 ModestDimmingRulesGroupPrivate *priv;
115 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
119 priv->notifications_enabled = FALSE;
120 priv->rules_map = g_hash_table_new_full ((GHashFunc) g_str_hash,
121 (GEqualFunc) g_str_equal,
122 (GDestroyNotify) g_free,
123 (GDestroyNotify) g_object_unref);
124 priv->widget_rules = NULL;
125 priv->window_weak_ref = FALSE;
129 modest_dimming_rules_group_finalize (GObject *obj)
131 ModestDimmingRulesGroupPrivate *priv;
133 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
135 if (priv->window && priv->window_weak_ref) {
136 g_object_weak_unref (G_OBJECT (priv->window), on_window_destroy, obj);
137 priv->window_weak_ref = FALSE;
140 G_OBJECT_CLASS(parent_class)->finalize (obj);
144 modest_dimming_rules_group_dispose (GObject *obj)
146 ModestDimmingRulesGroupPrivate *priv;
148 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
150 if (priv->rules_map != NULL) {
151 g_hash_table_destroy (priv->rules_map);
152 priv->rules_map = NULL;
155 if (priv->widget_rules != NULL) {
156 g_slist_foreach (priv->widget_rules, (GFunc) g_object_unref, NULL);
157 priv->widget_rules = NULL;
160 G_OBJECT_CLASS(parent_class)->dispose (obj);
164 ModestDimmingRulesGroup*
165 modest_dimming_rules_group_new(const gchar *group_name,
166 gboolean notifications_enabled)
168 ModestDimmingRulesGroup *obj;
169 ModestDimmingRulesGroupPrivate *priv;
171 g_return_val_if_fail (group_name != NULL, NULL);
173 obj = MODEST_DIMMING_RULES_GROUP(g_object_new(MODEST_TYPE_DIMMING_RULES_GROUP, NULL));
175 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
176 priv->name = g_strdup(group_name);
177 priv->notifications_enabled = notifications_enabled;
184 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self)
186 ModestDimmingRulesGroupPrivate *priv;
188 g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), NULL);
190 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
192 return g_strdup (priv->name);
196 _add_rule (ModestDimmingRulesGroup *self,
197 ModestDimmingRule *rule,
198 ModestWindow *window)
200 ModestDimmingRulesGroupPrivate *priv;
201 GtkWidget *widget = NULL;
202 const gchar *action_path = NULL;
204 g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
205 g_return_if_fail (MODEST_IS_WINDOW(window));
206 g_return_if_fail (MODEST_IS_DIMMING_RULE (rule));
208 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
210 /* Set window to process dimming rules */
211 priv->window = MODEST_WINDOW (window);
213 widget = modest_dimming_rule_get_widget (rule);
214 #ifndef MODEST_TOOLKIT_GTK
215 /* Connect insensitive-presss handler to show notifications */
216 g_signal_connect (G_OBJECT (widget), "insensitive-press",
217 G_CALLBACK (_insensitive_press_callback),
220 /* Register new dimming rule */
221 modest_dimming_rule_set_group (rule, self);
222 action_path = modest_dimming_rule_get_action_path (rule);
224 g_hash_table_insert (priv->rules_map, g_strdup(action_path), rule);
226 priv->widget_rules = g_slist_prepend (priv->widget_rules, rule);
230 modest_dimming_rules_group_add_widget_rule (ModestDimmingRulesGroup *self,
233 ModestWindow *window)
235 ModestDimmingRulesGroupPrivate *priv;
236 ModestDimmingRule *dim_rule = NULL;
238 g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
239 g_return_if_fail (GTK_IS_WIDGET (widget));
240 g_return_if_fail (MODEST_IS_WINDOW(window));
242 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
244 /* Set window to process dimming rules */
245 if (priv->window_weak_ref)
246 g_object_weak_unref ((GObject *) priv->window, on_window_destroy, self);
247 priv->window = MODEST_WINDOW (window);
248 g_object_weak_ref (G_OBJECT (window), on_window_destroy, self);
249 priv->window_weak_ref = TRUE;
251 dim_rule = modest_dimming_rule_new_from_widget (priv->window,
252 (ModestDimmingCallback) callback,
255 _add_rule (self, dim_rule, window);
259 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
260 const ModestDimmingEntry modest_dimming_entries[],
262 ModestWindow *window)
264 ModestDimmingRulesGroupPrivate *priv;
265 ModestDimmingRule *dim_rule = NULL;
266 ModestDimmingEntry entry;
267 GtkWidget *widget = NULL;
268 gboolean unique = FALSE;
271 g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
272 g_return_if_fail (modest_dimming_entries != NULL);
273 g_return_if_fail (n_elements > 0);
274 g_return_if_fail (MODEST_IS_WINDOW(window));
276 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
278 /* Set window to process dimming rules */
279 if (priv->window_weak_ref)
280 g_object_weak_unref ((GObject *) priv->window, on_window_destroy, self);
281 priv->window = MODEST_WINDOW (window);
282 g_object_weak_ref (G_OBJECT (window), on_window_destroy, self);
283 priv->window_weak_ref = TRUE;
285 /* Add dimming rules */
286 for (i=0; i < n_elements; i++) {
287 entry = modest_dimming_entries[i];
289 /* Check dimming_rule and action path are NOT NULL */
290 if (entry.action_path == NULL) continue;
291 if (entry.callback == NULL) continue;
293 /* Check action path is unique */
294 unique = g_hash_table_lookup (priv->rules_map, entry.action_path) == NULL;
295 if (!unique) continue;
297 /* Check action path is valid */
298 widget = modest_window_get_action_widget (MODEST_WINDOW (window), entry.action_path);
299 if (widget == NULL) continue;
301 /* Create a new dimming rule */
302 dim_rule = modest_dimming_rule_new (priv->window,
303 (ModestDimmingCallback) entry.callback,
306 _add_rule (self, dim_rule, window);
311 modest_dimming_rules_group_notifications_enabled (ModestDimmingRulesGroup *self)
313 ModestDimmingRulesGroupPrivate *priv;
315 g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), FALSE);
316 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
318 return priv->notifications_enabled;
322 modest_dimming_rules_group_execute (ModestDimmingRulesGroup *self)
324 ModestDimmingRulesGroupPrivate *priv;
325 DimmedState *state = NULL;
327 g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
328 priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
333 /* Init dimming rules init data */
334 state = modest_ui_dimming_rules_define_dimming_state (priv->window);
335 modest_window_set_dimming_state (priv->window, state);
337 /* execute group dimming rules */
338 g_hash_table_foreach (priv->rules_map, _execute_dimming_rule, NULL);
339 g_slist_foreach (priv->widget_rules, (GFunc) _execute_widget_dimming_rule, NULL);
341 /* Free dimming ruls init data */
342 modest_window_set_dimming_state (priv->window, NULL);
347 _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data)
349 g_return_if_fail (MODEST_IS_DIMMING_RULE (value));
351 /* Process dimming rule */
352 modest_dimming_rule_process (MODEST_DIMMING_RULE(value));
356 _execute_widget_dimming_rule (gpointer data, gpointer user_data)
358 g_return_if_fail (MODEST_IS_DIMMING_RULE (data));
360 /* Process dimming rule */
361 modest_dimming_rule_process (MODEST_DIMMING_RULE(data));
364 #ifndef MODEST_TOOLKIT_GTK
366 _insensitive_press_callback (GtkWidget *widget, gpointer user_data)
368 ModestDimmingRulesGroup *group = NULL;
369 ModestDimmingRule *rule = NULL;
370 gchar *notification = NULL;
372 g_return_if_fail (MODEST_IS_DIMMING_RULE (user_data));
373 rule = MODEST_DIMMING_RULE (user_data);
375 /* Check if this group has notification system enabled */
376 group = modest_dimming_rule_get_group (rule);
377 if (!modest_dimming_rules_group_notifications_enabled (group))
380 /* Get specific notification */
381 notification = modest_dimming_rule_get_notification (rule);
382 if (notification == NULL)
385 /* Notifications for dimmed items are not shown in Hildon2 */
386 #ifndef MODEST_TOOLKIT_HILDON2
387 /* Show notification banner */
388 modest_platform_information_banner (NULL, NULL, notification);
394 g_object_unref(group);
395 if (notification != NULL)
396 g_free(notification);
401 on_window_destroy (gpointer data,
404 ModestDimmingRulesGroup *self = MODEST_DIMMING_RULES_GROUP (data);
405 ModestDimmingRulesGroupPrivate *priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE (self);