Mercurial > hg > octave-lyh
view scripts/plot/gco.m @ 17405:0bf2fc8562c9
doc: Update documentation for file and directory functions.
* libinterp/corefcn/dirfns.cc(Fpwd, Freaddir, Fmkdir, Frmdir, Freadlink, Ffnmatch): Redo docstring.
* libinterp/corefcn/dirfns.cc(Fcd): Redo docstring. Return previous working
directory if nargout > 0.
* libinterp/corefcn/dirfns.cc(Flink, Fsymlink, Frename): Redo docstring.
Re-order return values so that highest numbered value is assigned first to
avoid re-sizing octave_value_list each time.
* libinterp/corefcn/syscalls.cc(Flstat, Fmkfifo, FS_ISREG, FS_ISDIR, FS_ISCHR,
FS_ISBLK, FS_ISFIFO, FS_ISLNK, FS_ISSOCK): Redo docstring.
* scripts/general/isdir.m: Add more xrefs to @seealso.
* scripts/miscellaneous/copyfile.m: Add more xrefs to @seealso.
* scripts/miscellaneous/dir.m: Redo docstring.
* scripts/miscellaneous/ls.m: Add more xrefs to @seealso.m.
* scripts/miscellaneous/movefile.m: Add more xrefs to @seealso.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 09 Sep 2013 14:30:31 -0700 |
parents | 1c89599167a6 |
children |
line wrap: on
line source
## 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 @qcode{"CurrentObject"} property of the target figure. ## ## If the last mouse click did not occur on any child object of the figure, ## then the current object is the figure itself. ## ## If no mouse click occurred in the target figure, this function returns an ## empty matrix. ## ## Programming Note: The value returned by this function is not necessarily the ## same as the one returned by @code{gcbo} during callback execution. An ## executing callback can be interrupted by another callback and the current ## object may be changed. ## ## @seealso{gcbo, gca, gcf, gcbf, get, set} ## @end deftypefn function h = gco () h = get (get (0, "currentfigure"), "currentobject"); endfunction