source: mainline/uspace/app/nav/panel.h@ be1d74c1

serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since be1d74c1 was be1d74c1, checked in by jxsvoboda <5887334+jxsvoboda@…>, 4 years ago

Cursor movement (up, down, to top, to bottom)

  • Property mode set to 100644
File size: 3.7 KB
Line 
1/*
2 * Copyright (c) 2021 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 <adt/list.h>
40#include <errno.h>
41#include <gfx/color.h>
42#include <gfx/coord.h>
43#include <io/kbd_event.h>
44#include <io/pos_event.h>
45#include <ui/control.h>
46#include <ui/window.h>
47#include <stdint.h>
48#include "nav.h"
49#include "panel.h"
50
51/** Panel entry */
52typedef struct {
53 /** Containing panel */
54 struct panel *panel;
55 /** Link to @c panel->entries */
56 link_t lentries;
57 /** File name */
58 char *name;
59 /** File size */
60 uint64_t size;
61} panel_entry_t;
62
63/** Navigator panel
64 *
65 * This is a custom UI control.
66 */
67typedef struct panel {
68 /** Base control object */
69 struct ui_control *control;
70
71 /** Containing window */
72 ui_window_t *window;
73
74 /** Panel rectangle */
75 gfx_rect_t rect;
76
77 /** Panel color */
78 gfx_color_t *color;
79
80 /** Panel cursor color */
81 gfx_color_t *curs_color;
82
83 /** Panel entries (list of panel_entry_t) */
84 list_t entries;
85
86 /** Number of entries */
87 size_t entries_cnt;
88
89 /** First entry of current page */
90 panel_entry_t *page;
91
92 /** Index of first entry of current page */
93 size_t page_idx;
94
95 /** Cursor position */
96 panel_entry_t *cursor;
97
98 /** Index of entry under cursor */
99 size_t cursor_idx;
100} panel_t;
101
102extern errno_t panel_create(ui_window_t *, panel_t **);
103extern void panel_destroy(panel_t *);
104extern errno_t panel_entry_paint(panel_entry_t *, size_t);
105extern errno_t panel_paint(panel_t *);
106extern ui_evclaim_t panel_kbd_event(panel_t *, kbd_event_t *);
107extern ui_evclaim_t panel_pos_event(panel_t *, pos_event_t *);
108extern ui_control_t *panel_ctl(panel_t *);
109extern void panel_set_rect(panel_t *, gfx_rect_t *);
110extern errno_t panel_entry_append(panel_t *, const char *, uint64_t);
111extern void panel_entry_delete(panel_entry_t *);
112extern void panel_clear_entries(panel_t *);
113extern errno_t panel_read_dir(panel_t *, const char *);
114extern panel_entry_t *panel_first(panel_t *);
115extern panel_entry_t *panel_last(panel_t *);
116extern panel_entry_t *panel_next(panel_entry_t *);
117extern panel_entry_t *panel_prev(panel_entry_t *);
118extern void panel_cursor_move(panel_t *, panel_entry_t *, size_t);
119extern void panel_cursor_up(panel_t *);
120extern void panel_cursor_down(panel_t *);
121extern void panel_cursor_top(panel_t *);
122extern void panel_cursor_bottom(panel_t *);
123
124#endif
125
126/** @}
127 */
Note: See TracBrowser for help on using the repository browser.