Mercurial > molko
annotate libmlk-ui/ui/button.h @ 261:bfde372bf152
core: prefix utilities with util_
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 06 Dec 2020 23:06:34 +0100 |
parents | 71b3b7036de7 |
children | 08ab73b32832 |
rev | line source |
---|---|
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * button.h -- GUI button |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
19 #ifndef MOLKO_UI_BUTTON_H |
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
20 #define MOLKO_UI_BUTTON_H |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file button.h |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief GUI button. |
152
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
25 * \ingroup ui |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 union event; |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
152
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
30 struct action; |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 struct theme; |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 /** |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * \brief Button state. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 enum button_state { |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 BUTTON_STATE_NONE, /*!< Button is inactive. */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 BUTTON_STATE_PRESSED, /*!< Button is currently pressed. */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 BUTTON_STATE_ACTIVATED /*!< Button is considered activated. */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 }; |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 /** |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 * \brief GUI button. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 struct button { |
147
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
46 int x; /*!< (+) Position in x. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
47 int y; /*!< (+) Position in y. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
48 unsigned int w; /*!< (+) Width. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
49 unsigned int h; /*!< (+) Height. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
50 const char *text; /*!< (+&) Text to draw. */ |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
51 enum button_state state; /*!< (+) Button state. */ |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
52 const struct theme *theme; /*!< (+&?) Theme to use. */ |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 }; |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 /** |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 * Handle the event. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 * You should always call this function even if the event is completely |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 * unrelated. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 * \pre button != NULL |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 * \pre ev != NULL |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 * \param button the button |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 * \param ev the event |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 void |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 button_handle(struct button *button, const union event *ev); |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 /** |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 * Use this function once the button has been considered activated. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 * \pre button != NULL |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 * \param button the button |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 void |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 button_reset(struct button *button); |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 /** |
151
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
79 * Default drawing function. |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
80 * |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
81 * \pre t != NULL |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
82 * \pre frame != NULL |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
83 * \param t the theme |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
84 * \param button the button |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
85 */ |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
86 void |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
87 button_draw_default(const struct theme *t, const struct button *button); |
151
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
88 |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
89 /** |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 * Draw the button. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 * |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 * \pre button != NULL |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 * \param button the button |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 void |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
96 button_draw(const struct button *button); |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 |
152
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
98 /** |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
99 * Convert the button into an action. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
100 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
101 * The following field will be set into the action: |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
102 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
103 * - act->data: points to button (reference), |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
104 * - act->handle: a wrapper to button_handle, |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
105 * - act->draw: a wrapper to button_draw. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
106 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
107 * The button being an UI element is considered to never completes, as such |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
108 * you will need to handle this case or to use a custom update function. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
109 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
110 * \note You will still need to check the button state and reset it at some |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
111 * point. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
112 * \pre button != NULL |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
113 * \pre act != NULL |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
114 * \param button the button to reference |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
115 * \param act the action to fill |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
116 */ |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
117 void |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
118 button_action(struct button *button, struct action *act); |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
119 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
120 #endif /* !MOLKO_UI_BUTTON_H */ |