Mercurial > molko
annotate libmlk-ui/ui/frame.h @ 292:08ab73b32832
misc: add extern "C" {} blocks for C++ friends
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 05 Mar 2021 10:08:09 +0100 |
parents | 71b3b7036de7 |
children | 196264679079 |
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 * frame.h -- GUI frame |
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_FRAME_H |
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
20 #define MOLKO_UI_FRAME_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 frame.h |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief GUI frame. |
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 |
292
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
diff
changeset
|
28 #include <core/core.h> |
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
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 Frame style. |
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 frame_style { |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 FRAME_STYLE_NORMAL, |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 FRAME_STYLE_BOX |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 }; |
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 * \brief GUI frame. |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 */ |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 struct frame { |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
45 int x; /*!< (+) Position in x. */ |
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
46 int y; /*!< (+) Position in y. */ |
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
47 unsigned int w; /*!< (+) Width. */ |
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
48 unsigned int h; /*!< (+) Height. */ |
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
49 enum frame_style style; /*!< (+) Frame style. */ |
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
50 const struct theme *theme; /*!< (+&?) Theme to use. */ |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 }; |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 |
292
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
diff
changeset
|
53 CORE_BEGIN_DECLS |
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
diff
changeset
|
54 |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 /** |
151
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
56 * Default drawing function. |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
57 * |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
58 * \pre t != NULL |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
59 * \pre frame != NULL |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
60 * \param t the theme |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
61 * \param frame the frame |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
62 */ |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
63 void |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
152
diff
changeset
|
64 frame_draw_default(const struct theme *t, const struct frame *frame); |
151
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
65 |
b19d076856d2
ui: cleanup theme module, closes #2498
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
66 /** |
99
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 * Draw the frame. |
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 * \pre frame != NULL |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 * \param frame the frame to draw |
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 void |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 frame_draw(const struct frame *frame); |
4ac71ac10c9f
core: start adding some UI elements
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 |
152
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
75 /** |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
76 * Convert the frame into an action. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
77 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
78 * 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
|
79 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
80 * - act->data: points to frame (reference), |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
81 * - act->draw: a wrapper to checkbox_draw. |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
82 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
83 * The frame 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
|
84 * 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
|
85 * |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
86 * \pre frame != NULL |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
87 * \pre act != NULL |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
88 * \param frame the frame to reference |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
89 * \param act the action to fill |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
90 */ |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
91 void |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
92 frame_action(struct frame *frame, struct action *act); |
1008a796a9e7
ui: make UI widgets usable as actions
David Demelier <markand@malikania.fr>
parents:
151
diff
changeset
|
93 |
292
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
diff
changeset
|
94 CORE_END_DECLS |
08ab73b32832
misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents:
243
diff
changeset
|
95 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
96 #endif /* !MOLKO_UI_FRAME_H */ |