source: mainline/uspace/lib/ui/include/ui/window.h@ 5de852c

serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 5de852c was 5de852c, checked in by Jiri Svoboda <jiri@…>, 4 years ago

Coordinate keyboard event delivery between application and UI framework

If an application sets its own keyboard event handler, it needs to call
ui_window_def_kbd() to deliver events to the window's UI control tree.
Menubar should be able to capture these events so that they are not
accidentally acted upon by the application keyboard handler.

  • Property mode set to 100644
File size: 3.0 KB
Line 
1/*
2 * Copyright (c) 2021 Jiri Svoboda
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libui
30 * @{
31 */
32/**
33 * @file Window
34 */
35
36#ifndef _UI_WINDOW_H
37#define _UI_WINDOW_H
38
39#include <errno.h>
40#include <gfx/context.h>
41#include <gfx/coord.h>
42#include <io/kbd_event.h>
43#include <io/pos_event.h>
44#include <types/ui/control.h>
45#include <types/ui/ui.h>
46#include <types/ui/resource.h>
47#include <types/ui/window.h>
48
49extern void ui_wnd_params_init(ui_wnd_params_t *);
50extern errno_t ui_window_create(ui_t *, ui_wnd_params_t *,
51 ui_window_t **);
52extern void ui_window_set_cb(ui_window_t *, ui_window_cb_t *, void *);
53extern errno_t ui_window_set_caption(ui_window_t *, const char *);
54extern void ui_window_destroy(ui_window_t *);
55extern void ui_window_add(ui_window_t *, ui_control_t *);
56extern void ui_window_remove(ui_window_t *, ui_control_t *);
57extern ui_window_t *ui_window_get_active(ui_t *);
58extern errno_t ui_window_resize(ui_window_t *, gfx_rect_t *);
59extern ui_t *ui_window_get_ui(ui_window_t *);
60extern ui_resource_t *ui_window_get_res(ui_window_t *);
61extern gfx_context_t *ui_window_get_gc(ui_window_t *);
62extern errno_t ui_window_get_pos(ui_window_t *, gfx_coord2_t *);
63extern errno_t ui_window_get_app_gc(ui_window_t *, gfx_context_t **);
64extern void ui_window_get_app_rect(ui_window_t *, gfx_rect_t *);
65extern void ui_window_set_ctl_cursor(ui_window_t *, ui_stock_cursor_t);
66extern errno_t ui_window_paint(ui_window_t *);
67extern ui_evclaim_t ui_window_def_kbd(ui_window_t *, kbd_event_t *);
68extern errno_t ui_window_def_paint(ui_window_t *);
69extern void ui_window_def_pos(ui_window_t *, pos_event_t *);
70extern void ui_window_def_unfocus(ui_window_t *);
71
72#endif
73
74/** @}
75 */
Note: See TracBrowser for help on using the repository browser.