dock.h File Reference

#include <libbase/libbase.h>
#include <libbase/plist.h>
#include <stdbool.h>
#include <wlr/util/edges.h>
#include "element.h"
#include "panel.h"
#include "style.h"
#include "tile.h"

Include dependency graph for dock.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	wlmtk_dock_positioning_t
struct	wlmtk_dock_style

Typedefs
typedef struct _wlmtk_dock_t	wlmtk_dock_t

Functions
wlmtk_dock_t *	wlmtk_dock_create (const wlmtk_dock_positioning_t *dock_positioning_ptr, const struct wlmtk_dock_style *style_ptr)
void	wlmtk_dock_destroy (wlmtk_dock_t *dock_ptr)
bool	wlmtk_dock_set_style (wlmtk_dock_t *dock_ptr, const struct wlmtk_dock_style *style_ptr, const struct wlmtk_tile_style *tile_style_ptr)
void	wlmtk_dock_add_tile (wlmtk_dock_t *dock_ptr, wlmtk_tile_t *tile_ptr)
void	wlmtk_dock_remove_tile (wlmtk_dock_t *dock_ptr, wlmtk_tile_t *tile_ptr)
wlmtk_panel_t *	wlmtk_dock_panel (wlmtk_dock_t *dock_ptr)
wlmtk_element_t *	wlmtk_dock_element (wlmtk_dock_t *dock_ptr)

Variables
const bspl_desc_t	wlmtk_dock_style_desc []
const bs_test_set_t	wlmtk_dock_test_set

Detailed Description

Copyright

Copyright (c) 2026 Philipp Kaeser (kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h) 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.

Typedef Documentation

wlmtk_dock_t

typedef struct _wlmtk_dock_t wlmtk_dock_t

Forward declaration: Dock handle.

Function Documentation

wlmtk_dock_add_tile()

void wlmtk_dock_add_tile	(	wlmtk_dock_t *	dock_ptr,
		wlmtk_tile_t *	tile_ptr
	)

Adds the tile to the dock.

Parameters

dock_ptr
tile_ptr

wlmtk_dock_create()

wlmtk_dock_t * wlmtk_dock_create	(	const wlmtk_dock_positioning_t *	dock_positioning_ptr,
		const struct wlmtk_dock_style *	style_ptr
	)

Creates a dock. A dock contains icons, launchers and the likes.

The dock is an implementation of a wlmtk_panel_t.

Parameters

dock_positioning_ptr
style_ptr

Returns

The dock handle, or NULL on error. Must be destroyed calling wlmtk_dock_destroy.

wlmtk_dock_destroy()

void wlmtk_dock_destroy

(

wlmtk_dock_t *

dock_ptr

)

Destroys the dock.

Parameters

dock_ptr

wlmtk_dock_element()

wlmtk_element_t * wlmtk_dock_element

(

wlmtk_dock_t *

dock_ptr

)

Returns

Pointer to the superclass wlmtk_element_t of dock_ptr.

wlmtk_dock_panel()

wlmtk_panel_t * wlmtk_dock_panel

(

wlmtk_dock_t *

dock_ptr

)

Returns

Pointer to the superclass wlmtk_panel_t of dock_ptr.

wlmtk_dock_remove_tile()

void wlmtk_dock_remove_tile	(	wlmtk_dock_t *	dock_ptr,
		wlmtk_tile_t *	tile_ptr
	)

Removes the tile from the dock.

Parameters

dock_ptr
tile_ptr

wlmtk_dock_set_style()

bool wlmtk_dock_set_style	(	wlmtk_dock_t *	dock_ptr,
		const struct wlmtk_dock_style *	style_ptr,
		const struct wlmtk_tile_style *	tile_style_ptr
	)

Sets the style for the dock, including all contained tiles.

Parameters

dock_ptr
style_ptr
tile_style_ptr

Returns

true on success.

Variable Documentation

wlmtk_dock_style_desc

const bspl_desc_t wlmtk_dock_style_desc[]

extern

Plist decoding descriptor of the dock's style.

wlmtk_dock_test_set

const bs_test_set_t wlmtk_dock_test_set

extern

Unit tests for wlmtk_dock_t.