annotate scripts/plot/util/gco.m @ 18746:29f00c0d0657

Fix double '-P' in print command to printer (bug #41957). * print.m: Expand documentation of latex and latexstandalone options. Change some of the documentation examples to use more useful, modern devices (jpg instead of HP DeskJet 550C). Use isempty to determine in there is a figure to print. Remove extra '-P' from print command going directly to printer.
author Michael Godfrey <michaeldgodfrey@gmail.com>
date Tue, 25 Mar 2014 17:00:41 +0000
parents d63878346099
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2012-2013 Michael Goffioul
14837
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
17122
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 ##
17122
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
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
26 ## is stored in the @qcode{"CurrentObject"} property of the target figure.
17122
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 ##
17122
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 ##
17122
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
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
47