Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/__init_fltk__.cc @ 12306:eedeed3ee849 release-3-4-x
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Add new section to plot.txi to document functions which change toolkit behavior.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 30 Jan 2011 09:36:11 -0800 |
parents | 2b7aa04f6b53 |
children | c8da31f12c1d |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/__init_fltk__.cc Sun Jan 30 12:01:35 2011 -0500 +++ b/src/DLD-FUNCTIONS/__init_fltk__.cc Sun Jan 30 09:36:11 2011 -0800 @@ -1966,12 +1966,22 @@ return retval; } -DEFUN_DLD (fltk_mouse_wheel_zoom, args, , +/* FIXME: This function should be abstracted and made potentially available + to all graphics toolkits. This suggests putting it in graphics.cc + as is done for drawnow() and having the master mouse_wheel_zoom + function call fltk_mouse_wheel_zoom. The same should be done for + gui_mode and fltk_gui_mode. For now (2011.01.30), just + changing function names and docstrings. +*/ + +DEFUN_DLD (mouse_wheel_zoom, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{speed} =} fltk_mouse_wheel_zoom ()\n\ -@deftypefnx {Built-in Function} {} fltk_mouse_wheel_zoom (@var{speed})\n\ -Query or set the mouse wheel zoom factor in the FLTK graphics toolkit.\n\ -@seealso{fltk_gui_mode}\n\ +@deftypefn {Built-in Function} {@var{speed} =} mouse_wheel_zoom ()\n\ +@deftypefnx {Built-in Function} {} mouse_wheel_zoom (@var{speed})\n\ +Query or set the mouse wheel zoom factor.\n\ +\n\ +This function is currently implemented only for the FLTK graphics toolkit.\n\ +@seealso{gui_mode}\n\ @end deftypefn") { octave_value retval = wheel_zoom_speed; @@ -1981,17 +1991,17 @@ if (args(0).is_real_scalar ()) wheel_zoom_speed = args(0).double_value (); else - error ("fltk_mouse_wheel_zoom: SPEED must be a real scalar"); + error ("mouse_wheel_zoom: SPEED must be a real scalar"); } return retval; } -DEFUN_DLD (fltk_gui_mode, args, , +DEFUN_DLD (gui_mode, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{mode} =} fltk_gui_mode ()\n\ -@deftypefnx {Built-in Function} {} fltk_gui_mode (@var{mode})\n\ -Query or set the GUI mode for the fltk graphics toolkit.\n\ +@deftypefn {Built-in Function} {@var{mode} =} gui_mode ()\n\ +@deftypefnx {Built-in Function} {} gui_mode (@var{mode})\n\ +Query or set the GUI mode for the current graphics toolkit.\n\ The @var{mode} argument can be one of the following strings:\n\ @table @asis\n\ @item '2d'\n\ @@ -2003,7 +2013,9 @@ @item 'none'\n\ Mouse inputs have no effect.\n\ @end table\n\ -@seealso{fltk_mouse_wheel_zoom}\n\ +\n\ +This function is currently implemented only for the FLTK graphics toolkit.\n\ +@seealso{mouse_wheel_zoom}\n\ @end deftypefn") { caseless_str mode_str;