4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2006 Develer S.r.l. (http://www.develer.com/)
34 * \author Bernie Innocenti <bernie@codewiz.org>
36 * \brief Very simple hierarchical windowing system.
38 * All functions in this module are to be intended as methods
39 * of the Window class. Please see its documentation
40 * for a module-wise introduction.
47 *#* Revision 1.2 2006/08/01 17:26:04 batt
50 *#* Revision 1.1 2006/08/01 15:43:01 batt
51 *#* Add in board_kd current edited channel visualization.
53 *#* Revision 1.4 2006/07/19 12:56:26 bernie
54 *#* Convert to new Doxygen style.
56 *#* Revision 1.3 2006/02/10 12:25:41 bernie
57 *#* Add missing header.
59 *#* Revision 1.2 2006/01/26 00:36:48 bernie
60 *#* Const correctness for some new functions.
62 *#* Revision 1.1 2006/01/23 23:14:29 bernie
63 *#* Implement simple, but impressive windowing system.
68 #include <struct/list.h>
71 * Map the contents of all child-windows into the bitmap of \a w.
73 * \note Recursively drawing children into their parent
74 * effectively damages the parent buffer.
76 void win_compose(Window *w)
81 * Walk over all children, in back to front order and tell them
84 REVERSE_FOREACH_NODE(child, &w->children)
86 /* Recursively compose child first. */
89 /* Draw child into our bitmap. */
91 gfx_blit(w->bitmap, &child->geom, child->bitmap, 0, 0);
96 * Map window \a w into \a parent.
98 * The new window becomes the topmost window.
100 * \note Opening a window twice is illegal.
104 void win_open(Window *w, Window *parent)
108 ADDHEAD(&parent->children, &w->link);
112 * Detach window from its parent.
114 * Closing a window causes it to become orphan of its
115 * parent. Its content will no longer appear in its
116 * parent after the next refresh cycle.
118 * \note Closing a window that has not been previously
123 void win_close(Window *w)
131 * Move window to the topmost position relative to its sibling.
133 * \see win_move(), win_resize(), win_setGeometry()
135 void win_raise(Window *w)
139 ADDHEAD(&w->parent->children, &w->link);
143 * Set window position and size at the same time.
145 * This function is equivalent to subsequent calls to win_move()
146 * and win_resize() using the coordinates provided by the
147 * \a new_geom rectangle.
149 * \note The xmax and ymax members of \a new_geom are non-inclusive,
150 * as usual for the Rect interface.
155 void win_setGeometry(Window *w, const Rect *new_geom)
158 // memcpy(&w->geom, new_geom, sizeof(w->geom));
163 * Move window to specified position.
165 * Move the window top-left corner to the pixel coordinates
166 * \a left and \a top, which are relative to the parent window.
168 * \note A window can also be moved outside the borders
169 * of its parent, or at negative coordinates.
171 * \note It is allowed to move an orphan window.
173 void win_move(Window *w, coord_t left, coord_t top)
179 r.xmax = r.xmin + RECT_WIDTH(&w->geom);
180 r.ymax = r.ymin + RECT_WIDTH(&w->geom);
182 win_setGeometry(w, &r);
186 * Resize the rectangle of a window.
188 * The window shrinks or grows to the specified size.
190 * \note Growing a window beyond the size of its
191 * backing bitmap results in unspecified behavior.
193 * \note It is allowed to resize an orphan window.
195 void win_resize(Window *w, coord_t width, coord_t height)
199 r.xmin = w->geom.xmin;
200 r.ymin = w->geom.ymin;
201 r.xmax = r.xmin + width;
202 r.ymax = r.ymin + height;
204 win_setGeometry(w, &r);
208 * Initialize a new window structure.
210 * The new window initial position is set to (0,0).
211 * The size is set to the size of the installed bitmap,
212 * or (0,0) if there's no backing store.
214 * \arg bm The bitmap to install as backing store
215 * for drawing into the window, or NULL if
216 * the window is not drawable.
218 void win_create(Window *w, Bitmap *bm)
226 w->geom.xmax = bm->width;
227 w->geom.ymax = bm->height;
229 LIST_INIT(&w->children);