This file is indexed.

/usr/share/doc/gnat-gps/html/Adding-new-menus.html is in gnat-gps-doc 5.0-16.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see http://www.gnu.org/licenses/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: Adding new menus</title>

<meta name="description" content="Using the GNAT Programming Studio: Adding new menus">
<meta name="keywords" content="Using the GNAT Programming Studio: Adding new menus">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" rel="up" title="Customizing through XML and Python files">
<link href="Adding-contextual-menus.html#Adding-contextual-menus" rel="next" title="Adding contextual menus">
<link href="Filtering-actions.html#Filtering-actions" rel="previous" title="Filtering actions">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    

-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Adding-new-menus"></a>
<div class="header">
<p>
Next: <a href="Adding-contextual-menus.html#Adding-contextual-menus" accesskey="n" rel="next">Adding contextual menus</a>, Previous: <a href="Filtering-actions.html#Filtering-actions" accesskey="p" rel="previous">Filtering actions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Adding-new-menus-1"></a>
<h4 class="subsection">16.5.5 Adding new menus</h4>
<a name="index-menus"></a>
<a name="index-_003cmenu_003e"></a>
<a name="index-_003csubmenu_003e"></a>
<a name="index-_003ctitle_003e"></a>

<p>These commands can be associated with menus, tool bar buttons and keys. All
of these use similar syntax.
</p>
<p>Binding a menu to an action is done through the <code>&lt;menu&gt;</code> and
<code>&lt;submenu&gt;</code> tags.
</p>
<p>The <code>&lt;menu&gt;</code> tag takes the following attributes:
</p>
<dl compact="compact">
<dt><code>action  (mandatory)</code></dt>
<dd><p>This attribute specifies which action to execute
when the menu is selected by the user. If no action by this name was defined,
no new menu is added. The action name can start with a &rsquo;/&rsquo;, in which case
it represents the absolute path to a menu to execute instead.
</p>
<p>This attribute can be omitted only when no title is specified for the menu
to make it a separator (see below).
</p>
<p>If a filter is associated with the action through the <code>&lt;filter&gt;</code> tag,
then the menu will be greyed out when the filter doesn&rsquo;t match. As a
result, users will not be able to click on it.
</p>
</dd>
<dt><code>before  (optional)</code></dt>
<dd><p>It specifies the name of another menu item before
which the new menu should be inserted. The reference menu must have been
created before, otherwise the new menu is inserted at the end. This attribute
can be used to control where precisely the new menu should be made visible.
</p>
</dd>
<dt><code>after   (optional)</code></dt>
<dd><p>This attribute is similar to <code>before</code>, but has a lower priority. If it
is specified, and there is no <code>before</code> attribute, it specifies a reference
menu after which the new menu should be inserted.
</p>
</dd>
</dl>

<p>It should also have one XML child called <code>&lt;title&gt;</code> which specifies the
label of the menu. This is really a path to a menu, and thus you can define
submenus by specifying something like &quot;/Parent1/Parent2/Menu&quot; in the title
to automatically create the parent menus if they don&rsquo;t exist yet.
</p>
<p>You can define the accelerator keys for your menus, using underscores
in the titles. Thus, if you want an accelerator on the first letter in
a menu named <code>File</code>, set its title as <code>_File</code>.
</p>
<p>The tag <code>&lt;submenu&gt;</code> accepts the following attributes:
</p>
<dl compact="compact">
<dt><code>before  (optional)</code></dt>
<dd><p>See description above, same as for <code>&lt;menu&gt;</code>
</p>
</dd>
<dt><code>after   (optional)</code></dt>
<dd><p>See description above, same as for <code>&lt;menu&gt;</code>
</p></dd>
</dl>

<p>It accepts several children, among <code>&lt;title&gt;</code> (which must be specified
at most once), <code>&lt;submenu&gt;</code> (for nested menus), and <code>&lt;menu&gt;</code>.
</p>
<p>Since <code>&lt;submenu&gt;</code> doesn&rsquo;t accept the <code>action</code> attribute, you should
use <code>&lt;menu&gt;</code> for clickable items that should result in an action, and
<code>&lt;submenu&gt;</code> if you want to define several menus with the same path.
</p>
<p>You can specify which menu the new item is added to in one of two ways:
</p>
<ul>
<li> Specify a path in the <code>title</code> attribute of <code>&lt;menu&gt;</code>
</li><li> Put the <code>&lt;menu&gt;</code> as a child of a <code>&lt;submenu&gt;</code> node
  This requires slightly more typing, but it allows you to specify the exact
  location, at each level, of the parent menu (before or after an existing
  menu).
</li></ul>

<p>For example, this adds an item named <code>mymenu</code> to the standard
<code>Edit</code> menu.
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;test&gt;
  &lt;submenu&gt;
    &lt;title&gt;Edit&lt;/title&gt;
    &lt;menu action=&quot;current file uses&quot;&gt;
       &lt;title&gt;mymenu&lt;/title&gt;
    &lt;/menu&gt;
  &lt;/submenu&gt;
&lt;/test&gt;
</pre></div>

<p>The following has exactly the same effect:
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;test&gt;
  &lt;menu action=&quot;current file uses&quot;&gt;
    &lt;title&gt;Edit/mymenu&lt;/title&gt;
  &lt;/menu&gt;
&lt;/test&gt;
</pre></div>

<p>The following adds a new item &quot;stats&quot; to the &quot;unit testing&quot; submenu
in &quot;my_tools&quot;.
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;test&gt;
  &lt;menu action=&quot;execute my stats&quot;&gt;
     &lt;title&gt;/My_Tools/unit testing/stats&lt;/title&gt;
  &lt;/menu&gt;
&lt;/test&gt;
</pre></div>

<p>The previous syntax is shorter, but less flexible than the following,
where we also force the My_Tools menu, if it doesn&rsquo;t exist yet, to
appear after the File menu. This is not doable by using only <code>&lt;menu&gt;</code>
tags. We also insert several items in that new menu
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;test&gt;
  &lt;submenu after=&quot;File&quot;&gt;
    &lt;title&gt;My_Tools&lt;/title&gt;
    &lt;menu action=&quot;execute my stats&quot;&gt;
       &lt;title&gt;unit testing/stats&lt;/title&gt;
    &lt;/menu&gt;
    &lt;menu action=&quot;execute my stats2&quot;&gt;
       &lt;title&gt;unit testing/stats2&lt;/title&gt;
    &lt;/menu&gt;
  &lt;/submenu&gt;
&lt;/test&gt;
</pre></div>

<a name="index-menu-separator"></a>
<p>Adding an item with an empty title or no title at all inserts a
menu separator. For instance, the following example will insert a separator
followed by a File/Custom menu:
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;menus&gt;
  &lt;action name=&quot;execute my stats&quot; /&gt;
  &lt;submenu&gt;
     &lt;title&gt;File&lt;/title&gt;
     &lt;menu&gt;&lt;title/&gt;&lt;/menu&gt;
     &lt;menu action=&quot;execute my stats&quot;&gt;
         &lt;title&gt;Custom&lt;/title&gt;
     &lt;/menu&gt;
  &lt;/submenu&gt;
&lt;/menus&gt;
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="Adding-contextual-menus.html#Adding-contextual-menus" accesskey="n" rel="next">Adding contextual menus</a>, Previous: <a href="Filtering-actions.html#Filtering-actions" accesskey="p" rel="previous">Filtering actions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>