uspace/app/nav/panel.h

   1 /*
   2  * Copyright (c) 2022 Jiri Svoboda
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup nav
  30  * @{
  31  */
  32 /**
  33  * @file Navigator panel
  34  */
  35
  36 #ifndef PANEL_H
  37 #define PANEL_H
  38
  39 #include <errno.h>
  40 #include <gfx/coord.h>
  41 #include <io/kbd_event.h>
  42 #include <io/pos_event.h>
  43 #include <ui/control.h>
  44 #include <ui/window.h>
  45 #include <stdbool.h>
  46 #include "types/panel.h"
  47
  48 extern errno_t panel_create(ui_window_t *, bool, panel_t **);
  49 extern void panel_destroy(panel_t *);
  50 extern void panel_set_cb(panel_t *, panel_cb_t *, void *);
  51 extern errno_t panel_paint(panel_t *);
  52 extern ui_evclaim_t panel_kbd_event(panel_t *, kbd_event_t *);
  53 extern ui_evclaim_t panel_pos_event(panel_t *, pos_event_t *);
  54 extern ui_control_t *panel_ctl(panel_t *);
  55 extern void panel_set_rect(panel_t *, gfx_rect_t *);
  56 extern bool panel_is_active(panel_t *);
  57 extern errno_t panel_activate(panel_t *);
  58 extern void panel_deactivate(panel_t *);
  59 extern errno_t panel_read_dir(panel_t *, const char *);
  60 extern void panel_activate_req(panel_t *);
  61
  62 #endif
  63
  64 /** @}
  65  */