view man/lispref/dialog.texi @ 5634:2014ff433daf

Support hash COLLECTIONs, #'{all,try}-completion{s,}; add #'test-completion src/ChangeLog addition: 2012-01-01 Aidan Kehoe <kehoea@parhasard.net> Add #'test-completion, API from GNU. Accept hash table COLLECTIONs in it and in the other completion-oriented functions, #'try-completion, #'all-completions, and those Lisp functions implemented in terms of them. * lisp.h: Update the prototype of map_obarray(), making FN compatible with the FUNCTION argument of elisp_maphash(); * abbrev.c (abbrev_match_mapper): * abbrev.c (record_symbol): * doc.c (verify_doc_mapper): * symbols.c (mapatoms_1): * symbols.c (apropos_mapper): Update these mapper functions to reflect the new argument to map_obarray(). * symbols.c (map_obarray): Call FN with two arguments, the string name of the symbol, and the symbol itself, for API (mapper) compatibility with elisp_maphash(). * minibuf.c (map_completion): New. Map a maphash_function_t across a non function COLLECTION, as appropriate for #'try-completion and friends. * minibuf.c (map_completion_list): New. Map a maphash_function_t across a pseudo-alist, as appropriate for the completion functions. * minibuf.c (ignore_completion_p): PRED needs to be called with two args if and only if the collection is a hash table. Implement this. * minibuf.c (try_completion_mapper): New. The loop body of #'try-completion, refactored out. * minibuf.c (Ftry_completion): Use try_completion_mapper(), map_completion(). * minibuf.c (all_completions_mapper): New. The loop body of #'all-completions, refactored out. * minibuf.c (Fall_completions): Use all_completions_mapper(), map_completion(). * minibuf.c (test_completion_mapper): New. The loop body of #'test-completion. * minibuf.c (Ftest_completion): New, API from GNU. * minibuf.c (syms_of_minibuf): Make Ftest_completion available. tests/ChangeLog addition: 2012-01-01 Aidan Kehoe <kehoea@parhasard.net> * automated/completion-tests.el: New. Test #'try-completion, #'all-completion and #'test-completion with list, vector and hash-table COLLECTION arguments.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 01 Jan 2012 15:18:52 +0000
parents 576fb035e263
children 9fae6227ede5
line wrap: on
line source

@c -*-texinfo-*-
@c This is part of the XEmacs Lisp Reference Manual.
@c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
@c See the file lispref.texi for copying conditions.
@setfilename ../../info/dialog.info
@node Dialog Boxes, Toolbar, Menus, Top
@chapter Dialog Boxes
@cindex dialog box

@menu
* Dialog Box Format::
* Dialog Box Functions::
@end menu

@node Dialog Box Format
@section Dialog Box Format

A dialog box description is a list.

@itemize @bullet
@item
The first element of the list is a string to display in the dialog box.
@item
The rest of the elements are descriptions of the dialog box's buttons.
Each one is a vector of three elements:
@itemize @minus
@item
The first element is the text of the button.
@item
The second element is the @dfn{callback}.
@item
The third element is @code{t} or @code{nil}, whether this button is
selectable.
@end itemize
@end itemize

If the callback of a button is a symbol, then it must name a command.
It will be invoked with @code{call-interactively}.  If it is a list,
then it is evaluated with @code{eval}.

One (and only one) of the buttons may be @code{nil}.  This marker means
that all following buttons should be flushright instead of flushleft.

The syntax, more precisely:

@example
   form         :=  <something to pass to `eval'>
   command      :=  <a symbol or string, to pass to `call-interactively'>
   callback     :=  command | form
   active-p     :=  <t, nil, or a form to evaluate to decide whether this
                    button should be selectable>
   name         :=  <string>
   partition    :=  'nil'
   button       :=  '['  name callback active-p ']'
   dialog       :=  '(' name [ button ]+ [ partition [ button ]+ ] ')'
@end example

@node Dialog Box Functions
@section Dialog Box Functions

@defun popup-dialog-box dbox-desc
This function pops up a dialog box.  @var{dbox-desc} describes how the
dialog box will appear (@pxref{Dialog Box Format}).
@end defun

@xref{Yes-or-No Queries}, for functions to ask a yes/no question using
a dialog box.