summaryrefslogtreecommitdiff
path: root/client/widgets/widget.h
blob: f2bf278a04504a0b401f0a54c66bea4e635afdb8 (plain)
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/***************************************************************************
 *            widget.h
 *
 *  Tue Jul 17 12:15:59 CEST 2007
 *  Copyright 2007 Bent Bisballe Nyeng and Lars Bisballe Jensen
 *  deva@aasimon.org and elsenator@gmail.com
 ****************************************************************************/

/*
 *  This file is part of Pracro.
 *
 *  Pracro is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  Pracro is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Pracro; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */
#ifndef __PRACRO_WIDGET_H__
#define __PRACRO_WIDGET_H__

#include <QString>
#include <QDomNode>
#include <QRegExp>
#include <QObject>
#include <QVector>
#include <QFrame>

#include "lua.h"

#ifdef LUA_CLASS
#undef LUA_CLASS
#endif
#define LUA_CLASS "Widget"

/***
 * Virtual Base Widget
 * This tag is purely virtual. It is inherited by all other widgets.
 * @clientside
 * @att name The name of the widget. This is also the name used by the scripts.
 * @att value The initial value of the widget. It is overwritten if there is a
 * map with a recent value or if the database contains a recent value. 
 * @att onChange Change event script callback. This attribute contains script
 *  code that are executed each time the widget is changed.
 * @att onInit Init event script callback. This attribute contains script code
 *  that are executed when the widget has just been created.
 * @att map This attribute binds the value of the widget to a map.
 * @att width Use this attribute to set the width of the widget to a fixed
 *  value.
 * @att height Use this attribute to set the height of the widget to a fixed
 *  value.
 * @att help This attribute contains a help text for this widget. It will be
 *  shown to the user when the mouse is hovering over the widget.
 * @att local This attribute is a boolean telling wether the field can be stored
 *  in the database on commits. It can be either 'true' or 'false'. The default
 *  is 'false'.
 * @att colour The foreground (text) colour of the widget. The value must be a
 * 6 byte hexadecimal string with each 2 byte pair describing the colour
 * channels in order: Red, green blue. Example: '0f1a3b'.
 * @att bgcolour The background colour of the widget. The value must be a
 * 6 byte hexadecimal string with each 2 byte pair describing the colour
 * channels in order: Red, green blue. Example: '0f1a3b'.
 */

class QLayout;
class MacroWindow;
class LUA;
class Widget;
class Widget : public QObject {
Q_OBJECT
public:
  Widget(QDomNode &node, MacroWindow *macrowindow);
  virtual ~Widget();

  QString name();
  QString type();
  bool local();

  virtual QString luaclass() { return LUA_CLASS; }

  virtual QString value() = 0;
  virtual void setValue(QString value, QString source) = 0;

  // Set deep to true to validate inner widgets.
  bool valid(bool deep = false);
  void setValid(bool valid, bool deep = false);

  // Make sanity check before commit.
  bool committable(bool deep = false);

  // Implement in subclasses to contribute to the validation.
  virtual bool preValid() { return true; }

  // Implement in subclasses to change widget according to validation status.
  virtual void setWdgValid(bool valid) = 0;

  virtual void setEnabled(bool enabled);
  virtual bool enabled();

  virtual void setVisible(bool visible);
  virtual bool visible();

  virtual void setHidden(bool hidden);
  virtual bool hidden();

  virtual bool setKeyboardFocus();
  bool setKeyboardFocusRecursive();

  virtual void setForegroundColour(unsigned char red,
                                   unsigned char green,
                                   unsigned char blue);
  virtual void setBackgroundColour(unsigned char red,
                                   unsigned char green,
                                   unsigned char blue);

  virtual QWidget *qwidget() { return widget; }
  
  // Set deep to true to search through inner widgets.
  Widget *findWidget(QString name, bool deep = false);
  QVector< Widget* > widgetList(bool deep = false);
  void addChild(Widget *widget);

  virtual void setValues();

signals:
  void wasChanged();

  /*
   * LUA scripting events:
   */
  void eventOnChange(bool deep = false);
  void eventOnInit(bool deep = false);

public slots:
  void childWasChanged();
  void runEventOnChange(bool deep = false);
  void runEventOnInit(bool deep = false);

protected:
  QWidget *widget;
  bool hideChildren;

  // Implement in subclasses to be able to block commits.
  virtual bool preCommit() { return true; }

  // Overload this to avoid children 'wasChanged' connection.
  virtual void connectChild(Widget *child);
  void addChildren(QDomNode &xml_node, QLayout *layout);

  LUA *lua;

  void createWidget(QDomNode &xml_node, QLayout *layout);
  QVector< Widget* > children;

  void setWdgValidRecursive(bool valid);

  // Store value in constructor to be set later.
  bool has_lazy;
  QString lazy_value;
  QString lazy_source;

  bool is_valid;
  QString widget_name;
  QString widget_type;
  bool widget_local;

  MacroWindow *macrowindow;

  bool hasOnChangeEvent;
  QString onChangeEventScript;

  bool hasOnInitEvent;
  QString onInitEventScript;

  QFrame *replwidget;
};

/***
 * @method string name()
 * This method is used to get the name of the widget. This name is the same as
 * the one specified in the <code>name</code> attribute.
 * @return a string containing the name of the widget.
 */
