base.h File Reference

#include <libbase/libbase.h>
#include <stdbool.h>
#include "container.h"
#include "element.h"

Include dependency graph for base.h:

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

Go to the source code of this file.

Classes
struct	_wlmtk_base_t

Typedefs
typedef struct _wlmtk_base_t	wlmtk_base_t

Functions
bool	wlmtk_base_init (wlmtk_base_t *base_ptr, wlmtk_element_t *element_ptr)
void	wlmtk_base_fini (wlmtk_base_t *base_ptr)
wlmtk_element_t *	wlmtk_base_element (wlmtk_base_t *base_ptr)
void	wlmtk_base_set_content_element (wlmtk_base_t *base_ptr, wlmtk_element_t *content_element_ptr)
void	wlmtk_base_push_element (wlmtk_base_t *base_ptr, wlmtk_element_t *element_ptr)
void	wlmtk_base_pop_element (wlmtk_base_t *base_ptr, wlmtk_element_t *element_ptr)

Variables
const bs_test_case_t	wlmtk_base_test_cases []

Detailed Description

Copyright

Copyright 2025 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_base_t

typedef struct _wlmtk_base_t wlmtk_base_t

Forward declaration: State of a base element.

Function Documentation

wlmtk_base_element()

wlmtk_element_t * wlmtk_base_element

(

wlmtk_base_t *

base_ptr

)

Returns

Pointer to the superclass wlmtk_element_t of the base.

wlmtk_base_fini()

void wlmtk_base_fini

(

wlmtk_base_t *

base_ptr

)

Un-initializes the base.

Parameters

base_ptr

wlmtk_base_init()

bool wlmtk_base_init	(	wlmtk_base_t *	base_ptr,
		wlmtk_element_t *	element_ptr
	)

Initializes the base with the given element.

Parameters

base_ptr
element_ptr	is added to wlmtk_base_t::super_container until wlmtk_base_fini is called. Will take ownership. May be NULL.

Returns

true on success.

wlmtk_base_pop_element()

void wlmtk_base_pop_element	(	wlmtk_base_t *	base_ptr,
		wlmtk_element_t *	element_ptr
	)

Removes a stacked element.

wlmtk_base_push_element()

void wlmtk_base_push_element	(	wlmtk_base_t *	base_ptr,
		wlmtk_element_t *	element_ptr
	)

Adds a stacked element (eg. a popup)

wlmtk_base_set_content_element()

void wlmtk_base_set_content_element	(	wlmtk_base_t *	base_ptr,
		wlmtk_element_t *	content_element_ptr
	)

Sets wlmtk_base_t::content_element_ptr. Any earlier content element will be destroyed.

Parameters

base_ptr
content_element_ptr

Variable Documentation

wlmtk_base_test_cases

const bs_test_case_t wlmtk_base_test_cases[]

extern

Unit test cases.