This file is indexed.

/usr/share/doc/gnat-gps/html/Adding-stock-icons.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
<!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 stock icons</title>

<meta name="description" content="Using the GNAT Programming Studio: Adding stock icons">
<meta name="keywords" content="Using the GNAT Programming Studio: Adding stock icons">
<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="Remote-programming-customization.html#Remote-programming-customization" rel="next" title="Remote programming customization">
<link href="Adding-documentation.html#Adding-documentation" rel="previous" title="Adding documentation">
<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-stock-icons"></a>
<div class="header">
<p>
Next: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="n" rel="next">Remote programming customization</a>, Previous: <a href="Adding-documentation.html#Adding-documentation" accesskey="p" rel="previous">Adding documentation</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-stock-icons-1"></a>
<h4 class="subsection">16.5.18 Adding stock icons</h4>
<a name="index-stock_005ficons"></a>
<a name="index-_003cstock_005ficons_003e"></a>

<p>XML files can be used to define &ldquo;stock icons&rdquo;. Stock icons are pictures
that are identified by their label, and which are used through GPS in various
places, such as buttons, menus, toolbars, and so on.
</p>
<p>The stock icons must be declared using the tag <code>&lt;icon&gt;</code>, within the global
tag <code>&lt;stock&gt;</code>. The attribute <code>id</code> indicates the label used to identify
the stock icon, and the attribute <code>file</code> points to the file which contains
the actual picture, either in absolute format, or relative to the directory
which contains the XML file.
</p>
<p>If the stock icon is to be used in a toolbar, use the attribute <code>label</code> to
specify the text to display in the toolbar, under the button, when the toolbar
is configured to show text.
</p>
<p>For icons that are intended to be displayed at multiple sizes, you can specify
multiple files corresponding to these multiple sizes. This is done by adding
children to the main icon node, with the tag <code>alternate</code>, containing
a <code>file</code> attribute and a <code>size</code> attribute which correspond to the
size for which this alternate source should be used.
</p>
<p>Possible sizes are:
</p>
<dl compact="compact">
<dt><code>1</code></dt>
<dd><p>Menu item (ideal size: 16x16 pixels)
</p>
</dd>
<dt><code>2</code></dt>
<dd><p>Button in a small toolbar (ideal size: 18x18 pixels)
</p>
</dd>
<dt><code>3</code></dt>
<dd><p>Button in a large toolbar (ideal size: 24x24 pixels)
</p>
</dd>
<dt><code>4</code></dt>
<dd><p>Image for a standard button (ideal size: 20x20 pixels)
</p>
</dd>
<dt><code>5</code></dt>
<dd><p>Image used during drag-and-drop operation (ideal size: 32x32 pixels)
</p>
</dd>
<dt><code>6</code></dt>
<dd><p>Main image in a dialog (ideal size: 48x48 pixels)
</p>
</dd>
</dl>

<p>Here is an example:
</p><div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;my_visual_preferences&gt;
  &lt;stock&gt;
    &lt;icon id=&quot;myproject-my-picture&quot; file=&quot;icons/my-picture.png&quot; /&gt;

    &lt;icon id=&quot;myproject-multipurpose-image&quot;
           label=&quot;do something&quot;
           file=&quot;icons/icon_default.png&quot;&gt;
       &lt;alternate file&quot;icons/icon_16.png&quot; size=&quot;menu&quot; /&gt;
       &lt;alternate file&quot;icons/icon_24.png&quot; size=&quot;large_toolbar&quot; /&gt;
       &lt;alternate file&quot;icons/icon_20.png&quot; size=&quot;button&quot; /&gt;
    &lt;/icon&gt;

  &lt;/stock&gt;
&lt;/my_visual_preferences&gt;
</pre></div>

<p>Note: as shown in the example above, it is a good practice to prefix the label
by a unique name (e.g. <code>myproject-</code>), in order to make sure that
predefined stock icons will not get overridden by your icons.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="n" rel="next">Remote programming customization</a>, Previous: <a href="Adding-documentation.html#Adding-documentation" accesskey="p" rel="previous">Adding documentation</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>