Mercurial > hg > octave-lyh
view scripts/plot/graphics_toolkit.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 06 Dec 2011 13:09:17 -0800 |
parents | 08ae07e40d4f |
children | e3bed294b117 |
line wrap: on
line source
## Copyright (C) 2008-2011 Michael Goffioul ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{name} =} graphics_toolkit () ## @deftypefnx {Function File} {@var{old_name} =} graphics_toolkit (@var{name}) ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name}) ## Query or set the default graphics toolkit to @var{name}. If the ## toolkit is not already loaded, it is first initialized by calling the ## function @code{__init_@var{name}__}. ## ## When called with a list of figure handles, @var{hlist}, the graphics ## toolkit is changed only for the listed figures. ## @seealso{available_graphics_toolkits} ## @end deftypefn function retval = graphics_toolkit (name, hlist = []) if (nargin > 2) print_usage (); endif if (nargin == 0) retval = get (0, "defaultfigure__graphics_toolkit__"); return; elseif (nargin == 1) if (! ischar (name)) error ("graphics_toolkit: invalid graphics toolkit NAME"); endif elseif (nargin == 2) ## Swap input arguments [hlist, name] = deal (name, hlist); if (! all (isfigure (hlist))) error ("graphics_toolkit: invalid figure handle list HLIST"); elseif (! ischar (name)) error ("graphics_toolkit: invalid graphics toolkit NAME"); endif endif if (! any (strcmp (available_graphics_toolkits (), name))) feval (["__init_", name, "__"]); if (! any (strcmp (available_graphics_toolkits (), name))) error ("graphics_toolkit: %s toolkit was not correctly registered", name); endif endif if (isempty (hlist)) set (0, "defaultfigure__graphics_toolkit__", name); else set (hlist, "__graphics_toolkit__", name); endif if (isargout (1)) retval = name; endif endfunction %!testif HAVE_FLTK %! unwind_protect %! hf = figure ("visible", "off"); %! toolkit = graphics_toolkit (); %! assert (get (0, "defaultfigure__graphics_toolkit__"), toolkit); %! graphics_toolkit (hf, "fltk"); %! assert (get (hf, "__graphics_toolkit__"), "fltk"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect