source: mainline/uspace/lib/ui/private/window.h@ 1af103e

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

System menu (WIP)

The system menu provides browsable, keyboard-accessible access to window
management functions (such as closing, minimizing, maximizing, resizing,
moving).

  • Property mode set to 100644
File size: 4.1 KB
Line 
1/*
2 * Copyright (c) 2023 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 structure
34 *
35 */
36
37#ifndef _UI_PRIVATE_WINDOW_H
38#define _UI_PRIVATE_WINDOW_H
39
40#include <adt/list.h>
41#include <errno.h>
42#include <congfx/console.h>
43#include <display.h>
44#include <gfx/context.h>
45#include <io/kbd_event.h>
46#include <io/pos_event.h>
47#include <memgfx/memgc.h>
48#include <memgfx/xlategc.h>
49#include <types/common.h>
50#include <types/ui/cursor.h>
51#include <types/ui/window.h>
52
53/** Actual structure of window.
54 *
55 * This is private to libui.
56 */
57struct ui_window {
58 /** Containing user interface */
59 struct ui *ui;
60 /** Link to @c ui->windows */
61 link_t lwindows;
62 /** Callbacks */
63 struct ui_window_cb *cb;
64 /** Callback argument */
65 void *arg;
66 /** Display window */
67 display_window_t *dwindow;
68 /** Window GC */
69 gfx_context_t *gc;
70 /** Window bitmap (if client-side rendering) */
71 gfx_bitmap_t *bmp;
72 /** Window memory GC (if client-side rendering) */
73 mem_gc_t *mgc;
74 /** Translating GC (if full screen & server-side rendering) */
75 xlate_gc_t *xgc;
76 /** Real window GC (if client-side rendering) */
77 gfx_context_t *realgc;
78 /** Window rectangle */
79 gfx_rect_t rect;
80 /** Normal window rectangle (when not maximized) */
81 gfx_rect_t normal_rect;
82 /** Display position (if fullscreen mode) */
83 gfx_coord2_t dpos;
84 /** Application area bitmap */
85 gfx_bitmap_t *app_bmp;
86 /** Application area memory GC */
87 mem_gc_t *app_mgc;
88 /** Application area GC */
89 gfx_context_t *app_gc;
90 /** Dirty rectangle */
91 gfx_rect_t dirty_rect;
92 /** UI resource. Ideally this would be in ui_t. */
93 struct ui_resource *res;
94 /** Window decoration */
95 struct ui_wdecor *wdecor;
96 /** System menu */
97 struct ui_menu *sysmenu;
98 /** Top-level control in the application area */
99 struct ui_control *control;
100 /** Current cursor */
101 ui_stock_cursor_t cursor;
102 /** Window placement */
103 ui_wnd_placement_t placement;
104};
105
106/** Size change operation */
107typedef enum {
108 /** Resize window */
109 ui_wsc_resize,
110 /** Maximize window */
111 ui_wsc_maximize,
112 /** Unmaximize window */
113 ui_wsc_unmaximize
114} ui_wnd_sc_op_t;
115
116extern display_stock_cursor_t wnd_dcursor_from_cursor(ui_stock_cursor_t);
117extern void ui_window_send_sysmenu(ui_window_t *, sysarg_t);
118extern void ui_window_send_minimize(ui_window_t *);
119extern void ui_window_send_maximize(ui_window_t *);
120extern void ui_window_send_unmaximize(ui_window_t *);
121extern void ui_window_send_close(ui_window_t *);
122extern void ui_window_send_focus(ui_window_t *, unsigned);
123extern void ui_window_send_kbd(ui_window_t *, kbd_event_t *);
124extern errno_t ui_window_send_paint(ui_window_t *);
125extern void ui_window_send_pos(ui_window_t *, pos_event_t *);
126extern void ui_window_send_unfocus(ui_window_t *, unsigned);
127extern errno_t ui_window_size_change(ui_window_t *, gfx_rect_t *,
128 ui_wnd_sc_op_t);
129
130#endif
131
132/** @}
133 */
Note: See TracBrowser for help on using the repository browser.