Mercurial > octave-nkf

comparison scripts/gui/waitbar.m @ 17572:7bb76a22cde1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/waitbar.m@359366a4994f
children d63878346099
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 2012 John W. Eaton
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 -*-
20 ## @deftypefn {Function File} {@var{h} =} waitbar (@var{frac})
21 ## @deftypefnx {Function File} {@var{h} =} waitbar (@var{frac}, @var{msg})
22 ## @deftypefnx {Function File} {@var{h} =} waitbar (@dots{}, "FigureProperty", "Value", @dots{})
23 ## @deftypefnx {Function File} {} waitbar (@var{frac})
24 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar})
25 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}, @var{msg})
26 ## Return a handle @var{h} to a new waitbar object.
27 ##
28 ## The waitbar is filled to fraction @var{frac} which must be in the range
29 ## [0, 1]. The optional message @var{msg} is centered and displayed above the
30 ## waitbar. The appearance of the waitbar figure window can be configured by
31 ## passing property/value pairs to the function.
32 ##
33 ## When called with a single input the current waitbar, if it exists, is
34 ## updated to the new value @var{frac}. If there are multiple outstanding
35 ## waitbars they can be updated individually by passing the handle @var{hwbar}
36 ## of the specific waitbar to modify.
37 ## @end deftypefn
38
39 ## Author: jwe
40
41 function h = waitbar (varargin)
42
43 persistent curr_waitbar;
44
45 if (nargin < 1)
46 print_usage ();
47 endif
48
49 frac = varargin{1};
50 varargin(1) = [];
51
52 if (! (isnumeric (frac) && isscalar (frac) && frac >= 0 && frac <= 1))
53 error ("waitbar: FRAC must be between 0 and 1");
54 endif
55
56 ## Use existing waitbar if it still points to a valid graphics handle.
57 if (nargin == 1 && ishandle (curr_waitbar))
58 hf = curr_waitbar;
59 else
60 hf = false;
61 endif
62
63 if (! isempty (varargin) && isnumeric (varargin{1}))
64 hf = varargin{1};
65 varargin(1) = [];
66 if (! isfigure (hf) || ! strcmp (get (hf, "tag"), "waitbar"))
67 error ("waitbar: H must be a handle to a waitbar object");
68 endif
69 endif
70
71 msg = false;
72
73 if (! isempty (varargin))
74 msg = varargin{1};
75 varargin(1) = [];
76 if (! (ischar (msg) || iscellstr (msg)))
77 error ("waitbar: MSG must be a character string or cell array of strings");
78 endif
79 endif
80
81 if (rem (numel (varargin), 2) != 0)
82 error ("waitbar: invalid number of property/value pairs");
83 endif
84
85 if (hf)
86 gd = get (hf, "__guidata__");
87 ## Get the cached handles.
88 ax = gd(1);
89 hp = gd(2);
90
91 set (hp, "xdata", [0; frac; frac; 0]);
92
93 if (ischar (msg) || iscellstr (msg))
94 th = get (ax, "title");
95 curr_msg = get (th, "string");
96 ## graphics handles always store data as column vectors
97 if (iscellstr (msg))
98 msg = msg(:);
99 endif
100 cmp = strcmp (msg, curr_msg);
101 if (! all (cmp(:)))
102 set (th, "string", msg);
103 endif
104 endif
105 else
106 ## Save and restore current figure
107 cf = get (0, "currentfigure");
108
109 hf = figure ("position", [250, 500, 400, 100],
110 "numbertitle", "off",
111 "menubar", "none", "toolbar", "none",
112 "integerhandle", "off",
113 "handlevisibility", "callback",
114 "tag", "waitbar",
115 varargin{:});
116
117 ax = axes ("parent", hf,
118 "xtick", [], "ytick", [],
119 "xlim", [0, 1], "ylim", [0, 1],
120 "position", [0.1, 0.3, 0.8, 0.2]);
121
122 hp = patch (ax, [0; frac; frac; 0], [0; 0; 1; 1], [0, 0.35, 0.75]);
123
124 ## Cache the axes and patch handles.
125 set (hf, "__guidata__", [ax hp]);
126
127 if (! (ischar (msg) || iscellstr (msg)))
128 msg = "Please wait...";
129 endif
130 title (ax, msg);
131
132 if (! isempty (cf))
133 set (0, "currentfigure", cf);
134 endif
135 endif
136
137 drawnow ();
138
139 if (nargout > 0)
140 h = hf;
141 endif
142
143 ## If there were no errors, update current waitbar.
144 curr_waitbar = hf;
145
146 endfunction
147
148
149 %!demo
150 %! h = waitbar (0, '0.00%');
151 %! for i = 0:0.01:1
152 %! waitbar (i, h, sprintf ('%.2f%%', 100*i));
153 %! end
154 %! close (h);
155
156 %!demo
157 %! h = waitbar (0, 'please wait...');
158 %! for i = 0:0.01:0.6
159 %! waitbar (i);
160 %! end
161 %! i = 0.3;
162 %! waitbar (i, h, 'don''t you hate taking a step backward?');
163 %! pause (0.5);
164 %! for i = i:0.005:0.7
165 %! waitbar (i, h);
166 %! end
167 %! waitbar (i, h, 'or stalling?');
168 %! pause (1);
169 %! for i = i:0.003:0.8
170 %! waitbar (i, h, 'just a little longer now');
171 %! end
172 %! for i = i:0.001:1
173 %! waitbar (i, h, 'please don''t be impatient');
174 %! end
175 %! close (h);
176
177 %!demo
178 %! h1 = waitbar (0, 'Waitbar #1');
179 %! h2 = waitbar (0, 'Waitbar #2');
180 %! h2pos = get (h2, 'position');
181 %! h2pos(1) = h2pos(1) + (h2pos(3) + 50);
182 %! set (h2, 'position', h2pos);
183 %! pause (0.5);
184 %! for i = 1:4
185 %! waitbar (i/4, h1);
186 %! pause (0.5);
187 %! waitbar (i/4, h2);
188 %! pause (0.5);
189 %! end
190 %! pause (0.5);
191 %! close (h1);
192 %! close (h2);
193
194 %% Test input validation
195 %!error <FRAC must be between 0 and 1> waitbar (-0.5)
196 %!error <FRAC must be between 0 and 1> waitbar (1.5)
197 %!error <MSG must be a character string> waitbar (0.5, struct ())
198 %!error <invalid number of property/value pairs> waitbar (0.5, "msg", "Name")
199