summaryrefslogtreecommitdiff
path: root/devdocs/elisp/layout-parameters.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/layout-parameters.html
new repository
Diffstat (limited to 'devdocs/elisp/layout-parameters.html')
-rw-r--r--devdocs/elisp/layout-parameters.html21
1 files changed, 21 insertions, 0 deletions
diff --git a/devdocs/elisp/layout-parameters.html b/devdocs/elisp/layout-parameters.html
new file mode 100644
index 00000000..2ff23be8
--- /dev/null
+++ b/devdocs/elisp/layout-parameters.html
@@ -0,0 +1,21 @@
+ <h4 class="subsubsection">Layout Parameters</h4> <p>These frame parameters enable or disable various parts of the frame, or control their sizes. </p> <dl compact> <dt><code>border-width</code></dt> <dd>
+<p>The width in pixels of the frame’s outer border (see <a href="frame-geometry">Frame Geometry</a>). </p> </dd> <dt><code>internal-border-width</code></dt> <dd>
+<p>The width in pixels of the frame’s internal border (see <a href="frame-geometry">Frame Geometry</a>). </p> </dd> <dt><code>child-frame-border-width</code></dt> <dd>
+<p>The width in pixels of the frame’s internal border (see <a href="frame-geometry">Frame Geometry</a>) if the given frame is a child frame (see <a href="child-frames">Child Frames</a>). If this is <code>nil</code>, the value specified by the <code>internal-border-width</code> parameter is used instead. </p> </dd> <dt><code>vertical-scroll-bars</code></dt> <dd>
+<p>Whether the frame has scroll bars (see <a href="scroll-bars">Scroll Bars</a>) for vertical scrolling, and which side of the frame they should be on. The possible values are <code>left</code>, <code>right</code>, and <code>nil</code> for no scroll bars. </p> </dd> <dt><code>horizontal-scroll-bars</code></dt> <dd>
+<p>Whether the frame has scroll bars for horizontal scrolling (<code>t</code> and <code>bottom</code> mean yes, <code>nil</code> means no). </p> </dd> <dt><code>scroll-bar-width</code></dt> <dd>
+<p>The width of vertical scroll bars, in pixels, or <code>nil</code> meaning to use the default width. </p> </dd> <dt><code>scroll-bar-height</code></dt> <dd>
+<p>The height of horizontal scroll bars, in pixels, or <code>nil</code> meaning to use the default height. </p> </dd> <dt><code>left-fringe</code></dt> <dt><code>right-fringe</code></dt> <dd>
+<p>The default width of the left and right fringes of windows in this frame (see <a href="fringes">Fringes</a>). If either of these is zero, that effectively removes the corresponding fringe. </p> <p>When you use <code>frame-parameter</code> to query the value of either of these two frame parameters, the return value is always an integer. When using <code>set-frame-parameter</code>, passing a <code>nil</code> value imposes an actual default value of 8 pixels. </p> </dd> <dt><code>right-divider-width</code></dt> <dd>
+<p>The width (thickness) reserved for the right divider (see <a href="window-dividers">Window Dividers</a>) of any window on the frame, in pixels. A value of zero means to not draw right dividers. </p> </dd> <dt><code>bottom-divider-width</code></dt> <dd>
+<p>The width (thickness) reserved for the bottom divider (see <a href="window-dividers">Window Dividers</a>) of any window on the frame, in pixels. A value of zero means to not draw bottom dividers. </p> </dd> <dt><code>menu-bar-lines</code></dt> <dd>
+<p>The number of lines to allocate at the top of the frame for a menu bar (see <a href="menu-bar">Menu Bar</a>). The default is one if Menu Bar mode is enabled and zero otherwise. See <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Menu-Bars.html#Menu-Bars">Menu Bars</a> in <cite>The GNU Emacs Manual</cite>. For an external menu bar (see <a href="frame-layout">Frame Layout</a>), this value remains unchanged even when the menu bar wraps to two or more lines. In that case, the <code>menu-bar-size</code> value returned by <code>frame-geometry</code> (see <a href="frame-geometry">Frame Geometry</a>) allows to derive whether the menu bar actually occupies one or more lines. </p> </dd> <dt><code>tool-bar-lines</code></dt> <dd>
+<p>The number of lines to use for the tool bar (see <a href="tool-bar">Tool Bar</a>). The default is one if Tool Bar mode is enabled and zero otherwise. See <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Tool-Bars.html#Tool-Bars">Tool Bars</a> in <cite>The GNU Emacs Manual</cite>. This value may change whenever the tool bar wraps (see <a href="frame-layout">Frame Layout</a>). </p> </dd> <dt><code>tool-bar-position</code></dt> <dd>
+<p>The position of the tool bar when Emacs was built with GTK+. Its value can be one of <code>top</code>, <code>bottom</code> <code>left</code>, <code>right</code>. The default is <code>top</code>. </p> </dd> <dt><code>tab-bar-lines</code></dt> <dd>
+<p>The number of lines to use for the tab bar (see <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Tab-Bars.html#Tab-Bars">Tab Bars</a> in <cite>The GNU Emacs Manual</cite>). The default is one if Tab Bar mode is enabled and zero otherwise. This value may change whenever the tab bar wraps (see <a href="frame-layout">Frame Layout</a>). </p> </dd> <dt><code>line-spacing</code></dt> <dd>
+<p>Additional space to leave below each text line, in pixels (a positive integer). See <a href="line-height">Line Height</a>, for more information. </p> </dd> <dt><code>no-special-glyphs</code></dt> <dd><p>If this is non-<code>nil</code>, it suppresses the display of any truncation and continuation glyphs (see <a href="truncation">Truncation</a>) for all buffers displayed by this frame. This is useful to eliminate such glyphs when fitting a frame to its buffer via <code>fit-frame-to-buffer</code> (see <a href="resizing-windows">Resizing Windows</a>). </p></dd> </dl><div class="_attribution">
+ <p class="_attribution-p">
+ Copyright &copy; 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br>
+ <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Layout-Parameters.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Layout-Parameters.html</a>
+ </p>
+</div>