octave_packages/m/plot/box.m

   1 ## Copyright (C) 2006-2012 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} {} box (@var{arg})
  21 ## @deftypefnx {Function File} {} box (@var{h}, @dots{})
  22 ## Control the display of a border around the plot.
  23 ## The argument may be either @code{"on"} or @code{"off"}.  If it is
  24 ## omitted, the current box state is toggled.
  25 ## @seealso{grid}
  26 ## @end deftypefn
  27
  28 ## Author: jwe
  29
  30 function box (varargin)
  31
  32   h = gca ();
  33
  34   box_state = get (h, "box");
  35
  36   nargs = numel (varargin);
  37
  38   if (nargs == 0)
  39     if (strcmpi (box_state, "on"))
  40       box_state = "off";
  41     else
  42       box_state = "on";
  43     endif
  44   elseif (nargs == 1)
  45     state = varargin{1};
  46     if (ischar (state))
  47       if (strcmpi (state, "off"))
  48         box_state = "off";
  49       elseif (strcmpi (state, "on"))
  50         box_state = "on";
  51       else
  52         print_usage ();
  53       endif
  54     endif
  55   else
  56     print_usage ();
  57   endif
  58
  59   set (h, "box", box_state);
  60
  61 endfunction