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
|
########################################################################
##
## Copyright (C) 2012-2025 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: 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 3 of the License, or
## (at your option) any later version.
##
## Octave 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 Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} uiwait
## @deftypefnx {} {} uiwait (@var{h})
## @deftypefnx {} {} uiwait (@var{h}, @var{timeout})
## Suspend program execution until the figure with handle @var{h} is deleted
## or @code{uiresume} is called.
##
## When no figure handle is specified this function uses the current figure.
## If the figure handle is invalid or there is no current figure, this
## functions returns immediately.
##
## When specified, @var{timeout} defines the number of seconds to wait
## for the figure deletion or the @code{uiresume} 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} is not specified,
## the program execution is suspended indefinitely.
## @seealso{uiresume, waitfor}
## @end deftypefn
function uiwait (varargin)
h = [];
timeout = [];
if (nargin == 0)
h = get (0, "currentfigure");
else
h = varargin{1};
if (! isfigure (h))
error ("uiwait: invalid figure handle H");
endif
if (nargin > 1)
timeout = varargin{2};
endif
endif
if (! isempty (h))
unwind_protect
try
addproperty ("__uiwait_state__", h, "radio", "none|{active}|triggered");
catch
if (! strcmp (get (h, "__uiwait_state__"), "none"))
error ("uiwait: an active uiwait call for this figure already exists");
endif
set (h, "__uiwait_state__", "active");
end_try_catch
waitfor_args = {h, "__uiwait_state__", "triggered"};
if (! isempty (timeout))
waitfor_args(end+1:end+2) = {"timeout", timeout};
endif
waitfor (waitfor_args{:});
unwind_protect_cleanup
if (ishghandle (h) && isprop (h, "__uiwait_state__"))
set (h, "__uiwait_state__", "none");
endif
end_unwind_protect
endif
endfunction
|
