From: Dana Jansens <danakj@orodu.net>
Date: Thu, 7 Feb 2008 05:10:57 +0000 (-0500)
Subject: let you specify return codes for the different buttons in a prompt, and specify a... 
X-Git-Url: https://git.brokenzipper.com/gitweb?a=commitdiff_plain;h=c7af49b5c564d6287a0293ae26fc713fb55b4dc8;p=chaz%2Fopenbox

let you specify return codes for the different buttons in a prompt, and specify a callback function for the prompt for when it is closed
---

diff --git a/openbox/client.c b/openbox/client.c
index 500562b0..7add1222 100644
--- a/openbox/client.c
+++ b/openbox/client.c
@@ -3349,7 +3349,7 @@ void client_close(ObClient *self)
     if (!(self->functions & OB_CLIENT_FUNC_CLOSE)) return;
 
     if (self->prompt) {
-        prompt_hide(self->prompt);
+        prompt_cancel(self->prompt);
         return;
     }
 
diff --git a/openbox/prompt.c b/openbox/prompt.c
index e63911ba..ba5228a1 100644
--- a/openbox/prompt.c
+++ b/openbox/prompt.c
@@ -92,18 +92,24 @@ void prompt_shutdown(gboolean reconfig)
     RrAppearanceFree(prompt_a_msg);
 }
 
