HelenOS sources

root/uspace/lib/ui/include/ui/menuentry.h

INCLUDED FROM

/*
 * Copyright (c) 2023 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup libui
 * @{
 */
/**
 * @file Menu entry
 */

#ifndef _UI_MENUENTRY_H
#define _UI_MENUENTRY_H

#include <errno.h>
#include <gfx/coord.h>
#include <io/pos_event.h>
#include <stdbool.h>
#include <types/ui/menu.h>
#include <types/ui/menuentry.h>
#include <types/ui/event.h>

extern errno_t ui_menu_entry_create(ui_menu_t *, const char *, const char *,
    ui_menu_entry_t **);
extern errno_t ui_menu_entry_sep_create(ui_menu_t *, ui_menu_entry_t **);
extern void ui_menu_entry_destroy(ui_menu_entry_t *);
extern void ui_menu_entry_set_cb(ui_menu_entry_t *, ui_menu_entry_cb_t,
    void *);
extern void ui_menu_entry_set_disabled(ui_menu_entry_t *, bool);
extern bool ui_menu_entry_is_disabled(ui_menu_entry_t *);
extern ui_menu_entry_t *ui_menu_entry_first(ui_menu_t *);
extern ui_menu_entry_t *ui_menu_entry_last(ui_menu_t *);
extern ui_menu_entry_t *ui_menu_entry_next(ui_menu_entry_t *);
extern ui_menu_entry_t *ui_menu_entry_prev(ui_menu_entry_t *);
extern gfx_coord_t ui_menu_entry_calc_width(ui_menu_t *,
    gfx_coord_t, gfx_coord_t);
extern void ui_menu_entry_column_widths(ui_menu_entry_t *,
    gfx_coord_t *, gfx_coord_t *);
extern gfx_coord_t ui_menu_entry_height(ui_menu_entry_t *);
extern char32_t ui_menu_entry_get_accel(ui_menu_entry_t *);
extern errno_t ui_menu_entry_paint(ui_menu_entry_t *, gfx_coord2_t *);
extern bool ui_menu_entry_selectable(ui_menu_entry_t *);
extern void ui_menu_entry_press(ui_menu_entry_t *, gfx_coord2_t *);
extern void ui_menu_entry_release(ui_menu_entry_t *);
extern void ui_menu_entry_enter(ui_menu_entry_t *, gfx_coord2_t *);
extern void ui_menu_entry_leave(ui_menu_entry_t *, gfx_coord2_t *);
extern void ui_menu_entry_activate(ui_menu_entry_t *);
extern ui_evclaim_t ui_menu_entry_pos_event(ui_menu_entry_t *, gfx_coord2_t *,
    pos_event_t *);

#endif

/** @}
 */