Mercurial > octave-nkf
annotate scripts/plot/figure.m @ 14366:b76f0740940e
doc: Periodic grammar check of documentation.
* accumarray.m, repmat.m, imshow.m, strread.m, edit.m, mkoctfile.m,
warning_ids.m, glpk.m, lsqnonneg.m, optimset.m, pqpnonneg.m, figure.m, print.m,
__print_parse_opts__.m, gmres.m, zscore.m, __init_fltk__.cc, cellfun.cc,
nproc.cc, regexp.cc, spparms.cc, dirfns.cc, file-io.cc, load-save.cc,
ov-null-mat.cc, ov-usr-fcn.cc, variables.cc: Periodic grammar check of
documentation.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Wed, 15 Feb 2012 13:31:31 -0800 |
| parents | f3d52523cde1 |
| children | 460a3c6d8bf1 |
| 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 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 2313 | 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 | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 2290 | 18 |
| 3368 | 19 ## -*- texinfo -*- |
|
14366
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
20 ## @deftypefn {Command} {} figure |
|
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
21 ## @deftypefnx {Command} {} figure @var{n} |
|
14276
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
22 ## @deftypefnx {Function File} {} figure (@var{n}) |
|
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
23 ## @deftypefnx {Function File} {} figure (@var{n}, "@var{property}", @var{value}, @dots{}) |
| 6308 | 24 ## Set the current plot window to plot window @var{n}. If no arguments are |
| 6895 | 25 ## specified, the next available window number is chosen. |
| 26 ## | |
| 27 ## Multiple property-value pairs may be specified for the figure, but they | |
| 28 ## must appear in pairs. | |
| 3368 | 29 ## @end deftypefn |
| 2290 | 30 |
| 6257 | 31 ## Author: jwe, Bill Denney |
| 2314 | 32 |
| 6257 | 33 function h = figure (varargin) |
| 3263 | 34 |
| 6257 | 35 nargs = nargin; |
| 5406 | 36 |
| 6405 | 37 f = NaN; |
| 6283 | 38 |
| 6293 | 39 init_new_figure = false; |
| 6283 | 40 if (mod (nargs, 2) == 1) |
| 6257 | 41 tmp = varargin{1}; |
|
14276
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
42 if (ischar (tmp)) |
|
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
43 tmp = str2double (tmp); |
|
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
44 endif |
|
14226
d580d7179f85
Use isfigure() to simplify some plot functions.
Rik <octave@nomad.inbox5.com>
parents:
14183
diff
changeset
|
45 if (isfigure (tmp)) |
| 6257 | 46 f = tmp; |
| 47 varargin(1) = []; | |
| 48 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
|
49 elseif (isnumeric (tmp) && tmp > 0 && tmp == fix (tmp)) |
| 6257 | 50 f = tmp; |
| 6293 | 51 init_new_figure = true; |
| 6257 | 52 varargin(1) = []; |
| 53 nargs--; | |
| 54 else | |
| 55 error ("figure: expecting figure handle or figure number"); | |
| 56 endif | |
| 3263 | 57 endif |
| 58 | |
| 6293 | 59 ## Check to see if we already have a figure on the screen. If we do, |
| 60 ## then update it if it is different from the figure we are creating | |
| 61 ## or switching to. | |
|
14276
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
62 cf = get (0, "currentfigure"); # Can't use gcf() because it calls figure() |
| 6293 | 63 if (! isempty (cf) && cf != 0) |
| 6405 | 64 if (isnan (f) || cf != f) |
| 6293 | 65 drawnow (); |
| 66 endif | |
| 67 endif | |
| 68 | |
| 6257 | 69 if (rem (nargs, 2) == 0) |
| 6405 | 70 if (isnan (f) || init_new_figure) |
|
14183
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
71 if (ismac () && strcmp (graphics_toolkit (), "fltk")) |
|
14276
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
72 ## FIXME - Hack for fltk-aqua to work around bug #31931 |
|
14183
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
73 f = __go_figure__ (f); |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
74 drawnow (); |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
75 if (! isempty (varargin)) |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
76 set (f, varargin{:}); |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
77 endif |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
78 else |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
79 f = __go_figure__ (f, varargin{:}); |
|
9e6ec5f55827
When creating an fltk (aqua) figure on MacOS, make sure one drawnow() occurs
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
80 endif |
| 6780 | 81 elseif (nargs > 0) |
| 6257 | 82 set (f, varargin{:}); |
| 2290 | 83 endif |
| 6257 | 84 set (0, "currentfigure", f); |
| 2290 | 85 else |
| 6046 | 86 print_usage (); |
| 2290 | 87 endif |
| 3263 | 88 |
|
14276
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
89 if (strcmp (get (f, "__graphics_toolkit__"), "fltk")) |
|
6b4bd6a86bdd
figure.m: Extend to accepting command form "figure N"
Rik <octave@nomad.inbox5.com>
parents:
14226
diff
changeset
|
90 __add_default_menu__ (f); |
|
13325
09b157ab2672
Only add default menus for FLTK toolkit.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
13279
diff
changeset
|
91 endif |
|
11349
4a3258b1448f
Add default menu for fltk backend figures
Kai Habel <kai.habel@gmx.de>
parents:
10793
diff
changeset
|
92 |
| 6283 | 93 if (nargout > 0) |
| 94 h = f; | |
| 95 endif | |
| 96 | |
| 2290 | 97 endfunction |
| 13204 | 98 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14276
diff
changeset
|
99 |
| 13204 | 100 %!test |
| 101 %! hf = figure ("visible", "off"); | |
| 102 %! unwind_protect | |
| 103 %! assert (gcf, hf); | |
| 104 %! assert (isfigure (hf)); | |
| 105 %! unwind_protect_cleanup | |
| 106 %! 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
|
107 %! end_unwind_protect |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14276
diff
changeset
|
108 |