octave-nkf: scripts/plot/waitbar.m annotate

annotate scripts/plot/waitbar.m @ 17447:359366a4994f

waitbar.m: Use Octave coding conventions. * scripts/plot/waitbar.m: Rename 'retval' to 'h' to match documentation. Use 'hf', 'hp' for figure and patch graphics handles.

author	Rik <rik@octave.org>
date	Thu, 19 Sep 2013 14:26:47 -0700
parents	efd8963f925f
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14112 diff changeset	1 ## Copyright (C) 2012 John W. Eaton
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	2 ##
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	3 ## This file is part of Octave.
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	4 ##
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	8 ## your option) any later version.
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	9 ##
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	13 ## General Public License for more details.
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	14 ##
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	18
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	19 ## -- texinfo --
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	20 ## @deftypefn {Function File} {@var{h} =} waitbar (@var{frac})
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	21 ## @deftypefnx {Function File} {@var{h} =} waitbar (@var{frac}, @var{msg})
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	22 ## @deftypefnx {Function File} {@var{h} =} waitbar (@dots{}, "FigureProperty", "Value", @dots{})
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	23 ## @deftypefnx {Function File} {} waitbar (@var{frac})
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	24 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar})
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	25 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}, @var{msg})
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	26 ## Return a handle @var{h} to a new waitbar object.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	27 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	28 ## The waitbar is filled to fraction @var{frac} which must be in the range
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	29 ## [0, 1]. The optional message @var{msg} is centered and displayed above the
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	30 ## waitbar. The appearance of the waitbar figure window can be configured by
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14313 diff changeset	31 ## passing property/value pairs to the function.
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	32 ##
13832 2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	33 ## When called with a single input the current waitbar, if it exists, is
2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	34 ## updated to the new value @var{frac}. If there are multiple outstanding
2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	35 ## waitbars they can be updated individually by passing the handle @var{hwbar}
2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	36 ## of the specific waitbar to modify.
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	37 ## @end deftypefn
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	38
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	39 ## Author: jwe
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	40
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	41 function h = waitbar (varargin)
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	42
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	43 persistent curr_waitbar;
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	44
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	45 if (nargin < 1)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	46 print_usage ();
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	47 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	48
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	49 frac = varargin{1};
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	50 varargin(1) = [];
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	51
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	52 if (! (isnumeric (frac) && isscalar (frac) && frac >= 0 && frac <= 1))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	53 error ("waitbar: FRAC must be between 0 and 1");
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	54 endif
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	55
13821 4d1927edf194 waitbar: use previous bar if nargin == 1, not nargout == 1 John W. Eaton <jwe@octave.org> parents: 13818 diff changeset	56 ## Use existing waitbar if it still points to a valid graphics handle.
4d1927edf194 waitbar: use previous bar if nargin == 1, not nargout == 1 John W. Eaton <jwe@octave.org> parents: 13818 diff changeset	57 if (nargin == 1 && ishandle (curr_waitbar))
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	58 hf = curr_waitbar;
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	59 else
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	60 hf = false;
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	61 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	62
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	63 if (! isempty (varargin) && isnumeric (varargin{1}))
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	64 hf = varargin{1};
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	65 varargin(1) = [];
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	66 if (! isfigure (hf) \|\| ! strcmp (get (hf, "tag"), "waitbar"))
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	67 error ("waitbar: H must be a handle to a waitbar object");
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	68 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	69 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	70
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	71 msg = false;
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	72
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	73 if (! isempty (varargin))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	74 msg = varargin{1};
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	75 varargin(1) = [];
13847 9fc597693b0b allow waitbar message to be a cellstr object John W. Eaton <jwe@octave.org> parents: 13832 diff changeset	76 if (! (ischar (msg) \|\| iscellstr (msg)))
9fc597693b0b allow waitbar message to be a cellstr object John W. Eaton <jwe@octave.org> parents: 13832 diff changeset	77 error ("waitbar: MSG must be a character string or cell array of strings");
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	78 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	79 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	80
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	81 if (rem (numel (varargin), 2) != 0)
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	82 error ("waitbar: invalid number of property/value pairs");
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	83 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	84
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	85 if (hf)
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	86 gd = get (hf, "__guidata__");
17141 13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	87 ## Get the cached handles.
13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	88 ax = gd(1);
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	89 hp = gd(2);
17141 13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	90
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	91 set (hp, "xdata", [0; frac; frac; 0]);
17141 13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	92
13847 9fc597693b0b allow waitbar message to be a cellstr object John W. Eaton <jwe@octave.org> parents: 13832 diff changeset	93 if (ischar (msg) \|\| iscellstr (msg))
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	94 th = get (ax, "title");
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	95 curr_msg = get (th, "string");
14238 1facbe04b00c Fix regression in 9fc597693b0b preventing updating of waitbar text string. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	96 ## graphics handles always store data as column vectors
1facbe04b00c Fix regression in 9fc597693b0b preventing updating of waitbar text string. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	97 if (iscellstr (msg))
1facbe04b00c Fix regression in 9fc597693b0b preventing updating of waitbar text string. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 msg = msg(:);
1facbe04b00c Fix regression in 9fc597693b0b preventing updating of waitbar text string. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99 endif
13847 9fc597693b0b allow waitbar message to be a cellstr object John W. Eaton <jwe@octave.org> parents: 13832 diff changeset	100 cmp = strcmp (msg, curr_msg);
14238 1facbe04b00c Fix regression in 9fc597693b0b preventing updating of waitbar text string. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	101 if (! all (cmp(:)))
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	102 set (th, "string", msg);
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	103 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	104 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	105 else
17203 efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	106 ## Save and restore current figure
efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	107 cf = get (0, "currentfigure");
efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	108
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	109 hf = figure ("position", [250, 500, 400, 100],
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	110 "numbertitle", "off",
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	111 "menubar", "none", "toolbar", "none",
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	112 "integerhandle", "off",
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	113 "handlevisibility", "callback",
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	114 "tag", "waitbar",
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	115 varargin{:});
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	116
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	117 ax = axes ("parent", hf,
359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	118 "xtick", [], "ytick", [],
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	119 "xlim", [0, 1], "ylim", [0, 1],
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	120 "position", [0.1, 0.3, 0.8, 0.2]);
13821 4d1927edf194 waitbar: use previous bar if nargin == 1, not nargout == 1 John W. Eaton <jwe@octave.org> parents: 13818 diff changeset	121
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	122 hp = patch (ax, [0; frac; frac; 0], [0; 0; 1; 1], [0, 0.35, 0.75]);
17141 13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	123
13da13e1e17f waitbar.m: Cache axes and patch handles in figure's __guidata__. Philipp Kutin <philipp.kutin@gmail.com> parents: 17122 diff changeset	124 ## Cache the axes and patch handles.
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	125 set (hf, "__guidata__", [ax hp]);
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	126
13847 9fc597693b0b allow waitbar message to be a cellstr object John W. Eaton <jwe@octave.org> parents: 13832 diff changeset	127 if (! (ischar (msg) \|\| iscellstr (msg)))
13822 38e3bfc4e076 provide default message for waitbar John W. Eaton <jwe@octave.org> parents: 13821 diff changeset	128 msg = "Please wait...";
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	129 endif
13822 38e3bfc4e076 provide default message for waitbar John W. Eaton <jwe@octave.org> parents: 13821 diff changeset	130 title (ax, msg);
17203 efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	131
efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	132 if (! isempty (cf))
efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	133 set (0, "currentfigure", cf);
efd8963f925f waitbar.m: Fix 2nd window pop-up when using gnuplot (bug #35773). Rik <rik@octave.org> parents: 17141 diff changeset	134 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	135 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	136
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	137 drawnow ();
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	138
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	139 if (nargout > 0)
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	140 h = hf;
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	141 endif
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	142
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	143 ## If there were no errors, update current waitbar.
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	144 curr_waitbar = hf;
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	145
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	146 endfunction
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	147
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	148
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	149 %!demo
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	150 %! h = waitbar (0, '0.00%');
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	151 %! for i = 0:0.01:1
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	152 %! waitbar (i, h, sprintf ('%.2f%%', 100*i));
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	153 %! end
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	154 %! close (h);
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	155
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	156 %!demo
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	157 %! h = waitbar (0, 'please wait...');
13818 a05e5db7b94e have some fun with waitbar demo #2 John W. Eaton <jwe@octave.org> parents: 13817 diff changeset	158 %! for i = 0:0.01:0.6
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	159 %! waitbar (i);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	160 %! end
14112 6e9fee72a01c Add missing ";" to line in waitbar.m demo. Philip Nienhuis <prnienhuis@users.sf.net> parents: 13847 diff changeset	161 %! i = 0.3;
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	162 %! waitbar (i, h, 'don''t you hate taking a step backward?');
13832 2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	163 %! pause (0.5);
13818 a05e5db7b94e have some fun with waitbar demo #2 John W. Eaton <jwe@octave.org> parents: 13817 diff changeset	164 %! for i = i:0.005:0.7
a05e5db7b94e have some fun with waitbar demo #2 John W. Eaton <jwe@octave.org> parents: 13817 diff changeset	165 %! waitbar (i, h);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	166 %! end
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	167 %! waitbar (i, h, 'or stalling?');
13832 2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	168 %! pause (1);
13818 a05e5db7b94e have some fun with waitbar demo #2 John W. Eaton <jwe@octave.org> parents: 13817 diff changeset	169 %! for i = i:0.003:0.8
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	170 %! waitbar (i, h, 'just a little longer now');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	171 %! end
13818 a05e5db7b94e have some fun with waitbar demo #2 John W. Eaton <jwe@octave.org> parents: 13817 diff changeset	172 %! for i = i:0.001:1
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	173 %! waitbar (i, h, 'please don''t be impatient');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	174 %! end
13806 a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	175 %! close (h);
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	176
a73c0811d2fa more updates for waitbar John W. Eaton <jwe@octave.org> parents: 13805 diff changeset	177 %!demo
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	178 %! h1 = waitbar (0, 'Waitbar #1');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	179 %! h2 = waitbar (0, 'Waitbar #2');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	180 %! h2pos = get (h2, 'position');
14249 27abe77158d6 Changes to allow plot demos to be converted and run by Matlab. Ben Abbott <bpabbott@mac.com> parents: 14245 diff changeset	181 %! h2pos(1) = h2pos(1) + (h2pos(3) + 50);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	182 %! set (h2, 'position', h2pos);
13832 2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	183 %! pause (0.5);
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	184 %! for i = 1:4
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	185 %! waitbar (i/4, h1);
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	186 %! pause (0.5);
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	187 %! waitbar (i/4, h2);
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	188 %! pause (0.5);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	189 %! end
13832 2e4252228f73 waitbar.m: Eliminate docstring reference to waitbar(frac,msg) Rik <octave@nomad.inbox5.com> parents: 13822 diff changeset	190 %! pause (0.5);
13817 b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	191 %! close (h1);
b3e1f9ae64dc waitbar.m: More improvements. Rik <octave@nomad.inbox5.com> parents: 13816 diff changeset	192 %! close (h2);
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	193
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	194 %% Test input validation
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	195 %!error <FRAC must be between 0 and 1> waitbar (-0.5)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	196 %!error <FRAC must be between 0 and 1> waitbar (1.5)
13813 72875370e2d1 allow waitbar test to succeed even if figure 1 exists John W. Eaton <jwe@octave.org> parents: 13806 diff changeset	197 %!error <MSG must be a character string> waitbar (0.5, struct ())
17447 359366a4994f waitbar.m: Use Octave coding conventions. Rik <rik@octave.org> parents: 17203 diff changeset	198 %!error <invalid number of property/value pairs> waitbar (0.5, "msg", "Name")
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	199

Mercurial > octave-nkf

annotate scripts/plot/waitbar.m @ 17447:359366a4994f