igor-public/doc/html/pearl-gui-tools_8ipf_source.html

104 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PEARL Procedures: pearl-gui-tools.ipf Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PEARL Procedures
&#160;<span id="projectnumber">rev-distro-2.0.3-0-g0fb0fd9</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('pearl-gui-tools_8ipf_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">pearl-gui-tools.ipf</div> </div>
</div><!--header-->
<div class="contents">
<a href="pearl-gui-tools_8ipf.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma rtGlobals=3 // Use modern global access method and strict wave access.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#pragma IgorVersion = 6.1</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#pragma ModuleName = PearlGuiTools</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#pragma version = 1.01</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Miscellaneous GUI tools</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// * progress bar</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// created: matthias.muntwiler@psi.ch, 2013-11-14</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// Copyright (c) 2013 Paul Scherrer Institut</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// $Id$</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="pearl-gui-tools_8ipf.html#aaf29d090c81e00cf44af295193b24c5a"> 18</a></span>&#160;<span class="keyword">function</span> <a class="code" href="pearl-gui-tools_8ipf.html#aaf29d090c81e00cf44af295193b24c5a">display_progress_panel</a>(title, message, progress_max)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordtype">string</span> title</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">string</span> message</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; variable progress_max</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; NewPanel /K=1 /N=ProgressPanel /W=(200,200,402,260) as title</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; TitleBox t_message,pos={2,2},size={189,13},title=message</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; TitleBox t_message,frame=0</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; ValDisplay vd_progress,pos={2,20},size={198,13}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; ValDisplay vd_progress,limits={0,progress_max,0},barmisc={0,0},mode= 3,value= _NUM:0</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; Button b_abort,pos={74,38},size={50,20},title=<span class="stringliteral">&quot;Abort&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; DoUpdate /W=ProgressPanel /E=1</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;end</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="pearl-gui-tools_8ipf.html#a97ad19d83cf0007c4bcf97a32164610f"> 32</a></span>&#160;<span class="keyword">function</span> <a class="code" href="pearl-gui-tools_8ipf.html#a97ad19d83cf0007c4bcf97a32164610f">update_progress_panel</a>(progress, [message, progress_max])</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// returns true if the user clicked the Abort button</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; variable progress</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">string</span> message</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; variable progress_max</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span> (!ParamIsDefault(message)) </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; TitleBox t_message,title=message,win=ProgressPanel</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; endif</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (ParamIsDefault(progress_max))</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; ValDisplay vd_progress,value=_NUM:progress,win=ProgressPanel</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; ValDisplay vd_progress,limits={0,progress_max,0},value=_NUM:progress,win=ProgressPanel</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; endif</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; DoUpdate /W=ProgressPanel</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> (v_flag == 2)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;end</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="pearl-gui-tools_8ipf.html#aca0a41a0f28a35ac7535df30ddbd79fe"> 50</a></span>&#160;<span class="keyword">function</span> <a class="code" href="pearl-gui-tools_8ipf.html#aca0a41a0f28a35ac7535df30ddbd79fe">kill_progress_panel</a>()</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; KillWindow ProgressPanel</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;end</div><div class="ttc" id="pearl-gui-tools_8ipf_html_aca0a41a0f28a35ac7535df30ddbd79fe"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#aca0a41a0f28a35ac7535df30ddbd79fe">kill_progress_panel</a></div><div class="ttdeci">variable kill_progress_panel()</div><div class="ttdef"><b>Definition:</b> <a href="pearl-gui-tools_8ipf_source.html#l00050">pearl-gui-tools.ipf:50</a></div></div>
<div class="ttc" id="pearl-gui-tools_8ipf_html_aaf29d090c81e00cf44af295193b24c5a"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#aaf29d090c81e00cf44af295193b24c5a">display_progress_panel</a></div><div class="ttdeci">variable display_progress_panel(string title, string message, variable progress_max)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-gui-tools_8ipf_source.html#l00018">pearl-gui-tools.ipf:18</a></div></div>
<div class="ttc" id="pearl-gui-tools_8ipf_html_a97ad19d83cf0007c4bcf97a32164610f"><div class="ttname"><a href="pearl-gui-tools_8ipf.html#a97ad19d83cf0007c4bcf97a32164610f">update_progress_panel</a></div><div class="ttdeci">variable update_progress_panel(variable progress, string message=defaultValue, variable progress_max=defaultValue)</div><div class="ttdef"><b>Definition:</b> <a href="pearl-gui-tools_8ipf_source.html#l00032">pearl-gui-tools.ipf:32</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_fe5dc42579d4b99403482a3a637d9f7d.html">pearl</a></li><li class="navelem"><a class="el" href="pearl-gui-tools_8ipf.html">pearl-gui-tools.ipf</a></li>
<li class="footer">Generated on Thu Feb 28 2019 18:57:24 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>