annotate scripts/plot/orient.m @ 6441:8bcceddab2d5

[project @ 2007-03-23 15:35:28 by jwe]
author jwe
date Fri, 23 Mar 2007 15:35:28 +0000
parents 44c91c5dfe1d
children 76e3d985ae56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2001 Paul Kienzle
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
2 ##
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
3 ## This file is part of Octave.
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
4 ##
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
6 ## under the terms of the GNU General Public License as published by
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
8 ## any later version.
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
9 ##
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
13 ## General Public License for more details.
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
14 ##
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
18 ## 02110-1301, USA.
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
19
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
20 ## -*- texinfo -*-
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
21 ## @deftypefn {Function File} {} orient (@var{orientation})
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
22 ## Set default print orientation. Valid values for @var{orientation}
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
23 ## include @code{"landscape"} and @code{"portrait"}. If called with no
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
24 ## arguments, return the default print orientation.
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
25 ## @end deftypefn
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
26
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
27 ## Author: Paul Kienzle
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
28 ## Adapted-By: jwe
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
29
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
30 ## PKG_ADD: mark_as_command orient
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
31
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
32 function retval = orient (varargin)
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
33
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
34 nargs = nargin;
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
35
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
36 if (nargs > 0 && ishandle (varargin{1}))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
37 cf = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
38 varargin(1) = [];
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
39 nargs--;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
40 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
41 cf = gcf ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
42 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
43
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
44 if (nargs == 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
45 retval = get (cf, "paperorientation");
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
46 elseif (nargin == 1)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 orientation = varargin{1};
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
48 if (strcmp (orientation, "landscape") || strcmp (orientation, "portrait"))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
49 set (cf, "paperorientation", orientation)
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
50 else
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
51 error ("orient: unknown orientation");
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
52 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
53 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5365
diff changeset
54 print_usage ();
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
55 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
56
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
57 endfunction
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
58
6441
8bcceddab2d5 [project @ 2007-03-23 15:35:28 by jwe]
jwe
parents: 6257
diff changeset
59 %!shared
8bcceddab2d5 [project @ 2007-03-23 15:35:28 by jwe]
jwe
parents: 6257
diff changeset
60 %! set (gcf (), "visible", "off")
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
61 %!assert(orient,"portrait") # default
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
62 %!test orient('landscape')
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
63 %!assert(orient,"landscape") # change to landscape
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
64 %!test orient('portrait')
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
65 %!assert(orient,"portrait") # change to portrait
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
66 %!fail("orient('nobody')","unknown orientation")
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
67 %!assert(orient,"portrait") # errors don't change the state