base data structures
[nikiroo-utils.git] / src / jexer / event / TKeypressEvent.java
1 /**
2 * Jexer - Java Text User Interface
3 *
4 * Version: $Id$
5 *
6 * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
7 *
8 * License: LGPLv3 or later
9 *
10 * Copyright: This module is licensed under the GNU Lesser General
11 * Public License Version 3. Please see the file "COPYING" in this
12 * directory for more information about the GNU Lesser General Public
13 * License Version 3.
14 *
15 * Copyright (C) 2015 Kevin Lamonte
16 *
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Lesser General Public License
19 * as published by the Free Software Foundation; either version 3 of
20 * the License, or (at your option) any later version.
21 *
22 * This program is distributed in the hope that it will be useful, but
23 * WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 * General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public
28 * License along with this program; if not, see
29 * http://www.gnu.org/licenses/, or write to the Free Software
30 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
31 * 02110-1301 USA
32 */
33 package jexer.event;
34
35 import jexer.TKeypress;
36
37 /**
38 * This class encapsulates a keyboard input event.
39 */
40 public class TKeypressEvent extends TInputEvent {
41
42 /**
43 * Keystroke received
44 */
45 public TKeypress key;
46
47 /**
48 * Public contructor
49 */
50 public TKeypressEvent() {
51 key = new TKeypress(false, 0, ' ', false, false, false);
52 }
53
54 /**
55 * Public contructor
56 *
57 * @param key the TKeypress received
58 */
59 public TKeypressEvent(TKeypress key) {
60 this.key = key;
61 }
62
63 /**
64 * Make human-readable description of this event
65 */
66 @Override
67 public String toString() {
68 return String.format("Keypress: %s", key.toString());
69 }
70 }