<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html  xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" />
<link rel="stylesheet" href="../robodoc.css" type="text/css" />
<title>./src/gui/utils-ui.ads</title>
<!-- Source: ./src/gui/utils-ui.ads -->
<!-- Generated with ROBODoc Version 4.99.43 (Feb  8 2020) -->
</head>
<body>
<div id="logo">
<a name="robo_top_of_doc">Hunter v1.6 code documentation</a>
</div> <!-- logo -->
<div id="navigation">
<a class="menuitem" href="../toc_index.html#top">Table of Contents</a>
<a class="menuitem" href="../sources.html#top">Source files</a>
<a class="menuitem" href="../index.html#top">Index</a>
<a class="menuitem" href="../robo_tasks.html#top">Tasks</a>
<a class="menuitem" href="../robo_constants.html#top">Constants</a>
<a class="menuitem" href="../robo_exceptions.html#top">Exceptions</a>
<a class="menuitem" href="../robo_subprograms.html#top">Subprograms</a>
<a class="menuitem" href="../robo_packages.html#top">Packages</a>
<a class="menuitem" href="../robo_commands.html#top">Commands</a>
<a class="menuitem" href="../robo_records.html#top">Records</a>
<a class="menuitem" href="../robo_types.html#top">Types</a>
<a class="menuitem" href="../robo_variables.html#top">Variables</a>
</div> <!-- navigation -->
<div id="content">
<h3>TABLE OF CONTENTS</h3>
<ul>
<li>1. <a href="#robo51">Utils/UtilsUI</a></li>
<ul>
<li>1.1. <a href="#robo312">UtilsUI/UtilsUI.Add_Command</a></li>
<li>1.2. <a href="#robo313">UtilsUI/UtilsUI.Find_Executable</a></li>
<li>1.3. <a href="#robo314">UtilsUI/UtilsUI.Set_Dialog</a></li>
<li>1.4. <a href="#robo315">UtilsUI/UtilsUI.Toggle_Tool_Buttons</a></li>
<li>1.5. <a href="#robo316">UtilsUI/UtilsUI.Update_Progress_Bar</a></li>
</ul>
</ul>
<hr />
<a name="Utils2fUtilsUI"></a>
<a name="robo51"></a><h2>Utils/UtilsUI [ Packages ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../utils_ads.html#robo49">Utils</a> ] [ <a href="../robo_packages.html#robo_top_of_doc">Packages</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Various utility subprograms.
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"><span class="keyword">package</span> <a href="../utils_ads.html#robo49">Utils</a><span class="sign">.</span>UI <span class="keyword">is</span>
</pre>

<hr />
<a name="UtilsUI2fUtilsUI2eAdd5fCommand"></a>
<a name="robo312"></a><h2>UtilsUI/UtilsUI.Add_Command [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo51">UtilsUI</a> ] [ <a href="../robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Add command to the Tcl interpreter
</pre>
<p class="item_name">SOURCE</p>
<pre class="source">   <span class="keyword">procedure</span> Add_Command
     <span class="sign">(</span>Name<span class="sign">:</span> String<span class="sign">;</span> Ada_Command<span class="sign">:</span> <span class="keyword">not</span> <span class="keyword">null</span> CreateCommands<span class="sign">.</span>Tcl_CmdProc<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> Name        - Name of the Tcl command which will be used to invoke the
               Ada code
 Ada_Command - Ada function which will be invoked
</pre>

<hr />
<a name="UtilsUI2fUtilsUI2eFind5fExecutable"></a>
<a name="robo313"></a><h2>UtilsUI/UtilsUI.Find_Executable [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo51">UtilsUI</a> ] [ <a href="../robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Find executable file with selected name in this same directory where
 the program is or in PATH variable
</pre>
<p class="item_name">SOURCE</p>
<pre class="source">   <span class="keyword">function</span> Find_Executable
     <span class="sign">(</span>Name<span class="sign">:</span> String<span class="sign">;</span> Display_Message<span class="sign">:</span> Boolean <span class="sign">:</span><span class="sign">=</span> True<span class="sign">)</span> <span class="keyword">return</span> String<span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> Name            - Name of executable file to find
 Display_Message - If true, show message that executable cannot be found.
                   Default value is true.
</pre>
<p class="item_name">RESULT</p>
<pre> Full path to the executable file or empty string and show message if
 file could not be found.
</pre>

<hr />
<a name="UtilsUI2fUtilsUI2eSet5fDialog"></a>
<a name="robo314"></a><h2>UtilsUI/UtilsUI.Set_Dialog [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo51">UtilsUI</a> ] [ <a href="../robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Set the selected dialog
</pre>
<p class="item_name">SOURCE</p>
<pre class="source">   <span class="keyword">procedure</span> Set_Dialog
     <span class="sign">(</span>Dialog<span class="sign">:</span> Tk_Toplevel<span class="sign">;</span> Dialog_Title<span class="sign">:</span> String<span class="sign">;</span> Width<span class="sign">:</span> Width_Range<span class="sign">;</span>
      Height<span class="sign">:</span> Height_Range<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> Dialog       - Tk_Toplevel dialog to set
 Dialog_Title - Title for the selected dialog
 Width        - Desired width for the selected dialog
 Height       - Desired height for the selected dialog
</pre>

<hr />
<a name="UtilsUI2fUtilsUI2eToggle5fTool5fButtons"></a>
<a name="robo315"></a><h2>UtilsUI/UtilsUI.Toggle_Tool_Buttons [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo51">UtilsUI</a> ] [ <a href="../robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Show or hide other tool bar buttons when user starts any action with
 files or directories
</pre>
<p class="item_name">SOURCE</p>
<pre class="source">   <span class="keyword">procedure</span> Toggle_Tool_Buttons
     <span class="sign">(</span>Action<span class="sign">:</span> Item_Actions<span class="sign">;</span> Finished<span class="sign">:</span> Boolean <span class="sign">:</span><span class="sign">=</span> False<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> Action   - Action on files or directories started or finished.
 Finished - If true, action was finished. Default is False
</pre>

<hr />
<a name="UtilsUI2fUtilsUI2eUpdate5fProgress5fBar"></a>
<a name="robo316"></a><h2>UtilsUI/UtilsUI.Update_Progress_Bar [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo51">UtilsUI</a> ] [ <a href="../robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Update fraction of the progress bar or set it maximum value and show it
 to the user
</pre>
<p class="item_name">SOURCE</p>
<pre class="source">   <span class="keyword">procedure</span> Update_Progress_Bar<span class="sign">(</span>Amount<span class="sign">:</span> Natural <span class="sign">:</span><span class="sign">=</span> 0<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> Amount - The maximum value for the progress bar. Will be used to count
          the progress
</pre>

</div> <!-- content -->
<div id="footer">
<p>Generated from ./src/gui/utils-ui.ads with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.43 on Sun Aug 08 2021 07:39:39
</p>
</div> <!-- footer -->
</body>
</html>

