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
|
/* ========================================================================= */
/**
* @file dock.h
*
* @copyright
* Copyright 2024 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_DOCK_H__
#define __WLMTK_DOCK_H__
#include <libbase/libbase.h>
#define WLR_USE_UNSTABLE
#include <wlr/util/edges.h>
#undef WLR_USE_UNSTABLE
#include "element.h"
#include "panel.h"
#include "style.h"
#include "tile.h"
/** Forward declaration: Dock handle. */
typedef struct _wlmtk_dock_t wlmtk_dock_t;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Positioning options for the dock. */
typedef struct {
/** Principal edge the dock aligns to. Must not be WLR_EDGE_NONE. */
enum wlr_edges edge;
/** Dock anchor, along @ref wlmtk_dock_positioning_t::edge. */
enum wlr_edges anchor;
} wlmtk_dock_positioning_t;
/**
* Creates a dock. A dock contains icons, launchers and the likes.
*
* The dock is an implementation of a @ref wlmtk_panel_t.
*
* @param dock_positioning_ptr
* @param style_ptr
*
* @return The dock handle, or NULL on error. Must be destroyed calling
* @ref wlmtk_dock_destroy.
*/
wlmtk_dock_t *wlmtk_dock_create(
const wlmtk_dock_positioning_t *dock_positioning_ptr,
const wlmtk_dock_style_t *style_ptr);
/**
* Destroys the dock.
*
* @param dock_ptr
*/
void wlmtk_dock_destroy(wlmtk_dock_t *dock_ptr);
/**
* Adds the tile to the dock.
*
* @param dock_ptr
* @param tile_ptr
*/
void wlmtk_dock_add_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr);
/**
* Removes the tile from the dock.
*
* @param dock_ptr
* @param tile_ptr
*/
void wlmtk_dock_remove_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr);
/** @return Pointer to the superclass @ref wlmtk_panel_t of `dock_ptr`. */
wlmtk_panel_t *wlmtk_dock_panel(wlmtk_dock_t *dock_ptr);
/** @return Pointer to the superclass @ref wlmtk_element_t of `dock_ptr`. */
wlmtk_element_t *wlmtk_dock_element(wlmtk_dock_t *dock_ptr);
/** Unit tests for @ref wlmtk_dock_t. */
extern const bs_test_case_t wlmtk_dock_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_DOCK_H__ */
/* == End of dock.h ======================================================== */
|
