blob: 38b76dea00ca740e6ff1be498bbcd4d0f4648204 [file]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>Click Sequences (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Click Sequences (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Click Sequences (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Glyphs-for-Programming.html" rel="up" title="Glyphs for Programming">
<link href="_0040point.html" rel="prev" title="@point">
<style type="text/css">
<!--
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
pre.display-preformatted {font-family: inherit}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Click-Sequences">
<div class="nav-panel">
<p>
Previous: <a href="_0040point.html" accesskey="p" rel="prev"><code class="code">@point{}</code> (&lowast;): Indicating Point in a Buffer</a>, Up: <a href="Glyphs-for-Programming.html" accesskey="u" rel="up">Glyphs for Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Click-Sequences-1">11.9.8 Click Sequences</h4>
<a class="index-entry-id" id="index-Click-sequences"></a>
<a class="index-entry-id" id="index-Sequence-of-clicks"></a>
<a class="index-entry-id" id="index-GUI-click-sequence"></a>
<a class="index-entry-id" id="index-clicksequence"></a>
<p>When documenting graphical interfaces, it is necessary to describe
sequences such as &lsquo;Click on &lsquo;<samp class="samp">File</samp>&rsquo;, then choose &lsquo;<samp class="samp">Open</samp>&rsquo;, then
&hellip;&rsquo;. Texinfo offers commands <code class="code">@clicksequence</code> and
<code class="code">click</code> to represent this, typically used like this:
</p>
<div class="example">
<pre class="example-preformatted">&hellip; @clicksequence{File @click{} Open} &hellip;
</pre></div>
<p>which produces:
</p>
<div class="display">
<pre class="display-preformatted">&hellip; File &rarr; Open &hellip;
</pre></div>
<a class="index-entry-id" id="index-click"></a>
<a class="index-entry-id" id="index-arrow"></a>
<p>The <code class="code">@click</code> command produces a right arrow by default; this
glyph is also available independently via the command
<code class="code">@arrow{}</code>.
</p>
<a class="index-entry-id" id="index-clickstyle"></a>
<p>You can change the glyph produced by <code class="code">@click</code> with the command
<code class="code">@clickstyle</code>, which takes a command name as its single argument
on the rest of the line, much like <code class="code">@itemize</code> and friends
(see <a class="pxref" href="_0040itemize.html"><code class="code">@itemize</code>: Making an Itemized List</a>). The command should produce a glyph, and
the usual empty braces &lsquo;<samp class="samp">{}</samp>&rsquo; are omitted. Here&rsquo;s an example:
</p>
<div class="example">
<pre class="example-preformatted">@clickstyle @result
&hellip; @clicksequence{File @click{} Open} &hellip;
</pre></div>
<p>now produces:
</p>
<div class="display">
<pre class="display-preformatted">&hellip; File &rArr; Open &hellip;
</pre></div>
</div>
</body>
</html>