xemacs-beta: man/widget.texi comparison

comparison man/widget.texi @ 5741:d11efddf3617

Fix texinfo constructs that are rejected by texinfo 5.x. See xemacs-patches message <CAHCOHQngK6wyLhBtP9i5ngMyGTV9GFh3qU9tq8XebYTdVOYU2w@mail.gmail.com>.

author	Jerry James <james@xemacs.org>
date	Fri, 21 Jun 2013 08:44:33 -0600
parents	64be8a494bdc
children

comparison

equal deleted inserted replaced

-:00a421d2b2ba
+:d11efddf3617
 @settitle The Emacs Widget Library
 @syncodeindex fn cp
 @syncodeindex vr cp
 @syncodeindex ky cp
 @c %**end of header
-@c Synced up with: FSF 23.1.92.
+@c Synced up with: FSF 24.3
-@c Synced by: Ben Wing, 2-17-10.
+@c Synced by: Jerry James, 19-Jun-2013.
 @copying
-Copyright @copyright{} 2000, 2001, 2002, 2003, 2004, 2005,
+Copyright @copyright{} 2000--2013 Free Software Foundation, Inc.
-2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
 @quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
 * composite::
 @end detailmenu
 @end menu
 @node  Introduction, User Interface, Top, Top
 @comment  node-name,  next,  previous,  up
-@section Introduction
+@chapter Introduction
 @c XEmacs changes to reflect history, native widgets, and GTK
 Most graphical user interface toolkits provide
 a number of standard user interface controls (sometimes known as
 `widgets' or `gadgets').  Historically, Emacs didn't support anything like
-this, except for its incredible powerful text ``widget''.  However,
+this, except for its incredibly powerful text ``widget''.  However,
 since XEmacs 21.4, XEmacs has supported ``native'' widgets (GUI controls
 implemented as Lisp APIs in C for the MS Windows, Motif, Athena, and GTK
 toolkits) and libglade (GUI controls with an XML API for the GTK
 toolkit).  On the other hand, Emacs does provide the necessary
 primitives to implement many other widgets within a text buffer, and of
 text field, and sometimes prevent entering invalid data.
 @item
 You can have fixed sized fields, thus allowing multiple fields to be
 lined up in columns.
 @item
 It is simple to query or set the value of a field.
 @item
 Editing happens in a normal buffer, not in the mini-buffer.
 @item
 Packages using the library get a uniform look-and-feel, making them easier for
 the user to learn.
 @item
 As support for embedded graphics improve, the widget library will be
 extended to use the GUI features.  This means that your code using the
 widget library will also use the new graphic features automatically.
 @item
 A widget specification is implemented as a class, and new subclasses can
 it will be autoloaded when needed.
 @end table
 @node User Interface, Programming Example, Introduction, Top
 @comment  node-name,  next,  previous,  up
-@section User Interface
+@chapter User Interface
 A form consists of read only text for documentation and some fields,
 where each field contains two parts, a tag and a value.  The tags are
 used to identify the fields, so the documentation can refer to the
 @samp{foo field}, meaning the field tagged with @samp{Foo}. Here is an
 @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
 @samp{[Reset Form]}.  There are basically two things the user can do
 within a form, namely editing the editable text fields and activating
 the buttons.
-@subsection Editable Text Fields
+@section Editable Text Fields
 In the example, the value for the @samp{Name} is most likely displayed
 in an editable text field, and so are values for each of the members of
 the @samp{Numbers} list.  All the normal Emacs editing operations are
 available for editing these fields.  The only restriction is that each
 @deffn Face widget-field-face
 Face used for other editing fields.
 @end deffn
-@subsection Buttons
+@section Buttons
 @cindex widget buttons
 @cindex button widgets
 Some portions of the buffer have an associated @dfn{action}, which can
 be @dfn{invoked} by a standard key or mouse command.  These portions
 @defopt widget-mouse-face
 Face used for highlighting a button when the mouse pointer moves across
 it.
 @end defopt
-@subsection Navigation
+@section Navigation
 You can use all the normal Emacs commands to move around in a form
 buffer, plus you will have these additional commands:
 @table @kbd
 @end deffn
 @end table
 @node Programming Example, Setting Up the Buffer, User Interface, Top
 @comment  node-name,  next,  previous,  up
-@section Programming Example
+@chapter Programming Example
 @cindex widgets, programming example
 @cindex example of using widgets
 Here is the code to implement the user interface example (@pxref{User
 Interface}).
 (widget-setup))
 @end lisp
 @node Setting Up the Buffer, Basic Types, Programming Example, Top
 @comment  node-name,  next,  previous,  up
