Mercurial > hg > xemacs-beta

comparison man/lispref/toolbar.texi @ 412:697ef44129c6 r21-2-14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-14
author cvs
date Mon, 13 Aug 2007 11:20:41 +0200
parents 501cfd01ee6d
children
comparison
equal deleted inserted replaced
411:12e008d41344 412:697ef44129c6
1 @c -*-texinfo-*- 1 @c -*-texinfo-*-
2 @c This is part of the XEmacs Lisp Reference Manual. 2 @c This is part of the XEmacs Lisp Reference Manual.
3 @c Copyright (C) 1995, 1996 Ben Wing. 3 @c Copyright (C) 1995, 1996 Ben Wing.
4 @c See the file lispref.texi for copying conditions. 4 @c See the file lispref.texi for copying conditions.
5 @setfilename ../../info/toolbar.info 5 @setfilename ../../info/toolbar.info
6 @node Toolbar, Gutter, Dialog Boxes, top 6 @node Toolbar, Scrollbars, Dialog Boxes, top
7 @chapter Toolbar 7 @chapter Toolbar
8 @cindex toolbar 8 @cindex toolbar
9 9
10 @menu 10 @menu
11 * Toolbar Intro:: An introduction. 11 * Toolbar Intro:: An introduction.
12 * Creating Toolbar:: How to create a toolbar. 12 * Toolbar Descriptor Format:: How to create a toolbar.
13 * Toolbar Descriptor Format:: Accessing and modifying a toolbar's
14 properties.
15 * Specifying the Toolbar:: Setting a toolbar's contents. 13 * Specifying the Toolbar:: Setting a toolbar's contents.
16 * Other Toolbar Variables:: Controlling the size of toolbars. 14 * Other Toolbar Variables:: Controlling the size of toolbars.
17 @end menu 15 @end menu
18 16
19 @node Toolbar Intro 17 @node Toolbar Intro
20 @section Toolbar Intro 18 @section Toolbar Intro
21 19
22 A @dfn{toolbar} is a bar of icons displayed along one edge of a frame. 20 A @dfn{toolbar} is a bar of icons displayed along one edge of a frame.
23 You can view a toolbar as a series of menu shortcuts---the most 21 You can view a toolbar as a series of menu shortcuts -- the most
24 common menu options can be accessed with a single click rather than 22 common menu options can be accessed with a single click rather than
25 a series of clicks and/or drags to select the option from a menu. 23 a series of clicks and/or drags to select the option from a menu.
26 Consistent with this, a help string (called the @dfn{help-echo}) 24 Consistent with this, a help string (called the @dfn{help-echo})
27 describing what an icon in the toolbar (called a @dfn{toolbar button}) 25 describing what an icon in the toolbar (called a @dfn{toolbar button})
28 does, is displayed in the minibuffer when the mouse is over the 26 does, is displayed in the minibuffer when the mouse is over the
57 such as VM that wants to put its own toolbar in a different location 55 such as VM that wants to put its own toolbar in a different location
58 from the default just sets the position-specific specifiers, and if 56 from the default just sets the position-specific specifiers, and if
59 the user sets the default toolbar to the same position, it will just 57 the user sets the default toolbar to the same position, it will just
60 not be visible. 58 not be visible.
61 59
62 @node Creating Toolbar
63 @section Creating Toolbar
64
65 @defun make-toolbar-specifier spec-list
66
67 Return a new @code{toolbar} specifier object with the given
68 specification list. @var{spec-list} can be a list of specifications
69 (each of which is a cons of a locale and a list of instantiators), a
70 single instantiator, or a list of instantiators. @xref{Specifiers}, for
71 more information about specifiers.
72
73 Toolbar specifiers are used to specify the format of a toolbar. The
74 values of the variables @code{default-toolbar}, @code{top-toolbar},
75 @code{left-toolbar}, @code{right-toolbar}, and @code{bottom-toolbar} are
76 always toolbar specifiers.
77
78 Valid toolbar instantiators are called "toolbar descriptors"
79 and are lists of vectors. See @code{default-toolbar} for a description
80 of the exact format.
81 @end defun
82
83 @node Toolbar Descriptor Format 60 @node Toolbar Descriptor Format
84 @section Toolbar Descriptor Format 61 @section Toolbar Descriptor Format
85 62
86 The contents of a toolbar are specified using a @dfn{toolbar descriptor}. 63 The contents of a toolbar are specified using a @dfn{toolbar descriptor}.
87 The format of a toolbar descriptor is a list of @dfn{toolbar button 64 The format of a toolbar descriptor is a list of @dfn{toolbar button
367 sized to fit 80 characters plus a 68-pixel left toolbar. If you then 344 sized to fit 80 characters plus a 68-pixel left toolbar. If you then
368 set the left toolbar width to 0 for a particular buffer (or if that 345 set the left toolbar width to 0 for a particular buffer (or if that
369 buffer does not specify a left toolbar or has a nil value specified for 346 buffer does not specify a left toolbar or has a nil value specified for
370 @code{left-toolbar-visible-p}), you will find that, when that buffer is 347 @code{left-toolbar-visible-p}), you will find that, when that buffer is
371 displayed in the selected window, the window will have a width of 86 or 348 displayed in the selected window, the window will have a width of 86 or
372 87 characters---the frame is sized for a 68-pixel left toolbar but the 349 87 characters -- the frame is sized for a 68-pixel left toolbar but the
373 selected window specifies that the left toolbar is not visible, so it is 350 selected window specifies that the left toolbar is not visible, so it is
374 expanded to take up the slack. 351 expanded to take up the slack.
375 352
376 @defvr Specifier toolbar-buttons-captioned-p 353 @defvr Specifier toolbar-buttons-captioned-p
377 Whether toolbar buttons are captioned. This affects which glyphs from a 354 Whether toolbar buttons are captioned. This affects which glyphs from a