-ObPrompt* prompt_new(const gchar *msg, const gchar *const *answers)
+ObPrompt* prompt_new(const gchar *msg,
+                     const ObPromptAnswer *answers, gint n_answers,
+                     gint default_result, gint cancel_result,
+                     ObPromptCallback func, gpointer data)
 {
     ObPrompt *self;
     XSetWindowAttributes attrib;
-    guint i;
-    const gchar *const *c;
+    gint i;
 
     attrib.override_redirect = FALSE;
     attrib.border_pixel = RrColorPixel(ob_rr_theme->osd_border_color);
 
     self = g_new0(ObPrompt, 1);
     self->ref = 1;
+    self->func = func;
+    self->data = data;
+    self->default_result = default_result;
+    self->cancel_result = cancel_result;
     self->super.type = Window_Prompt;
     self->super.window = XCreateWindow(ob_display,
                                        RootWindow(ob_display, ob_screen),
@@ -120,8 +126,10 @@ ObPrompt* prompt_new(const gchar *msg, const gchar *const *answers)
     /* listen for key presses on the window */
     self->event_mask = KeyPressMask;
 
+    /* we make a copy of this appearance for each prompt */
     self->a_bg = RrAppearanceCopy(ob_rr_theme->osd_hilite_bg);
 
+    /* set up the text message widow */
     self->msg.text = g_strdup(msg);
     self->msg.window = XCreateWindow(ob_display, self->super.window,
                                      0, 0, 1, 1, 0,
@@ -129,23 +137,24 @@ ObPrompt* prompt_new(const gchar *msg, const gchar *const *answers)
                                      CopyFromParent, 0, NULL);
     XMapWindow(ob_display, self->msg.window);
 
-    self->n_buttons = 0;
-    for (c = answers; *c != NULL; ++c)
-        ++self->n_buttons;
+    /* set up the buttons from the answers */
 
+    self->n_buttons = n_answers;
     if (!self->n_buttons)
         self->n_buttons = 1;
 
-    self->button = g_new(ObPromptElement, self->n_buttons);
+    self->button = g_new0(ObPromptElement, self->n_buttons);
 
-    if (!answers) {
+    if (n_answers == 0) {
         g_assert(self->n_buttons == 1); /* should be set to this above.. */
         self->button[0].text = g_strdup(_("OK"));
     }
     else {
         g_assert(self->n_buttons > 0);
-        for (i = 0; i < self->n_buttons; ++i)
-            self->button[i].text = g_strdup(answers[i]);
+        for (i = 0; i < self->n_buttons; ++i) {
+            self->button[i].text = g_strdup(answers[i].text);
+            self->button[i].result = answers[i].result;
+        }
     }
 
     for (i = 0; i < self->n_buttons; ++i) {
@@ -162,9 +171,6 @@ ObPrompt* prompt_new(const gchar *msg, const gchar *const *answers)
                      ButtonPressMask | ButtonReleaseMask | ButtonMotionMask);
     }
 
-    /* set the focus to the first button */
-    self->focus = &self->button[0];
-
     prompt_list = g_list_prepend(prompt_list, self);
 
     return self;
@@ -178,7 +184,7 @@ void prompt_ref(ObPrompt *self)
 void prompt_unref(ObPrompt *self)
 {
     if (self && --self->ref == 0) {
-        guint i;
+        gint i;
 
         prompt_list = g_list_remove(prompt_list, self);
 
@@ -199,7 +205,7 @@ void prompt_unref(ObPrompt *self)
 static void prompt_layout(ObPrompt *self)
 {
     gint l, r, t, b;
-    guint i;
+    gint i;
     gint allbuttonsw, allbuttonsh, buttonx;
     gint w, h;
     gint maxw;
@@ -265,11 +271,11 @@ static void prompt_layout(ObPrompt *self)
 
     /* position the button buttons on the right of the dialog */
     buttonx = l + w;
-    for (i = self->n_buttons; i > 0; --i) {
-        self->button[i-1].x = buttonx - self->button[i-1].width;
-        buttonx -= self->button[i-1].width + BUTTON_SEPARATION;
-        self->button[i-1].y = t + h - allbuttonsh;
-        self->button[i-1].y += (allbuttonsh - self->button[i-1].height) / 2;
+    for (i = self->n_buttons - 1; i >= 0; --i) {
+        self->button[i].x = buttonx - self->button[i].width;
+        buttonx -= self->button[i].width + BUTTON_SEPARATION;
+        self->button[i].y = t + h - allbuttonsh;
+        self->button[i].y += (allbuttonsh - self->button[i].height) / 2;
     }
 
     /* size and position the toplevel window */
@@ -305,7 +311,7 @@ static void render_button(ObPrompt *self, ObPromptElement *e)
 
 static void render_all(ObPrompt *self)
 {
-    guint i;
+    gint i;
 
     RrPaint(self->a_bg, self->super.window, self->width, self->height);
 
@@ -324,11 +330,17 @@ static void render_all(ObPrompt *self)
 void prompt_show(ObPrompt *self, ObClient *parent)
 {
     XSizeHints hints;
+    gint i;
 
     if (self->mapped) return;
 
-    prompt_layout(self);
-    render_all(self);
+    /* set the focused button (if not found then the first button is used) */
+    self->focus = &self->button[0];
+    for (i = 0; i < self->n_buttons; ++i)
+        if (self->button[i].result == self->default_result) {
+            self->focus = &self->button[i];
+            break;
+        }
 
     /* you can't resize the prompt */
     hints.flags = PMinSize | PMaxSize;
@@ -339,6 +351,10 @@ void prompt_show(ObPrompt *self, ObClient *parent)
     XSetTransientForHint(ob_display, (parent ? parent->window : 0),
                          self->super.window);
 
+    /* set up the dialog and render it */
+    prompt_layout(self);
+    render_all(self);
+
     client_manage(self->super.window, self);
 
     self->mapped = TRUE;
@@ -367,13 +383,13 @@ void prompt_key_event(ObPrompt *self, XEvent *e)
         return;
 
     if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
-        prompt_hide(self);
+        prompt_cancel(self);
     else if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN)) {
-        /* XXX run stuff */
+        if (self->func) self->func(self, self->focus->result, self->data);
         prompt_hide(self);
     }
     else if (e->xkey.keycode == ob_keycode(OB_KEY_TAB)) {
-        guint i;
+        gint i;
         ObPromptElement *oldfocus;
 
         oldfocus = self->focus;
@@ -392,7 +408,7 @@ void prompt_key_event(ObPrompt *self, XEvent *e)
 
 void prompt_mouse_event(ObPrompt *self, XEvent *e)
 {
-    guint i;
+    gint i;
     ObPromptElement *but;
 
     if (e->type != ButtonPress && e->type != ButtonRelease &&
@@ -421,7 +437,7 @@ void prompt_mouse_event(ObPrompt *self, XEvent *e)
     }
     else if (e->type == ButtonRelease) {
         if (but->pressed) {
-            /* XXX run stuff */
+            if (self->func) self->func(self, but->result, self->data);
             prompt_hide(self);
         }
     }
@@ -437,3 +453,9 @@ void prompt_mouse_event(ObPrompt *self, XEvent *e)
         }
     }
 }
+
+void prompt_cancel(ObPrompt *self)
+{
+    if (self->func) self->func(self, self->cancel_result, self->data);
+    prompt_hide(self);
+}
diff --git a/openbox/prompt.h b/openbox/prompt.h
index b31a0c04..c470f101 100644
--- a/openbox/prompt.h
+++ b/openbox/prompt.h
@@ -19,21 +19,25 @@
 #ifndef ob__prompt_h
 #define ob__prompt_h
 
-typedef struct _ObPrompt       ObPrompt;
-typedef struct _ObPromptElement ObPromptElement;
-
 #include "window.h"
 #include "geom.h"
 #include "render/render.h"
 #include <glib.h>
 #include <X11/Xlib.h>
 
+typedef struct _ObPrompt       ObPrompt;
+typedef struct _ObPromptElement ObPromptElement;
+typedef struct _ObPromptAnswer ObPromptAnswer;
+
+typedef void (*ObPromptCallback)(ObPrompt *p, gint result, gpointer data);
+
 struct _ObPromptElement {
     gchar *text;
     Window window;
 
     gint x, y, width, height;
     gboolean pressed;
+    gint result;
 };
 
 struct _ObPrompt
@@ -55,16 +59,43 @@ struct _ObPrompt
 
     /* one for each answer */
     ObPromptElement *button;
-    guint n_buttons;
+    gint n_buttons;
 
     /* points to the button with the focus */
     ObPromptElement *focus;
+    /* the default button to have selected */
+    gint default_result;
+    /* the cancel result if the dialog is closed */
+    gint cancel_result;
+
+    ObPromptCallback func;
+    gpointer data;
+};
+
+struct _ObPromptAnswer {
+    const gchar *text;
+    gint result;
 };
 
 void prompt_startup(gboolean reconfig);
 void prompt_shutdown(gboolean reconfig);
 
-ObPrompt* prompt_new(const gchar *msg, const gchar *const *answers);
+/*! Create a new prompt
+  @param answers A number of ObPromptAnswers which define the buttons which
+                 will appear in the dialog from left to right, and the result
+                 returned when they are selected.
+  @param n_answers The number of answers
+  @param default_result The result for the answer button selected by default
+  @param cancel_result The result that is given if the dialog is closed instead
+         of having a button presssed
+  @param func The callback function which is called when the dialog is closed
+         or a button is pressed
+  @param data User defined data which will be passed to the callback
+*/
+ObPrompt* prompt_new(const gchar *msg,
+                     const ObPromptAnswer *answers, gint n_answers,
+                     gint default_result, gint cancel_result,
+                     ObPromptCallback func, gpointer data);
 void prompt_ref(ObPrompt *self);
 void prompt_unref(ObPrompt *self);
 
@@ -74,5 +105,6 @@ void prompt_hide(ObPrompt *self);
 
 void prompt_key_event(ObPrompt *self, XEvent *e);
 void prompt_mouse_event(ObPrompt *self, XEvent *e);
+void prompt_cancel(ObPrompt *self);
 
 #endif