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
|
/* ========================================================================= */
/**
* @file rectangle.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_RECTANGLE_H__
#define __WLMTK_RECTANGLE_H__
#include <libbase/libbase.h>
#include <stdint.h>
#include "element.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Rectangle state. */
typedef struct _wlmtk_rectangle_t wlmtk_rectangle_t;
/**
* Creates a rectangle. Useful for margins and borders.
*
* @param width
* @param height
* @param color
*
* @return Pointer to the rectangle state or NULL on error.
*/
wlmtk_rectangle_t *wlmtk_rectangle_create(
int width,
int height,
uint32_t color);
/**
* Destroys the rectangle.
*
* @param rectangle_ptr
*/
void wlmtk_rectangle_destroy(wlmtk_rectangle_t *rectangle_ptr);
/**
* Sets (or updates) the size of the rectangle.
*
* @param rectangle_ptr
* @param width
* @param height
*/
void wlmtk_rectangle_set_size(
wlmtk_rectangle_t *rectangle_ptr,
int width,
int height);
/**
* Sets (or updates) the color of the rectangle.
*
* @param rectangle_ptr
* @param color
*/
void wlmtk_rectangle_set_color(
wlmtk_rectangle_t *rectangle_ptr,
uint32_t color);
/** Returns the superclass @ref wlmtk_element_t of the rectangle. */
wlmtk_element_t *wlmtk_rectangle_element(wlmtk_rectangle_t *rectangle_ptr);
/**
* Gets the @ref wlmtk_rectangle_t instance from it's element superclass.
*
* Requires `element_ptr` as pointer to @ref wlmtk_rectangle_t::super_element.
*
* @param element_ptr
*
* @return The pointer to the @ref wlmtk_rectangle_t instance.
*/
wlmtk_rectangle_t *wlmtk_rectangle_from_element(wlmtk_element_t *element_ptr);
/** Unit tests. */
extern const bs_test_case_t wlmtk_rectangle_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_RECTANGLE_H__ */
/* == End of rectangle.h =================================================== */
|
