Mercurial > hg > octave-lyh

annotate scripts/plot/orient.m @ 17496:edd15fceff14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
guihandles.m: Overhaul function. * scripts/plot/guihandles.m: Add docstring which was missing. Match function variables to docstring. Put input validation first.
author Rik <rik@octave.org>
date Wed, 25 Sep 2013 10:46:18 -0700
parents bc924baa2c4e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11589
diff changeset
1 ## Copyright (C) 2001-2012 Paul Kienzle
5364
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
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: 6895
diff changeset
8 ## your option) any later version.
5365
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
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: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
18
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
19 ## -*- texinfo -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
20 ## @deftypefn {Function File} {} orient (@var{orientation})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
21 ## @deftypefnx {Function File} {} orient (@var{hfig}, @var{orientation})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
22 ## @deftypefnx {Function File} {@var{orientation} =} orient ()
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
23 ## @deftypefnx {Function File} {@var{orientation} =} orient (@var{hfig})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
24 ## Query or set the default print orientation.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
25 ##
17289
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17179
diff changeset
26 ## Valid values for @var{orientation} are @qcode{"landscape"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17179
diff changeset
27 ## @qcode{"portrait"}, and @qcode{"tall"}.
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
28 ##
17289
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17179
diff changeset
29 ## The @qcode{"tall"} option sets the orientation to portrait and fills
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
30 ## the page with the plot, while leaving a 0.25 inch border.
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
31 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
32 ## When called with no arguments, return the default print orientation.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
33 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ## If the first argument @var{hfig} is a figure handle, then operate on this
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## figure rather than the current figure returned by @code{gcf}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
36 ## @seealso{print, saveas}
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
37 ## @end deftypefn
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
38
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
39 ## Author: Paul Kienzle
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
40 ## Adapted-By: jwe
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
41
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
42 function retval = orient (varargin)
5365
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe]
jwe
parents: 5364
diff changeset
43
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
44 nargs = nargin;
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
45
8248
08bb64396685 orient.m: Fix syntax error.
Ben Abbott <bpabbott@mac.com>
parents: 8239
diff changeset
46 if (nargs > 0 && numel (varargin{1}) == 1 && isfigure (varargin{1}))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 cf = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
48 varargin(1) = [];
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
49 nargs--;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
50 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
51 cf = gcf ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
52 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
53
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
54 if (nargs == 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
55 retval = get (cf, "paperorientation");
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
56 elseif (nargin == 1)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
57 orientation = varargin{1};
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 8189
diff changeset
58 if (strcmpi (orientation, "landscape") || strcmpi (orientation, "portrait"))
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
59 if (! strcmpi (get (cf, "paperorientation"), orientation))
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
60 ## FIXME: with the proper listeners in place there won't be a need to
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
61 ## set the papersize and paperpostion here.
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
62 papersize = get (cf, "papersize");
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
63 paperposition = get (cf, "paperposition");
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
64 set (cf, "paperorientation", orientation);
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
65 set (cf, "papersize", papersize([2, 1]));
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
66 set (cf, "paperposition", paperposition([2, 1, 4, 3]));
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
67 endif
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
68 elseif (strcmpi (varargin{1}, 'tall'))
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
69 orient ("portrait");
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
70 papersize = get (cf, "papersize");
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
71 set (cf, "paperposition", [0.25, 0.25, (papersize - 0.5)]);
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
72 else
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 9832
diff changeset
73 error ("orient: unknown ORIENTATION");
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
74 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
75 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5365
diff changeset
76 print_usage ();
5364
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
77 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
78
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
79 endfunction
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe]
jwe
parents:
diff changeset
80
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
82 %!shared papersize, paperposition, tallpaperposition, hfig
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
83 %! papersize = [8.5, 11];
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
84 %! paperposition = [0.25, 2.5, 8, 6];
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
85 %! tallpaperposition = [0.25, 0.25, (papersize-0.5)];
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
86 %! hfig = figure ("visible", "off");
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
87 %! set (hfig, "paperorientation", "portrait");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
88 %! set (hfig, "papersize", papersize);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
89 %! set (hfig, "paperposition", paperposition);
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
90
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
91 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 %! orient portrait;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
93 %! assert (orient, "portrait") # default
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
94 %! assert (get (hfig, "papersize"), papersize);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
95 %! assert (get (hfig, "paperposition"), paperposition);
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
96
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
97 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
98 %! orient landscape;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
99 %! assert (orient,"landscape") # change to landscape
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
100 %! assert (get (hfig, "papersize"), papersize([2, 1]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
101 %! assert (get (hfig, "paperposition"), paperposition([2, 1, 4, 3]));
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
102
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
103 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
104 %! orient portrait # change back to portrait
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 %! assert (orient, "portrait");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
106 %! assert (get (hfig, "papersize"), papersize);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
107 %! assert (get (hfig, "paperposition"), paperposition);
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
108
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
109 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
110 %! orient landscape;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
111 %! orient tall;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
112 %! assert (orient, "portrait");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
113 %! assert (get (hfig, "papersize"), papersize);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
114 %! assert (get (hfig, "paperposition"), tallpaperposition);
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
115
11473
44032aac5223 Correct failing error() tests due to change in capitalization of previous changeset.
Rik <octave@nomad.inbox5.com>
parents: 11472
diff changeset
116 %!fail ("orient ('nobody')", "unknown ORIENTATION")
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
117
9832
cd0c4a5a12c8 orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.
Ben Abbott <bpabbott@mac.com>
parents: 8920
diff changeset
118 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
119 %! orient portrait # errors don't change the state
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
120 %! assert (orient, "portrait");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
121 %! assert (get (hfig, "papersize"), papersize);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
122 %! assert (get (hfig, "paperposition"), tallpaperposition);
17158
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
123
e7723410ec32 Recode some %!tests which pop up figures with new figure() behavior.
Rik <rik@octave.org>
parents: 17126
diff changeset
124 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
125 %! close (hfig);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
126