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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.2: http://docutils.sourceforge.net/" />
<title>widget</title>
<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
</head>
<body>
<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
<input type="hidden" name="domains" value="www.graphicsmagick.org" />
<input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" /> <input type="submit" name="sa" value="Search" /></span>
</form>
</div>
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../project.html">Project</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../README.html">Install</a></li>
<li><a href="../Hg.html">Source</a></li>
<li><a href="../NEWS.html">News</a> </li>
<li><a href="../utilities.html">Utilities</a></li>
<li><a href="../programming.html">Programming</a></li>
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
<div class="document" id="widget">
<h1 class="title">widget</h1>
<h2 class="subtitle" id="x11-widgets">X11 Widgets</h2>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#xcolorbrowserwidget" id="id25">XColorBrowserWidget</a></li>
<li><a class="reference internal" href="#xcommandwidget" id="id26">XCommandWidget</a></li>
<li><a class="reference internal" href="#xconfirmwidget" id="id27">XConfirmWidget</a></li>
<li><a class="reference internal" href="#xdialogwidget" id="id28">XDialogWidget</a></li>
<li><a class="reference internal" href="#xfilebrowserwidget" id="id29">XFileBrowserWidget</a></li>
<li><a class="reference internal" href="#xfontbrowserwidget" id="id30">XFontBrowserWidget</a></li>
<li><a class="reference internal" href="#xinfowidget" id="id31">XInfoWidget</a></li>
<li><a class="reference internal" href="#xlistbrowserwidget" id="id32">XListBrowserWidget</a></li>
<li><a class="reference internal" href="#xmenuwidget" id="id33">XMenuWidget</a></li>
<li><a class="reference internal" href="#xmonitorwidget" id="id34">XMonitorWidget</a></li>
<li><a class="reference internal" href="#xnoticewidget" id="id35">XNoticeWidget</a></li>
<li><a class="reference internal" href="#xpreferenceswidget" id="id36">XPreferencesWidget</a></li>
<li><a class="reference internal" href="#xtextviewwidget" id="id37">XTextViewWidget</a></li>
</ul>
</div>
<div class="section" id="xcolorbrowserwidget">
<h1><a class="toc-backref" href="#id25">XColorBrowserWidget</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>Method MagickXColorBrowserWidget displays a Color Browser widget with a color
query to the user. The user keys a reply and presses the Action or Cancel
button to exit. The typed text is returned as the reply function parameter.</p>
<p>The format of the MagickXColorBrowserWidget method is:</p>
<pre class="literal-block">
void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>action:</dt>
<dd>Specifies a pointer to the action of this widget.</dd>
<dt>reply:</dt>
<dd>The response from the user is returned in this parameter.</dd>
</dl>
</div>
</div>
<div class="section" id="xcommandwidget">
<h1><a class="toc-backref" href="#id26">XCommandWidget</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
<pre class="literal-block">
int MagickXCommandWidget( Display *display, MagickXWindows *windows,
const char ** selections, XEvent *event );
</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
<p>Method MagickXCommandWidget maps a menu and returns the command pointed to by
the user when the button is released.</p>
<p>The format of the MagickXCommandWidget method is:</p>
<pre class="literal-block">
int MagickXCommandWidget( Display *display, MagickXWindows *windows,
const char ** selections, XEvent *event );
</pre>
<dl class="docutils">
<dt>selection_number:</dt>
<dd>Specifies the number of the selection that the
user choose.</dd>
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>selections:</dt>
<dd>Specifies a pointer to one or more strings that comprise
the choices in the menu.</dd>
<dt>event:</dt>
<dd>Specifies a pointer to a X11 XEvent structure.</dd>
</dl>
</div>
</div>
<div class="section" id="xconfirmwidget">
<h1><a class="toc-backref" href="#id27">XConfirmWidget</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
<pre class="literal-block">
int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
const char *description );
</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
<p>Method MagickXConfirmWidget displays a Confirm widget with a notice to the user.
The function returns -1 if Dismiss is pressed, 0 for Cancel, and 1 for
Yes.</p>
<p>The format of the MagickXConfirmWidget method is:</p>
<pre class="literal-block">
int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
const char *description );
</pre>
<dl class="docutils">
<dt>status:</dt>
<dd>Method MagickXConfirmWidget returns True if the user presses Yes
otherwise False is returned.</dd>
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>reason:</dt>
<dd>Specifies the message to display before terminating the
program.</dd>
<dt>description:</dt>
<dd>Specifies any description to the message.</dd>
</dl>
</div>
</div>
<div class="section" id="xdialogwidget">
<h1><a class="toc-backref" href="#id28">XDialogWidget</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
<pre class="literal-block">
int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
const char *query, char *reply );
</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
<p>Method MagickXDialogWidget displays a Dialog widget with a query to the user.
The user keys a reply and presses the Ok or Cancel button to exit. The
typed text is returned as the reply function parameter.</p>
<p>The format of the MagickXDialogWidget method is:</p>
<pre class="literal-block">
int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
const char *query, char *reply );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>action:</dt>
<dd>Specifies a pointer to the action of this widget.</dd>
<dt>query:</dt>
<dd>Specifies a pointer to the query to present to the user.</dd>
<dt>reply:</dt>
<dd>The response from the user is returned in this parameter.</dd>
</dl>
</div>
</div>
<div class="section" id="xfilebrowserwidget">
<h1><a class="toc-backref" href="#id29">XFileBrowserWidget</a></h1>
<div class="section" id="id7">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
</div>
<div class="section" id="id8">
<h2>Description</h2>
<p>Method MagickXFileBrowserWidget displays a File Browser widget with a file query
to the user. The user keys a reply and presses the Action or Cancel button
to exit. The typed text is returned as the reply function parameter.</p>
<p>The format of the MagickXFileBrowserWidget method is:</p>
<pre class="literal-block">
void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>action:</dt>
<dd>Specifies a pointer to the action of this widget.</dd>
<dt>reply:</dt>
<dd>The response from the user is returned in this parameter.</dd>
</dl>
</div>
</div>
<div class="section" id="xfontbrowserwidget">
<h1><a class="toc-backref" href="#id30">XFontBrowserWidget</a></h1>
<div class="section" id="id9">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
</div>
<div class="section" id="id10">
<h2>Description</h2>
<p>Method MagickXFontBrowserWidget displays a Font Browser widget with a font query
to the user. The user keys a reply and presses the Action or Cancel button
to exit. The typed text is returned as the reply function parameter.</p>
<p>The format of the MagickXFontBrowserWidget method is:</p>
<pre class="literal-block">
void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
char *reply );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>action:</dt>
<dd>Specifies a pointer to the action of this widget.</dd>
<dt>reply:</dt>
<dd>The response from the user is returned in this parameter.</dd>
</dl>
</div>
</div>
<div class="section" id="xinfowidget">
<h1><a class="toc-backref" href="#id31">XInfoWidget</a></h1>
<div class="section" id="id11">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );
</pre>
</div>
<div class="section" id="id12">
<h2>Description</h2>
<p>Method MagickXInfoWidget displays text in the Info widget. The purpose is to
inform the user that what activity is currently being performed (e.g.
reading an image, rotating an image, etc.).</p>
<p>The format of the MagickXInfoWidget method is:</p>
<pre class="literal-block">
void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );
</pre>
<p>A description of each parameter follows:</p>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>activity:</dt>
<dd>This character string reflects the current activity and is
displayed in the Info widget.</dd>
</dl>
</div>
</div>
<div class="section" id="xlistbrowserwidget">
<h1><a class="toc-backref" href="#id32">XListBrowserWidget</a></h1>
<div class="section" id="id13">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
MagickXWindowInfo *window_info, const char ** list,
const char *action, const char *query, char *reply );
</pre>
</div>
<div class="section" id="id14">
<h2>Description</h2>
<p>Method MagickXListBrowserWidget displays a List Browser widget with a query to
the user. The user keys a reply or select a reply from the list. Finally,
the user presses the Action or Cancel button to exit. The typed text is
returned as the reply function parameter.</p>
<p>The format of the MagickXListBrowserWidget method is:</p>
<pre class="literal-block">
void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
MagickXWindowInfo *window_info, const char ** list,
const char *action, const char *query, char *reply );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>list:</dt>
<dd>Specifies a pointer to an array of strings. The user can
select from these strings as a possible reply value.</dd>
<dt>action:</dt>
<dd>Specifies a pointer to the action of this widget.</dd>
<dt>query:</dt>
<dd>Specifies a pointer to the query to present to the user.</dd>
<dt>reply:</dt>
<dd>The response from the user is returned in this parameter.</dd>
</dl>
</div>
</div>
<div class="section" id="xmenuwidget">
<h1><a class="toc-backref" href="#id33">XMenuWidget</a></h1>
<div class="section" id="id15">
<h2>Synopsis</h2>
<pre class="literal-block">
int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
const char ** selections, char *item );
</pre>
</div>
<div class="section" id="id16">
<h2>Description</h2>
<p>Method MagickXMenuWidget maps a menu and returns the command pointed to by the
user when the button is released.</p>
<p>The format of the MagickXMenuWidget method is:</p>
<pre class="literal-block">
int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
const char ** selections, char *item );
</pre>
<dl class="docutils">
<dt>selection_number:</dt>
<dd>Specifies the number of the selection that the
user choose.</dd>
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>title:</dt>
<dd>Specifies a character string that describes the menu selections.</dd>
<dt>selections:</dt>
<dd>Specifies a pointer to one or more strings that comprise
the choices in the menu.</dd>
<dt>item:</dt>
<dd>Specifies a character array. The item selected from the menu
is returned here.</dd>
</dl>
</div>
</div>
<div class="section" id="xmonitorwidget">
<h1><a class="toc-backref" href="#id34">XMonitorWidget</a></h1>
<div class="section" id="id17">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
const magick_int64_t quantum, const magick_uint64_t span );
</pre>
</div>
<div class="section" id="id18">
<h2>Description</h2>
<p>Method MagickXMonitorWidget displays the progress a task is making in
completing a task. A span of zero toggles the active status. An inactive
state disables the progress monitor.</p>
<p>The format of the MagickXMonitorWidget method is:</p>
<pre class="literal-block">
void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
const magick_int64_t quantum, const magick_uint64_t span );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>task:</dt>
<dd>Identifies the task in progress.</dd>
<dt>quantum:</dt>
<dd>Specifies the quantum position within the span which represents
how much progress has been made in completing a task.</dd>
<dt>span:</dt>
<dd>Specifies the span relative to completing a task.</dd>
</dl>
</div>
</div>
<div class="section" id="xnoticewidget">
<h1><a class="toc-backref" href="#id35">XNoticeWidget</a></h1>
<div class="section" id="id19">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
const char *description );
</pre>
</div>
<div class="section" id="id20">
<h2>Description</h2>
<p>Method MagickXNoticeWidget displays a Notice widget with a notice to the user.
The function returns when the user presses the "Dismiss" button.</p>
<p>The format of the MagickXNoticeWidget method is:</p>
<pre class="literal-block">
void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
const char *description );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>reason:</dt>
<dd>Specifies the message to display before terminating the
program.</dd>
<dt>description:</dt>
<dd>Specifies any description to the message.</dd>
</dl>
</div>
</div>
<div class="section" id="xpreferenceswidget">
<h1><a class="toc-backref" href="#id36">XPreferencesWidget</a></h1>
<div class="section" id="id21">
<h2>Synopsis</h2>
<pre class="literal-block">
unsigned int MagickXPreferencesWidget( Display *display,
<a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows );
</pre>
</div>
<div class="section" id="id22">
<h2>Description</h2>
<p>Method MagickXPreferencesWidget displays a Preferences widget with program
preferences. If the user presses the Apply button, the preferences are
stored in a configuration file in the users' home directory.</p>
<p>The format of the MagickXPreferencesWidget method is:</p>
<pre class="literal-block">
unsigned int MagickXPreferencesWidget( Display *display,
<a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>resource_info:</dt>
<dd>Specifies a pointer to a X11 MagickXResourceInfo structure.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
</dl>
</div>
</div>
<div class="section" id="xtextviewwidget">
<h1><a class="toc-backref" href="#id37">XTextViewWidget</a></h1>
<div class="section" id="id23">
<h2>Synopsis</h2>
<pre class="literal-block">
void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows, const unsigned int mono,
const char *title, const char ** textlist );
</pre>
</div>
<div class="section" id="id24">
<h2>Description</h2>
<p>Method MagickXTextViewWidget displays text in a Text View widget.</p>
<p>The format of the MagickXTextViewWidget method is:</p>
<pre class="literal-block">
void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows, const unsigned int mono,
const char *title, const char ** textlist );
</pre>
<dl class="docutils">
<dt>display:</dt>
<dd>Specifies a connection to an X server; returned from
XOpenDisplay.</dd>
<dt>resource_info:</dt>
<dd>Specifies a pointer to a X11 MagickXResourceInfo structure.</dd>
<dt>window:</dt>
<dd>Specifies a pointer to a MagickXWindows structure.</dd>
<dt>mono:</dt>
<dd>Use mono-spaced font when displaying text.</dd>
<dt>title:</dt>
<dd>This character string is displayed at the top of the widget
window.</dd>
<dt>textlist:</dt>
<dd>This string list is displayed within the Text View widget.</dd>
</dl>
</div>
</div>
</div>
<hr class="docutils">
<div class="document">
<p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2020<!--SPONSOR_LOGO--></p>
</div>
</body>
</html>
|
