1#ifndef SO@GUI@_KEYBOARD_H
2#define SO@GUI@_KEYBOARD_H
3
4// @configure_input@
5
6/**************************************************************************\
7 * Copyright (c) Kongsberg Oil & Gas Technologies AS
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions are
12 * met:
13 *
14 * Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 *
17 * Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 *
21 * Neither the name of the copyright holder nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36\**************************************************************************/
37
38#include <Inventor/@Gui@/devices/So@Gui@Device.h>
39
40class SoKeyboardEvent;
41
42// *************************************************************************
43
44#define SO_@GUI@_ALL_KEYBOARD_EVENTS So@Gui@Keyboard::ALL
45
46class SO@GUI@_DLL_API So@Gui@Keyboard : public So@Gui@Device {
47  SO@GUI@_OBJECT_HEADER(So@Gui@Keyboard, So@Gui@Device);
48
49public:
50  enum Events {
51    KEY_PRESS = 0x01,
52    KEY_RELEASE = 0x02,
53    ALL_EVENTS = KEY_PRESS | KEY_RELEASE
54  };
55
56  So@Gui@Keyboard(int eventmask = ALL_EVENTS);
57  virtual ~So@Gui@Keyboard(void);
58
59  virtual void enable(@WIDGET@ widget, So@Gui@EventHandler * handler, void * closure);
60  virtual void disable(@WIDGET@ widget, So@Gui@EventHandler * handler, void * closure);
61
62  virtual const SoEvent * translateEvent(@EVENT@ event);
63
64private:
65  class So@Gui@KeyboardP * pimpl;
66  friend class So@Gui@KeyboardP;
67  friend class SoGuiKeyboardP;
68};
69
70// *************************************************************************
71
72#endif // ! SO@GUI@_KEYBOARD_H
73