Mercurial > molko

annotate libmlk-ui/mlk/ui/ui.h @ 646:7e1eb7f6c049 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: remove .clang
author David Demelier <markand@malikania.fr>
date Sun, 04 Feb 2024 15:24:37 +0100
parents c2b62ff38224
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * ui.h -- libui convenient header
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 433
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_UI_UI_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_UI_UI_H
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
431
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
22 #include <mlk/core/core.h>
603
ed1d3244ed57 ui: start re-working delegates
David Demelier <markand@malikania.fr>
parents: 534
diff changeset
23 #include <mlk/core/font.h>
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
24
507
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
25 /* TODO: make this a global variable to allow modification of default theme. */
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
26 /* https://lospec.com/palette-list/duel */
534
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
27 #define MLK_UI_COLOR_TEXT (0x222323ff)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
28 #define MLK_UI_COLOR_SELECTED (0x55b67dff)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
29 #define MLK_UI_COLOR_BG (0xf5f7faff)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
30 #define MLK_UI_COLOR_BORDER (0xcdd2daff)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
31 #define MLK_UI_COLOR_DEBUG (0xe45c5fff)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
32
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
33 #define MLK_UI_PADDING (10)
88e9bd420a28 rpg: add delegate/style support to mlk_message
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
34 #define MLK_UI_BORDER (2)
507
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
35
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
36 enum mlk_align;
614
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
37 enum mlk_window_theme;
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
38
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
39 union mlk_event;
507
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
40
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
41 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
42 * \enum mlk_ui_font
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
43 * \brief Predefined font alias.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
44 */
505
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
45 enum mlk_ui_font {
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
46 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
47 * Font for UI elements.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
48 */
505
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
49 MLK_UI_FONT_INTERFACE,
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
50
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
51 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
52 * Unused sentinel value.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
53 */
505
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
54 MLK_UI_FONT_LAST
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
55 };
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
56
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
57 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
58 * \brief Global array of predefined fonts.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
59 */
603
ed1d3244ed57 ui: start re-working delegates
David Demelier <markand@malikania.fr>
parents: 534
diff changeset
60 extern struct mlk_font mlk_ui_fonts[MLK_UI_FONT_LAST];
505
6100c643dba0 ui: finally ditch theme
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
61
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
62 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
63 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
64 #endif
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
65
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
66 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
67 * Initialize the libmlk-ui library.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
68 */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
69 int
497
8d5a266a1774 ui: ui -> mlk_ui
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
70 mlk_ui_init(void);
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
72 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
73 * Handle an event in the libmlk-ui library.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
74 *
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
75 * This function is required to adjust global parameters such as dark/light
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
76 * theme if desired.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
77 *
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
78 * \pre ev != NULL
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
79 * \param ev the event
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
80 */
614
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
81 void
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
82 mlk_ui_handle(const union mlk_event *ev);
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
83
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
84 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
85 * Apply the light or dark theme to the predefined UI elements.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
86 *
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
87 * \pre theme must be ::MLK_WINDOW_THEME_DARK or ::MLK_WINDOW_THEME_LIGHT
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
88 * \param theme new theme to set
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
89 */
614
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
90 void
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
91 mlk_ui_set_theme(enum mlk_window_theme theme);
281608524dd1 misc: implement dark/light theming
David Demelier <markand@malikania.fr>
parents: 603
diff changeset
92
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
93 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
94 * Convenient helper to draw and align text directly on the current rendering
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
95 * target.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
96 *
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
97 * \pre font != NULL
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
98 * \pre text != NULL and not empty
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
99 * \param align alignment into the destination region
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
100 * \param font the font to use
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
101 * \param color the text color
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
102 * \param text the text to show
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
103 * \param x the x coordinate
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
104 * \param y the y coordinate
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
105 * \param w the rectangle destination width
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
106 * \param h the rectangle destination height
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
107 */
507
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
108 void
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
109 mlk_ui_draw_text(enum mlk_align align,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
110 struct mlk_font *font,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
111 unsigned long color,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
112 const char *text,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
113 int x,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
114 int y,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
115 unsigned int w,
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
116 unsigned int h);
d49a05e7a5b5 ui: separate delegate/style
David Demelier <markand@malikania.fr>
parents: 505
diff changeset
117
628
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
118 /**
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
119 * Cleanup resources allocated by the library.
c2b62ff38224 ui: improve documentation (ui.h)
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
120 */
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 void
497
8d5a266a1774 ui: ui -> mlk_ui
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
122 mlk_ui_finish(void);
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
123
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
124 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
125 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 507
diff changeset
126 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
127
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
128 #endif /* !MLK_UI_UI_H */