macro/command/statusbox.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <title>statusbox</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>statusbox</h1>

<p>
Displays the status dialog box.
</p>

<pre class="macro-syntax">
statusbox &lt;message&gt; &lt;title&gt; [&lt;special&gt;]
</pre>

<h2>Parameters</h2>

<dl>
        <dt class="macro">string &lt;message&gt;</dt>
        <dd>It is displayed in the dialog box.</dd>

        <dt class="macro">string &lt;title&gt;</dt>
        <dd>It is displayed as the dialog box title.</dd>

        <dt class="macro">integer &lt;special&gt; (optional default=0)</dt>
        <dd>If it is non-zero, following strings in &lt;message&gt; is treated as spacial character.<br>
            <table border="2">
             <tr>
              <th>input</th>
              <th>output</th>
             </tr>
             <tr>
              <td>\\</td>
              <td>"\"</td>
             </tr>
             <tr>
              <td>\n</td>
              <td>line feed</td>
             </tr>
             <tr>
              <td>\t</td>
              <td>tab</td>
             </tr>
            </table>
            <b><u>This option is obsolete. You are recommended to use the strspecial command.</u></b>
        </dd>
</dl>

<h2>Remarks</h2>

<p>
Displays the status dialog box if it has not been displayed yet.<br>
Changes the message to &lt;message&gt; and title to &lt;title&gt;.
</p>

<p>
The "<a href="setdlgpos.html">setdlgpos</a>" command changes the position of status dialog box.<br>
The "<a href="closesbox.html">closesbox</a>" command closes the status dialog box. A user can not close the status dialog box by using the Enter and ESC key.
</p>

<h2>Example</h2>

<pre class="macro-example">
; Set the initial position.
setdlgpos 200 200
; Display the status dialog box.
statusbox 'Message' 'Title'
pause 3
; Move the dialog box.
setdlgpos 0 0
pause 3
; Move the dialog box.
closesbox
</pre>


<pre class="macro-example">
; infinite loop while displaying the counter
step = 0
while 1
  call show_step
  sendln 'echo do something'
  wait '$'
  pause 2
endwhile
end

:show_step
step = step + 1
gettime timestr &quot;%Y/%m/%d-%H:%M:%S&quot;
sprintf2 s &quot;counter %d&quot; step
statusbox timestr s
return
</pre>

<h2>See also</h2>
<ul>
  <li><a href="strspecial.html">strspecial</a></li>
  <li><a href="closesbox.html">closesbox</a></li>
  <li><a href="bringupbox.html">bringupbox</a></li>
  <li><a href="setdlgpos.html">setdlgpos</a></li>
</ul>

</body>
</html>