annotate src/libmlk-ui/ui/notify.h @ 327:42a6710629f5

ui: implement notifications
author David Demelier <markand@malikania.fr>
date Sun, 03 Oct 2021 10:31:45 +0200
parents
children 19782ea1cf4a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
327
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * notify.h -- in game notifications
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020-2021 David Demelier <markand@malikania.fr>
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_UI_NOTIFY_H
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_UI_NOTIFY_H
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stddef.h>
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include <core/core.h>
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #define NOTIFY_MAX (4)
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #define NOTIFY_TIMEOUT_DEFAULT (5000)
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct texture;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 struct theme;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 struct notify {
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 const struct texture *icon;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 const char *title;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 const char *body;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 unsigned int elapsed;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 };
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 struct notify_system {
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 struct theme *theme;
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 void (*draw)(const struct notify *, size_t);
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 };
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 CORE_BEGIN_DECLS
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 void
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 notify(const struct texture *, const char *, const char *);
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 void
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 notify_update(unsigned int ticks);
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 void
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 notify_draw(void);
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 void
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 notify_set_system(const struct notify_system *);
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 CORE_END_DECLS
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
42a6710629f5 ui: implement notifications
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 #endif /*! MOLKO_UI_NOTIFY_H */