int wdg_name(lua_State *L);

/***
 * @method string type()
 * This method is used to get the type of the widget. This type is the same as
 * the widget tagname and can be used by script to verify the type before
 * calling any type specific methods.
 * @return a string containing the type of the widget.
 */
int wdg_type(lua_State *L);

/***
 * @method string value()
 * This method is used to get the current value of the widget.
 * @return a string containing the value of the widget.
 */
int wdg_value(lua_State *L);

/***
 * @method nil setValue(string value)
 * This method is used to set the value of the widget.
 * @param value A string containing the value to set.
 */
int wdg_set_value(lua_State *L);

/***
 * @method boolean enabled()
 * This method is used to get the current enable state of the widget.
 * @return a boolean value. If the widget is enabled the method returns true
 * otherwise it returns false.
 */
int wdg_enabled(lua_State *L);

/***
 * @method nil setEnabled(boolean enabled)
 * This method is used to either enable (make editable) or disable (grey out)
 * the widget. <em>NOTE</em>: A disabled widget will not supply its value to
 * the server during a commit.
 * @param enabled A boolean value. If true the widget is enabled. If false the
 * widget is disabled.
 */
int wdg_set_enabled(lua_State *L);

/***
 * @method boolean visible()
 * This method is used to get the current visibility state of the widget.
 * @return a boolean value. If the widget is visible the method returns true
 * otherwise it returns false.
 */
int wdg_visible(lua_State *L);

/***
 * @method nil setVisible(boolean visible)
 * This method is used to either show or hide the widget. 
 * The widget will take up an equal amount of layout space regardless of its
 * visibility state meaning that the layout will remain static after a
 * hiding/showing of the widget.
 * <em>NOTE</em>: An invisble widget will not supply its value to the server
 * during a commit.
 * @param visible A boolean value. If true the widget is shown. If false the
 * widget is hidden.
 */
int wdg_set_visible(lua_State *L);

/***
 * @method boolean hidden()
 * This method is used to get the current hide state of the widget.
 * @return a boolean value. If the widget is hidden the method returns true
 * otherwise it returns false.
 */
int wdg_hidden(lua_State *L);

/***
 * @method nil setHidden(boolean hidden)
 * This method is used to either show or hide the widget, collapsing the occupied
 * space.
 * <em>NOTE</em>: A hidden widget will not supply its value to the server
 * during a commit.
 * @param hidden A boolean value. If true the widget is hidden. If false the
 * widget is shown.
 */
int wdg_set_hidden(lua_State *L);

/***
 * @method boolean valid()
 * This method is used to get the current validity state of the widget. See
 * also @see setValid().
 * @return a boolean value. If the widget is valid the method returns true
 * otherwise it returns false.
 */
int wdg_valid(lua_State *L);

/***
 * @method nil setValid(boolean valid)
 * This method is used to set the widgets validity state. Most widgets have a
 * visual indication of their validity state (a red background colour for
 * example) and this will also be set using this method. See also @see valid().
 * <em>NOTE</em>: An invalid widget that are not an inner widget will block a
 * server commit.
 * @param valid A boolean value. If true the widgets validity state is set to
 * 'valid'. If false the widgets validity state is set to 'invalid'.
 */
int wdg_set_valid(lua_State *L);

/***
 * @method nil setBackgroundColour(integer red, integer green, integer blue)
 * This method is used to change to background colour of the widget.
 * @param red An integer value in the range 0-255. This is the red component of
 * the RGB colour value.
 * @param green An integer value in the range 0-255. This is the green component
 * of the RGB colour value.
 * @param blue An integer value in the range 0-255. This is the blue component
 * of the RGB colour value.
 */
int wdg_set_bgcol(lua_State *L);

/***
 * @method nil setForegroundColour(integer red, integer green, integer blue)
 * This method is used to change to foreground (text) colour of the widget.
 * @param red An integer value in the range 0-255. This is the red component of
 * the RGB colour value.
 * @param green An integer value in the range 0-255. This is the green component
 * of the RGB colour value.
 * @param blue An integer value in the range 0-255. This is the blue component
 * of the RGB colour value.
 */
int wdg_set_fgcol(lua_State *L);

#define WDG_METHS \
  {"name", wdg_name},\
  {"type", wdg_type},\
  {"value", wdg_value},\
  {"setValue", wdg_set_value},\
  {"enabled", wdg_enabled},\
  {"setEnabled", wdg_set_enabled},\
  {"visible", wdg_visible},\
  {"setVisible", wdg_set_visible},\
  {"hidden", wdg_hidden},\
  {"setHidden", wdg_set_hidden},\
  {"valid", wdg_valid},\
  {"setValid", wdg_set_valid},\
  {"setForegroundColour", wdg_set_fgcol},\
  {"setBackgroundColour", wdg_set_bgcol}

const struct luaL_Reg wdg_meths[] =
  { WDG_METHS, {NULL, NULL} };

inline void register_widget(lua_State *L)
{
  luaL_newmetatable(L, LUA_CLASS);
  lua_pushliteral(L, "__index");
  lua_pushvalue(L, -2);
  lua_rawset(L, -3);
  luaL_register(L, NULL, wdg_meths);
}

#endif/*__PRACRO_WIDGET_H__*/