(no-conversion): Fix docstring.
[emacs.git] / lwlib / lwlib-utils.c
blobdcc0b42ca54665c62a5f5676d15dcf44d444fa31
1 /* Defines some widget utility functions.
2 Copyright (C) 1992 Lucid, Inc.
4 This file is part of the Lucid Widget Library.
6 The Lucid Widget Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 1, or (at your option)
9 any later version.
11 The Lucid Widget Library 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 GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #ifdef HAVE_CONFIG_H
22 #include <config.h>
23 #endif
25 /* Definitions of these in config.h can cause
26 declaration conflicts later on between declarations for index
27 and declarations for strchr. This file doesn't use
28 index and rindex, so cancel them. */
29 #undef index
30 #undef rindex
32 #include <X11/Xatom.h>
33 #include <X11/IntrinsicP.h>
34 #include <X11/ObjectP.h>
35 #include "lwlib-utils.h"
36 #include "lwlib.h"
38 /* Redisplay the contents of the widget, without first clearing it. */
39 void
40 XtNoClearRefreshWidget (widget)
41 Widget widget;
43 XEvent event;
45 event.type = Expose;
46 event.xexpose.serial = 0;
47 event.xexpose.send_event = 0;
48 event.xexpose.display = XtDisplay (widget);
49 event.xexpose.window = XtWindow (widget);
50 event.xexpose.x = 0;
51 event.xexpose.y = 0;
52 event.xexpose.width = widget->core.width;
53 event.xexpose.height = widget->core.height;
54 event.xexpose.count = 0;
56 (*widget->core.widget_class->core_class.expose)
57 (widget, &event, (Region)NULL);
61 /*
62 * Apply a function to all the subwidgets of a given widget recursively.
64 void
65 XtApplyToWidgets (w, proc, arg)
66 Widget w;
67 XtApplyToWidgetsProc proc;
68 XtPointer arg;
70 if (XtIsComposite (w))
72 CompositeWidget cw = (CompositeWidget) w;
73 /* We have to copy the children list before mapping over it, because
74 the procedure might add/delete elements, which would lose badly.
76 int nkids = cw->composite.num_children;
77 Widget *kids = (Widget *) malloc (sizeof (Widget) * nkids);
78 int i;
79 lwlib_bcopy ((char *) cw->composite.children, (char *) kids,
80 sizeof (Widget) * nkids);
81 for (i = 0; i < nkids; i++)
82 /* This prevent us from using gadgets, why is it here? */
83 /* if (XtIsWidget (kids [i])) */
85 /* do the kiddies first in case we're destroying */
86 XtApplyToWidgets (kids [i], proc, arg);
87 proc (kids [i], arg);
89 free (kids);
95 * Apply a function to all the subwidgets of a given widget recursively.
96 * Stop as soon as the function returns non NULL and returns this as a value.
98 void *
99 XtApplyUntilToWidgets (w, proc, arg)
100 Widget w;
101 XtApplyUntilToWidgetsProc proc;
102 XtPointer arg;
104 void* result;
105 if (XtIsComposite (w))
107 CompositeWidget cw = (CompositeWidget)w;
108 int i;
109 for (i = 0; i < cw->composite.num_children; i++)
110 if (XtIsWidget (cw->composite.children [i])){
111 result = proc (cw->composite.children [i], arg);
112 if (result)
113 return result;
114 result = XtApplyUntilToWidgets (cw->composite.children [i], proc,
115 arg);
116 if (result)
117 return result;
120 return NULL;
125 * Returns a copy of the list of all children of a composite widget
127 Widget *
128 XtCompositeChildren (widget, number)
129 Widget widget;
130 unsigned int* number;
132 CompositeWidget cw = (CompositeWidget)widget;
133 Widget* result;
134 int n;
135 int i;
137 if (!XtIsComposite (widget))
139 *number = 0;
140 return NULL;
142 n = cw->composite.num_children;
143 result = (Widget*)XtMalloc (n * sizeof (Widget));
144 *number = n;
145 for (i = 0; i < n; i++)
146 result [i] = cw->composite.children [i];
147 return result;
150 Boolean
151 XtWidgetBeingDestroyedP (widget)
152 Widget widget;
154 return widget->core.being_destroyed;
157 void
158 XtSafelyDestroyWidget (widget)
159 Widget widget;
161 #if 0
163 /* this requires IntrinsicI.h (actually, InitialI.h) */
165 XtAppContext app = XtWidgetToApplicationContext(widget);
167 if (app->dispatch_level == 0)
169 app->dispatch_level = 1;
170 XtDestroyWidget (widget);
171 /* generates an event so that the event loop will be called */
172 XChangeProperty (XtDisplay (widget), XtWindow (widget),
173 XA_STRING, XA_STRING, 32, PropModeAppend, NULL, 0);
174 app->dispatch_level = 0;
176 else
177 XtDestroyWidget (widget);
179 #else
180 abort ();
181 #endif