changelog shortlog tags changeset files revisions annotate raw

scripts/plot/gcf.m

changeset 10289: 4b124317dc38
parent:93c65f2a5668
author: John W. Eaton <jwe@octave.org>
date: Tue Feb 09 20:58:55 2010 -0500 (71 minutes ago)
permissions: -rw-r--r--
description: base_properties::set_children: account for hidden children 
     1## Copyright (C) 2005, 2006, 2007 John W. Eaton

     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

     7## the Free Software Foundation; either version 3 of the License, or (at

     8## your option) any later version.

     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

    16## along with Octave; see the file COPYING.  If not, see

    17## <http://www.gnu.org/licenses/>.

    18

    19## -*- texinfo -*-

    20## @deftypefn {Function File} {} gcf ()

    21## Return the current figure handle.  If a figure does not exist, create

    22## one and return its handle.  The handle may then be used to examine or

    23## set properties of the figure.  For example,

    24##

    25## @example

    26## @group

    27## fplot (@@sin, [-10, 10]);

    28## fig = gcf ();

    29## set (fig, "visible", "off");

    30## @end group

    31## @end example

    32##

    33## @noindent

    34## plots a sine wave, finds the handle of the current figure, and then

    35## makes that figure invisible.  Setting the visible property of the

    36## figure to @code{"on"} will cause it to be displayed again.

    37## @seealso{get, set}

    38## @end deftypefn

    39

    40## Author: jwe, Bill Denney

    41

    42function h = gcf ()

    43

    44  if (nargin == 0)

    45    h = get (0, "currentfigure");

    46    if (isempty (h) || h == 0)

    47      ## We only have a root figure object, so create a new figure

    48      ## object and make it the current figure.

    49      h = figure (1);

    50    endif

    51  else

    52    print_usage ();

    53  endif

    54

    55endfunction