* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
[emacs.git] / lwlib / lwlib-utils.c
blob0b14933110ccbf4ba855c21ee2aa813401e6a744
1 /* Defines some widget utility functions.
2 Copyright (C) 1992 Lucid, Inc.
3 Copyright (C) 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
4 2010, 2011 Free Software Foundation, Inc.
6 This file is part of the Lucid Widget Library.
8 The Lucid Widget Library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 1, or (at your option)
11 any later version.
13 The Lucid Widget Library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
27 /* Definitions of these in config.h can cause
28 declaration conflicts later on between declarations for index
29 and declarations for strchr. This file doesn't use
30 index and rindex, so cancel them. */
31 #undef index
32 #undef rindex
34 #include <setjmp.h>
35 #include "../src/lisp.h"
37 #include <X11/Xatom.h>
38 #include <X11/IntrinsicP.h>
39 #include <X11/ObjectP.h>
40 #include "lwlib-utils.h"
41 #include "lwlib.h"
43 /* Redisplay the contents of the widget, without first clearing it. */
44 void
45 XtNoClearRefreshWidget (widget)
46 Widget widget;
48 XEvent event;
50 event.type = Expose;
51 event.xexpose.serial = 0;
52 event.xexpose.send_event = 0;
53 event.xexpose.display = XtDisplay (widget);
54 event.xexpose.window = XtWindow (widget);
55 event.xexpose.x = 0;
56 event.xexpose.y = 0;
57 event.xexpose.width = widget->core.width;
58 event.xexpose.height = widget->core.height;
59 event.xexpose.count = 0;
61 (*widget->core.widget_class->core_class.expose)
62 (widget, &event, (Region)NULL);
67 * Apply a function to all the subwidgets of a given widget recursively.
69 void
70 XtApplyToWidgets (w, proc, arg)
71 Widget w;
72 XtApplyToWidgetsProc proc;
73 XtPointer arg;
75 if (XtIsComposite (w))
77 CompositeWidget cw = (CompositeWidget) w;
78 /* We have to copy the children list before mapping over it, because
79 the procedure might add/delete elements, which would lose badly.
81 int nkids = cw->composite.num_children;
82 Widget *kids = (Widget *) malloc (sizeof (Widget) * nkids);
83 int i;
84 lwlib_bcopy ((char *) cw->composite.children, (char *) kids,
85 sizeof (Widget) * nkids);
86 for (i = 0; i < nkids; i++)
87 /* This prevent us from using gadgets, why is it here? */
88 /* if (XtIsWidget (kids [i])) */
90 /* do the kiddies first in case we're destroying */
91 XtApplyToWidgets (kids [i], proc, arg);
92 proc (kids [i], arg);
94 free (kids);
100 * Apply a function to all the subwidgets of a given widget recursively.
101 * Stop as soon as the function returns non NULL and returns this as a value.
103 void *
104 XtApplyUntilToWidgets (w, proc, arg)
105 Widget w;
106 XtApplyUntilToWidgetsProc proc;
107 XtPointer arg;
109 void* result;
110 if (XtIsComposite (w))
112 CompositeWidget cw = (CompositeWidget)w;
113 int i;
114 for (i = 0; i < cw->composite.num_children; i++)
115 if (XtIsWidget (cw->composite.children [i])){
116 result = proc (cw->composite.children [i], arg);
117 if (result)
118 return result;
119 result = XtApplyUntilToWidgets (cw->composite.children [i], proc,
120 arg);
121 if (result)
122 return result;
125 return NULL;
130 * Returns a copy of the list of all children of a composite widget
132 Widget *
133 XtCompositeChildren (widget, number)
134 Widget widget;
135 unsigned int* number;
137 CompositeWidget cw = (CompositeWidget)widget;
138 Widget* result;
139 int n;
140 int i;
142 if (!XtIsComposite (widget))
144 *number = 0;
145 return NULL;
147 n = cw->composite.num_children;
148 result = (Widget*)XtMalloc (n * sizeof (Widget));
149 *number = n;
150 for (i = 0; i < n; i++)
151 result [i] = cw->composite.children [i];
152 return result;
155 Boolean
156 XtWidgetBeingDestroyedP (widget)
157 Widget widget;
159 return widget->core.being_destroyed;
162 void
163 XtSafelyDestroyWidget (widget)
164 Widget widget;
166 #if 0
168 /* this requires IntrinsicI.h (actually, InitialI.h) */
170 XtAppContext app = XtWidgetToApplicationContext(widget);
172 if (app->dispatch_level == 0)
174 app->dispatch_level = 1;
175 XtDestroyWidget (widget);
176 /* generates an event so that the event loop will be called */
177 XChangeProperty (XtDisplay (widget), XtWindow (widget),
178 XA_STRING, XA_STRING, 32, PropModeAppend, NULL, 0);
179 app->dispatch_level = 0;
181 else
182 XtDestroyWidget (widget);
184 #else
185 abort ();
186 #endif
189 /* arch-tag: f21f0a1f-2a4e-44e1-8715-7f234fe2d159
190 (do not change this comment) */