octave-nkf: scripts/plot/orient.m annotate

annotate scripts/plot/orient.m @ 12112:3ab05b7b61ee release-3-2-x

orient.m: Flip papersize and paperposition when orientation changes. Add support for 'tall' option. Add tests.

author	Ben Abbott <bpabbott@mac.com>
date	Wed, 18 Nov 2009 20:18:47 -0500
parents	eb63fbe60fab
children	1740012184f9

rev	line source
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8746 diff changeset	1 ## Copyright (C) 2001, 2005, 2006, 2007, 2008, 2009 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 --
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe] jwe parents: 5364 diff changeset	20 ## @deftypefn {Function File} {} orient (@var{orientation})
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6441 diff changeset	21 ## Set the default print orientation. Valid values for
12112 3ab05b7b61ee 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	22 ## @var{orientation} include @code{"landscape"}, @code{"portrait"},
3ab05b7b61ee 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	23 ## and @code{"tall"}.
3ab05b7b61ee 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	24 ##
3ab05b7b61ee 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	25 ## The @code{"tall"} option sets the orientation to portait and fills
3ab05b7b61ee 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	26 ## the page with the plot, while leaving a 0.25in border.
3ab05b7b61ee 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	27 ##
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6441 diff changeset	28 ## If called with no arguments, return the default print orientation.
5365 c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe] jwe parents: 5364 diff changeset	29 ## @end deftypefn
5364 dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	30
5365 c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe] jwe parents: 5364 diff changeset	31 ## Author: Paul Kienzle
c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe] jwe parents: 5364 diff changeset	32 ## Adapted-By: jwe
5364 dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	33
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	34 function retval = orient (varargin)
5365 c9c773d8333f [project @ 2005-05-23 20:05:15 by jwe] jwe parents: 5364 diff changeset	35
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	36 nargs = nargin;
5364 dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	37
8248 08bb64396685 orient.m: Fix syntax error. Ben Abbott <bpabbott@mac.com> parents: 8239 diff changeset	38 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	39 cf = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	40 varargin(1) = [];
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	41 nargs--;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	42 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	43 cf = gcf ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	44 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	45
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	46 if (nargs == 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	47 retval = get (cf, "paperorientation");
5364 dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	48 elseif (nargin == 1)
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6046 diff changeset	49 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	50 if (strcmpi (orientation, "landscape") \|\| strcmpi (orientation, "portrait"))
12112 3ab05b7b61ee 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	51 if (! strcmpi (get (cf, "paperorientation"), orientation))
3ab05b7b61ee 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	52 ## FIXME - with the proper listeners in place there won't be a need to set
3ab05b7b61ee 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	53 ## the papersize and paperpostion here.
3ab05b7b61ee 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	54 papersize = get (cf, "papersize");
3ab05b7b61ee 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	55 paperposition = get (cf, "paperposition");
3ab05b7b61ee 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	56 set (cf, "paperorientation", orientation)
3ab05b7b61ee 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	57 set (cf, "papersize", papersize([2, 1]));
3ab05b7b61ee 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	58 set (cf, "paperposition", paperposition([2, 1, 4, 3]));
3ab05b7b61ee 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 endif
3ab05b7b61ee 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	60 elseif (strcmpi (varargin{1}, 'tall'))
3ab05b7b61ee 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	61 orient ("portrait")
3ab05b7b61ee 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");
3ab05b7b61ee 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 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	64 else
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	65 error ("orient: unknown orientation");
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	66 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	67 else
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5365 diff changeset	68 print_usage ();
5364 dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	69 endif
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	70
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	71 endfunction
dd230a6f68f6 [project @ 2005-05-23 19:59:53 by jwe] jwe parents: diff changeset	72
12112 3ab05b7b61ee 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	73 %!shared papersize, paperposition, tallpaperposition, hfig
3ab05b7b61ee 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	74 %! papersize = [8.5, 11];
3ab05b7b61ee 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	75 %! paperposition = [0.25, 2.5, 8, 6];
3ab05b7b61ee 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	76 %! tallpaperposition = [0.25, 0.25, (papersize-0.5)];
3ab05b7b61ee 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	77 %! hfig = figure ();
3ab05b7b61ee 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	78 %! set (hfig, "visible", "off")
3ab05b7b61ee 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	79 %! set (hfig, "paperorientation", "portrait")
3ab05b7b61ee 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	80 %! set (hfig, "papersize", papersize)
3ab05b7b61ee 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	81 %! set (hfig, "paperposition", paperposition)
3ab05b7b61ee 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 %!test
3ab05b7b61ee 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	83 %! orient portrait
3ab05b7b61ee 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	84 %! assert (orient, "portrait") # default
3ab05b7b61ee 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	85 %! assert (get (hfig, "papersize"), papersize)
3ab05b7b61ee 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	86 %! assert (get (hfig, "paperposition"), paperposition)
3ab05b7b61ee 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	87 %!test
3ab05b7b61ee 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	88 %! orient landscape
3ab05b7b61ee 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	89 %! assert (orient,"landscape") # change to landscape
3ab05b7b61ee 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	90 %! assert (get (hfig, "papersize"), papersize([2, 1]))
3ab05b7b61ee 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 %! assert (get (hfig, "paperposition"), paperposition([2, 1, 4, 3]))
3ab05b7b61ee 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	92 %!test
3ab05b7b61ee 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	93 %! orient portrait # change back to portrait
3ab05b7b61ee 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	94 %! assert (orient, "portrait")
3ab05b7b61ee 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	95 %! assert (get (hfig, "papersize"), papersize)
3ab05b7b61ee 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	96 %! assert (get (hfig, "paperposition"), paperposition)
3ab05b7b61ee 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
3ab05b7b61ee 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	98 %! orient landscape
3ab05b7b61ee 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	99 %! orient tall
3ab05b7b61ee 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	100 %! assert (orient, "portrait")
3ab05b7b61ee 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	101 %! assert (get (hfig, "papersize"), papersize)
3ab05b7b61ee 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	102 %! assert (get (hfig, "paperposition"), tallpaperposition)
3ab05b7b61ee 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 %!fail ("orient ('nobody')", "unknown orientation")
3ab05b7b61ee 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	104 %!test
3ab05b7b61ee 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	105 %! orient portrait # errors don't change the state
3ab05b7b61ee 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	106 %! assert (orient, "portrait")
3ab05b7b61ee 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	107 %! assert (get (hfig, "papersize"), papersize)
3ab05b7b61ee 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	108 %! assert (get (hfig, "paperposition"), tallpaperposition)
3ab05b7b61ee 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 %! close (hfig)

Mercurial > octave-nkf

annotate scripts/plot/orient.m @ 12112:3ab05b7b61ee release-3-2-x