[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
29.1 Toolbar Intro | An introduction. | |
29.2 Creating Toolbar | How to create a toolbar. | |
29.3 Toolbar Descriptor Format | Accessing and modifying a toolbar’s properties. | |
29.4 Specifying the Toolbar | Setting a toolbar’s contents. | |
29.5 Other Toolbar Variables | Controlling the size of toolbars. |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
A 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 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. Consistent with this, a help string (called the help-echo) describing what an icon in the toolbar (called a toolbar button) does, is displayed in the minibuffer when the mouse is over the button.
In XEmacs, a toolbar can be displayed along any of the four edges of the frame, and two or more different edges can be displaying toolbars simultaneously. The contents, thickness, and visibility of the toolbars can be controlled separately, and the values can be per-buffer, per-frame, etc., using specifiers (see section Specifiers).
Normally, there is one toolbar displayed in a frame. Usually, this is
the standard toolbar, but certain modes will override this and
substitute their own toolbar. In some cases (e.g. the VM package), a
package will supply its own toolbar along a different edge from the
standard toolbar, so that both can be visible at once. This standard
toolbar is usually positioned along the top of the frame, but this can
be changed using set-default-toolbar-position
.
Note that, for each of the toolbar properties (contents, thickness,
and visibility), there is a separate specifier for each of the four
toolbar positions (top, bottom, left, and right), and an additional
specifier for the “default” toolbar, i.e. the toolbar whose
position is controlled by set-default-toolbar-position
. The
way this works is that set-default-toolbar-position
arranges
things so that the appropriate position-specific specifiers for the
default position inherit from the corresponding default specifiers.
That way, if the position-specific specifier does not give a value
(which it usually doesn’t), then the value from the default
specifier applies. If you want to control the default toolbar, you
just change the default specifiers, and everything works. A package
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
the user sets the default toolbar to the same position, it will just
not be visible.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Return a new toolbar
specifier object with the given
specification list. spec-list can be a list of specifications
(each of which is a cons of a locale and a list of instantiators), a
single instantiator, or a list of instantiators. See section Specifiers, for
more information about specifiers.
Toolbar specifiers are used to specify the format of a toolbar. The
values of the variables default-toolbar
, top-toolbar
,
left-toolbar
, right-toolbar
, and bottom-toolbar
are
always toolbar specifiers.
Valid toolbar instantiators are called "toolbar descriptors"
and are lists of vectors. See default-toolbar
for a description
of the exact format.
The default toolbar is created in ‘toolbar-items.el’. An example which modifies an existing toolbar (by adding a button) is presented in the specifier section See section Simple Specifier Usage.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The contents of a toolbar are specified using a toolbar descriptor. The format of a toolbar descriptor is a list of toolbar button descriptors. Each toolbar button descriptor is a vector in one of the following formats:
[glyph-list function enabled-p help]
[:style 2d-or-3d]
[:style 2d-or-3d :size width-or-height]
[:size width-or-height :style 2d-or-3d]
Optionally, one of the toolbar button descriptors may be nil
instead of a vector; this signifies the division between the toolbar
buttons that are to be displayed flush-left, and the buttons to be
displayed flush-right.
The first vector format above specifies a normal toolbar button; the others specify blank areas in the toolbar.
For the first vector format:
make-glyph
) or a symbol whose value is such a list. The first
glyph, which must be provided, is the glyph used to display the toolbar
button when it is in the “up” (not pressed) state. The optional
second glyph is for displaying the button when it is in the “down”
(pressed) state. The optional third glyph is for when the button is
disabled. The last three glyphs are for displaying the button in the
“up”, “down”, and “disabled” states, respectively, but are used
when the user has called for captioned toolbar buttons (using
toolbar-buttons-captioned-p
). The function
toolbar-make-button-list
is useful in creating these glyph lists.
UP: up DOWN: down -> up DISABLED: disabled -> up CAP-UP: cap-up -> up CAP-DOWN: cap-down -> cap-up -> down -> up CAP-DISABLED: cap-disabled -> cap-up -> disabled -> up |
call-interactively
, since this is how it is
invoked.
nil
, should be a string.
This string is displayed in the echo area when the mouse passes over the
toolbar button.
For the other vector formats (specifying blank areas of the toolbar):
2d
or 3d
,
indicating whether the area is displayed with shadows (giving it a
raised, 3-d appearance) or without shadows (giving it a flat
appearance).
This function calls make-glyph
on each arg and returns a list of
the results. This is useful for setting the first argument of a toolbar
button descriptor (typically, the result of this function is assigned
to a symbol, which is specified as the first argument of the toolbar
button descriptor).
Verify the syntax of entry button in a toolbar description list.
If you want to verify the syntax of a toolbar description list as a
whole, use check-valid-instantiator
with a specifier type of
toolbar
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
In order to specify the contents of a toolbar, set one of the specifier
variables default-toolbar
, top-toolbar
,
bottom-toolbar
, left-toolbar
, or right-toolbar
.
These are specifiers, which means you set them with set-specifier
and query them with specifier-specs
or specifier-instance
.
You will get an error if you try to set them using setq
. The
valid instantiators for these specifiers are toolbar descriptors, as
described above. See section Specifiers, for more information.
Most of the time, you will set default-toolbar
, which allows
the user to choose where the toolbar should go.
The position of this toolbar is specified in the function
default-toolbar-position
. If the corresponding
position-specific toolbar (e.g. top-toolbar
if
default-toolbar-position
is top
) does not specify a
toolbar in a particular domain, then the value of default-toolbar
in that domain, of any, will be used instead.
Note that the toolbar at any particular position will not be displayed
unless its thickness (width or height, depending on orientation) is
non-zero and its visibility status is true. The thickness is controlled
by the specifiers top-toolbar-height
,
bottom-toolbar-height
, left-toolbar-width
, and
right-toolbar-width
, and the visibility status is controlled by
the specifiers top-toolbar-visible-p
,
bottom-toolbar-visible-p
, left-toolbar-visible-p
, and
right-toolbar-visible-p
(see section Other Toolbar Variables).
This function sets the position that the default-toolbar
will be
displayed at. Valid positions are the symbols top
,
bottom
, left
and right
. What this actually does is
set the fallback specifier for the position-specific specifier
corresponding to the given position to default-toolbar
, and set
the fallbacks for the other position-specific specifiers to nil
.
It also does the same thing for the position-specific thickness and
visibility specifiers, which inherit from one of
default-toolbar-height
or default-toolbar-width
, and from
default-toolbar-visible-p
, respectively (see section Other Toolbar Variables).
This function returns the position that the default-toolbar
will
be displayed at.
You can also explicitly set a toolbar at a particular position. When
redisplay determines what to display at a particular position in a
particular domain (i.e. window), it first consults the position-specific
toolbar. If that does not yield a toolbar descriptor, the
default-toolbar
is consulted if default-toolbar-position
indicates this position.
Specifier for the toolbar at the top of the frame.
Specifier for the toolbar at the bottom of the frame.
Specifier for the toolbar at the left edge of the frame.
Specifier for the toolbar at the right edge of the frame.
This function returns non-nil
if object is a toolbar specifier.
Toolbar specifiers are the actual objects contained in the toolbar
variables described above, and their valid instantiators are
toolbar descriptors (see section Toolbar Descriptor Format).
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This document was generated by Aidan Kehoe on December 27, 2016 using texi2html 1.82.