<html lang="en">
<head>
<title>GUI Utility Functions - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="GUI-Development.html#GUI-Development" title="GUI Development">
<link rel="prev" href="Progress-Bar.html#Progress-Bar" title="Progress Bar">
<link rel="next" href="User_002dDefined-Preferences.html#User_002dDefined-Preferences" title="User-Defined Preferences">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="GUI-Utility-Functions"></a>
<p>
Next: <a rel="next" accesskey="n" href="User_002dDefined-Preferences.html#User_002dDefined-Preferences">User-Defined Preferences</a>,
Previous: <a rel="previous" accesskey="p" href="Progress-Bar.html#Progress-Bar">Progress Bar</a>,
Up: <a rel="up" accesskey="u" href="GUI-Development.html#GUI-Development">GUI Development</a>
<hr>
</div>
<h3 class="section">35.3 GUI Utility Functions</h3>
<p>These functions do not implement a GUI element but are useful when developing
programs that do. <strong>Warning:</strong> The functions <code>uiwait</code>,
<code>uiresume</code>, and <code>waitfor</code> are only available for the FLTK tooolkit.
<!-- guidata scripts/plot/guidata.m -->
<p><a name="doc_002dguidata"></a>
<div class="defun">
— Function File: <var>data</var> = <b>guidata</b> (<var>handle</var>)<var><a name="index-guidata-3084"></a></var><br>
— Function File: <b>guidata</b> (<var>handle, data</var>)<var><a name="index-guidata-3085"></a></var><br>
</div>
<!-- guihandles scripts/plot/guihandles.m -->
<p><a name="doc_002dguihandles"></a>
<div class="defun">
— Function File: <var>hdata</var> = <b>guihandles</b> (<var>handle</var>)<var><a name="index-guihandles-3086"></a></var><br>
— Function File: <var>hdata</var> = <b>guihandles</b><var><a name="index-guihandles-3087"></a></var><br>
</div>
<!-- uiwait scripts/plot/uiwait.m -->
<p><a name="doc_002duiwait"></a>
<div class="defun">
— Function File: <b>uiwait</b><var><a name="index-uiwait-3088"></a></var><br>
— Function File: <b>uiwait</b> (<var>h</var>)<var><a name="index-uiwait-3089"></a></var><br>
— Function File: <b>uiwait</b> (<var>h, timeout</var>)<var><a name="index-uiwait-3090"></a></var><br>
<blockquote><p>Suspend program execution until the figure with handle <var>h</var> is
deleted or <code>uiresume</code> is called. When no figure handle is specified,
this function uses the current figure.
<p>If the figure handle is invalid or there is no current figure, this
functions returns immediately.
<p>When specified, <var>timeout</var> defines the number of seconds to wait
for the figure deletion or the <code>uiresume</code> call. The timeout value
must be at least 1. If a smaller value is specified, a warning is issued
and a timeout value of 1 is used instead. If a non-integer value is
specified, it is truncated towards 0. If <var>timeout</var> is not specified,
the program execution is suspended indefinitely.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002duiresume.html#doc_002duiresume">uiresume</a>, <a href="doc_002dwaitfor.html#doc_002dwaitfor">waitfor</a>.
</p></blockquote></div>
<!-- uiresume scripts/plot/uiresume.m -->
<p><a name="doc_002duiresume"></a>
<div class="defun">
— Function File: <b>uiresume</b> (<var>h</var>)<var><a name="index-uiresume-3091"></a></var><br>
<blockquote><p>Resume program execution suspended with <code>uiwait</code>. The handle <var>h</var>
must be the same as the on specified in <code>uiwait</code>. If the handle
is invalid or there is no <code>uiwait</code> call pending for the figure
with handle <var>h</var>, this function does nothing.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002duiwait.html#doc_002duiwait">uiwait</a>.
</p></blockquote></div>
<!-- waitfor src/graphics.cc -->
<p><a name="doc_002dwaitfor"></a>
<div class="defun">
— Built-in Function: <b>waitfor</b> (<var>h</var>)<var><a name="index-waitfor-3092"></a></var><br>
— Built-in Function: <b>waitfor</b> (<var>h, prop</var>)<var><a name="index-waitfor-3093"></a></var><br>
— Built-in Function: <b>waitfor</b> (<var>h, prop, value</var>)<var><a name="index-waitfor-3094"></a></var><br>
— Built-in Function: <b>waitfor</b> (<var><small class="dots">...</small>, "timeout", timeout</var>)<var><a name="index-waitfor-3095"></a></var><br>
<blockquote><p>Suspend the execution of the current program until a condition is
satisfied on the graphics handle <var>h</var>. While the program is suspended
graphics events are still being processed normally, allowing callbacks to
modify the state of graphics objects. This function is reentrant and can be
called from a callback, while another <code>waitfor</code> call is pending at
top-level.
<p>In the first form, program execution is suspended until the graphics object
<var>h</var> is destroyed. If the graphics handle is invalid, the function
returns immediately.
<p>In the second form, execution is suspended until the graphics object is
destroyed or the property named <var>prop</var> is modified. If the graphics
handle is invalid or the property does not exist, the function returns
immediately.
<p>In the third form, execution is suspended until the graphics object is
destroyed or the property named <var>prop</var> is set to <var>value</var>. The
function <code>isequal</code> is used to compare property values. If the graphics
handle is invalid, the property does not exist or the property is already
set to <var>value</var>, the function returns immediately.
<p>An optional timeout can be specified using the property <code>timeout</code>.
This timeout value is the number of seconds to wait for the condition to be
true. <var>timeout</var> must be at least 1. If a smaller value is specified, a
warning is issued and a value of 1 is used instead. If the timeout value is
not an integer, it is truncated towards 0.
<p>To define a condition on a property named <code>timeout</code>, use the string
<code>\timeout</code> instead.
<p>In all cases, typing CTRL-C stops program execution immediately.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002disequal.html#doc_002disequal">isequal</a>.
</p></blockquote></div>
</body></html>
