1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/****************************************************************************
* NxWidgets/nxwm/include/iapplicationwindow.hxx
*
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
* me be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __INCLUDE_IAPPLICATIONWINDOW_NXX
#define __INCLUDE_IAPPLICATIONWINDOW_NXX
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include "inxwindow.hxx"
#include "cnxstring.hxx"
#include "cwidgetcontrol.hxx"
#include "iapplication.hxx"
/****************************************************************************
* Pre-Processor Definitions
****************************************************************************/
/****************************************************************************
* Abstract Base Class
****************************************************************************/
#if defined(__cplusplus)
namespace NxWM
{
/**
* Foward references
*/
class IApplication;
/**
* This callback class is used by the application to get notification of toolbar
* related events.
*/
class IApplicationCallback
{
public:
/**
* Called when the window minimize button is pressed.
*/
virtual void minimize(void) = 0;
/**
* Called when the window minimize close is pressed.
*/
virtual void close(void) = 0;
};
/**
* This class represents the general application window. The actual window
* may be a contained, framed window or and unframed, fullscreen window.
*/
class IApplicationWindow
{
public:
/**
* A virtual destructor is required in order to override the IApplicationWindow
* destructor. We do this because if we delete IApplicationWindow, we want the
* destructor of the class that inherits from IApplicationWindow to run, not this
* one.
*/
virtual ~IApplicationWindow(void) { }
/**
* Initialize window. Window initialization is separate from
* object instantiation so that failures can be reported.
*
* @return True if the window was successfully initialized.
*/
virtual bool open(void) = 0;
/**
* Re-draw the application window
*/
virtual void redraw(void) = 0;
/**
* The application window is hidden (either it is minimized or it is
* maximized, but not at the top of the hierarchy)
*/
virtual void hide(void) = 0;
/**
* Recover the contained window instance
*
* @return. The window used by this application
*/
virtual NXWidgets::INxWindow *getWindow(void) const = 0;
/**
* Recover the contained widget control
*
* @return. The widget control used by this application
*/
virtual NXWidgets::CWidgetControl *getWidgetControl(void) const = 0;
/**
* Block further activity on this window in preparation for window
* shutdown.
*
* @param app. The application to be blocked
*/
virtual void block(IApplication *app) = 0;
/**
* Set the window label
*
* @param appname. The name of the application to place on the window
*/
virtual void setWindowLabel(NXWidgets::CNxString &appname) = 0;
/**
* Report of this is a "normal" window or a full screen window. The
* primary purpose of this method is so that window manager will know
* whether or not it show draw the task bar.
*
* @return True if this is a full screen window.
*/
virtual bool isFullScreen(void) const = 0;
/**
* Register to receive callbacks when toolbar icons are selected
*/
virtual void registerCallbacks(IApplicationCallback *callback) = 0;
/**
* Simulate a mouse click or release on the minimize icon. This method
* is only available for automated testing of NxWM.
*
* @param click. True to click; false to release;
*/
#if defined(CONFIG_NXWM_UNITTEST) && !defined(CONFIG_NXWM_TOUCHSCREEN)
virtual void clickMinimizePosition(bool click) = 0;
#endif
/**
* Simulate a mouse click or release on the stop icon. This method
* is only available for automated testing of NxWM.
*
* @param click. True to click; false to release;
*/
#if defined(CONFIG_NXWM_UNITTEST) && !defined(CONFIG_NXWM_TOUCHSCREEN)
virtual void clickStopIcon(bool click) = 0;
#endif
};
}
#endif // __cplusplus
#endif // __INCLUDE_IAPPLICATIONWINDOW_NXX
|
