1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/* ========================================================================= */
/**
* @file surface.h
*
* @copyright
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __WLMTK_SURFACE_H__
#define __WLMTK_SURFACE_H__
#include <libbase/libbase.h>
#include <stdbool.h>
#include <wayland-server-core.h>
/** Forward declaration: State of a toolkit's WLR surface. */
typedef struct _wlmtk_surface_t wlmtk_surface_t;
/** Forward declaration: Virtual method table of the toolkit's WLR surface. */
typedef struct _wlmtk_surface_vmt_t wlmtk_surface_vmt_t;
#include "element.h"
/** Forward declaration. */
struct wlr_seat;
struct wlr_surface;
struct wlr_xdg_surface;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a toolkit surface from the `wlr_surface_ptr`.
*
* @param wlr_surface_ptr
* @param wlr_seat_ptr
*
* @return A pointer to the @ref wlmtk_surface_t. Must be destroyed by calling
* @ref wlmtk_surface_destroy.
*/
wlmtk_surface_t *wlmtk_surface_create(
struct wlr_surface *wlr_surface_ptr,
struct wlr_seat *wlr_seat_ptr);
/**
* Creates a toolkit surface from the XDG surface `wlr_xdg_surface_ptr`.
*
* TODO(kaeser@gubbe.ch): Merge with @ref wlmtk_surface_create.
*
* @param wlr_xdg_surface_ptr
* @param wlr_seat_ptr
*
* @return A pointer to the @ref wlmtk_surface_t. Must be destroyed by calling
* @ref wlmtk_surface_destroy.
*/
wlmtk_surface_t *wlmtk_xdg_surface_create(
struct wlr_xdg_surface *wlr_xdg_surface_ptr,
struct wlr_seat *wlr_seat_ptr);
/**
* Destroys the toolkit surface.
*
* @param surface_ptr
*/
void wlmtk_surface_destroy(wlmtk_surface_t *surface_ptr);
/**
* Returns a pointer to the surface's element superclass instance.
*
* @param surface_ptr
*
* @return Pointer to the corresponding @ref wlmtk_element_t.
*/
wlmtk_element_t *wlmtk_surface_element(wlmtk_surface_t *surface_ptr);
/**
* Returns committed size of the surface.
*
* @param surface_ptr
* @param width_ptr
* @param height_ptr
*/
void wlmtk_surface_get_size(
wlmtk_surface_t *surface_ptr,
int *width_ptr,
int *height_ptr);
/**
* Activates the surface.
*
* @param surface_ptr
* @param activated
*/
void wlmtk_surface_set_activated(
wlmtk_surface_t *surface_ptr,
bool activated);
/** @return Whether the surface is activated. */
bool wlmtk_surface_is_activated(wlmtk_surface_t *surface_ptr);
/** Connects a listener and handler to the `map` signal of `wlr_surface`. */
void wlmtk_surface_connect_map_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler);
/** Connects a listener and handler to the `unmap` signal of `wlr_surface`. */
void wlmtk_surface_connect_unmap_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_surface_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_SURFACE_H__ */
/* == End of surface.h ===================================================== */
|
