Mercurial > octave
annotate scripts/plot/waitbar.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | 7a7ce92cff56 |
| children | 13da13e1e17f |
| 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 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 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 | 37 ## @end deftypefn |
| 38 | |
| 39 ## Author: jwe | |
| 40 | |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
41 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
|
42 |
| 13806 | 43 persistent curr_waitbar; |
| 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 | 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 | 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)) |
| 13806 | 58 h = curr_waitbar; |
| 59 else | |
| 60 h = false; | |
| 61 endif | |
| 13803 | 62 |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
63 if (! isempty (varargin) && isnumeric (varargin{1})) |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
64 if (! ishandle (varargin{1})) |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
65 error ("waitbar: H must be a handle to a waitbar object"); |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
66 else |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
67 h = varargin{1}; |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
68 varargin(1) = []; |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
69 if (! isfigure (h) || ! strcmp (get (h, "tag"), "waitbar")) |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
70 error ("waitbar: H must be a handle to a waitbar object"); |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
71 endif |
| 13803 | 72 endif |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
73 endif |
| 13803 | 74 |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
75 msg = false; |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
76 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
77 if (! isempty (varargin)) |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
78 msg = varargin{1}; |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
79 varargin(1) = []; |
|
13847
9fc597693b0b
allow waitbar message to be a cellstr object
John W. Eaton <jwe@octave.org>
parents:
13832
diff
changeset
|
80 if (! (ischar (msg) || iscellstr (msg))) |
|
9fc597693b0b
allow waitbar message to be a cellstr object
John W. Eaton <jwe@octave.org>
parents:
13832
diff
changeset
|
81 error ("waitbar: MSG must be a character string or cell array of strings"); |
| 13803 | 82 endif |
|
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 | 84 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
85 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
|
86 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
|
87 endif |
| 13803 | 88 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
89 if (h) |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
90 p = findobj (h, "type", "patch"); |
| 13806 | 91 set (p, "xdata", [0; frac; frac; 0]); |
| 92 ax = findobj (h, "type", "axes"); | |
|
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 | 94 th = get (ax, "title"); |
| 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 | 102 set (th, "string", msg); |
| 103 endif | |
| 13803 | 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 |
|
13816
7ee18dc46bbb
new and improved non-integer figure handles
John W. Eaton <jwe@octave.org>
parents:
13813
diff
changeset
|
106 h = __go_figure__ (NaN, "position", [250, 500, 400, 100], |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
107 "numbertitle", "off", |
| 13806 | 108 "toolbar", "none", "menubar", "none", |
|
13816
7ee18dc46bbb
new and improved non-integer figure handles
John W. Eaton <jwe@octave.org>
parents:
13813
diff
changeset
|
109 "integerhandle", "off", |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
110 "handlevisibility", "callback", |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
111 "tag", "waitbar", |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
112 varargin{:}); |
| 13803 | 113 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
114 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
|
115 "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
|
116 "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
|
117 "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
|
118 |
| 13806 | 119 patch (ax, [0; frac; frac; 0], [0; 0; 1; 1], [0, 0.35, 0.75]); |
| 120 | |
|
13847
9fc597693b0b
allow waitbar message to be a cellstr object
John W. Eaton <jwe@octave.org>
parents:
13832
diff
changeset
|
121 if (! (ischar (msg) || iscellstr (msg))) |
|
13822
38e3bfc4e076
provide default message for waitbar
John W. Eaton <jwe@octave.org>
parents:
13821
diff
changeset
|
122 msg = "Please wait..."; |
| 13806 | 123 endif |
|
13822
38e3bfc4e076
provide default message for waitbar
John W. Eaton <jwe@octave.org>
parents:
13821
diff
changeset
|
124 title (ax, msg); |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
125 endif |
| 13803 | 126 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
127 drawnow (); |
| 13803 | 128 |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
129 if (nargout > 0) |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
130 retval = h; |
| 13803 | 131 endif |
| 132 | |
| 13806 | 133 ## If there were no errors, update current waitbar. |
| 134 curr_waitbar = h; | |
| 135 | |
| 13803 | 136 endfunction |
| 137 | |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
138 |
| 13803 | 139 %!demo |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
140 %! h = waitbar (0, '0.00%'); |
| 13803 | 141 %! 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
|
142 %! 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
|
143 %! end |
| 13806 | 144 %! close (h); |
| 145 | |
| 146 %!demo | |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
147 %! h = waitbar (0, 'please wait...'); |
|
13818
a05e5db7b94e
have some fun with waitbar demo #2
John W. Eaton <jwe@octave.org>
parents:
13817
diff
changeset
|
148 %! for i = 0:0.01:0.6 |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
149 %! waitbar (i); |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
150 %! end |
|
14112
6e9fee72a01c
Add missing ";" to line in waitbar.m demo.
Philip Nienhuis <prnienhuis@users.sf.net>
parents:
13847
diff
changeset
|
151 %! i = 0.3; |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
152 %! 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
|
153 %! pause (0.5); |
|
13818
a05e5db7b94e
have some fun with waitbar demo #2
John W. Eaton <jwe@octave.org>
parents:
13817
diff
changeset
|
154 %! 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
|
155 %! waitbar (i, h); |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
156 %! end |
|
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
157 %! 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
|
158 %! pause (1); |
|
13818
a05e5db7b94e
have some fun with waitbar demo #2
John W. Eaton <jwe@octave.org>
parents:
13817
diff
changeset
|
159 %! 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
|
160 %! 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
|
161 %! end |
|
13818
a05e5db7b94e
have some fun with waitbar demo #2
John W. Eaton <jwe@octave.org>
parents:
13817
diff
changeset
|
162 %! 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
|
163 %! 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
|
164 %! end |
| 13806 | 165 %! close (h); |
| 166 | |
| 167 %!demo | |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
168 %! h1 = waitbar (0, 'Waitbar #1'); |
|
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
169 %! h2 = waitbar (0, 'Waitbar #2'); |
|
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
170 %! 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
|
171 %! 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
|
172 %! set (h2, 'position', h2pos); |
|
13832
2e4252228f73
waitbar.m: Eliminate docstring reference to waitbar(frac,msg)
Rik <octave@nomad.inbox5.com>
parents:
13822
diff
changeset
|
173 %! pause (0.5); |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
174 %! for i = 1:4 |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
175 %! waitbar (i/4, h1); |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
176 %! pause (0.5); |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
177 %! waitbar (i/4, h2); |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
178 %! pause (0.5); |
|
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
179 %! end |
|
13832
2e4252228f73
waitbar.m: Eliminate docstring reference to waitbar(frac,msg)
Rik <octave@nomad.inbox5.com>
parents:
13822
diff
changeset
|
180 %! pause (0.5); |
|
13817
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
181 %! close (h1); |
|
b3e1f9ae64dc
waitbar.m: More improvements.
Rik <octave@nomad.inbox5.com>
parents:
13816
diff
changeset
|
182 %! close (h2); |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
183 |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
184 %% Test input validation |
|
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
185 %!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
|
186 %!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
|
187 %!error <MSG must be a character string> waitbar (0.5, struct ()) |
|
13805
b3cdef33ac0e
waitbar.m: Update docstring. Only return output handle h if requested.
Rik <octave@nomad.inbox5.com>
parents:
13803
diff
changeset
|
188 %!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
|
189 |