[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1 Toolbar


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.1 Toolbar Intro

#### Not yet written.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.2 Toolbar Descriptor Format

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:

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:

For the other vector formats (specifying blank areas of the toolbar):

Function: toolbar-make-button-list up &optional down disabled

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).

Function: check-toolbar-button-syntax button &optional noerror

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] [ ? ]

1.3 Specifying the Toolbar

In order to specify a toolbar, set one of the 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. @xref{Specifiers} for more information.

Most of the time, you will set default-toolbar, which allows the user to choose where the toolbar should go.

Variable: default-toolbar

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. The thickness is controlled by the variables top-toolbar-height, bottom-toolbar-height, left-toolbar-width, and right-toolbar-width (see section Other Toolbar Variables). By default, only top-toolbar-height has a non-zero value.

Function: set-default-toolbar-position position

This function sets the position that the default-toolbar will be displayed at. Valid positions are the symbols top, bottom, left and right.

Function: default-toolbar-position

This function return 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.

Variable: top-toolbar

Specifier for toolbar at the top of the frame.

Variable: bottom-toolbar

Specifier for toolbar at the bottom of the frame.

Variable: left-toolbar

Specifier for toolbar at the left edge of the frame.

Variable: right-toolbar

Specifier for toolbar at the right edge of the frame.

Function: toolbar-specifier-p object

This function Returns non-nil if object is an toolbar specifier. Toolbar specifiers are the actual objects contained in the toolbar variables described above.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.4 Other Toolbar Variables

The variables to control the toolbar height and width are all specifiers. @xref{Specifiers}.

Variable: top-toolbar-height

Height of top toolbar.

Variable: bottom-toolbar-height

Height of bottom toolbar.

Variable: left-toolbar-width

Width of left toolbar.

Variable: right-toolbar-width

Width of right toolbar.

You can also reset the toolbar to what it was when XEmacs started up.

Variable: initial-toolbar-spec

The toolbar descriptor used to initialize default-toolbar at startup.


[Top] [Contents] [Index] [ ? ]

About This Document

This document was generated on December 6, 2024 using texi2html 5.0.

The buttons in the navigation panels have the following meaning:

Button Name Go to From 1.2.3 go to
[ << ] FastBack Beginning of this chapter or previous chapter 1
[ < ] Back Previous section in reading order 1.2.2
[ Up ] Up Up section 1.2
[ > ] Forward Next section in reading order 1.2.4
[ >> ] FastForward Next chapter 2
[Top] Top Cover (top) of document  
[Contents] Contents Table of contents  
[Index] Index Index  
[ ? ] About About (help)  

where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure:


This document was generated on December 6, 2024 using texi2html 5.0.