NXWidgets: cwindoweventhandler.hxx Source File

NXWidgets 1.19

cwindoweventhandler.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/cwindoweventhandler.hxx
3 *
4 * Copyright (C) 2012 Gregory Nutt. All rights reserved.
5 * Author: Gregory Nutt <gnutt@nuttx.org>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
18 * me be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************/
35
36 #ifndef __INCLUDE_CWINDOWEVENTHANDLER_HXX
37 #define __INCLUDE_CWINDOWEVENTHANDLER_HXX
38
39 /****************************************************************************
40 * Included Files
41 ****************************************************************************/
42
43 #include "nxconfig.hxx"
44
45 /****************************************************************************
46 * Pre-Processor Definitions
47 ****************************************************************************/
48
49 /****************************************************************************
50 * Implementation Classes
51 ****************************************************************************/
52
53 #if defined(__cplusplus)
54
55 namespace NXWidgets
56 {
57 class CNxWidget;
58
59 /**
60 * Base CWindowEventHandler class, intended to be subclassed. Any class that
61 * needs to listen for window events should inherit from this class.
62 */
63
64 class CWindowEventHandler
65 {
66 public:
67 /**
68 * Constructor.
69 */
70
71 inline CWindowEventHandler() { }
72
73 /**
74 * Destructor.
75 */
76
77 virtual inline ~CWindowEventHandler() { }
78
79 /**
80 * Handle a NX window redraw request event
81 */
82
83 virtual void handleRedrawEvent(void) { }
84
85 /**
86 * Handle a NX window position/size change event
87 */
88
89 virtual void handleGeometryEvent(void) { }
90
91 /**
92 * Handle an NX window mouse input event.
93 *
94 * @param e The event data.
95 */
96
97 #ifdef CONFIG_NX_XYINPUT
98 virtual void handleMouseEvent(void) { }
99 #endif
100
101 /**
102 * Handle a NX window keyboard input event.
103 */
104
105 #ifdef CONFIG_NX_KBD
106 virtual void handleKeyboardEvent(void) { }
107 #endif
108
109 /**
110 * Handle a NX window blocked event
111 *
112 * @param arg - User provided argument (see nx_block or nxtk_block)
113 */
114
115 virtual void handleBlockedEvent(FAR void *arg) { }
116 };
117 }
118
119 #endif // __cplusplus
120
121 #endif // __INCLUDE_CWINDOWEVENTHANDLER_HXX
NXWidgets::CWindowEventHandler::~CWindowEventHandler
virtual ~CWindowEventHandler()
Definition: cwindoweventhandler.hxx:77
NXWidgets::CWindowEventHandler::handleBlockedEvent
virtual void handleBlockedEvent(FAR void *arg)
Definition: cwindoweventhandler.hxx:115
NXWidgets::CWindowEventHandler::CWindowEventHandler
CWindowEventHandler()
Definition: cwindoweventhandler.hxx:71
NXWidgets::CWindowEventHandler::handleGeometryEvent
virtual void handleGeometryEvent(void)
Definition: cwindoweventhandler.hxx:89
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::CWindowEventHandler::handleMouseEvent
virtual void handleMouseEvent(void)
Definition: cwindoweventhandler.hxx:98
NXWidgets::CWindowEventHandler::handleRedrawEvent
virtual void handleRedrawEvent(void)
Definition: cwindoweventhandler.hxx:83
nxconfig.hxx
NXWidgets::CWindowEventHandler
Definition: cwindoweventhandler.hxx:64
NXWidgets::CWindowEventHandler::handleKeyboardEvent
virtual void handleKeyboardEvent(void)
Definition: cwindoweventhandler.hxx:106