update packages

[CreaPhase.git] / octave_packages / m / plot / orient.m

diff --git a/octave_packages/m/plot/orient.m b/octave_packages/m/plot/orient.m
new file mode 100644 (file)
index 0000000..d71122a
--- /dev/null
+++ b/octave_packages/m/plot/orient.m
@@ -0,0 +1,109 @@
+## Copyright (C) 2001-2012 Paul Kienzle
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} orient (@var{orientation})
+## Set the default print orientation.  Valid values for
+## @var{orientation} include @code{"landscape"}, @code{"portrait"},
+## and @code{"tall"}.
+##
+## The @code{"tall"} option sets the orientation to portait and fills
+## the page with the plot, while leaving a 0.25in border.
+##
+## If called with no arguments, return the default print orientation.
+## @end deftypefn
+
+## Author: Paul Kienzle
+## Adapted-By: jwe
+
+function retval = orient (varargin)
+
+  nargs = nargin;
+
+  if (nargs > 0 && numel (varargin{1}) == 1 && isfigure (varargin{1}))
+    cf = varargin{1};
+    varargin(1) = [];
+    nargs--;
+  else
+    cf = gcf ();
+  endif
+
+  if (nargs == 0)
+    retval = get (cf, "paperorientation");
+  elseif (nargin == 1)
+    orientation = varargin{1};
+    if (strcmpi (orientation, "landscape") || strcmpi (orientation, "portrait"))
+      if (! strcmpi (get (cf, "paperorientation"), orientation))
+        ## FIXME - with the proper listeners in place there won't be a need to set
+        ##         the papersize and paperpostion here.
+        papersize = get (cf, "papersize");
+        paperposition = get (cf, "paperposition");
+        set (cf, "paperorientation", orientation);
+        set (cf, "papersize", papersize([2, 1]));
+        set (cf, "paperposition", paperposition([2, 1, 4, 3]));
+      endif
+    elseif (strcmpi (varargin{1}, 'tall'))
+      orient ("portrait");
+      papersize = get (cf, "papersize");
+      set (cf, "paperposition", [0.25, 0.25, (papersize - 0.5)]);
+    else
+      error ("orient: unknown ORIENTATION");
+    endif
+  else
+    print_usage ();
+  endif
+
+endfunction
+
+%!shared papersize, paperposition, tallpaperposition, hfig
+%!  papersize = [8.5, 11];
+%!  paperposition = [0.25, 2.5, 8, 6];
+%!  tallpaperposition = [0.25, 0.25, (papersize-0.5)];
+%!  hfig = figure ();
+%!  set (hfig, "visible", "off")
+%!  set (hfig, "paperorientation", "portrait")
+%!  set (hfig, "papersize", papersize)
+%!  set (hfig, "paperposition", paperposition)
+%!test
+%!  orient portrait
+%!  assert (orient, "portrait") # default
+%!  assert (get (hfig, "papersize"), papersize)
+%!  assert (get (hfig, "paperposition"), paperposition)
+%!test
+%!  orient landscape
+%!  assert (orient,"landscape") # change to landscape
+%!  assert (get (hfig, "papersize"), papersize([2, 1]))
+%!  assert (get (hfig, "paperposition"), paperposition([2, 1, 4, 3]))
+%!test
+%!  orient portrait # change back to portrait
+%!  assert (orient, "portrait")
+%!  assert (get (hfig, "papersize"), papersize)
+%!  assert (get (hfig, "paperposition"), paperposition)
+%!test
+%!  orient landscape
+%!  orient tall
+%!  assert (orient, "portrait")
+%!  assert (get (hfig, "papersize"), papersize)
+%!  assert (get (hfig, "paperposition"), tallpaperposition)
+%!fail ("orient ('nobody')", "unknown ORIENTATION")
+%!test
+%!  orient portrait # errors don't change the state
+%!  assert (orient, "portrait")
+%!  assert (get (hfig, "papersize"), papersize)
+%!  assert (get (hfig, "paperposition"), tallpaperposition)
+%!  close (hfig)