annotate scripts/plot/box.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents eb63fbe60fab
children be55736a0783
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
1 ## Copyright (C) 2006, 2007, 2008, 2009 John W. Eaton
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
2 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
4 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6849
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6849
diff changeset
8 ## your option) any later version.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
9 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
14 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6849
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6849
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
18
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} box (@var{arg})
6849
c118ea1823f1 [project @ 2007-08-31 10:47:27 by dbateman]
dbateman
parents: 6653
diff changeset
21 ## @deftypefnx {Function File} {} box (@var{h}, @dots{})
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
22 ## Control the display of a border around the plot.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
23 ## The argument may be either @code{"on"} or @code{"off"}. If it is
6653
673686daec87 [project @ 2007-05-22 15:36:09 by jwe]
jwe
parents: 6567
diff changeset
24 ## omitted, the current box state is toggled.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
25 ## @seealso{grid}
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
26 ## @end deftypefn
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
27
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
28 ## Author: jwe
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
29
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
30 function box (varargin)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
31
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
32 h = gca ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
33
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
34 box_state = get (h, "box");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
35
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
36 nargs = numel (varargin);
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
37
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
38 if (nargs == 0)
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
39 if (strcmpi (box_state, "on"))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
40 box_state = "off";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
41 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
42 box_state = "on";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
43 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
44 elseif (nargs == 1)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
45 state = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
46 if (ischar (state))
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
47 if (strcmpi (state, "off"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
48 box_state = "off";
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
49 elseif (strcmpi (state, "on"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
50 box_state = "on";
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
51 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
52 print_usage ();
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
53 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
54 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
55 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
56 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
57 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
58
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
59 set (h, "box", box_state);
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
60
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
61 endfunction