Mercurial > hg > octave-nkf
changeset 14837:c55493bb7363
Add gco implementation.
* scripts/plot/gco.m: New file.
* scripts/plot/models.mk (plot_FCN_FILES): Add it to module.
| author | Michael Goffioul <michael.goffioul@gmail.com> |
|---|---|
| date | Wed, 04 Jul 2012 14:57:57 +0100 |
| parents | a1e1f914ae79 |
| children | 1abb7c083171 |
| files | scripts/plot/gco.m scripts/plot/module.mk |
| diffstat | 2 files changed, 46 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/scripts/plot/gco.m @@ -0,0 +1,45 @@ +## Copyright (C) 2012 Michael Goffioul +## +## 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} {@var{h} =} gco () +## @deftypefnx {Function File} {@var{h} =} gco (@var{fig}) +## Return a handle to the current object of the current figure, or a handle +## to the current object of the figure with handle @var{fig}. The current +## object of a figure is the object that was last clicked on. It is stored +## in the CurrentObject property of the target figure. +## +## If the last mouse click didn't occur on any child object of the figure, +## the current object is the figure itself. +## +## If no mouse click occured in the target figure, this function returns and +## empty matrix. +## +## Note that the value returned by this function is not necessarily the same +## as the one returned by gcbo during callback execution. An executing +## callback can be interrupted by another callback and the current object +## can be modified. +## +##@seealso{gcbo, gcf} +##@end deftypefn + +function h = gco () + + h = get (gcf (), "currentobject"); + +endfunction