1 ;;; dialog.el --- Dialog-box support for XEmacs
3 ;; Copyright (C) 1991-4, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 2000 Ben Wing.
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: extensions, internal, dumped
9 ;; This file is part of XEmacs.
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ;; General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Synched up with: Not in FSF.
30 ;; This file is dumped with XEmacs (when dialog boxes are compiled in).
32 ;; Dialog boxes are non-modal at the C level, but made modal at the
33 ;; Lisp level via hacks in functions such as yes-or-no-p-dialog-box
34 ;; below. Perhaps there should be truly modal dialog boxes
35 ;; implemented at the C level for safety. All code using dialog boxes
36 ;; should be careful to assume that the environment, for example the
37 ;; current buffer, might be completely different after returning from
38 ;; yes-or-no-p-dialog-box, but such code is difficult to write and test.
41 (defun yes-or-no-p-dialog-box (prompt)
42 "Ask user a yes-or-no question with a popup dialog box.
43 Return t if the answer is \"yes\".
44 Takes one argument, which is the string to display to ask the question."
46 (make-dialog-box 'question
49 :buttons '(["Yes" (dialog-box-finish t)]
50 ["No" (dialog-box-finish nil)]
52 ["Cancel" (dialog-box-cancel)]))))
54 ;; FSF has a similar function `x-popup-dialog'.
55 (defun get-dialog-box-response (position contents)
56 "Pop up a dialog box and return user's selection.
57 POSITION specifies which frame to use.
58 This is normally an event or a window or frame.
59 If POSITION is t or nil, it means to use the frame the mouse is on.
60 The dialog box appears in the middle of the specified frame.
62 CONTENTS specifies the alternatives to display in the dialog box.
63 It is a list of the form (TITLE ITEM1 ITEM2...).
64 Each ITEM is a cons cell (STRING . VALUE).
65 The return value is VALUE from the chosen item.
67 An ITEM may also be just a string--that makes a nonselectable item.
68 An ITEM may also be nil--that means to put all preceding items
69 on the left of the dialog box and all following items on the right."
72 (select-frame (event-frame position)))
74 (select-frame position))
76 (select-window position)))
77 (make-dialog-box 'question
78 :question (car contents)
86 ;;this will never get selected
89 `[,(car x) (dialog-box-finish ',(cdr x)) t])))
92 (defun message-box (fmt &rest args)
93 "Display a message, in a dialog box if possible.
94 If the selected device has no dialog-box support, use the echo area.
95 The arguments are the same as to `format'.
97 If the only argument is nil, clear any existing message; let the
98 minibuffer contents show."
99 (if (and (null fmt) (null args))
103 (let ((str (apply 'format fmt args)))
104 (if (device-on-window-system-p)
105 (get-dialog-box-response nil (list str (cons "%_OK" t)))
106 (display-message 'message str))
109 (defun message-or-box (fmt &rest args)
110 "Display a message in a dialog box or in the echo area.
111 If this command was invoked with the mouse, use a dialog box.
112 Otherwise, use the echo area.
113 The arguments are the same as to `format'.
115 If the only argument is nil, clear any existing message; let the
116 minibuffer contents show."
117 (if (should-use-dialog-box-p)
118 (apply 'message-box fmt args)
119 (apply 'message fmt args)))
121 (defun make-dialog-box (type &rest cl-keys)
122 "Pop up a dialog box.
123 TYPE is a symbol, the type of dialog box. Remaining arguments are
124 keyword-value pairs, specifying the particular characteristics of the
125 dialog box. The allowed keywords are particular to each type, but
126 some standard keywords are common to many types:
129 The title of the dialog box's window.
132 If true, indicates that XEmacs will wait until the user is \"done\"
133 with the dialog box (usually, this means that a response has been
134 given). Typically, the response is returned. NOTE: Some dialog
135 boxes are always modal. If the dialog box is modal, `make-dialog-box'
136 returns immediately. The return value will be either nil or a
137 dialog box handle of some sort, e.g. a frame for type `general'.
139 ---------------------------------------------------------------------------
144 A dialog box consisting of an XEmacs glyph, typically a `layout'
145 widget specifying a dialog box arrangement. This is the most
146 general and powerful dialog box type, but requires more work than
147 the other types below.
150 A simple dialog box that displays a question and contains one or
151 more user-defined buttons to specify possible responses. (This is
152 compatible with the old built-in dialog boxes formerly specified
153 using `popup-dialog-box'.)
156 A file dialog box, of the type typically used in the window system
157 XEmacs is running on.
169 A dialog box used when printing (e.g. number of pages, printer).
172 A dialog box for setting page options (e.g. margins) for printing.
175 A find/replace dialog box.
178 An MS Windows-specific standard dialog box type similar to `question'.
180 ---------------------------------------------------------------------------
184 This type creates a frame and puts the specified widget layout in it.
185 \(Currently this is done by eliminating all areas but the gutter and placing
186 the layout there; but this is an implementation detail and may change.)
188 The keywords allowed for `general' are
191 The widget spec -- anything that can be passed to `make-glyph'.
193 The title of the frame.
195 The frame is made a child of this frame (defaults to the selected frame).
197 Additional properties of the frame, as well as `dialog-frame-plist'.
199 ---------------------------------------------------------------------------
203 The keywords allowed are
206 t or nil. When t, the dialog box callback should exit the dialog box
207 using the functions `dialog-box-finish' or `dialog-box-cancel'.
209 The title of the frame.
211 A string, the question.
213 A list, describing the buttons below the question. Each of these is a
214 vector, the syntax of which is essentially the same as that of popup menu
215 items. They may have any of the following forms:
217 [ \"name\" callback <active-p> ]
218 [ \"name\" callback <active-p> \"suffix\" ]
219 [ \"name\" callback :<keyword> <value> :<keyword> <value> ... ]
221 The name is the string to display on the button; it is filtered through the
222 resource database, so it is possible for resources to override what string
223 is actually displayed.
225 Accelerators can be indicated in the string by putting the sequence
226 \"%_\" before the character corresponding to the key that will invoke
227 the button. Uppercase and lowercase accelerators are equivalent. The
228 sequence \"%%\" is also special, and is translated into a single %.
230 If the `callback' of a button is a symbol, then it must name a command.
231 It will be invoked with `call-interactively'. If it is a list, then it is
232 evaluated with `eval'.
234 One (and only one) of the buttons may be `nil'. This marker means that all
235 following buttons should be flushright instead of flushleft.
237 Though the keyword/value syntax is supported for dialog boxes just as in
238 popup menus, the only keyword which is both meaningful and fully implemented
239 for dialog box buttons is `:active'.
241 ---------------------------------------------------------------------------
245 The keywords allowed are
248 The initial filename to be placed in the dialog box (defaults to nothing).
250 The initial directory to be selected in the dialog box (defaults to the
251 current buffer's `default-directory).
253 A list of (filter-desc filter ...)
255 The title of the dialog box (defaults to \"Open\").
256 :allow-multi-select t or nil
257 :create-prompt-on-nonexistent t or nil
258 :overwrite-prompt t or nil
259 :file-must-exist t or nil
260 :no-network-button t or nil
261 :no-read-only-return t or nil
263 ---------------------------------------------------------------------------
267 This invokes the Windows standard Print dialog.
268 This dialog is usually invoked when the user selects the Print command.
269 After the user presses OK, the program should start actual printout.
271 The keywords allowed are
274 An 'msprinter device.
276 A printer settings object.
278 t or nil -- whether the \"Selection\" button is enabled (defaults to nil).
280 t or nil -- whether the \"Pages\" button and associated edit controls
281 are enabled (defaults to t).
282 :selected-page-button
283 `all', `selection', or `pages' -- which page button is initially
286 Exactly one of :device and :print-settings must be given.
288 The function brings up the Print dialog, where the user can
289 select a different printer and/or change printer options. Connection
290 name can change as a result of selecting a different printer device. If
291 a device is specified, then changes are stored into the settings object
292 currently selected into that printer. If a settings object is supplied,
293 then changes are recorded into it, and, it is selected into a
294 printer, then changes are propagated to that printer
297 Return value is nil if the user has canceled the dialog. Otherwise, it
298 is a new plist, with the following properties:
299 name Printer device name, even if unchanged by the user.
300 from-page First page to print, 1-based. Returned if
301 `selected-page-button' is `pages'.
302 user, then this value is not included in the plist.
303 to-page Last page to print, inclusive, 1-based. Returned if
304 `selected-page-button' is `pages'.
305 copies Number of copies to print. Always returned.
306 selected-page-button Which page button was selected (`all', `selection',
309 The DEVICE is destroyed and an error is signaled in case of
310 initialization problem with the new printer.
312 See also the `page-setup' dialog box type.
314 ---------------------------------------------------------------------------
316 For type `page-setup':
318 This invokes the Windows standard Page Setup dialog.
319 This dialog is usually invoked in response to the Page Setup command,
320 and used to choose such parameters as page orientation, print margins
321 etc. Note that this dialog contains the \"Printer\" button, which
322 invokes the Printer Setup dialog so that the user can update the
323 printer options or even select a different printer as well.
325 The keywords allowed are
328 An 'msprinter device.
330 A printer settings object.
332 A plist of job properties.
334 Exactly one of these keywords must be given.
336 The function brings up the Page Setup dialog, where the user
337 can select a different printer and/or change printer options.
338 Connection name can change as a result of selecting a different printer
339 device. If a device is specified, then changes are stored into the
340 settings object currently selected into that printer. If a settings
341 object is supplied, then changes are recorded into it, and, it is
342 selected into a printer, then changes are propagated to that printer
345 :properties specifies a plist of job properties;
346 see `default-msprinter-frame-plist' for the complete list. The plist
347 is used to initialize the dialog.
349 Return value is nil if the user has canceled the dialog. Otherwise,
350 it is a new plist, containing the new list of properties.
352 NOTE: The margin properties (returned by this function) are *NOT* stored
353 into the print-settings or device object.
355 The DEVICE is destroyed and an error is signaled in case of
356 initialization problem with the new printer.
358 See also the `print' dialog box type.
360 ---------------------------------------------------------------------------
362 For type `mswindows-message':
364 The keywords allowed are
367 The title of the dialog box.
369 The string to display.
371 A symbol or list of symbols:
373 -- To specify the buttons in the message box:
376 The message box contains three push buttons: Abort, Retry, and Ignore.
378 The message box contains one push button: OK. This is the default.
380 The message box contains two push buttons: OK and Cancel.
382 The message box contains two push buttons: Retry and Cancel.
384 The message box contains two push buttons: Yes and No.
386 The message box contains three push buttons: Yes, No, and Cancel.
389 -- To display an icon in the message box:
391 iconexclamation, iconwarning
392 An exclamation-point icon appears in the message box.
393 iconinformation, iconasterisk
394 An icon consisting of a lowercase letter i in a circle appears in
397 A question-mark icon appears in the message box.
398 iconstop, iconerror, iconhand
399 A stop-sign icon appears in the message box.
402 -- To indicate the default button:
405 The first button is the default button. This is the default.
407 The second button is the default button.
409 The third button is the default button.
411 The fourth button is the default button.
414 -- To indicate the modality of the dialog box:
417 The user must respond to the message box before continuing work in
418 the window identified by the hWnd parameter. However, the user can
419 move to the windows of other applications and work in those windows.
420 Depending on the hierarchy of windows in the application, the user
421 may be able to move to other windows within the application. All
422 child windows of the parent of the message box are automatically
423 disabled, but popup windows are not. This is the default.
425 Same as applmodal except that the message box has the WS_EX_TOPMOST
426 style. Use system-modal message boxes to notify the user of serious,
427 potentially damaging errors that require immediate attention (for
428 example, running out of memory). This flag has no effect on the
429 user's ability to interact with windows other than those associated
432 Same as applmodal except that all the top-level windows belonging to
433 the current task are disabled if the hWnd parameter is NULL. Use
434 this flag when the calling application or library does not have a
435 window handle available but still needs to prevent input to other
436 windows in the current application without suspending other
440 In addition, you can specify the following flags:
443 The desktop currently receiving input must be a default desktop;
444 otherwise, the function fails. A default desktop is one an
445 application runs on after the user has logged on.
447 Adds a Help button to the message box. Choosing the Help button or
448 pressing F1 generates a Help event.
450 The text is right-justified.
452 Displays message and caption text using right-to-left reading order
453 on Hebrew and Arabic systems.
455 The message box becomes the foreground window. Internally, Windows
456 calls the SetForegroundWindow function for the message box.
458 The message box is created with the WS_EX_TOPMOST window style.
460 Windows NT only: The caller is a service notifying the user of an
461 event. The function displays a message box on the current active
462 desktop, even if there is no user logged on to the computer. If
463 this flag is set, the hWnd parameter must be NULL. This is so the
464 message box can appear on a desktop other than the desktop
465 corresponding to the hWnd.
468 The return value is one of the following menu-item values returned by
472 Abort button was selected.
474 Cancel button was selected.
476 Ignore button was selected.
478 No button was selected.
480 OK button was selected.
482 Retry button was selected.
484 Yes button was selected.
486 If a message box has a Cancel button, the function returns the
487 `cancel' value if either the ESC key is pressed or the Cancel button
488 is selected. If the message box has no Cancel button, pressing ESC has
490 (flet ((dialog-box-modal-loop (thunk)
491 (let* ((frames (frame-list))
493 ;; ok, this is extremely tricky. normally a modal
494 ;; dialog will pop itself down using (dialog-box-finish)
495 ;; or (dialog-box-cancel), which throws back to this
496 ;; catch. but question dialog boxes pop down themselves
497 ;; regardless, so a badly written question dialog box
498 ;; that does not use (dialog-box-finish) could seriously
499 ;; wedge us. furthermore, we disable all other frames
500 ;; in order to implement modality; we need to restore
501 ;; them before the dialog box is destroyed, because
502 ;; otherwise windows at least will notice that no top-
503 ;; level window can have the focus and will shift the
504 ;; focus to a different app, raising it and obscuring us.
505 ;; so we create `delete-dialog-box-hook', which is
506 ;; called right *before* the dialog box gets destroyed.
507 ;; here, we put a hook on it, and when it's our dialog
508 ;; box and not someone else's that's being destroyed,
509 ;; we reenable all the frames and remove the hook.
510 ;; BUT ... we still have to deal with exiting the
511 ;; modal loop in case it doesn't happen before us.
512 ;; we can't do this until after the callbacks for this
513 ;; dialog box get executed, and that doesn't happen until
514 ;; after the dialog box is destroyed. so to keep things
515 ;; synchronous, we enqueue an eval event, which goes into
516 ;; the same queue as the misc-user events encapsulating
517 ;; the dialog callbacks and will go after it (because
518 ;; destroying the dialog box happens after processing
519 ;; its selection). if the dialog boxes are written
520 ;; properly, we don't see this eval event, because we've
521 ;; already exited our modal loop. (Thus, we make sure the
522 ;; function given in this eval event is actually defined
523 ;; and does nothing.) If we do see it, though, we know
524 ;; that we encountered a badly written dialog box and
525 ;; need to exit now. Currently we just return nil, but
526 ;; maybe we should signal an error or issue a warning.
527 (catch 'internal-dialog-box-finish
528 (let ((id (eval thunk))
533 (mapc 'enable-frame ',frames)
535 'internal-make-dialog-box-exit did)
536 (remove-hook 'delete-dialog-box-hook
538 (add-hook 'delete-dialog-box-hook sym)
539 (mapc 'disable-frame frames)
542 (let ((event (next-event)))
543 (if (and (eval-event-p event)
544 (eq (event-function event)
545 'internal-make-dialog-box-exit)
546 (eq (event-object event) id))
548 (dispatch-event event)))))))))
551 (signal 'quit nil)))))
556 (:parent (selected-frame))
561 (flet ((create-dialog-box-frame ()
562 (let* ((ftop (frame-property cl-parent 'top))
563 (fleft (frame-property cl-parent 'left))
564 (fwidth (frame-pixel-width cl-parent))
565 (fheight (frame-pixel-height cl-parent))
566 (fonth (font-height (face-font 'default)))
567 (fontw (font-width (face-font 'default)))
568 (cl-properties (append cl-properties
570 (dfheight (plist-get cl-properties 'height))
571 (dfwidth (plist-get cl-properties 'width))
572 (unmapped (plist-get cl-properties
573 'initially-unmapped))
574 (gutter-spec cl-spec)
575 (name (or (plist-get cl-properties 'name) "XEmacs"))
577 (plist-remprop cl-properties 'initially-unmapped)
578 ;; allow the user to just provide a glyph
579 (or (glyphp cl-spec) (setq cl-spec (make-glyph cl-spec)))
580 (setq gutter-spec (copy-sequence "\n"))
581 (set-extent-begin-glyph (make-extent 0 1 gutter-spec)
583 ;; under FVWM at least, if I don't specify the
584 ;; initial position, it ends up always at (0, 0).
585 ;; xwininfo doesn't tell me that there are any
586 ;; program-specified position hints, so it must be
587 ;; an FVWM bug. So just be smashing and position in
588 ;; the center of the selected frame.
591 (append cl-properties
592 `(popup ,cl-parent initially-unmapped t
593 menubar-visible-p nil
595 default-toolbar-visible-p nil
596 top-gutter-visible-p t
599 top-gutter ,gutter-spec
602 modeline-shadow-thickness 0
603 vertical-scrollbar-visible-p nil
604 horizontal-scrollbar-visible-p nil
606 left ,(+ fleft (- (/ fwidth 2)
610 top ,(+ ftop (- (/ fheight 2)
614 (set-face-foreground 'modeline [default foreground] frame)
615 (set-face-background 'modeline [default background] frame)
616 (unless unmapped (make-frame-visible frame))
617 (let ((newbuf (generate-new-buffer " *dialog box*")))
618 (set-buffer-dedicated-frame newbuf frame)
619 (set-frame-property frame 'dialog-box-buffer newbuf)
620 (set-window-buffer (frame-root-window frame) newbuf)
621 (with-current-buffer newbuf
622 (set (make-local-variable 'frame-title-format)
624 (add-local-hook 'delete-frame-hook
629 'dialog-box-buffer))))))
632 (dialog-box-modal-loop '(create-dialog-box-frame))
633 (create-dialog-box-frame)))))
638 (remf cl-keys :modal)
640 (dialog-box-modal-loop `(make-dialog-box-internal ',type
642 (make-dialog-box-internal type cl-keys))))
644 (make-dialog-box-internal type cl-keys)))))
646 (defun dialog-box-finish (result)
647 "Exit a modal dialog box, returning RESULT.
648 This is meant to be executed from a dialog box callback function."
649 (throw 'internal-dialog-box-finish (list result)))
651 (defun dialog-box-cancel ()
652 "Cancel a modal dialog box.
653 This is meant to be executed from a dialog box callback function."
654 (throw 'internal-dialog-box-finish 'cancel))
656 ;; an eval event, used as a trigger inside of the dialog modal loop.
657 (defun internal-make-dialog-box-exit (did)
660 (make-obsolete 'popup-dialog-box 'make-dialog-box)
661 (defun popup-dialog-box (desc)
662 "Obsolete equivalent of (make-dialog-box 'question ...).
664 \(popup-dialog-box (QUESTION BUTTONS ...)
668 \(make-dialog-box 'question :question QUESTION :buttons BUTTONS)"
669 (check-argument-type 'stringp (car desc))
670 (or (consp (cdr desc))
672 "Dialog descriptor must supply at least one button"
674 (make-dialog-box 'question :question (car desc) :buttons (cdr desc)))
676 ;;; dialog.el ends here
projects / chise / xemacs-chise.git.1 / blob