1 /***********************************************************************************
2 * Display blanking status area plugin
3 * Copyright (C) 2012 Leandro Lucarella
4 * Based on status-area-orientationlock-applet by Mohammad Abu-Garbeyyeh.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 ***********************************************************************************/
27 #include <hildon/hildon.h>
28 #include <libhildondesktop/libhildondesktop.h>
29 #include <gconf/gconf-client.h>
30 #include <dbus/dbus.h>
31 #include <mce/dbus-names.h>
34 #define TYPE_DISPLAY_BLANKING_STATUS_PLUGIN (display_blanking_status_plugin_get_type ())
36 #define DISPLAY_BLANKING_STATUS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
37 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN, DisplayBlankingStatusPlugin))
39 #define DISPLAY_BLANKING_STATUS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), \
40 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN, DisplayBlankingStatusPluginClass))
42 #define IS_DISPLAY_BLANKING_STATUS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
43 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN))
45 #define IS_DISPLAY_BLANKING_STATUS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), \
46 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN))
48 #define DISPLAY_BLANKING_STATUS_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), \
49 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN, DisplayBlankingStatusPluginClass))
51 #define STATUS_AREA_DISPLAY_BLANKING_ICON_SIZE 18
53 typedef struct _DisplayBlankingStatusPlugin DisplayBlankingStatusPlugin;
54 typedef struct _DisplayBlankingStatusPluginClass DisplayBlankingStatusPluginClass;
55 typedef struct _DisplayBlankingStatusPluginPrivate DisplayBlankingStatusPluginPrivate;
57 struct _DisplayBlankingStatusPlugin
59 HDStatusMenuItem parent;
61 DisplayBlankingStatusPluginPrivate *priv;
64 struct _DisplayBlankingStatusPluginClass
66 HDStatusMenuItemClass parent;
69 GType display_blanking_status_plugin_get_type (void);
71 #define DISPLAY_BLANKING_STATUS_PLUGIN_GET_PRIVATE(obj) \
72 (G_TYPE_INSTANCE_GET_PRIVATE (obj, \
73 TYPE_DISPLAY_BLANKING_STATUS_PLUGIN, \
74 DisplayBlankingStatusPluginPrivate))
76 #define MODE_GCONF_ROOT "/system/osso/dsm/display"
77 #define MODE_GCONF_KEY MODE_GCONF_ROOT "/inhibit_blank_mode"
79 #define HOURS_GCONF_KEY "/apps/Maemo/sadba/timed_inhibit_hours"
80 #define MINUTES_GCONF_KEY "/apps/Maemo/sadba/timed_inhibit_minutes"
82 #define INHIBIT_MSG_INTERVAL 30 // in seconds
84 #define GETTEXT_DOM "status-area-displayblanking-applet"
85 #define _(str) dgettext (GETTEXT_DOM, (str))
86 #define gettext_noop(str) (str)
87 #define N_(str) gettext_noop(str)
89 // Undocumented blanking modes as reported by David Weinehall from Nokia:
90 // http://www.gossamer-threads.com/lists/maemo/developers/61201#61201
91 #define BLANKING_MODES 5
92 static const char *mode_title[BLANKING_MODES] =
95 N_ ("Both only on battery"),
96 N_ ("Blanking only on battery"),
100 static const char *mode_icon_name[BLANKING_MODES] =
102 "display-blanking-icon.0",
103 "display-blanking-icon.1",
104 "display-blanking-icon.2",
105 "display-blanking-icon.3",
106 "display-blanking-icon.4",
108 #define INHIBIT_ICON_NAME "display-blanking-inhibit-icon"
109 #define TIMED_INHIBIT_ICON_NAME "display-blanking-inhibit-icon.timed"
110 #define INHIBIT_STATUS_ICON_NAME "display-blanking-status"
112 struct _DisplayBlankingStatusPluginPrivate
114 DisplayBlankingStatusPlugin* plugin;
115 GConfClient *gconf_client;
116 DBusConnection* dbus_conn;
117 DBusMessage* dbus_msg;
118 GtkWidget *mode_button;
119 GtkWidget *mode_dialog;
120 GtkWidget *inhibit_button;
121 GtkWidget *timed_inhibit_button;
122 GtkWidget *timed_inhibit_dialog;
123 gint inhibit_timer_id; // if == 0
124 gint timed_inhibit_timer_id; // no timer is set
125 // gtk_toggle_button_set_active () triggers the "clicked" signal on the
126 // affected button, since we don't want to process the signal while
127 // changing the "pressed" state (we want just the GUI to change, we use
128 // this flag to ignore the "clicke" signal handler when is TRUE
129 gboolean inhibit_in_signal;
133 HD_DEFINE_PLUGIN_MODULE (DisplayBlankingStatusPlugin,
134 display_blanking_status_plugin, HD_TYPE_STATUS_MENU_ITEM)
137 display_blanking_status_plugin_class_finalize (
138 DisplayBlankingStatusPluginClass *klass)
143 display_blanking_status_plugin_class_init (DisplayBlankingStatusPluginClass *c)
145 g_type_class_add_private (c, sizeof (DisplayBlankingStatusPluginPrivate));
149 update_mode_gui (gint mode, DisplayBlankingStatusPluginPrivate *priv)
151 GtkWidget *icon = gtk_image_new_from_icon_name (mode_icon_name[mode],
152 GTK_ICON_SIZE_DIALOG);
153 gtk_button_set_image (GTK_BUTTON (priv->mode_button), icon);
157 disable_timer (gint *timer_id)
159 g_assert (*timer_id != 0);
160 gboolean ok = g_source_remove (*timer_id);
161 g_assert (ok == TRUE);
166 disable_inhibition (DisplayBlankingStatusPluginPrivate *priv)
168 disable_timer (&(priv->inhibit_timer_id));
169 hd_status_plugin_item_set_status_area_icon (
170 HD_STATUS_PLUGIN_ITEM (priv->plugin), NULL);
174 on_inhibit_timeout (DisplayBlankingStatusPluginPrivate *priv)
176 dbus_bool_t ok = dbus_connection_send (priv->dbus_conn, priv->dbus_msg,
178 g_assert (ok == TRUE);
184 on_timed_inhibit_timeout (DisplayBlankingStatusPluginPrivate *priv)
186 disable_inhibition (priv);
187 disable_timer (&(priv->timed_inhibit_timer_id));
189 priv->inhibit_in_signal = TRUE;
190 gtk_toggle_button_set_active (
191 GTK_TOGGLE_BUTTON (priv->timed_inhibit_button), FALSE);
192 priv->inhibit_in_signal = FALSE;
194 GtkWidget *banner = hildon_banner_show_information (
195 priv->timed_inhibit_button, NULL,
196 _ ("Display blanking inhibition disabled"));
197 hildon_banner_set_timeout (HILDON_BANNER (banner), 5000);
203 enable_inhibition (DisplayBlankingStatusPluginPrivate *priv)
205 g_assert (priv->inhibit_timer_id == 0);
206 priv->inhibit_timer_id = g_timeout_add_seconds (INHIBIT_MSG_INTERVAL,
207 (GSourceFunc) on_inhibit_timeout, priv);
208 g_assert (priv->inhibit_timer_id > 0);
210 GtkIconTheme *icon_theme = gtk_icon_theme_get_default ();
211 GdkPixbuf *pixbuf = gtk_icon_theme_load_icon (icon_theme,
212 INHIBIT_STATUS_ICON_NAME, 18, GTK_ICON_LOOKUP_NO_SVG, NULL);
213 hd_status_plugin_item_set_status_area_icon (
214 HD_STATUS_PLUGIN_ITEM (priv->plugin), pixbuf);
218 on_inhibit_button_clicked (GtkWidget *button,
219 DisplayBlankingStatusPluginPrivate *priv)
221 if (priv->inhibit_in_signal)
224 GtkWidget *parent = gtk_widget_get_ancestor (button, GTK_TYPE_WINDOW);
225 gtk_widget_hide (parent);
227 gboolean self_pressed = gtk_toggle_button_get_active (
228 GTK_TOGGLE_BUTTON (button));
229 gboolean other_pressed = gtk_toggle_button_get_active (
230 GTK_TOGGLE_BUTTON (priv->timed_inhibit_button));
232 if (self_pressed && other_pressed) {
233 g_assert (priv->inhibit_timer_id != 0);
235 disable_timer (&(priv->timed_inhibit_timer_id));
237 priv->inhibit_in_signal = TRUE;
238 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (
239 priv->timed_inhibit_button), FALSE);
240 priv->inhibit_in_signal = FALSE;
242 else if (self_pressed && !other_pressed) {
243 g_assert (priv->timed_inhibit_timer_id == 0);
245 enable_inhibition (priv);
247 else if (!self_pressed) {
248 g_assert (!other_pressed);
249 g_assert (priv->timed_inhibit_timer_id == 0);
251 disable_inhibition (priv);
258 timed_inhibit_picker_new (const gchar* title, gsize current, guint max,
261 g_assert (max < 100);
262 static gchar buffer[3]; // 2 for the number + 1 for \0
264 GtkWidget *selector = hildon_touch_selector_entry_new_text ();
266 for (int i = 0; i*step <= max; i++) {
267 if (i*step == current)
269 hildon_touch_selector_append_text (HILDON_TOUCH_SELECTOR (selector),
270 g_ascii_formatd (buffer, 3, "%.0f", i*step));
272 hildon_gtk_entry_set_input_mode (GTK_ENTRY (
273 hildon_touch_selector_entry_get_entry (
274 HILDON_TOUCH_SELECTOR_ENTRY (selector))),
275 HILDON_GTK_INPUT_MODE_NUMERIC);
277 GtkWidget *picker = hildon_picker_button_new (HILDON_SIZE_FINGER_HEIGHT,
278 HILDON_BUTTON_ARRANGEMENT_VERTICAL);
279 hildon_button_set_title (HILDON_BUTTON (picker), title);
280 hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (picker),
281 HILDON_TOUCH_SELECTOR (selector));
282 hildon_picker_button_set_active (HILDON_PICKER_BUTTON (picker),
284 hildon_button_set_value (HILDON_BUTTON (picker),
285 g_ascii_formatd (buffer, 3, "%.0f", current));
287 g_object_set_data (G_OBJECT (picker), "max", GUINT_TO_POINTER (max));
293 timed_inhibit_picker_get_value (GtkWidget *picker)
295 guint max = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (picker), "max"));
297 return CLAMP (g_ascii_strtod (hildon_button_get_value (
298 HILDON_BUTTON (picker)), NULL), 0, max);
302 timed_inhibit_get_input (DisplayBlankingStatusPluginPrivate *priv)
304 g_assert (priv->timed_inhibit_dialog == NULL);
305 priv->timed_inhibit_dialog = gtk_dialog_new_with_buttons (
306 _ ("Inhibit display blanking for..."), NULL, GTK_DIALOG_MODAL,
307 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
308 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL);
310 GtkWidget *h_picker = timed_inhibit_picker_new (_ ("Hours"),
311 gconf_client_get_int (priv->gconf_client, HOURS_GCONF_KEY, NULL),
313 GtkWidget *m_picker = timed_inhibit_picker_new (_ ("Minutes"),
314 gconf_client_get_int (priv->gconf_client, MINUTES_GCONF_KEY, NULL),
317 GtkWidget *hbox = gtk_hbox_new (FALSE, 0);
318 g_assert (hbox != NULL);
320 gtk_container_add (GTK_CONTAINER (hbox), h_picker);
321 gtk_container_add (GTK_CONTAINER (hbox), m_picker);
323 GtkWidget *content_area = gtk_dialog_get_content_area (
324 GTK_DIALOG (priv->timed_inhibit_dialog));
325 gtk_container_add (GTK_CONTAINER (content_area), hbox);
327 gtk_widget_show_all (priv->timed_inhibit_dialog);
329 gint result = gtk_dialog_run (GTK_DIALOG (priv->timed_inhibit_dialog));
332 if (result == GTK_RESPONSE_ACCEPT) {
333 gint hours = timed_inhibit_picker_get_value (h_picker);
334 gint mins = timed_inhibit_picker_get_value (m_picker);
337 gconf_client_set_int (priv->gconf_client, HOURS_GCONF_KEY, hours, &e);
338 g_assert (e == NULL);
339 gconf_client_set_int (priv->gconf_client, MINUTES_GCONF_KEY, mins, &e);
340 g_assert (e == NULL);
342 timeout = hours*3600 + mins*60;
345 gtk_widget_destroy (priv->timed_inhibit_dialog);
346 priv->timed_inhibit_dialog = NULL;
352 on_timed_inhibit_button_clicked (GtkWidget *button,
353 DisplayBlankingStatusPluginPrivate *priv)
355 if (priv->inhibit_in_signal)
358 GtkWidget *parent = gtk_widget_get_ancestor (GTK_WIDGET (priv->mode_button),
360 gtk_widget_hide (parent);
362 gboolean self_pressed = gtk_toggle_button_get_active (
363 GTK_TOGGLE_BUTTON (button));
364 gboolean other_pressed = gtk_toggle_button_get_active (
365 GTK_TOGGLE_BUTTON (priv->inhibit_button));
368 g_assert (priv->timed_inhibit_timer_id == 0);
370 g_assert (priv->inhibit_timer_id != 0);
372 guint timeout = timed_inhibit_get_input (priv);
375 priv->inhibit_in_signal = TRUE;
376 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (
377 priv->inhibit_button), FALSE);
378 priv->inhibit_in_signal = FALSE;
381 enable_inhibition (priv);
383 priv->timed_inhibit_timer_id = g_timeout_add_seconds (timeout,
384 (GSourceFunc) on_timed_inhibit_timeout, priv);
385 g_assert (priv->timed_inhibit_timer_id > 0);
388 priv->inhibit_in_signal = TRUE;
389 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (
390 priv->timed_inhibit_button), FALSE);
391 priv->inhibit_in_signal = FALSE;
394 else { // !self_pressed
395 g_assert (!other_pressed);
397 disable_inhibition (priv);
398 disable_timer (&(priv->timed_inhibit_timer_id));
403 on_mode_dialog_button_clicked (GtkWidget *button, GtkDialog *dialog)
405 const gchar *title = hildon_button_get_title (HILDON_BUTTON (button));
407 gint *mode = (gint *) g_object_get_data (G_OBJECT(dialog), "mode");
408 g_assert (mode != NULL);
410 for (*mode = 0; *mode < BLANKING_MODES; (*mode)++) {
411 if (strcmp (title, mode_title[*mode]) == 0)
414 g_assert (*mode < BLANKING_MODES);
416 gtk_dialog_response (dialog, GTK_RESPONSE_OK);
420 mode_get_input (DisplayBlankingStatusPluginPrivate *priv)
422 g_assert (priv->mode_dialog == NULL);
423 priv->mode_dialog = gtk_dialog_new ();
424 gtk_window_set_modal (GTK_WINDOW (priv->mode_dialog), TRUE);
425 gtk_window_set_title (GTK_WINDOW (priv->mode_dialog),
426 _ ("Select display blanking mode"));
428 GtkWidget *pan_area = hildon_pannable_area_new ();
429 g_assert (pan_area != NULL);
431 GtkWidget *vbox = gtk_vbox_new (FALSE, 0);
432 g_assert (vbox != NULL);
434 hildon_pannable_area_add_with_viewport (HILDON_PANNABLE_AREA (pan_area),
436 GtkWidget *content_area = gtk_dialog_get_content_area (
437 GTK_DIALOG (priv->mode_dialog));
438 gtk_box_pack_start (GTK_BOX (content_area), pan_area, TRUE, TRUE, 0);
440 gtk_widget_set_size_request (pan_area, -1, MIN (350, BLANKING_MODES * 70));
442 gint mode = BLANKING_MODES;
443 for (int i = 0; i < BLANKING_MODES; i++) {
445 hildon_button_new_with_text (HILDON_SIZE_FINGER_HEIGHT,
446 HILDON_BUTTON_ARRANGEMENT_VERTICAL, _ (mode_title[i]),
448 hildon_button_set_style (HILDON_BUTTON (button),
449 HILDON_BUTTON_STYLE_PICKER);
450 GtkWidget *icon = gtk_image_new_from_icon_name (mode_icon_name[i],
451 GTK_ICON_SIZE_DIALOG);
452 hildon_button_set_image (HILDON_BUTTON (button), icon);
453 gtk_button_set_alignment (GTK_BUTTON (button), 0.0f, 0.5f);
454 gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
455 g_signal_connect (button, "clicked",
456 G_CALLBACK (on_mode_dialog_button_clicked), priv->mode_dialog);
459 g_object_set_data (G_OBJECT (priv->mode_dialog), "mode", &mode);
460 gtk_widget_show_all (priv->mode_dialog);
461 gtk_dialog_run (GTK_DIALOG (priv->mode_dialog));
463 gtk_widget_destroy (priv->mode_dialog);
464 priv->mode_dialog = NULL;
470 on_mode_button_clicked (GtkWidget *button,
471 DisplayBlankingStatusPluginPrivate *priv)
473 GtkWidget *parent = gtk_widget_get_ancestor (GTK_WIDGET (priv->mode_button),
475 gtk_widget_hide (parent);
477 gint mode = mode_get_input (priv);
479 if (mode != BLANKING_MODES) {
480 // will trigger the gconf notify signal
481 GError *error = NULL;
482 gconf_client_set_int (priv->gconf_client, MODE_GCONF_KEY, mode, &error);
483 g_assert (error == NULL);
488 on_gconf_notify (GConfClient* client, guint cnxn_id, GConfEntry* entry,
489 DisplayBlankingStatusPluginPrivate* priv)
491 const gchar* key = gconf_entry_get_key (entry);
492 g_assert (key != NULL);
494 // Ignore notification about keys we don't care about
495 if (strcmp (key, MODE_GCONF_KEY) != 0)
498 const GConfValue* value = gconf_entry_get_value (entry);
499 g_assert (value != NULL);
500 g_assert (GCONF_VALUE_TYPE_VALID (value->type));
501 g_assert (value->type == GCONF_VALUE_INT);
503 gint mode = gconf_value_get_int (value);
504 update_mode_gui (mode, priv);
508 init_gconf (DisplayBlankingStatusPluginPrivate *priv)
510 GError* error = NULL;
512 priv->gconf_client = gconf_client_get_default ();
513 g_assert (GCONF_IS_CLIENT (priv->gconf_client));
515 gconf_client_add_dir (priv->gconf_client, MODE_GCONF_ROOT,
516 GCONF_CLIENT_PRELOAD_NONE, &error);
517 g_assert (error == NULL);
519 gconf_client_notify_add (priv->gconf_client, MODE_GCONF_KEY,
520 (GConfClientNotifyFunc) &on_gconf_notify, priv, NULL, &error);
521 g_assert (error == NULL);
525 init_dbus (DisplayBlankingStatusPluginPrivate *priv)
528 dbus_error_init (&error);
530 priv->dbus_conn = dbus_bus_get (DBUS_BUS_SYSTEM, &error);
531 g_assert (!dbus_error_is_set (&error));
532 g_assert (priv->dbus_conn != NULL);
534 priv->dbus_msg = dbus_message_new_method_call (MCE_SERVICE,
535 MCE_REQUEST_PATH, MCE_REQUEST_IF, MCE_PREVENT_BLANK_REQ);
536 g_assert (priv->dbus_msg != NULL);
537 dbus_message_set_no_reply (priv->dbus_msg, TRUE);
541 init_mode_gui (DisplayBlankingStatusPluginPrivate *priv)
543 priv->mode_dialog = NULL;
544 priv->mode_button = hildon_gtk_button_new (HILDON_SIZE_FINGER_HEIGHT |
545 HILDON_SIZE_AUTO_WIDTH);
547 GError* error = NULL;
548 gint mode = gconf_client_get_int (priv->gconf_client, MODE_GCONF_KEY,
550 g_assert (error == NULL);
551 update_mode_gui (mode, priv);
553 g_signal_connect (priv->mode_button, "clicked",
554 G_CALLBACK (on_mode_button_clicked), priv);
558 inhibit_button_new (const gchar *icon_name,
559 void (*cb) (GtkWidget *, DisplayBlankingStatusPluginPrivate *),
563 GtkWidget *b = hildon_gtk_toggle_button_new (HILDON_SIZE_FINGER_HEIGHT |
564 HILDON_SIZE_AUTO_WIDTH);
565 gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON(b), FALSE);
566 GtkWidget *icon = gtk_image_new_from_icon_name (icon_name,
567 GTK_ICON_SIZE_DIALOG);
568 gtk_button_set_image (GTK_BUTTON (b), icon);
569 g_signal_connect (b, "clicked", G_CALLBACK (cb), cb_data);
575 init_inhibit_gui (DisplayBlankingStatusPluginPrivate *priv)
577 priv->inhibit_in_signal = FALSE;
579 priv->inhibit_timer_id = 0;
580 priv->timed_inhibit_timer_id = 0;
582 priv->inhibit_button = inhibit_button_new (INHIBIT_ICON_NAME,
583 on_inhibit_button_clicked, priv);
585 priv->timed_inhibit_button = inhibit_button_new (
586 TIMED_INHIBIT_ICON_NAME, on_timed_inhibit_button_clicked, priv);
590 display_blanking_status_plugin_init (DisplayBlankingStatusPlugin *plugin)
592 DisplayBlankingStatusPluginPrivate *priv;
594 priv = DISPLAY_BLANKING_STATUS_PLUGIN_GET_PRIVATE (plugin);
596 priv->plugin = plugin;
600 init_mode_gui (priv);
601 init_inhibit_gui (priv);
603 GtkWidget *hbbox = gtk_hbutton_box_new ();
604 g_assert (hbbox != NULL);
606 gtk_container_add (GTK_CONTAINER (hbbox), priv->mode_button);
607 gtk_container_add (GTK_CONTAINER (hbbox), priv->inhibit_button);
608 gtk_container_add (GTK_CONTAINER (hbbox), priv->timed_inhibit_button);
610 gtk_container_add (GTK_CONTAINER (plugin), hbbox);
612 gtk_widget_show_all (GTK_WIDGET (plugin));