Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'
[nikiroo-utils.git] / src / jexer / backend / TerminalReader.java
CommitLineData
7b5261bc
KL
1/*
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
7b5261bc 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
7b5261bc 7 *
e16dda65
KL
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
7b5261bc 14 *
e16dda65
KL
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
7b5261bc 17 *
e16dda65
KL
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
7b5261bc
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
42873e30
KL
29package jexer.backend;
30
31import java.util.List;
32
33import jexer.event.TInputEvent;
7b5261bc
KL
34
35/**
42873e30 36 * TerminalReader provides keyboard and mouse events.
7b5261bc 37 */
42873e30
KL
38public interface TerminalReader {
39
40 /**
41 * Check if there are events in the queue.
42 *
43 * @return if true, getEvents() has something to return to the backend
44 */
45 public boolean hasEvents();
46
47 /**
48 * Classes must provide an implementation to get keyboard, mouse, and
49 * screen resize events.
50 *
51 * @param queue list to append new events to
52 */
53 public void getEvents(List<TInputEvent> queue);
54
55 /**
56 * Classes must provide an implementation that closes sockets, restores
57 * console, etc.
58 */
59 public void closeTerminal();
60
88a99379
KL
61 /**
62 * Set listener to a different Object.
63 *
64 * @param listener the new listening object that run() wakes up on new
65 * input
66 */
67 public void setListener(final Object listener);
68
e23ea538
KL
69 /**
70 * Reload options from System properties.
71 */
72 public void reloadOptions();
73
42873e30 74}