add-common-status-bar

Arguments: window &rest options &key (font (status-bar-font window)) parts min-height (minimum-height min-height) size-grip-p along-top-p name

Creates a status-bar that has multiple sections, rather than allowing multiple lines of text as with status-bars created by add-status-bar. The status bar is placed along the bottom of window. Panes that are siblings of the new status-bar and overlap with it are automatically resized so they no longer overlap with the new status-bar. The status bar added by this function has a more Windows look and feel compared to that added by add-status-bar but, as mentioned, supports only one line of text.

The arguments are:

• font specifies the font that will be used for status-bar messages. The height of the status-bar is set to fit this font.
• parts can be a list of section widths (a number or t) into which the status-bar will be divided. If some members of the list are t, then those sections will be assigned a width such that they are equally wide and just wide enough to make all of the sections cover the entire width of window.
• min-height can be used to make the status-bar taller than its default, which is the height of the status-bar's font.
• size-grip-p is designed to control whether a resizing icon is added at the right end of the status-bar (yes if true, no if nil) but the OS seems to add it in all cases.
• along-top-p if true adds the status-bar to the top of window rather than the bottom as usual. The automatic resizing of sibling panes to make room for the status-bar is not implemented when the status-bar is placed along the top.
• name, if supplied, should be a symbol (we recommend using a keyword) providing a programmatic handle for the status bar, suitable as the name argument to, e.g., find-named-object.

Note that the argument list of this function as returned by arglist (or describe or other tools) includes &rest options. This is included for internal technical reasons. From the programmer's point of view, there is one required argument and a number of keyword arguments.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.