-@section Setting Up the Buffer
+@chapter Setting Up the Buffer
 Widgets are created with @code{widget-create}, which returns a
 @dfn{widget} object.  This object can be queried and manipulated by
 other widget functions, until it is deleted with @code{widget-delete}.
 After the widgets have been created, @code{widget-setup} must be called
 when not on a button.  By default this is @code{global-map}.
 @end defvar
 @node Basic Types, Sexp Types, Setting Up the Buffer, Top
 @comment  node-name,  next,  previous,  up
-@section Basic Types
+@chapter Basic Types
 This is the general syntax of a type specification:
 @example
 @var{name} ::= (@var{name} [@var{keyword} @var{argument}]... @var{args})
 * group::
 @end menu
 @node link, url-link, Basic Types, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{link} Widget
+@section The @code{link} Widget
 @findex link@r{ widget}
 Syntax:
 @example
 String to suffix links.
 @end defopt
 @node url-link, info-link, link, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{url-link} Widget
+@section The @code{url-link} Widget
 @findex url-link@r{ widget}
 Syntax:
 @example
 When this link is invoked, the @acronym{WWW} browser specified by
 @code{browse-url-browser-function} will be called with @var{url}.
 @node info-link, push-button, url-link, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{info-link} Widget
+@section The @code{info-link} Widget
 @findex info-link@r{ widget}
 Syntax:
 @example
 When this link is invoked, the built-in Info reader is started on
 @var{address}.
 @node  push-button, editable-field, info-link, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{push-button} Widget
+@section The @code{push-button} Widget
 @findex push-button@r{ widget}
 Syntax:
 @example
 String to suffix push buttons.
 @end defopt
 @node editable-field, text, push-button, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{editable-field} Widget
+@section The @code{editable-field} Widget
 @findex editable-field@r{ widget}
 Syntax:
 @example
 @code{:action}.
 @end table
 @node text, menu-choice, editable-field, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{text} Widget
+@section The @code{text} Widget
 @findex text@r{ widget}
 @vindex widget-text-keymap
 This is just like @code{editable-field}, but intended for multiline text
 fields.  The default @code{:keymap} is @code{widget-text-keymap}, which
 does not rebind the @key{RET} key.
 @node menu-choice, radio-button-choice, text, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{menu-choice} Widget
+@section The @code{menu-choice} Widget
 @findex menu-choice@r{ widget}
 Syntax:
 @example
 The list of types.
 @end table
 @node radio-button-choice, item, menu-choice, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{radio-button-choice} Widget
+@section The @code{radio-button-choice} Widget
 @findex radio-button-choice@r{ widget}
 Syntax:
 @example
 widget has been created will @strong{not} be properly destructed when
 you call @code{widget-delete}.
 @node item, choice-item, radio-button-choice, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{item} Widget
+@section The @code{item} Widget
 @findex item@r{ widget}
 Syntax:
 @example
 property.  The value should be a string, which will be inserted in the
 buffer.  This widget will only match the specified value.
 @node choice-item, toggle, item, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{choice-item} Widget
+@section The @code{choice-item} Widget
 @findex choice-item@r{ widget}
 Syntax:
 @example
 equivalent to activating the parent widget.  This widget will only match
 the specified value.
 @node toggle, checkbox, choice-item, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{toggle} Widget
+@section The @code{toggle} Widget
 @findex toggle@r{ widget}
 Syntax:
 @example
 emacsen that supports this.
 @end table
 @node checkbox, checklist, toggle, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{checkbox} Widget
+@section The @code{checkbox} Widget
 @findex checkbox@r{ widget}
 This widget has two possible states, @samp{selected} and
 @samp{unselected}, which corresponds to a @code{t} or @code{nil} value.
 @var{type} ::= (checkbox [@var{keyword} @var{argument}]...)
 @end example
 @node checklist, editable-list, checkbox, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{checklist} Widget
+@section The @code{checklist} Widget
 @findex checklist@r{ widget}
 Syntax:
 @example
 The list of types.
 @end table
 @node editable-list, group, checklist, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{editable-list} Widget
+@section The @code{editable-list} Widget
 @findex editable-list@r{ widget}
 Syntax:
 @example
 List whose @sc{car} is the type of the list elements.
 @end table
 @node group,  , editable-list, Basic Types
 @comment  node-name,  next,  previous,  up
-@subsection The @code{group} Widget
+@section The @code{group} Widget
 @findex group@r{ widget}
 This widget simply groups other widgets together.
 Syntax:
 The value is a list, with one member for each @var{type}.
 @node Sexp Types, Widget Properties, Basic Types, Top
 @comment
