Mercurial > octave-nkf
view scripts/plot/util/gcf.m @ 19867:9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Try to trim long lines to < 80 chars.
Use '##' for single line comments.
Use '(...)' around tests for if/elseif/switch/while.
Abut cell indexing operator '{' next to variable.
Abut array indexing operator '(' next to variable.
Use space between negation operator '!' and following expression.
Use two newlines between endfunction and start of %!test or %!demo code.
Remove unnecessary parens grouping between short-circuit operators.
Remove stray extra spaces (typos) between variables and assignment operators.
Remove stray extra spaces from ends of lines.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 23 Feb 2015 14:54:39 -0800 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2005-2015 John W. Eaton ## ## 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{h} =} gcf () ## Return a handle to the current figure. ## ## The current figure is the default target for graphics output. If multiple ## figures exist, @code{gcf} returns the last created figure or the last figure ## that was clicked on with the mouse. ## ## If a current figure does not exist, create one and return its handle. The ## handle may then be used to examine or set properties of the figure. For ## example, ## ## @example ## @group ## fplot (@@sin, [-10, 10]); ## fig = gcf (); ## set (fig, "numbertitle", "off", "name", "sin plot") ## @end group ## @end example ## ## @noindent ## plots a sine wave, finds the handle of the current figure, and then ## renames the figure window to describe the contents. ## ## Note: To find the current figure without creating a new one if it does not ## exist, query the @qcode{"CurrentFigure"} property of the root graphics ## object. ## ## @example ## get (0, "currentfigure"); ## @end example ## ## @seealso{gca, gco, gcbf, gcbo, get, set} ## @end deftypefn ## Author: jwe, Bill Denney function h = gcf () if (nargin == 0) h = get (0, "currentfigure"); if (isempty (h) || h == 0) ## We only have a root figure object, so create a new figure ## object and make it the current figure. h = figure (); endif else print_usage (); endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! assert (gcf, hf); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect