Mercurial > hg > octave-lyh

annotate scripts/plot/gco.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents a4969508008e
children bc924baa2c4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
1 ## Copyright (C) 2012 Michael Goffioul
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
2 ##
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
4 ##
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
9 ##
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
14 ##
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
18
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} gco ()
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{h} =} gco (@var{fig})
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
22 ## Return a handle to the current object of the current figure, or a handle
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
23 ## to the current object of the figure with handle @var{fig}.
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
24 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
25 ## The current object of a figure is the object that was last clicked on. It
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
26 ## is stored in the "CurrentObject" property of the target figure.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
27 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
28 ## If the last mouse click did not occur on any child object of the figure,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
29 ## then the current object is the figure itself.
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
30 ##
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16814
diff changeset
31 ## If no mouse click occurred in the target figure, this function returns an
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
32 ## empty matrix.
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
33 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
34 ## Programming Note: The value returned by this function is not necessarily the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
35 ## same as the one returned by @code{gcbo} during callback execution. An
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
36 ## executing callback can be interrupted by another callback and the current
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
37 ## object may be changed.
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
38 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
39 ## @seealso{gcbo, gca, gcf, gcbf, get, set}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16826
diff changeset
40 ## @end deftypefn
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
41
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
42 function h = gco ()
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
43
15246
fa8f3955e70a gco.m: Don't create figure if it doesn't already exist (Bug #37211)
Rik <rik@octave.org>
parents: 15010
diff changeset
44 h = get (get (0, "currentfigure"), "currentobject");
14837
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
45
c55493bb7363 Add gco implementation.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
46 endfunction