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'.
194 The title of the frame.
196 The frame is made a child of this frame (defaults to the selected frame).
199 Additional properties of the frame, as well as `dialog-frame-plist'.
201 ---------------------------------------------------------------------------
205 The keywords allowed are
208 t or nil. When t, the dialog box callback should exit the dialog box
209 using the functions `dialog-box-finish' or `dialog-box-cancel'.
211 The title of the frame.
213 A string, the question.
215 A list, describing the buttons below the question. Each of these is a
216 vector, the syntax of which is essentially the same as that of popup menu
217 items. They may have any of the following forms:
219 [ \"name\" callback <active-p> ]
220 [ \"name\" callback <active-p> \"suffix\" ]
221 [ \"name\" callback :<keyword> <value> :<keyword> <value> ... ]
223 The name is the string to display on the button; it is filtered through the
224 resource database, so it is possible for resources to override what string
225 is actually displayed.
227 Accelerators can be indicated in the string by putting the sequence
228 \"%_\" before the character corresponding to the key that will invoke
229 the button. Uppercase and lowercase accelerators are equivalent. The
230 sequence \"%%\" is also special, and is translated into a single %.
232 If the `callback' of a button is a symbol, then it must name a command.
233 It will be invoked with `call-interactively'. If it is a list, then it is
234 evaluated with `eval'.
236 One (and only one) of the buttons may be `nil'. This marker means that all
237 following buttons should be flushright instead of flushleft.
239 Though the keyword/value syntax is supported for dialog boxes just as in
240 popup menus, the only keyword which is both meaningful and fully implemented
241 for dialog box buttons is `:active'.
243 ---------------------------------------------------------------------------
247 The keywords allowed are
250 The initial filename to be placed in the dialog box (defaults to nothing).
252 The initial directory to be selected in the dialog box (defaults to the
253 current buffer's `default-directory).
255 A list of (filter-desc filter ...)
257 The title of the dialog box (defaults to \"Open\").
258 :allow-multi-select t or nil
259 :create-prompt-on-nonexistent t or nil
260 :overwrite-prompt t or nil
261 :file-must-exist t or nil
262 :no-network-button t or nil
263 :no-read-only-return t or nil
265 ---------------------------------------------------------------------------
269 This invokes the Windows standard Print dialog.
270 This dialog is usually invoked when the user selects the Print command.
271 After the user presses OK, the program should start actual printout.
273 The keywords allowed are
276 An 'msprinter device.
278 A printer settings object.
280 Exactly one of these keywords must be given.
282 The function brings up the Print dialog, where the user can
283 select a different printer and/or change printer options. Connection
284 name can change as a result of selecting a different printer device. If
285 a printer is specified, then changes are stored into the settings object
286 currently selected into that printer. If a settings object is supplied,
287 then changes are recorded into it, and, it it is selected into a
288 printer, then changes are propagated to that printer
291 Return value is nil if the user has canceled the dialog. Otherwise, it
292 is a new plist, with the following properties:
293 name Printer device name, even if unchanged by the user.
294 from-page First page to print, 1-based. If not specified by the user,
295 then this value is not included in the plist.
296 to-page Last page to print, inclusive, 1-based. If not specified by
297 the user, then this value is not included in the plist.
298 copies Number of copies to print. Always returned.
300 The DEVICE is destroyed and an error is signaled in case of
301 initialization problem with the new printer.
303 See also the `page-setup' and `print-setup' dialog boxes.
305 ---------------------------------------------------------------------------
307 For type `page-setup':
309 This invokes the Windows standard Page Setup dialog.
310 This dialog is usually invoked in response to the Page Setup command, and
311 used to choose such parameters as page orientation, print margins etc.
312 Note that this dialog contains the \"Printer\" button, which invokes
313 the Printer Setup dialog (see `msprinter-print-setup-dialog') so that the
314 user can update the printer options or even select a different printer
317 The keywords allowed are
320 An 'msprinter device.
322 A printer settings object.
324 A plist of job properties.
326 Exactly one of these keywords must be given.
328 The function brings up the Page Setup dialog, where the user
329 can select a different printer and/or change printer options.
330 Connection name can change as a result of selecting a different printer
331 device. If a printer is specified, then changes are stored into the
332 settings object currently selected into that printer. If a settings
333 object is supplied, then changes are recorded into it, and, it it is
334 selected into a printer, then changes are propagated to that printer
337 :properties specifies a plist of job properties;
338 see `default-msprinter-frame-plist' for the complete list. The plist
339 is used to initialize the dialog.
341 Return value is nil if the user has canceled the dialog. Otherwise,
342 it is a new plist, containing the new list of properties.
344 The DEVICE is destroyed and an error is signaled in case of
345 initialization problem with the new printer.
347 See also the `print' and `print-setup' dialogs.
349 ---------------------------------------------------------------------------
351 For type `print-setup':
353 This invokes the Windows standard Print Setup dialog.
354 This dialog is usually invoked when the user selects the Printer Setup
357 The keywords allowed are
360 An 'msprinter device.
362 A printer settings object.
364 Exactly one of these keywords must be given.
366 The function brings up the Print Setup dialog, where the user
367 can select a different printer and/or change printer options.
368 Connection name can change as a result of selecting a different printer
369 device. If a printer is specified, then changes are stored into the
370 settings object currently selected into that printer. If a settings
371 object is supplied, then changes are recorded into it, and, it it is
372 selected into a printer, then changes are propagated to that printer
375 Return value is nil if the user has canceled the dialog. Otherwise, it
376 is a new plist, with the following properties:
377 name Printer device name, even if unchanged by the user.
379 The printer device is destroyed and an error is signaled if new printer
380 is selected by the user, but cannot be initialized.
382 See also the `print' and `page-setup' dialogs.
384 ---------------------------------------------------------------------------
386 For type `mswindows-message':
388 The keywords allowed are
391 The title of the dialog box.
393 The string to display.
395 A symbol or list of symbols:
397 -- To specify the buttons in the message box:
400 The message box contains three push buttons: Abort, Retry, and Ignore.
402 The message box contains one push button: OK. This is the default.
404 The message box contains two push buttons: OK and Cancel.
406 The message box contains two push buttons: Retry and Cancel.
408 The message box contains two push buttons: Yes and No.
410 The message box contains three push buttons: Yes, No, and Cancel.
413 -- To display an icon in the message box:
415 iconexclamation, iconwarning
416 An exclamation-point icon appears in the message box.
417 iconinformation, iconasterisk
418 An icon consisting of a lowercase letter i in a circle appears in
421 A question-mark icon appears in the message box.
422 iconstop, iconerror, iconhand
423 A stop-sign icon appears in the message box.
426 -- To indicate the default button:
429 The first button is the default button. This is the default.
431 The second button is the default button.
433 The third button is the default button.
435 The fourth button is the default button.
438 -- To indicate the modality of the dialog box:
441 The user must respond to the message box before continuing work in
442 the window identified by the hWnd parameter. However, the user can
443 move to the windows of other applications and work in those windows.
444 Depending on the hierarchy of windows in the application, the user
445 may be able to move to other windows within the application. All
446 child windows of the parent of the message box are automatically
447 disabled, but popup windows are not. This is the default.
449 Same as applmodal except that the message box has the WS_EX_TOPMOST
450 style. Use system-modal message boxes to notify the user of serious,
451 potentially damaging errors that require immediate attention (for
452 example, running out of memory). This flag has no effect on the
453 user's ability to interact with windows other than those associated
456 Same as applmodal except that all the top-level windows belonging to
457 the current task are disabled if the hWnd parameter is NULL. Use
458 this flag when the calling application or library does not have a
459 window handle available but still needs to prevent input to other
460 windows in the current application without suspending other
464 In addition, you can specify the following flags:
467 The desktop currently receiving input must be a default desktop;
468 otherwise, the function fails. A default desktop is one an
469 application runs on after the user has logged on.
471 Adds a Help button to the message box. Choosing the Help button or
472 pressing F1 generates a Help event.
474 The text is right-justified.
476 Displays message and caption text using right-to-left reading order
477 on Hebrew and Arabic systems.
479 The message box becomes the foreground window. Internally, Windows
480 calls the SetForegroundWindow function for the message box.
482 The message box is created with the WS_EX_TOPMOST window style.
484 Windows NT only: The caller is a service notifying the user of an
485 event. The function displays a message box on the current active
486 desktop, even if there is no user logged on to the computer. If
487 this flag is set, the hWnd parameter must be NULL. This is so the
488 message box can appear on a desktop other than the desktop
489 corresponding to the hWnd.
492 The return value is one of the following menu-item values returned by
496 Abort button was selected.
498 Cancel button was selected.
500 Ignore button was selected.
502 No button was selected.
504 OK button was selected.
506 Retry button was selected.
508 Yes button was selected.
510 If a message box has a Cancel button, the function returns the
511 `cancel' value if either the ESC key is pressed or the Cancel button
512 is selected. If the message box has no Cancel button, pressing ESC has
514 (flet ((dialog-box-modal-loop (thunk)
515 (let* ((frames (frame-list))
517 ;; ok, this is extremely tricky. normally a modal
518 ;; dialog will pop itself down using (dialog-box-finish)
519 ;; or (dialog-box-cancel), which throws back to this
520 ;; catch. but question dialog boxes pop down themselves
521 ;; regardless, so a badly written question dialog box
522 ;; that does not use (dialog-box-finish) could seriously
523 ;; wedge us. furthermore, we disable all other frames
524 ;; in order to implement modality; we need to restore
525 ;; them before the dialog box is destroyed, because
526 ;; otherwise windows at least will notice that no top-
527 ;; level window can have the focus and will shift the
528 ;; focus to a different app, raising it and obscuring us.
529 ;; so we create `delete-dialog-box-hook', which is
530 ;; called right *before* the dialog box gets destroyed.
531 ;; here, we put a hook on it, and when it's our dialog
532 ;; box and not someone else's that's being destroyed,
533 ;; we reenable all the frames and remove the hook.
534 ;; BUT ... we still have to deal with exiting the
535 ;; modal loop in case it doesn't happen before us.
536 ;; we can't do this until after the callbacks for this
537 ;; dialog box get executed, and that doesn't happen until
538 ;; after the dialog box is destroyed. so to keep things
539 ;; synchronous, we enqueue an eval event, which goes into
540 ;; the same queue as the misc-user events encapsulating
541 ;; the dialog callbacks and will go after it (because
542 ;; destroying the dialog box happens after processing
543 ;; its selection). if the dialog boxes are written
544 ;; properly, we don't see this eval event, because we've
545 ;; already exited our modal loop. (Thus, we make sure the
546 ;; function given in this eval event is actually defined
547 ;; and does nothing.) If we do see it, though, we know
548 ;; that we encountered a badly written dialog box and
549 ;; need to exit now. Currently we just return nil, but
550 ;; maybe we should signal an error or issue a warning.
551 (catch 'internal-dialog-box-finish
552 (let ((id (eval thunk))
557 (mapc 'enable-frame ',frames)
559 'internal-make-dialog-box-exit did)
560 (remove-hook 'delete-dialog-box-hook
562 (add-hook 'delete-dialog-box-hook sym)
563 (mapc 'disable-frame frames)
566 (let ((event (next-event)))
567 (if (and (eval-event-p event)
568 (eq (event-function event)
569 'internal-make-dialog-box-exit)
570 (eq (event-object event) id))
572 (dispatch-event event)))))))))
575 (signal 'quit nil)))))
580 (:parent (selected-frame))
585 (flet ((create-dialog-box-frame ()
586 (let* ((ftop (frame-property cl-parent 'top))
587 (fleft (frame-property cl-parent 'left))
588 (fwidth (frame-pixel-width cl-parent))
589 (fheight (frame-pixel-height cl-parent))
590 (fonth (font-height (face-font 'default)))
591 (fontw (font-width (face-font 'default)))
592 (cl-properties (append cl-properties
594 (dfheight (plist-get cl-properties 'height))
595 (dfwidth (plist-get cl-properties 'width))
596 (unmapped (plist-get cl-properties
597 'initially-unmapped))
598 (gutter-spec cl-spec)
599 (name (or (plist-get cl-properties 'name) "XEmacs"))
601 (plist-remprop cl-properties 'initially-unmapped)
602 ;; allow the user to just provide a glyph
603 (or (glyphp cl-spec) (setq cl-spec (make-glyph cl-spec)))
604 (setq gutter-spec (copy-sequence "\n"))
605 (set-extent-begin-glyph (make-extent 0 1 gutter-spec)
607 ;; under FVWM at least, if I don't specify the
608 ;; initial position, it ends up always at (0, 0).
609 ;; xwininfo doesn't tell me that there are any
610 ;; program-specified position hints, so it must be
611 ;; an FVWM bug. So just be smashing and position in
612 ;; the center of the selected frame.
615 (append cl-properties
616 `(popup ,cl-parent initially-unmapped t
617 menubar-visible-p nil
619 default-toolbar-visible-p nil
620 top-gutter-visible-p t
623 top-gutter ,gutter-spec
626 modeline-shadow-thickness 0
627 vertical-scrollbar-visible-p nil
628 horizontal-scrollbar-visible-p nil
630 left ,(+ fleft (- (/ fwidth 2)
634 top ,(+ ftop (- (/ fheight 2)
638 (set-face-foreground 'modeline [default foreground] frame)
639 (set-face-background 'modeline [default background] frame)
640 (unless unmapped (make-frame-visible frame))
641 (let ((newbuf (generate-new-buffer " *dialog box*")))
642 (set-buffer-dedicated-frame newbuf frame)
643 (set-frame-property frame 'dialog-box-buffer newbuf)
644 (with-current-buffer newbuf
645 (setq frame-title-format cl-title)
646 (make-local-hook 'delete-frame-hook)
647 (add-hook 'delete-frame-hook
652 'dialog-box-buffer))))))
655 (dialog-box-modal-loop '(create-dialog-box-frame))
656 (create-dialog-box-frame)))))
661 (remf cl-keys :modal)
663 (dialog-box-modal-loop `(make-dialog-box-internal ',type
665 (make-dialog-box-internal type cl-keys))))
667 (make-dialog-box-internal type cl-keys)))))
669 (defun dialog-box-finish (result)
670 "Exit a modal dialog box, returning RESULT.
671 This is meant to be executed from a dialog box callback function."
672 (throw 'internal-dialog-box-finish (list result)))
674 (defun dialog-box-cancel ()
675 "Cancel a modal dialog box.
676 This is meant to be executed from a dialog box callback function."
677 (throw 'internal-dialog-box-finish 'cancel))
679 ;; an eval event, used as a trigger inside of the dialog modal loop.
680 (defun internal-make-dialog-box-exit (did)
683 (make-obsolete 'popup-dialog-box 'make-dialog-box)
684 (defun popup-dialog-box (desc)
685 "Obsolete equivalent of (make-dialog-box 'question ...).
687 \(popup-dialog-box (QUESTION BUTTONS ...)
691 \(make-dialog-box 'question :question QUESTION :buttons BUTTONS)"
692 (check-argument-type 'stringp (car desc))
693 (or (consp (cdr desc))
695 "Dialog descriptor must supply at least one button"
697 (make-dialog-box 'question :question (car desc) :buttons (cdr desc)))
699 ;;; dialog.el ends here
projects / chise / xemacs-chise.git- / blob