annotate scripts/plot/box.m @ 6567:e82cb026b893

[project @ 2007-04-24 20:40:23 by jwe]
author jwe
date Tue, 24 Apr 2007 20:40:24 +0000
parents 44c91c5dfe1d
children 673686daec87
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2006 John W. Eaton
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
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
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
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
19
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} box (@var{arg})
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} grid (@var{h}, @dots{})
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
23 ## Control the display of a border around the plot.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
24 ## The argument may be either @code{"on"} or @code{"off"}. If it is
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
25 ## omitted, the the current box state is toggled.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
26 ## @seealso{grid}
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
28
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
29 ## Author: jwe
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
30
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
31 ## PKG_ADD: mark_as_command box
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
32
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
33 function box (varargin)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
34
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
35 h = gca ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
36
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
37 box_state = get (h, "box");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
38
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
39 nargs = numel (varargin);
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
40
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
41 if (nargs == 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
42 if (strcmp (box_state, "on"))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
43 box_state = "off";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
44 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
45 box_state = "on";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
46 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
47 elseif (nargs == 1)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
48 state = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
49 if (ischar (state))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
50 if (strcmp ("off", state))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
51 box_state = "off";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
52 elseif (strcmp ("on", state))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
53 box_state = "on";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
54 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
55 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
56 endif
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 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
59 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
60 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
61
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
62 set (h, "box", box_state);
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
63
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
64 endfunction