1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 prompt.c for the Openbox window manager
4 Copyright (c) 2008 Dana Jansens
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 See the COPYING file for a copy of the GNU General Public License.
30 static GList *prompt_list = NULL;
32 /* we construct these */
33 static RrAppearance *prompt_a_bg;
34 static RrAppearance *prompt_a_button;
35 static RrAppearance *prompt_a_focus;
36 static RrAppearance *prompt_a_press;
37 static RrAppearance *prompt_a_pfocus;
38 /* we change the max width which would screw with others */
39 static RrAppearance *prompt_a_msg;
42 #define OUTSIDE_MARGIN 4
43 #define MSG_BUTTON_SEPARATION 4
44 #define BUTTON_SEPARATION 4
45 #define BUTTON_VMARGIN 4
46 #define BUTTON_HMARGIN 12
49 static void prompt_layout(ObPrompt *self);
50 static void render_all(ObPrompt *self);
51 static void render_button(ObPrompt *self, ObPromptElement *e);
52 static void prompt_resize(ObPrompt *self, gint w, gint h);
53 static void prompt_run_callback(ObPrompt *self, gint result);
55 void prompt_startup(gboolean reconfig)
57 RrColor *c_button, *c_focus, *c_press, *c_pfocus;
59 /* note: this is not a copy, don't free it */
60 prompt_a_bg = ob_rr_theme->osd_hilite_bg;
62 prompt_a_button = RrAppearanceCopy(ob_rr_theme->a_focused_unpressed_close);
63 prompt_a_focus = RrAppearanceCopy(ob_rr_theme->a_hover_focused_close);
64 prompt_a_press = RrAppearanceCopy(ob_rr_theme->a_focused_pressed_close);
65 prompt_a_pfocus = RrAppearanceCopy(ob_rr_theme->a_focused_pressed_close);
67 c_button = prompt_a_button->texture[0].data.mask.color;
68 c_focus = prompt_a_focus->texture[0].data.mask.color;
69 c_press = prompt_a_press->texture[0].data.mask.color;
70 c_pfocus = prompt_a_press->texture[0].data.mask.color;
72 RrAppearanceRemoveTextures(prompt_a_button);
73 RrAppearanceRemoveTextures(prompt_a_focus);
74 RrAppearanceRemoveTextures(prompt_a_press);
75 RrAppearanceRemoveTextures(prompt_a_pfocus);
77 /* texture[0] is the text and texture[1-4] (for prompt_a_focus and
78 prompt_a_pfocus) is lineart to show where keyboard focus is */
79 RrAppearanceAddTextures(prompt_a_button, 1);
80 RrAppearanceAddTextures(prompt_a_focus, 5);
81 RrAppearanceAddTextures(prompt_a_press, 1);
82 RrAppearanceAddTextures(prompt_a_pfocus, 5);
84 /* totally cheating here.. */
85 prompt_a_button->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
86 prompt_a_focus->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
87 prompt_a_press->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
88 prompt_a_pfocus->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
90 prompt_a_button->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
91 prompt_a_focus->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
92 prompt_a_press->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
93 prompt_a_pfocus->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
95 prompt_a_button->texture[0].data.text.color = c_button;
96 prompt_a_focus->texture[0].data.text.color = c_focus;
97 prompt_a_press->texture[0].data.text.color = c_press;
98 prompt_a_pfocus->texture[0].data.text.color = c_press;
100 prompt_a_focus->texture[1].data.lineart.color = c_focus;
101 prompt_a_focus->texture[2].data.lineart.color = c_focus;
102 prompt_a_focus->texture[3].data.lineart.color = c_focus;
103 prompt_a_focus->texture[4].data.lineart.color = c_focus;
105 prompt_a_pfocus->texture[1].data.lineart.color = c_press;
106 prompt_a_pfocus->texture[2].data.lineart.color = c_press;
107 prompt_a_pfocus->texture[3].data.lineart.color = c_press;
108 prompt_a_pfocus->texture[4].data.lineart.color = c_press;
110 prompt_a_msg = RrAppearanceCopy(ob_rr_theme->osd_hilite_label);
111 prompt_a_msg->texture[0].data.text.flow = TRUE;
115 for (it = prompt_list; it; it = g_list_next(it)) {
116 ObPrompt *p = it->data;
123 void prompt_shutdown(gboolean reconfig)
128 for (it = prompt_list; it; it = g_list_next(it)) {
129 ObPrompt *p = it->data;
130 if (p->cleanup) p->cleanup(p, p->data);
133 g_assert(prompt_list == NULL);
136 RrAppearanceFree(prompt_a_button);
137 RrAppearanceFree(prompt_a_focus);
138 RrAppearanceFree(prompt_a_press);
139 RrAppearanceFree(prompt_a_pfocus);
140 RrAppearanceFree(prompt_a_msg);
143 ObPrompt* prompt_new(const gchar *msg, const gchar *title,
144 const ObPromptAnswer *answers, gint n_answers,
145 gint default_result, gint cancel_result,
146 ObPromptCallback func, ObPromptCleanup cleanup,
150 XSetWindowAttributes attrib;
153 attrib.override_redirect = FALSE;
155 self = g_new0(ObPrompt, 1);
158 self->cleanup = cleanup;
160 self->default_result = default_result;
161 self->cancel_result = cancel_result;
162 self->super.type = Window_Prompt;
163 self->super.window = XCreateWindow(ob_display,
164 RootWindow(ob_display, ob_screen),
166 CopyFromParent, InputOutput,
171 /* make it a dialog type window */
172 PROP_SET32(self->super.window, net_wm_window_type, atom,
173 prop_atoms.net_wm_window_type_dialog);
175 /* set the window's title */
177 PROP_SETS(self->super.window, net_wm_name, title);
179 /* listen for key presses on the window */
180 self->event_mask = KeyPressMask;
182 /* set up the text message widow */
183 self->msg.text = g_strdup(msg);
184 self->msg.window = XCreateWindow(ob_display, self->super.window,
186 CopyFromParent, InputOutput,
187 CopyFromParent, 0, NULL);
188 XMapWindow(ob_display, self->msg.window);
190 /* set up the buttons from the answers */
192 self->n_buttons = n_answers;
193 if (!self->n_buttons)
196 self->button = g_new0(ObPromptElement, self->n_buttons);
198 if (n_answers == 0) {
199 g_assert(self->n_buttons == 1); /* should be set to this above.. */
200 self->button[0].text = g_strdup(_("OK"));
203 g_assert(self->n_buttons > 0);
204 for (i = 0; i < self->n_buttons; ++i) {
205 self->button[i].text = g_strdup(answers[i].text);
206 self->button[i].result = answers[i].result;
210 for (i = 0; i < self->n_buttons; ++i) {
211 self->button[i].window = XCreateWindow(ob_display, self->super.window,
213 CopyFromParent, InputOutput,
214 CopyFromParent, 0, NULL);
215 XMapWindow(ob_display, self->button[i].window);
216 g_hash_table_insert(window_map, &self->button[i].window,
217 PROMPT_AS_WINDOW(self));
219 /* listen for button presses on the buttons */
220 XSelectInput(ob_display, self->button[i].window,
221 ButtonPressMask | ButtonReleaseMask | ButtonMotionMask);
224 prompt_list = g_list_prepend(prompt_list, self);
229 void prompt_ref(ObPrompt *self)
234 void prompt_unref(ObPrompt *self)
236 if (self && --self->ref == 0) {
242 prompt_list = g_list_remove(prompt_list, self);
244 for (i = 0; i < self->n_buttons; ++i) {
245 g_hash_table_remove(window_map, &self->button[i].window);
246 XDestroyWindow(ob_display, self->button[i].window);
249 XDestroyWindow(ob_display, self->msg.window);
250 XDestroyWindow(ob_display, self->super.window);
255 static void prompt_layout(ObPrompt *self)
259 gint allbuttonsw, allbuttonsh, buttonx;
263 RrMargins(prompt_a_bg, &l, &t, &r, &b);
270 Rect *area = screen_physical_area_all_monitors();
271 maxw = MIN(MAX_WIDTH, area->width*4/5);
275 /* find the button sizes and how much space we need for them */
276 allbuttonsw = allbuttonsh = 0;
277 for (i = 0; i < self->n_buttons; ++i) {
280 prompt_a_button->texture[0].data.text.string = self->button[i].text;
281 prompt_a_focus->texture[0].data.text.string = self->button[i].text;
282 prompt_a_press->texture[0].data.text.string = self->button[i].text;
283 prompt_a_pfocus->texture[0].data.text.string = self->button[i].text;
284 RrMinSize(prompt_a_button, &bw, &bh);
285 self->button[i].width = bw;
286 self->button[i].height = bh;
287 RrMinSize(prompt_a_focus, &bw, &bh);
288 self->button[i].width = MAX(self->button[i].width, bw);
289 self->button[i].height = MAX(self->button[i].height, bh);
290 RrMinSize(prompt_a_press, &bw, &bh);
291 self->button[i].width = MAX(self->button[i].width, bw);
292 self->button[i].height = MAX(self->button[i].height, bh);
293 RrMinSize(prompt_a_pfocus, &bw, &bh);
294 self->button[i].width = MAX(self->button[i].width, bw);
295 self->button[i].height = MAX(self->button[i].height, bh);
297 self->button[i].width += BUTTON_HMARGIN * 2;
298 self->button[i].height += BUTTON_VMARGIN * 2;
300 allbuttonsw += self->button[i].width + (i > 0 ? BUTTON_SEPARATION : 0);
301 allbuttonsh = MAX(allbuttonsh, self->button[i].height);
304 self->msg_wbound = MAX(allbuttonsw, maxw);
306 /* measure the text message area */
307 prompt_a_msg->texture[0].data.text.string = self->msg.text;
308 prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
309 RrMinSize(prompt_a_msg, &self->msg.width, &self->msg.height);
311 /* width and height inside the outer margins */
312 w = MAX(self->msg.width, allbuttonsw);
313 h = self->msg.height + MSG_BUTTON_SEPARATION + allbuttonsh;
315 /* position the text message */
316 self->msg.x = l + (w - self->msg.width) / 2;
319 /* position the button buttons on the right of the dialog */
321 for (i = self->n_buttons - 1; i >= 0; --i) {
322 self->button[i].x = buttonx - self->button[i].width;
323 buttonx -= self->button[i].width + BUTTON_SEPARATION;
324 self->button[i].y = t + h - allbuttonsh;
325 self->button[i].y += (allbuttonsh - self->button[i].height) / 2;
328 /* size and position the toplevel window */
329 prompt_resize(self, w + l + r, h + t + b);
331 /* move and resize the internal windows */
332 XMoveResizeWindow(ob_display, self->msg.window,
333 self->msg.x, self->msg.y,
334 self->msg.width, self->msg.height);
335 for (i = 0; i < self->n_buttons; ++i)
336 XMoveResizeWindow(ob_display, self->button[i].window,
337 self->button[i].x, self->button[i].y,
338 self->button[i].width, self->button[i].height);
341 static void prompt_resize(ObPrompt *self, gint w, gint h)
343 XConfigureRequestEvent req;
349 /* the user can't resize the prompt */
350 hints.flags = PMinSize | PMaxSize;
351 hints.min_width = hints.max_width = w;
352 hints.min_height = hints.max_height = h;
353 XSetWMNormalHints(ob_display, self->super.window, &hints);
356 /* send a configure request like a normal client would */
357 req.type = ConfigureRequest;
358 req.display = ob_display;
359 req.parent = RootWindow(ob_display, ob_screen);
360 req.window = self->super.window;
363 req.value_mask = CWWidth | CWHeight;
364 XSendEvent(req.display, req.window, FALSE, StructureNotifyMask,
368 XResizeWindow(ob_display, self->super.window, w, h);
371 static void setup_button_focus_tex(ObPromptElement *e, RrAppearance *a,
376 for (i = 1; i < 5; ++i)
377 a->texture[i].type = on ? RR_TEXTURE_LINE_ART : RR_TEXTURE_NONE;
381 RrMargins(a, &l, &t, &r, &b);
382 l += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
383 r += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
384 t += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
385 b += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
388 a->texture[1].data.lineart.x1 = l;
389 a->texture[1].data.lineart.x2 = e->width - r - 1;
390 a->texture[1].data.lineart.y1 = t;
391 a->texture[1].data.lineart.y2 = t;
394 a->texture[2].data.lineart.x1 = l;
395 a->texture[2].data.lineart.x2 = e->width - r - 1;
396 a->texture[2].data.lineart.y1 = e->height - b - 1;
397 a->texture[2].data.lineart.y2 = e->height - b - 1;
400 a->texture[3].data.lineart.x1 = l;
401 a->texture[3].data.lineart.x2 = l;
402 a->texture[3].data.lineart.y1 = t;
403 a->texture[3].data.lineart.y2 = e->height - b - 1;
406 a->texture[4].data.lineart.x1 = e->width - r - 1;
407 a->texture[4].data.lineart.x2 = e->width - r - 1;
408 a->texture[4].data.lineart.y1 = t;
409 a->texture[4].data.lineart.y2 = e->height - b - 1;
412 static void render_button(ObPrompt *self, ObPromptElement *e)
416 if (e->pressed && self->focus == e) a = prompt_a_pfocus;
417 else if (self->focus == e) a = prompt_a_focus;
418 else if (e->pressed) a = prompt_a_press;
419 else a = prompt_a_button;
421 a->surface.parent = prompt_a_bg;
422 a->surface.parentx = e->x;
423 a->surface.parenty = e->y;
425 /* draw the keyfocus line */
426 if (a == prompt_a_pfocus || a == prompt_a_focus)
427 setup_button_focus_tex(e, a, TRUE);
429 a->texture[0].data.text.string = e->text;
430 RrPaint(a, e->window, e->width, e->height);
432 /* turn off the keyfocus line so that it doesn't affect size calculations
434 if (a == prompt_a_pfocus || a == prompt_a_focus)
435 setup_button_focus_tex(e, a, FALSE);
438 static void render_all(ObPrompt *self)
442 RrPaint(prompt_a_bg, self->super.window, self->width, self->height);
444 prompt_a_msg->surface.parent = prompt_a_bg;
445 prompt_a_msg->surface.parentx = self->msg.x;
446 prompt_a_msg->surface.parenty = self->msg.y;
448 prompt_a_msg->texture[0].data.text.string = self->msg.text;
449 prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
450 RrPaint(prompt_a_msg, self->msg.window, self->msg.width, self->msg.height);
452 for (i = 0; i < self->n_buttons; ++i)
453 render_button(self, &self->button[i]);
456 void prompt_show(ObPrompt *self, ObClient *parent, gboolean modal)
461 /* activate the prompt */
462 PROP_MSG(self->super.window, net_active_window,
463 1, /* from an application.. */
470 /* set the focused button (if not found then the first button is used) */
471 self->focus = &self->button[0];
472 for (i = 0; i < self->n_buttons; ++i)
473 if (self->button[i].result == self->default_result) {
474 self->focus = &self->button[i];
485 /* make it transient for the window's group */
486 h.flags = WindowGroupHint;
487 h.window_group = parent->group->leader;
488 p = RootWindow(ob_display, ob_screen);
491 /* make it transient for the window directly */
496 XSetWMHints(ob_display, self->super.window, &h);
497 PROP_SET32(self->super.window, wm_transient_for, window, p);
499 states[0] = prop_atoms.net_wm_state_modal;
500 nstates = (modal ? 1 : 0);
501 PROP_SETA32(self->super.window, net_wm_state, atom, states, nstates);
504 PROP_ERASE(self->super.window, wm_transient_for);
506 /* set up the dialog and render it */
510 client_manage(self->super.window, self);
515 void prompt_hide(ObPrompt *self)
517 XUnmapWindow(ob_display, self->super.window);
518 self->mapped = FALSE;
521 gboolean prompt_key_event(ObPrompt *self, XEvent *e)
526 if (e->type != KeyPress) return FALSE;
528 shift_mask = modkeys_key_to_mask(OB_MODKEY_KEY_SHIFT);
529 shift = !!(e->xkey.state & shift_mask);
531 /* only accept shift */
532 if (e->xkey.state != 0 && e->xkey.state != shift_mask)
535 if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
537 else if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN) ||
538 e->xkey.keycode == ob_keycode(OB_KEY_SPACE))
540 prompt_run_callback(self, self->focus->result);
542 else if (e->xkey.keycode == ob_keycode(OB_KEY_TAB) ||
543 e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
544 e->xkey.keycode == ob_keycode(OB_KEY_RIGHT))
548 ObPromptElement *oldfocus;
550 left = e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
551 (e->xkey.keycode == ob_keycode(OB_KEY_TAB) && shift);
552 oldfocus = self->focus;
554 for (i = 0; i < self->n_buttons; ++i)
555 if (self->focus == &self->button[i]) break;
556 i += (left ? -1 : 1);
557 if (i < 0) i = self->n_buttons - 1;
558 else if (i >= self->n_buttons) i = 0;
559 self->focus = &self->button[i];
561 if (oldfocus != self->focus) render_button(self, oldfocus);
562 render_button(self, self->focus);
567 gboolean prompt_mouse_event(ObPrompt *self, XEvent *e)
570 ObPromptElement *but;
572 if (e->type != ButtonPress && e->type != ButtonRelease &&
573 e->type != MotionNotify) return FALSE;
575 /* find the button */
577 for (i = 0; i < self->n_buttons; ++i)
578 if (self->button[i].window ==
579 (e->type == MotionNotify ? e->xmotion.window : e->xbutton.window))
581 but = &self->button[i];
584 if (!but) return FALSE;
586 if (e->type == ButtonPress) {
587 ObPromptElement *oldfocus;
589 oldfocus = self->focus;
594 if (oldfocus != but) render_button(self, oldfocus);
595 render_button(self, but);
597 else if (e->type == ButtonRelease) {
599 prompt_run_callback(self, but->result);
601 else if (e->type == MotionNotify) {
604 press = (e->xmotion.x >= 0 && e->xmotion.y >= 0 &&
605 e->xmotion.x < but->width && e->xmotion.y < but->height);
607 if (press != but->pressed) {
608 but->pressed = press;
609 render_button(self, but);
615 void prompt_cancel(ObPrompt *self)
617 prompt_run_callback(self, self->cancel_result);
620 static gboolean prompt_show_message_cb(ObPrompt *p, int res, gpointer data)
622 return TRUE; /* call the cleanup func */
625 static void prompt_show_message_cleanup(ObPrompt *p, gpointer data)
630 ObPrompt* prompt_show_message(const gchar *msg, const gchar *title,
634 ObPromptAnswer ans[] = {
638 p = prompt_new(msg, title, ans, 1, 0, 0,
639 prompt_show_message_cb, prompt_show_message_cleanup, NULL);
640 prompt_show(p, NULL, FALSE);
644 static void prompt_run_callback(ObPrompt *self, gint result)
648 gboolean clean = self->func(self, self->focus->result, self->data);
649 if (clean && self->cleanup)
650 self->cleanup(self, self->data);