annotate scripts/plot/figure.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents 09b157ab2672
children 9e6ec5f55827
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13325
diff changeset
1 ## Copyright (C) 1996-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
18
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3263
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
20 ## @deftypefn {Function File} {} figure (@var{n})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6780
diff changeset
21 ## @deftypefnx {Function File} {} figure (@var{n}, @var{property}, @var{value}, @dots{})
6308
22e2c78e406e [project @ 2007-02-15 08:16:08 by jwe]
jwe
parents: 6293
diff changeset
22 ## Set the current plot window to plot window @var{n}. If no arguments are
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6780
diff changeset
23 ## specified, the next available window number is chosen.
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6780
diff changeset
24 ##
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6780
diff changeset
25 ## Multiple property-value pairs may be specified for the figure, but they
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6780
diff changeset
26 ## must appear in pairs.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3263
diff changeset
27 ## @end deftypefn
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
28
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
29 ## Author: jwe, Bill Denney
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
30
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
31 function h = figure (varargin)
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3103
diff changeset
32
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
33 nargs = nargin;
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents: 5307
diff changeset
34
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6308
diff changeset
35 f = NaN;
6283
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
36
6293
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
37 init_new_figure = false;
6283
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
38 if (mod (nargs, 2) == 1)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
39 tmp = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
40 if (ishandle (tmp) && strcmp (get (tmp, "type"), "figure"))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
41 f = tmp;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
42 varargin(1) = [];
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
43 nargs--;
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 13204
diff changeset
44 elseif (isnumeric (tmp) && tmp > 0 && tmp == fix (tmp))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
45 f = tmp;
6293
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
46 init_new_figure = true;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 varargin(1) = [];
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
48 nargs--;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
49 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
50 error ("figure: expecting figure handle or figure number");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
51 endif
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3103
diff changeset
52 endif
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3103
diff changeset
53
6293
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
54 ## Check to see if we already have a figure on the screen. If we do,
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
55 ## then update it if it is different from the figure we are creating
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
56 ## or switching to.
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
57 cf = get (0, "currentfigure");
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
58 if (! isempty (cf) && cf != 0)
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6308
diff changeset
59 if (isnan (f) || cf != f)
6293
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
60 drawnow ();
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
61 endif
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
62 endif
b649aa46950d [project @ 2007-02-09 21:50:40 by jwe]
jwe
parents: 6283
diff changeset
63
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
64 if (rem (nargs, 2) == 0)
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6308
diff changeset
65 if (isnan (f) || init_new_figure)
6780
38bc358b6c9a [project @ 2007-07-18 18:02:56 by jwe]
jwe
parents: 6405
diff changeset
66 f = __go_figure__ (f, varargin{:});
38bc358b6c9a [project @ 2007-07-18 18:02:56 by jwe]
jwe
parents: 6405
diff changeset
67 elseif (nargs > 0)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
68 set (f, varargin{:});
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
69 endif
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
70 set (0, "currentfigure", f);
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
71 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5489
diff changeset
72 print_usage ();
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
73 endif
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3103
diff changeset
74
11349
4a3258b1448f Add default menu for fltk backend figures
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
75 cf = get (0, "currentfigure");
13325
09b157ab2672 Only add default menus for FLTK toolkit.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13279
diff changeset
76 if (strcmp (get (cf, "__graphics_toolkit__"), "fltk"))
09b157ab2672 Only add default menus for FLTK toolkit.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13279
diff changeset
77 __add_default_menu__ (cf);
09b157ab2672 Only add default menus for FLTK toolkit.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13279
diff changeset
78 endif
11349
4a3258b1448f Add default menu for fltk backend figures
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
79
6283
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
80 if (nargout > 0)
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
81 h = f;
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
82 endif
7099f1ae465e [project @ 2007-02-08 08:37:00 by jwe]
jwe
parents: 6257
diff changeset
83
2290
9170d297145f [project @ 1996-06-06 05:18:49 by jwe]
jwe
parents:
diff changeset
84 endfunction
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
85
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
86 %!test
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
87 %! hf = figure ("visible", "off");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
88 %! unwind_protect
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
89 %! assert (gcf, hf);
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
90 %! assert (isfigure (hf));
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
91 %! unwind_protect_cleanup
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
92 %! close (hf);
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 13204
diff changeset
93 %! end_unwind_protect