container.h

Go to the documentation of this file.

/* ========================================================================= */
#ifndef __WLMTK_CONTAINER_H__
#define __WLMTK_CONTAINER_H__
 
#include <stdbool.h>
#include <wayland-server-core.h>
 
#include "libbase/libbase.h"
 
struct _wlmtk_container_t;
struct _wlmtk_container_vmt_t;
struct wlr_scene_tree;
typedef struct _wlmtk_container_t wlmtk_container_t;
typedef struct _wlmtk_container_vmt_t wlmtk_container_vmt_t;
 
#include "element.h"
#include "input.h"
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
struct _wlmtk_container_vmt_t {
    bool (*update_layout)(wlmtk_container_t *container_ptr);
};
 
struct _wlmtk_container_t {
    wlmtk_element_t           super_element;
    wlmtk_element_vmt_t       orig_super_element_vmt;
 
    wlmtk_container_vmt_t     vmt;
 
    bs_dllist_t               elements;
 
    struct wlr_scene_tree     *wlr_scene_tree_ptr;
 
    struct wl_listener        wlr_scene_tree_node_destroy_listener;
    struct wl_listener        element_pointer_leave_listener;
 
    wlmtk_element_t           *pointer_focus_element_ptr;
    wlmtk_element_t           *pointer_grab_element_ptr;
    wlmtk_element_t           *left_button_element_ptr;
    wlmtk_element_t           *keyboard_focus_element_ptr;
 
    bool                      inhibit_layout_update;
};
 
bool wlmtk_container_init(wlmtk_container_t *container_ptr);
 
wlmtk_container_vmt_t wlmtk_container_extend(
    wlmtk_container_t *container_ptr,
    const wlmtk_container_vmt_t *container_vmt_ptr);
 
bool wlmtk_container_init_attached(
    wlmtk_container_t *container_ptr,
    struct wlr_scene_tree *root_wlr_scene_tree_ptr);
 
void wlmtk_container_fini(
    wlmtk_container_t *container_ptr);
 
void wlmtk_container_add_element(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr);
 
void wlmtk_container_add_element_atop(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *reference_element_ptr,
    wlmtk_element_t *element_ptr);
 
void wlmtk_container_remove_element(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr);
 
void wlmtk_container_raise_element_to_top(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr);
 
// TODO(kaeser@gubbe.ch): Unify handling with pointer grab.
bool wlmtk_container_request_pointer_focus(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr,
    wlmtk_pointer_motion_event_t *motion_event_ptr);
 
// TODO(kaeser@gubbe.ch): Merge with @ref wlmtk_container_request_pointer_focus.
void wlmtk_container_pointer_grab(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr);
 
void wlmtk_container_pointer_grab_release(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr);
 
 
void wlmtk_container_set_keyboard_focus_element(
    wlmtk_container_t *container_ptr,
    wlmtk_element_t *element_ptr,
    bool enabled);
 
void wlmtk_container_update_layout_and_pointer_focus(
    wlmtk_container_t *container_ptr);
 
struct wlr_scene_tree *wlmtk_container_wlr_scene_tree(
    wlmtk_container_t *container_ptr);
 
extern const bs_test_case_t wlmtk_container_test_cases[];
 
wlmtk_container_t *wlmtk_container_create_fake_parent(void);
void wlmtk_container_destroy_fake_parent(wlmtk_container_t *container_ptr);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif /* __WLMTK_CONTAINER_H__ */
/* == End of container.h =================================================== */