changeset 19794:47440b762547

bring back mouse_wheel_zoom function as deprecated * mouse_wheel_zoom.m: New function. * scripts/deprecated/module.mk: Update. * NEWS: Note that mouse_wheel_zoom is deprecated.
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2015 01:31:56 -0500
parents ed1bafbb87ee
children 74b5209ad68d
files NEWS scripts/deprecated/module.mk scripts/deprecated/mouse_wheel_zoom.m
diffstat 3 files changed, 57 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Thu Feb 19 01:30:54 2015 -0500
+++ b/NEWS	Thu Feb 19 01:31:56 2015 -0500
@@ -207,6 +207,7 @@
       fnmatch              | glob or regexp
       loadaudio            | audioread
       luinc                | ilu or ichol
+      mouse_wheel_zoom     | mousewheelzoom axes property
       nfields              | numfields
       octave_tmp_file_name | tempname
       playaudio            | audioplayer
--- a/scripts/deprecated/module.mk	Thu Feb 19 01:30:54 2015 -0500
+++ b/scripts/deprecated/module.mk	Thu Feb 19 01:31:56 2015 -0500
@@ -22,6 +22,7 @@
   deprecated/javamethods.m \
   deprecated/loadaudio.m \
   deprecated/luinc.m \
+  deprecated/mousewheelzoom.m \
   deprecated/nfields.m \
   deprecated/octave_tmp_file_name.m \
   deprecated/playaudio.m \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/mouse_wheel_zoom.m	Thu Feb 19 01:31:56 2015 -0500
@@ -0,0 +1,55 @@
+## Copyright (C) 2007-2013 Shai Ayal
+##
+## 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 {Loadable Function} {@var{old_val} =} mouse_wheel_zoom (@var{new_val})
+## Query or set the mouse wheel zoom factor.
+##
+## The zoom factor is a number in the range (0,1) which is the
+## percentage of the current axis limits that will be used when zooming.
+## For example, if the current x-axis limits are [0, 50] and
+## @code{mouse_wheel_zoom} is 0.4 (40%), then a zoom operation will
+## change the limits by 20.
+#### @end deftypefn
+
+## Deprecated in 4.0
+
+function retval = mouse_wheel_zoom (val)
+
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "mouse_wheel_zoom is obsolete and will be removed from a future version of Octave, please use the mousehweelzoom axes property instead");
+  endif
+
+  if (nargin != 1)
+    print_usage ();
+  endif
+
+  fig = get (0, "currentfigure");
+  if (isempty (fig))
+    retval = get (0, "defaultaxesmousewheelzoom");
+    set (0, "defaultaxesmousewheelzoom", val);
+  else
+    retval = get (gca, "mousewheelzoom");
+    set (gca, "mousewheelzoom", val);
+  endif
+
+endfunction
+