Mercurial > hg > octave-lyh

annotate scripts/plot/graphics_toolkit.m @ 14724:395d238418a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Allow graphics_toolkit (h) to return the value for specified figures. * graphics_toolkit: Support "kits = graphics_toolkit (h)." Improve documentation. Modify test.
author Ben Abbott <bpabbott@mac.com>
date Mon, 04 Jun 2012 20:55:25 -0400
parents f3d52523cde1
children 53d2c3598d33
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: 14046
diff changeset
1 ## Copyright (C) 2008-2012 Michael Goffioul
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
20 ## @deftypefn {Function File} {@var{name} =} graphics_toolkit ()
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
21 ## Returns the default graphics toolkit. The default graphics toolkit value
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
22 ## is assigned to new figures.
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
23 ## @deftypefnx {Function File} {@var{name} =} graphics_toolkit (@var{hlist})
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
24 ## Returns the graphics toolkits for the figures with handles @var{hlist}.
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
25 ## @deftypefnx {Function File} {} graphics_toolkit (@var{name})
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
26 ## Sets the default graphics toolkit to @var{name}. If the toolkit is not
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
27 ## already loaded, it is initialized by calling the function
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
28 ## @code{__init_@var{name}__}.
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
29 ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name})
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
30 ## Sets the graphics toolkit for the figues with handles @var{hlist} to
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
31 ## @var{name}.
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
32 ## @seealso{available_graphics_toolkits}
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ## @end deftypefn
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
35 function retval = graphics_toolkit (name, hlist = [])
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
37 if (nargin > 2)
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
38 print_usage ();
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
39 endif
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
41 if (nargout > 0 || nargin == 0)
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
42 retval = get (0, "defaultfigure__graphics_toolkit__");
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
43 endif
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
44
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
45 if (nargin == 0)
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
46 return;
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
47 elseif (nargin == 1)
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
48 if (all (isfigure (name)))
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
49 hlist = name;
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
50 retval = get (hlist, "__graphics_toolkit__");
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
51 return
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
52 elseif (! ischar (name))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
53 error ("graphics_toolkit: invalid graphics toolkit NAME");
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 elseif (nargin == 2)
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
56 ## Swap input arguments
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
57 [hlist, name] = deal (name, hlist);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
58 if (! all (isfigure (hlist)))
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
59 error ("graphics_toolkit: invalid figure handle list HLIST");
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
60 elseif (! ischar (name))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
61 error ("graphics_toolkit: invalid graphics toolkit NAME");
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
14021
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
65 if (! any (strcmp (loaded_graphics_toolkits (), name)))
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 feval (["__init_", name, "__"]);
14021
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
67 if (! any (strcmp (loaded_graphics_toolkits (), name)))
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
68 error ("graphics_toolkit: %s toolkit was not correctly loaded", name);
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 if (isempty (hlist))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
73 set (0, "defaultfigure__graphics_toolkit__", name);
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 else
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
75 set (hlist, "__graphics_toolkit__", name);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
76 endif
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
77
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 endfunction
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
79
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
80
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
81 %!testif HAVE_FLTK
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
82 %! unwind_protect
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
83 %! hf = figure ("visible", "off");
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
84 %! toolkit = graphics_toolkit ();
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
85 %! assert (get (0, "defaultfigure__graphics_toolkit__"), toolkit);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
86 %! graphics_toolkit (hf, "fltk");
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
87 %! assert (graphics_toolkit (hf), "fltk");
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
88 %! unwind_protect_cleanup
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
89 %! close (hf);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
90 %! end_unwind_protect
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
91
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
92 %!testif HAVE_FLTK
14277
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
93 %! old_toolkit = graphics_toolkit ();
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
94 %! switch old_toolkit
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
95 %! case {"gnuplot"}
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
96 %! new_toolkit = "fltk";
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97 %! otherwise
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
98 %! new_toolkit = "gnuplot";
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
99 %! endswitch
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14277
diff changeset
100 %! assert (graphics_toolkit (new_toolkit), old_toolkit);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14277
diff changeset
101 %! assert (graphics_toolkit (old_toolkit), new_toolkit);
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
102