"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/lispref/toolbar.texi" between
xemacs-21.4.22.tar.gz and xemacs-21.4.24.tar.bz2

About: XEmacs (an alternative to GNU Emacs) is a highly customizable open source text editor and application development system (current version).

toolbar.texi  (xemacs-21.4.22):toolbar.texi  (xemacs-21.4.24.tar.bz2)
@c -*-texinfo-*- @c -*-texinfo-*-
@c This is part of the XEmacs Lisp Reference Manual. @c This is part of the XEmacs Lisp Reference Manual.
@c Copyright (C) 1995, 1996 Ben Wing. @c Copyright (C) 1995, 1996 Ben Wing.
@c See the file lispref.texi for copying conditions. @c See the file lispref.texi for copying conditions.
@setfilename ../../info/toolbar.info @setfilename ../../info/toolbar.info
@node Toolbar, Gutter, Dialog Boxes, top @node Toolbar, Gutter, Dialog Boxes, Top
@chapter Toolbar @chapter Toolbar
@cindex toolbar @cindex toolbar
@menu @menu
* Toolbar Intro:: An introduction. * Toolbar Intro:: An introduction.
* Creating Toolbar:: How to create a toolbar. * Creating Toolbar:: How to create a toolbar.
* Toolbar Descriptor Format:: Accessing and modifying a toolbar's * Toolbar Descriptor Format:: Accessing and modifying a toolbar's
properties. properties.
* Specifying the Toolbar:: Setting a toolbar's contents. * Specifying the Toolbar:: Setting a toolbar's contents.
* Other Toolbar Variables:: Controlling the size of toolbars. * Other Toolbar Variables:: Controlling the size of toolbars.
@end menu @end menu
@node Toolbar Intro @node Toolbar Intro, Creating Toolbar, Toolbar, Toolbar
@section Toolbar Intro @section Toolbar Intro
A @dfn{toolbar} is a bar of icons displayed along one edge of a frame. A @dfn{toolbar} is a bar of icons displayed along one edge of a frame.
You can view a toolbar as a series of menu shortcuts---the most You can view a toolbar as a series of menu shortcuts---the most
common menu options can be accessed with a single click rather than common menu options can be accessed with a single click rather than
a series of clicks and/or drags to select the option from a menu. a series of clicks and/or drags to select the option from a menu.
Consistent with this, a help string (called the @dfn{help-echo}) Consistent with this, a help string (called the @dfn{help-echo})
describing what an icon in the toolbar (called a @dfn{toolbar button}) describing what an icon in the toolbar (called a @dfn{toolbar button})
does, is displayed in the minibuffer when the mouse is over the does, is displayed in the minibuffer when the mouse is over the
button. button.
skipping to change at line 62 skipping to change at line 62
default position inherit from the corresponding default specifiers. default position inherit from the corresponding default specifiers.
That way, if the position-specific specifier does not give a value That way, if the position-specific specifier does not give a value
(which it usually doesn't), then the value from the default (which it usually doesn't), then the value from the default
specifier applies. If you want to control the default toolbar, you specifier applies. If you want to control the default toolbar, you
just change the default specifiers, and everything works. A package just change the default specifiers, and everything works. A package
such as VM that wants to put its own toolbar in a different location such as VM that wants to put its own toolbar in a different location
from the default just sets the position-specific specifiers, and if from the default just sets the position-specific specifiers, and if
the user sets the default toolbar to the same position, it will just the user sets the default toolbar to the same position, it will just
not be visible. not be visible.
@node Creating Toolbar @node Creating Toolbar, Toolbar Descriptor Format, Toolbar Intro, Toolbar
@section Creating Toolbar @section Creating Toolbar
@defun make-toolbar-specifier spec-list @defun make-toolbar-specifier spec-list
Return a new @code{toolbar} specifier object with the given Return a new @code{toolbar} specifier object with the given
specification list. @var{spec-list} can be a list of specifications specification list. @var{spec-list} can be a list of specifications
(each of which is a cons of a locale and a list of instantiators), a (each of which is a cons of a locale and a list of instantiators), a
single instantiator, or a list of instantiators. @xref{Specifiers}, for single instantiator, or a list of instantiators. @xref{Specifiers}, for
more information about specifiers. more information about specifiers.
Toolbar specifiers are used to specify the format of a toolbar. The Toolbar specifiers are used to specify the format of a toolbar. The
values of the variables @code{default-toolbar}, @code{top-toolbar}, values of the variables @code{default-toolbar}, @code{top-toolbar},
@code{left-toolbar}, @code{right-toolbar}, and @code{bottom-toolbar} are @code{left-toolbar}, @code{right-toolbar}, and @code{bottom-toolbar} are
always toolbar specifiers. always toolbar specifiers.
Valid toolbar instantiators are called "toolbar descriptors" Valid toolbar instantiators are called "toolbar descriptors"
and are lists of vectors. See @code{default-toolbar} for a description and are lists of vectors. See @code{default-toolbar} for a description
of the exact format. of the exact format.
@end defun @end defun
@node Toolbar Descriptor Format @node Toolbar Descriptor Format, Specifying the Toolbar, Creating Toolbar, Toolb ar
@section Toolbar Descriptor Format @section Toolbar Descriptor Format
The contents of a toolbar are specified using a @dfn{toolbar descriptor}. The contents of a toolbar are specified using a @dfn{toolbar descriptor}.
The format of a toolbar descriptor is a list of @dfn{toolbar button The format of a toolbar descriptor is a list of @dfn{toolbar button
descriptors}. Each toolbar button descriptor is a vector in one of the descriptors}. Each toolbar button descriptor is a vector in one of the
following formats: following formats:
@itemize @bullet @itemize @bullet
@item @item
@code{[@var{glyph-list} @var{function} @var{enabled-p} @var{help}]} @code{[@var{glyph-list} @var{function} @var{enabled-p} @var{help}]}
skipping to change at line 196 skipping to change at line 196
button descriptor). button descriptor).
@end defun @end defun
@defun check-toolbar-button-syntax button &optional noerror @defun check-toolbar-button-syntax button &optional noerror
Verify the syntax of entry @var{button} in a toolbar description list. Verify the syntax of entry @var{button} in a toolbar description list.
If you want to verify the syntax of a toolbar description list as a If you want to verify the syntax of a toolbar description list as a
whole, use @code{check-valid-instantiator} with a specifier type of whole, use @code{check-valid-instantiator} with a specifier type of
@code{toolbar}. @code{toolbar}.
@end defun @end defun
@node Specifying the Toolbar @node Specifying the Toolbar, Other Toolbar Variables, Toolbar Descriptor Format , Toolbar
@section Specifying the Toolbar @section Specifying the Toolbar
In order to specify the contents of a toolbar, set one of the specifier In order to specify the contents of a toolbar, set one of the specifier
variables @code{default-toolbar}, @code{top-toolbar}, variables @code{default-toolbar}, @code{top-toolbar},
@code{bottom-toolbar}, @code{left-toolbar}, or @code{right-toolbar}. @code{bottom-toolbar}, @code{left-toolbar}, or @code{right-toolbar}.
These are specifiers, which means you set them with @code{set-specifier} These are specifiers, which means you set them with @code{set-specifier}
and query them with @code{specifier-specs} or @code{specifier-instance}. and query them with @code{specifier-specs} or @code{specifier-instance}.
You will get an error if you try to set them using @code{setq}. The You will get an error if you try to set them using @code{setq}. The
valid instantiators for these specifiers are toolbar descriptors, as valid instantiators for these specifiers are toolbar descriptors, as
described above. @xref{Specifiers}, for more information. described above. @xref{Specifiers}, for more information.
skipping to change at line 279 skipping to change at line 279
Specifier for the toolbar at the right edge of the frame. Specifier for the toolbar at the right edge of the frame.
@end defvr @end defvr
@defun toolbar-specifier-p object @defun toolbar-specifier-p object
This function returns non-@code{nil} if @var{object} is a toolbar specifier. This function returns non-@code{nil} if @var{object} is a toolbar specifier.
Toolbar specifiers are the actual objects contained in the toolbar Toolbar specifiers are the actual objects contained in the toolbar
variables described above, and their valid instantiators are variables described above, and their valid instantiators are
toolbar descriptors (@pxref{Toolbar Descriptor Format}). toolbar descriptors (@pxref{Toolbar Descriptor Format}).
@end defun @end defun
@node Other Toolbar Variables @node Other Toolbar Variables, , Specifying the Toolbar, Toolbar
@section Other Toolbar Variables @section Other Toolbar Variables
The variables to control the toolbar thickness, visibility status, and The variables to control the toolbar thickness, visibility status, and
captioned status are all specifiers. @xref{Specifiers}. captioned status are all specifiers. @xref{Specifiers}.
@defvr Specifier default-toolbar-height @defvr Specifier default-toolbar-height
This specifies the height of the default toolbar, if it's oriented This specifies the height of the default toolbar, if it's oriented
horizontally. The position of the default toolbar is specified by the horizontally. The position of the default toolbar is specified by the
function @code{set-default-toolbar-position}. If the corresponding function @code{set-default-toolbar-position}. If the corresponding
position-specific toolbar thickness specifier position-specific toolbar thickness specifier
 End of changes. 6 change blocks. 
6 lines changed or deleted 6 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)