changelog shortlog tags changeset files revisions annotate raw

scripts/plot/clf.m

changeset 10289: 4b124317dc38
parent:c539ec5726e7
author: John W. Eaton <jwe@octave.org>
date: Tue Feb 09 20:58:55 2010 -0500 (57 minutes ago)
permissions: -rw-r--r--
description: base_properties::set_children: account for hidden children 
     1## Copyright (C) 2005, 2006, 2007, 2008, 2009 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} {} clf ()

    21## @deftypefnx {Function File} {} clf ("reset")

    22## @deftypefnx {Function File} {} clf (@var{hfig})

    23## @deftypefnx {Function File} {} clf (@var{hfig}, "reset")

    24## Clear the current figure window.  @code{clf} operates by deleting child

    25## graphics objects with visible handles (@code{handlevisibility} = on).

    26## If @var{hfig} is specified operate on it instead of the current figure.

    27## If the optional argument @code{"reset"} is specified, all objects including

    28## those with hidden handles are deleted.

    29## @seealso{cla, close, delete}

    30## @end deftypefn

    31

    32## Author: jwe

    33

    34function clf (varargin)

    35

    36  if (nargin > 2)

    37    print_usage ();

    38  elseif (nargin > 1)

    39    if (isfigure (varargin{1}) && ischar (varargin{2})

    40	&& strcmpi (varargin{2}, "reset"))

    41      oldfig = gcf;

    42      hfig = varargin{1};

    43      do_reset = true;

    44    else

    45      print_usage ();

    46    endif

    47  elseif (nargin == 1)

    48    if (isfigure (varargin{1}))

    49      oldfig = gcf;

    50      hfig = varargin{1};

    51      do_reset = false;

    52    elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset"))

    53      hfig = gcf;

    54      oldfig = hfig;

    55      do_reset = true;

    56    else

    57      print_usage ();

    58    endif

    59  else

    60    hfig = gcf;

    61    oldfig = hfig;

    62    do_reset = false;

    63  endif

    64

    65  if (do_reset)

    66    ## Select all the children, including the one with hidden handles.

    67    hc = allchild (hfig);

    68    reset (hfig)

    69  else

    70    ## Select only the chilren with visible handles.

    71    hc = get (hfig, "children");

    72  endif

    73

    74  ## Delete the children.

    75  delete (hc);

    76

    77endfunction