Merge branch 'backport' into work
[dana/openbox.git] / openbox / prompt.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    prompt.h for the Openbox window manager
4    Copyright (c) 2008        Dana Jansens
5
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.
10
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.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef ob__prompt_h
20 #define ob__prompt_h
21
22 #include "window.h"
23 #include "geom.h"
24 #include "obrender/render.h"
25 #include <glib.h>
26 #include <X11/Xlib.h>
27
28 typedef struct _ObPrompt       ObPrompt;
29 typedef struct _ObPromptElement ObPromptElement;
30 typedef struct _ObPromptAnswer ObPromptAnswer;
31
32 typedef gboolean (*ObPromptCallback)(ObPrompt *p, gint result, gpointer data);
33 typedef void (*ObPromptCleanup)(ObPrompt *p, gpointer data);
34
35 struct _ObPromptElement {
36     gchar *text;
37     Window window;
38
39     gint x, y, width, height;
40     gboolean pressed;
41     gboolean hover;
42     gint result;
43 };
44
45 struct _ObPrompt
46 {
47     ObInternalWindow super;
48     gint ref;
49
50     guint event_mask;
51
52     /* keep a copy of this because we re-render things that may need it
53        (i.e. the buttons) */
54     RrAppearance *a_bg;
55
56     gboolean mapped;
57     gint width, height;
58     gint msg_wbound;
59
60     ObPromptElement msg;
61
62     /* one for each answer */
63     ObPromptElement *button;
64     gint n_buttons;
65
66     /* points to the button with the focus */
67     ObPromptElement *focus;
68     /* the default button to have selected */
69     gint default_result;
70     /* the cancel result if the dialog is closed */
71     gint cancel_result;
72
73     ObPromptCallback func;
74     ObPromptCleanup cleanup;
75     gpointer data;
76 };
77
78 struct _ObPromptAnswer {
79     const gchar *text;
80     gint result;
81 };
82
83 void prompt_startup(gboolean reconfig);
84 void prompt_shutdown(gboolean reconfig);
85
86 /*! Create a new prompt
87   @param answers A number of ObPromptAnswers which define the buttons which
88                  will appear in the dialog from left to right, and the result
89                  returned when they are selected.
90   @param n_answers The number of answers
91   @param default_result The result for the answer button selected by default
92   @param cancel_result The result that is given if the dialog is closed instead
93          of having a button presssed
94   @param func The callback function which is called when the dialog is closed
95          or a button is pressed
96   @param cleanup The cleanup function which is called if the prompt system
97          is shutting down, and someone is still holding a reference to the
98          prompt.  This callback should cause the prompt's refcount to go to
99          zero so it can be freed, and free any other memory associated with
100          the prompt.  The cleanup function is also called if the prompt's
101          callback function returns TRUE.
102   @param data User defined data which will be passed to the callback
103 */
104 ObPrompt* prompt_new(const gchar *msg, const gchar *title,
105                      const ObPromptAnswer *answers, gint n_answers,
106                      gint default_result, gint cancel_result,
107                      ObPromptCallback func, ObPromptCleanup cleanup,
108                      gpointer data);
109 void prompt_ref(ObPrompt *self);
110 void prompt_unref(ObPrompt *self);
111
112 /*! Show the prompt.  It will be centered within the given area rectangle */
113 void prompt_show(ObPrompt *self, struct _ObClient *parent, gboolean modal);
114 void prompt_hide(ObPrompt *self);
115
116 gboolean prompt_key_event(ObPrompt *self, XEvent *e);
117 gboolean prompt_mouse_event(ObPrompt *self, XEvent *e);
118 void prompt_cancel(ObPrompt *self);
119
120 ObPrompt* prompt_show_message(const gchar *msg, const gchar *title,
121                               const gchar *answer);
122
123 #endif