-@section Sexp Types
+@chapter Sexp Types
 @cindex sexp types
 A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp
 for short, are also available.  These basically fall in several
 categories described in this section.
 * composite::
 @end menu
 @node constants, generic, Sexp Types, Sexp Types
 @comment  node-name,  next,  previous,  up
-@subsection The Constant Widgets
+@section The Constant Widgets
 @cindex constant widgets
 The @code{const} widget can contain any Lisp expression, but the user is
 prohibited from editing it, which is mainly useful as a component of one
 of the composite widgets.
 An immutable symbol that is bound as a function.
 @end deffn
 @node generic, atoms, constants, Sexp Types
 @comment  node-name,  next,  previous,  up
-@subsection Generic Sexp Widget
+@section Generic Sexp Widget
 @cindex generic sexp widget
 The @code{sexp} widget can contain any Lisp expression, and allows the
 user to edit it inline in the buffer.
 @code{editable-field} widget.  @xref{editable-field}.
 @end deffn
 @node atoms, composite, generic, Sexp Types
 @comment  node-name,  next,  previous,  up
-@subsection Atomic Sexp Widgets
+@section Atomic Sexp Widgets
 @cindex atomic sexp widget
 The atoms are s-expressions that do not consist of other s-expressions.
 For example, a string, a file name, or a symbol are atoms, while a list
 is a composite type.  You can edit the value of an atom with the
 @end deffn
 @node composite,  , atoms, Sexp Types
 @comment  node-name,  next,  previous,  up
-@subsection Composite Sexp Widgets
+@section Composite Sexp Widgets
 @cindex composite sexp widgets
 The syntax for the composite widget construct is:
 @example
 @end example
 @end deffn
 @node Widget Properties, Defining New Widgets, Sexp Types, Top
 @comment  node-name,  next,  previous,  up
-@section Properties
+@chapter Properties
 @cindex properties of widgets
 @cindex widget properties
 You can examine or set the value of a widget by using the widget object
 that was returned by @code{widget-create}.
 @code{:deactivate} keywords instead.
 @node Defining New Widgets, Widget Browser, Widget Properties, Top
 @comment  node-name,  next,  previous,  up
-@section Defining New Widgets
+@chapter Defining New Widgets
 @cindex new widgets
 @cindex defining new widgets
 You can define specialized widgets with @code{define-widget}.  It allows
 you to create a shorthand for more complex widgets, including specifying
 @var{name} and class should both be symbols, @code{class} should be one
 of the existing widget types.
 The third argument @var{doc} is a documentation string for the widget.
-After the new widget has been defined the following two calls will
+After the new widget has been defined, the following two calls will
 create identical widgets:
 @itemize @bullet
 @item
 @lisp
 @code{widget-convert} is typically not called from user code; rather it
 is called implicitly through the @samp{widget-create*} functions.
 @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top
 @comment  node-name,  next,  previous,  up
-@section Widget Browser
+@chapter Widget Browser
 @cindex widget browser
 There is a separate package to browse widgets.  This is intended to help
 programmers who want to examine the content of a widget.  The browser
 shows the value of each keyword, but uses links for certain keywords
 When called interactively, use the position of point.
 @end deffn
 @node  Widget Minor Mode, Utilities, Widget Browser, Top
 @comment  node-name,  next,  previous,  up
-@section Widget Minor Mode
+@chapter Widget Minor Mode
 @cindex widget minor mode
 There is a minor mode for manipulating widgets in major modes that
 don't provide any support for widgets themselves.  This is mostly
 intended to be useful for programmers doing experiments.
 Keymap used in @code{widget-minor-mode}.
 @end defvar
 @node  Utilities, Widget Wishlist, Widget Minor Mode, Top
 @comment  node-name,  next,  previous,  up
-@section Utilities.
+@chapter Utilities
 @cindex utility functions for widgets
 @defun widget-prompt-value widget prompt [ value unbound ]
 Prompt for a value matching @var{widget}, using @var{prompt}.@*
 The current value is assumed to be @var{value}, unless @var{unbound} is
 This is only meaningful for radio buttons or checkboxes in a list.
 @end defun
 @node Widget Wishlist, Widget Internals, Utilities, Top
 @comment  node-name,  next,  previous,  up
-@section Wishlist
+@chapter Wishlist
 @cindex todo
 @itemize @bullet
 @item
 It should be possible to add or remove items from a list with @kbd{C-k}
 This is an alphabetical listing of all concepts, functions, commands,
 variables, and widgets described in this manual.
 @printindex cp
 @bye
-@ignore
-arch-tag: 2b427731-4c61-4e72-85de-5ccec9c623f0
-@end ignore

Mercurial > hg > xemacs-beta

comparison man/widget.texi @ 5741:d11efddf3617