panel.h

Go to the documentation of this file.

/* ========================================================================= */
#ifndef __WLMTK_PANEL_H__
#define __WLMTK_PANEL_H__
 
#include <libbase/libbase.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "container.h"  // IWYU pragma: keep
#include "element.h"
 
typedef struct _wlmtk_panel_t wlmtk_panel_t;
typedef struct _wlmtk_panel_vmt_t wlmtk_panel_vmt_t;
typedef struct _wlmtk_panel_positioning_t wlmtk_panel_positioning_t;
 
#include "layer.h"  // IWYU pragma: keep
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
struct _wlmtk_panel_vmt_t {
    uint32_t (*request_size)(
        wlmtk_panel_t *panel_ptr,
        int width,
        int height);
};
 
struct _wlmtk_panel_positioning_t {
    int                       desired_width;
    int                       desired_height;
    uint32_t                  anchor;
 
    int                       margin_left;
    int                       margin_right;
    int                       margin_top;
    int                       margin_bottom;
 
    int                       exclusive_zone;
};
 
struct _wlmtk_panel_t {
    wlmtk_container_t         super_container;
    wlmtk_panel_vmt_t         vmt;
 
    wlmtk_container_t         popup_container;
 
    wlmtk_layer_t             *layer_ptr;
    wlmtk_layer_output_t      *layer_output_ptr;
    bs_dllist_node_t          dlnode;
 
    wlmtk_panel_positioning_t positioning;
};
 
bool wlmtk_panel_init(
    wlmtk_panel_t *panel_ptr,
    const wlmtk_panel_positioning_t *positioning_ptr);
 
void wlmtk_panel_fini(wlmtk_panel_t *panel_ptr);
 
wlmtk_panel_vmt_t wlmtk_panel_extend(
    wlmtk_panel_t *panel_ptr,
    const wlmtk_panel_vmt_t *panel_vmt_ptr);
 
wlmtk_element_t *wlmtk_panel_element(wlmtk_panel_t *panel_ptr);
 
bs_dllist_node_t *wlmtk_dlnode_from_panel(wlmtk_panel_t *panel_ptr);
wlmtk_panel_t *wlmtk_panel_from_dlnode(bs_dllist_node_t *dlnode_ptr);
 
void wlmtk_panel_set_layer(wlmtk_panel_t *panel_ptr,
                           wlmtk_layer_t *layer_ptr);
 
wlmtk_layer_t *wlmtk_panel_get_layer(wlmtk_panel_t *panel_ptr);
 
void wlmtk_panel_set_layer_output(
    wlmtk_panel_t *panel_ptr,
    wlmtk_layer_output_t *layer_output_ptr);
 
wlmtk_layer_output_t *wlmtk_panel_get_layer_output(wlmtk_panel_t *panel_ptr);
 
static inline uint32_t wlmtk_panel_request_size(
    wlmtk_panel_t *panel_ptr,
    int width,
    int height) {
    return panel_ptr->vmt.request_size(panel_ptr, width, height);
}
 
void wlmtk_panel_commit(
    wlmtk_panel_t *panel_ptr,
    uint32_t serial,
    const wlmtk_panel_positioning_t *positioning_ptr);
 
struct wlr_box wlmtk_panel_compute_dimensions(
    const wlmtk_panel_t *panel_ptr,
    const struct wlr_box *full_area_ptr,
    struct wlr_box *usable_area_ptr);
 
extern const bs_test_case_t wlmtk_panel_test_cases[];
 
typedef struct _wlmtk_fake_panel_t wlmtk_fake_panel_t;
struct _wlmtk_fake_panel_t {
    wlmtk_panel_t             panel;
    uint32_t                  serial;
    int                       requested_width;
    int                       requested_height;
};
wlmtk_fake_panel_t *wlmtk_fake_panel_create(
    const wlmtk_panel_positioning_t *positioning_ptr);
void wlmtk_fake_panel_destroy(wlmtk_fake_panel_t *fake_panel_ptr);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif /* __WLMTK_PANEL_H__ */
/* == End of panel.h ======================================================= */