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

annotate scripts/plot/waitbar.m @ 13805:b3cdef33ac0e

waitbar.m: Update docstring. Only return output handle h if requested. * waitbar.m: Update docstring. Only return output handle h if requested. Don't delete message from waitbar window when only FRAC is updated. Add input validation tests.

author	Rik <octave@nomad.inbox5.com>
date	Thu, 03 Nov 2011 09:54:57 -0700
parents	a2e158c3451f
children	a73c0811d2fa

rev	line source
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	1 ## Copyright (C) 2011 John W. Eaton
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 --
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	20 ## @deftypefn {Function File} {} waitbar (@var{frac})
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	21 ## @deftypefn {Function File} {} waitbar (@var{frac}, @var{msg})
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	22 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{h}, @dots{})
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	23 ## @deftypefnx {Function File} {} waitbar (@dots{}, "FigureProperty", "Value", @dots{})
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	24 ## @deftypefnx {Function File} {@var{h} = } waitbar (@dots{})
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	25 ## Create a waitbar filled to fraction @var{frac} and display an optional
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	26 ## message @var{msg}. The waitbar fraction must be in the range [0, 1]. If
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	27 ## the optional input @var{h} is specified then update the waitbar in the
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	28 ## specified figure handle. Otherwise, a new waitbar is created.
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	29 ##
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	30 ## The display of the waitbar window can be configured by passing
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	31 ## property/value pairs to the function.
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	32 ## @end deftypefn
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	33
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	34 ## Author: jwe
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	35
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	36 function retval = waitbar (varargin)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	37
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	38 if (nargin < 1)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	39 print_usage ();
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	40 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	41
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	42 frac = varargin{1};
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	43 varargin(1) = [];
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: 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 (! (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	46 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	47 endif
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	48
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	49 msg = false;
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	50 h = 0;
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 (! isempty (varargin) && ishandle (varargin{1}))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	53 h = varargin{1};
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	54 varargin(1) = [];
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	55 ## FIXME -- also check that H is really a waitbar?
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	56 if (! isfigure (h))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	57 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	58 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	59 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	60
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	61 if (! isempty (varargin))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	62 msg = varargin{1};
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	63 varargin(1) = [];
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	64 if (! ischar (msg))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	65 error ("waitbar: MSG must be a character string");
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	66 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	67 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	68
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	69 if (rem (numel (varargin), 2) != 0)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	70 error ("waitbar: invalid number of property-value pairs");
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	71 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: 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 (h)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	74 p = findobj (h, "type", "patch");
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	75 if (p)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	76 delete (p);
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	77 endif
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	78 ax = findobj (h, "type", "axes");
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	79 else
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	80 h = __go_figure__ (Inf, "position", [250, 500, 400, 100],
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	81 "numbertitle", "off",
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	82 "handlevisibility", "callback",
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	83 varargin{:});
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	84
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	85 ax = axes ("parent", h, "xtick", [], "ytick", [],
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	86 "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	87 "xlimmode", "manual", "ylimmode", "manual",
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	88 "position", [0.1, 0.3, 0.8, 0.2]);
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	89 endif
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	90
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	91 patch (ax, [0, frac, frac, 0], [0, 0, 1, 1], [0, 0.35, 0.75]);
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	92 if (ischar (msg))
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	93 title (ax, msg);
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	94 endif
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	95 drawnow ();
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	96
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	97 if (nargout > 0)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	98 retval = h;
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	99 endif
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	100
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	101 endfunction
a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	102
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	103
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	104 %!demo
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	105 %! h = waitbar (0, "0.00%");
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	106 %! for i = 0:0.01:1
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	107 %! waitbar (i, h, sprintf ("%.2f%%", 100*i));
13803 a2e158c3451f provide the waitbar function John W. Eaton <jwe@octave.org> parents: diff changeset	108 %! endfor
13805 b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	109
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	110 %% Test input validation
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	111 %!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	112 %!error <FRAC must be between 0 and 1> waitbar (1.5)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	113 %!error <MSG must be a character string> waitbar (0.5, 1)
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	114 %!error <invalid number of property-value pairs> waitbar (0.5, "msg", "Name")
b3cdef33ac0e waitbar.m: Update docstring. Only return output handle h if requested. Rik <octave@nomad.inbox5.com> parents: 13803 diff changeset	115

Mercurial > octave-nkf

annotate scripts/plot/waitbar.m @ 13805:b3cdef33ac0e