Doc fixes.
[bertos.git] / dt / editbool.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
30  * -->
31  *
32  * \version $Id$
33  *
34  * \brief Edit bool widget (implementation).
35  * This widget handles boolean editing.
36  * The boolean value will be displayed using two strings:
37  * one when the bool is false and one when it's true.
38  *
39  * \version $Id$
40  * \author Francesco Sacchi <batt@ðeveler.com>
41  */
42
43 /*#*
44  *#* $Log$
45  *#* Revision 1.2  2006/07/19 12:56:26  bernie
46  *#* Convert to new Doxygen style.
47  *#*
48  *#* Revision 1.1  2005/11/04 18:26:38  bernie
49  *#* Import into DevLib.
50  *#*
51  *#* Revision 1.3  2005/06/08 17:32:33  batt
52  *#* Switch to new messaging system.
53  *#*
54  *#* Revision 1.2  2005/06/06 11:04:12  batt
55  *#* Add some comments.
56  *#*
57  *#* Revision 1.1  2005/05/31 11:11:37  batt
58  *#* Edit bool: first release.
59  *#*
60  *#*/
61
62 #include <mware/editbool.h>
63 #include <dt/dtag.h>
64
65 #include <drv/lcd_text.h>
66
67 /**
68  * Init widget.
69  */
70 void editbool_init(DEditBool *e, dpos_t pos, dpos_t size, dcontext_t *context, bool *value, const char *true_string, const char *false_string)
71 {
72         // Initialize superclass
73         widget_init(&e->widget, pos, size, context);
74
75         // Override superclass methods
76         e->widget.notifier.update = (update_func_ptr)editbool_update;
77
78         // Init instance
79         e->value = value;
80         e->true_string = true_string;
81         e->false_string = false_string;
82         e->draw = editbool_draw;
83 }
84
85 /**
86  * Handle the messages (edit the bool).
87  */
88 void editbool_update(DEditBool *e, dtag_t tag, dval_t _val)
89 {
90         bool changed = false;
91
92         switch (tag)
93         {
94         case TAG_SETVALUE:
95                 *e->value = (bool)_val;
96                 changed = true;
97                 break;
98
99         case TAG_TOGGLE:
100                 *e->value = !*e->value;
101                 changed = true;
102                 break;
103         default:
104                 break;
105         }
106
107         if (changed)
108         {
109                 e->draw(e);
110                 dnotify_targets(&e->widget.notifier, TAG_SETVALUE, (dval_t)*e->value);
111         }
112 }
113
114 /**
115  * Draw the string on the context.
116  */
117 void editbool_draw(DEditBool *e)
118 {
119         lcd_printf((Layer *)e->widget.context, (lcdpos_t)e->widget.pos, LCD_NORMAL, "%*s", (int)e->widget.size , *e->value? e->true_string: e->false_string);
120 }