octave: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 21319:8880d93010d8

Remove further uses of CLASS field in @deftypefn macro. * errors.txi, external.txi, genpropdoc.m, intro.txi, tips.txi, ode23.m, runge_kutta_23.m, gnuplot_binary.in: Remove further uses of CLASS field in @deftypefn macro.

author	Rik <rik@octave.org>
date	Mon, 22 Feb 2016 08:37:15 -0800
parents	b6ea72a439f8
children	7c143e73e921

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19597 diff changeset	1 ## Copyright (C) 2014-2015 Pantxo Diribarne
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	3 ## This program is free software; you can redistribute it and/or modify it
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	4 ## under the terms of the GNU General Public License as published by
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	5 ## the Free Software Foundation; either version 3 of the License, or
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	6 ## (at your option) any later version.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	7 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	8 ## This program is distributed in the hope that it will be useful,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	11 ## GNU General Public License for more details.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	12 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	13 ## You should have received a copy of the GNU General Public License
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	14 ## along with this program. If not, see
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	15 ## <http://www.gnu.org/licenses/>.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	16
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	17 ## -- texinfo --
21319 8880d93010d8 Remove further uses of CLASS field in @deftypefn macro. Rik <rik@octave.org> parents: 20930 diff changeset	18 ## @deftypefn {} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	19 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	20 ## Print FILENAME texinfo source file associated to OBJNAME objects. This
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	21 ## function is meant to be run for generating octave documentation
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	22 ## (see doc/interpreter/graphics_properties.mk).
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	23 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	24 ## All the hard coded documentation is written in getdoc function. See the
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	25 ## comments in getdoc bellow for instruction on how to document a graphics
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	26 ## property.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	27 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	28 ## @seealso{}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	29 ## @end deftypefn
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	30
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	31 function genpropdoc (objname, fname)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	32 objnames = {"root", "figure", "axes", "line", ...
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	33 "text", "image", "patch", "surface", ...
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	34 "uimenu", "uicontextmenu", "uipanel", ...
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	35 "uicontrol", "uitoolbar", "uipushtool", "uitoggletool"};
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	36
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	37 ## Base properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	38 base = getstructure ("base");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	39
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	40 ## Object properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	41 if (any (strcmp (objname, objnames)))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	42 obj = getstructure (objname, base);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	43 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	44 error ("genpropdoc: unknown object %s", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	45 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	46
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	47 ## Docstring
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	48 str = printdoc (objname, obj);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	49
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	50 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	51 fid = fopen (fname, "w+");
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	52 if (fid < 0)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	53 error ("genpropdoc: couldn't open %s.", fname);
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	54 endif
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	55 else
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	56 fid = stdout;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	57 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	58
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	59 fprintf (fid, str);
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	60
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	61 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	62 fclose (fid);
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	63 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	64
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	65 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	66
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	67 function s = getdoc (objname, field, base)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	68 ## Properties are represented by a struct with fields :
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	69 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	70 ## -"doc": string to be printed verbatim after being expanded
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	71 ## through expand_doc function. Special keywords are:
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	72 ## "__objname__" : replaced by the current object name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	73 ## "__prop__" : replaced by the current property name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	74 ## "__modemsg__" : replaced by a message explaining that
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	75 ## the propmode will be toggled to "manual".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	76 ## You may also cross reference properties using the label format
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	77 ## OBJNAMEPROPERTY, e.g, "@xref{XREFaxescolor, , axes color property}."
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	78 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	79 ## -"valid": string that describes valid values for the current property.
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	80 ## Use "packopt" function to join options with " \| " separator
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	81 ## and "markdef" to mark default among valid values between curly braces.
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	82 ## If not provided, valid values for radio properties are automatically
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	83 ## retrieved using set function.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	84 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	85 ## -"default": string. If not provided the default value is automatically
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	86 ## retrieved using get function.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	87 ##
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	88 ## -"printdefault": a boolean (def. true) that specifies whether the
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	89 ## default value should be printed. It is useful for properties
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	90 ## like root "screendepth" that default to screen dependant values.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	91
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	92 packopt = @(c) strjoin (c, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	93 markdef = @(s) ["@{" s "@}"];
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	94
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	95 ## Some generic templates:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	96 valid_color = "colorspec";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	97 valid_handle = "graphics handle";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	98 valid_string = "string";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	99 valid_fcn = packopt ({"string", "function handle"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	100 valid_cellstring = packopt ({"string", "cell array of strings"});
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	101 valid_2elvec = "two-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	102 valid_3elvec = "three-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	103 valid_4elvec = "four-element vector";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	104 valid_vecmat = packopt ({"vector", "matrix"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	105 valid_scalmat = packopt ({"scalar", "matrix"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	106
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	107 doc_notimpl = "%s is not yet implemented for __objname__ objects. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	108 __prop__ is unused.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	109 doc_unused = "__prop__ is unused.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	110
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	111 ## Initialize structure
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	112 if (isfield (base, field))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	113 s = base.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	114 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	115 s = struct ("valid", "", "default", "", "doc", "", "printdefault", true);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	116 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	117
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	118 ## Base properties: Write generic documentation because it will be included
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	119 ## in the list of each graphics object. If a given graphics object
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	120 ## interprets the property differently than others, then the doc will have
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	121 ## to be rewritten for this object.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	122 if (strcmp (objname, "base"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	123 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	124 case "beingdeleted"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	125 case "busyaction"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	126 case "buttondownfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	127 s.valid = valid_fcn;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	128
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	129 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	130 s.doc = "Graphics handles of the __objname__'s children.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	131 s.valid = "vector of graphics handles";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	132
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	133 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	134 s.doc = "If __prop__ is @qcode{\"on\"}, the __objname__ is \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	135 clipped in its parent axes limits.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	136
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	137 case "createfcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	138 s.doc = "Callback function executed immediately after __objname__ \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	139 has been created. Function is set by using default property on root object, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	140 e.g., @code{set (0, \"default__objname__createfcn\", \
20101 e51473fdb622 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 20077 diff changeset	141 'disp (\"__objname__ created!\")')}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	142 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	143
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	144 case "deletefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	145 s.doc = "Callback function executed immediately before __objname__ \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	146 is deleted.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	147 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	148
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	149 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	150 s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__'s \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	151 handle is not visible in its parent's \"children\" property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	152
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	153 case "hittest"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	154 case "interruptible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	155 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	156 s.doc = "Handle of the parent graphics object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	157 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	158
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	159 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	160 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	161 case "tag"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	162 s.doc = "A user-defined string to label the graphics object.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	163 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	164
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	165 case "type"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	166 s.doc = "Class name of the graphics object. __prop__ is \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	167 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	168 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	169 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	170
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	171 case "uicontextmenu"
20077 69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	172 s.doc = "Graphics handle of the uicontextmenu object that is \
69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	173 currently associated to this __objname__ object.";
69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	174 s.valid = valid_handle;
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	175
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	176 case "userdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	177 s.doc = "User-defined data to associate with the graphics object.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	178 s.valid = "Any Octave data";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	179
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	180 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	181 s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__ is \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	182 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	183 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	184
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	185 ## Root properties:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	186 elseif (strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	187 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	188 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	189 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	190 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	191 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	192 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	193 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	194
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	195 case "parent"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	196 s.doc = "Root figure has no parent graphics object. __prop__ \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	197 is always empty.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	198
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	199 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	200 case "callbackobject"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	201 s.doc = "Graphics handle of the current object whose callback is executing.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	202 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	203
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	204 case "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	205 s.doc = "Graphics handle of the current figure.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	206 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	207
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	208 case "diary"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	209 s.doc = "If __prop__ is @qcode{\"on\"}, the Octave command window \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	210 session is saved to file. @xref{XREFrootdiaryfile, , @w{diaryfile property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	211
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	212 case "diaryfile"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	213 s.doc = "The name of the diary file. \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	214 @xref{XREFdiary, , @w{diary function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	215 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	216
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	217 case "echo"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	218 s.doc = "Control whether Octave displays commands executed from \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	219 scripts. @xref{XREFecho, , @w{echo function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	220
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	221 case "errormessage"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	222 s.doc = "The last error message raised. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	223 @xref{XREFlasterr, , @w{lasterr function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	224 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	225
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	226 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	227 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	228
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	229 case "format"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	230 s.doc = "This property is a wrapper around the @code{format} function.\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	231 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	232
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	233 case "formatspacing"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	234 s.doc = "This property is a wrapper around the @code{format} function.\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	235 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	236
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	237 case "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	238 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	239
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	240 case "monitorpositions"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	241 s.doc = doc_unused;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	242 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	243
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	244 case "pointerlocation"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	245 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	246 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	247
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	248 case "pointerwindow"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	249 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	250 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	251
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	252 case "recursionlimit"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	253 s.doc = "The maximum number of times a function can be called \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	254 recursively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	255 @xref{XREFmax_recursion_depth, , @w{max_recursion_depth function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	256 s.valid = "double";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	257
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	258 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	259 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	260 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	261
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	262 case "screenpixelsperinch"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	263 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	264 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	265
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	266 case "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	267 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	268 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	269
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	270 case "showhiddenhandles"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	271 s.doc = "If __prop__ is @qcode{\"on\"}, all graphics objects handles \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	272 are visible in their parents' children list, regardless of the value of their \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	273 @code{handlevisibility} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	274
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	275 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	276 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	277
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	278 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	279 elseif (strcmp (objname, "figure"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	280 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	281 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	282 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	283 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	284
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	285 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	286 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	287 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	288
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	289 case "closerequestfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	290 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	291
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	292 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	293 s.doc = "Color of the figure background. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	294 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	295 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	296
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	297 case "colormap"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	298 s.doc = "A matrix containing the RGB color map for the current axes.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	299 s.valid = "N-by-3 matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	300
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	301 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	302 s.doc = "Handle to the graphics object of the current axes.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	303 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	304
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	305 case "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	306 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	307
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	308 case "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	309 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	310
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	311 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	312 s.doc = "A 1-by-2 matrix which holds the coordinates of the point \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	313 over which the mouse pointer was when a mouse event occurred. The X and Y \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	314 coordinates are in units defined by the figure's @code{units} property \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	315 and their origin is the lower left corner of the plotting area.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	316 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	317 Events which set @code{currentpoint} are\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	318 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	319 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	320 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	321 @item A mouse button was released\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	322 only if the figure's callback @code{windowbuttonupfcn} is defined\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	323 @item The pointer was moved while pressing the mouse button (drag)\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	324 only if the figure's callback @code{windowbuttonmotionfcn} is defined\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	325 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	326 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	327
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	328 case "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	329 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	330
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	331 case "doublebuffer"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	332
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	333 case "filename"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	334 s.doc = "The filename used when saving the plot figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	335 s.valid = valid_string;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	336
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	337 case "graphicssmoothing"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	338 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	339
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	340 case "integerhandle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	341 s.doc = "Assign the next lowest unused integer as the Figure number.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	342
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	343 case "inverthardcopy"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	344 case "keypressfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	345 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	346
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	347 case "keyreleasefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	348 s.doc = "With @code{keypressfcn}, the keyboard callback functions. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	349 These callback functions are called when a key is pressed/released \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	350 respectively. The functions are called with two input arguments. The first \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	351 argument holds the handle of the calling figure. The second argument holds \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	352 an event structure which has the following members:\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	353 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	354 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	355 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	356 @item Key:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	357 Lowercase value of the key\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	358 @item Modifier:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	359 A cell array containing strings representing the modifiers pressed with the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	360 key.\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	361 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	362 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	363
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	364 case "menubar"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	365 s.doc = "Control the display of the figure menu bar in the upper \
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	366 left of the figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	367
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	368 case "name"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	369 s.doc = "Name to be displayed in the figure title bar. The name is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	370 displayed to the right of any title determined by the @code{numbertitle} \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	371 property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	372 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	373
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	374 ## FIXME: Uncomment when support added in graphics.in.h
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	375 #case "number"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	376 # s.doc = "Number of current figure (RO).";
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	377
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	378 case "nextplot"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	379
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	380 case "numbertitle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	381 s.doc = "Display \"Figure\" followed by the numerical figure handle \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	382 value in the figure title bar.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	383
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	384 case "outerposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	385 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	386
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	387 case "paperorientation"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	388 s.doc = "The value for the @code{papersize}, and @code{paperposition} \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	389 properties depends upon __prop__. The horizontal and vertical values for \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	390 @code{papersize} and @code{paperposition} reverse order \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	391 when __prop__ is switched between @code{\"portrait\"} and either \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	392 @code{\"landscape\"} or @code{\"rotated\"}."
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	393
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	394 case "paperposition"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	395 s.doc = "Vector @code{[left bottom width height]} defining the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	396 position and size of the figure (in @code{paperunits} units) on the printed \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	397 page. The position @code{[left bottom]} defines the lower left corner of the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	398 figure on the page, and the size is defined by @code{[width height]}. For \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	399 output formats not implicity rendered on paper, @code{width} and @code{height} \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	400 define the size of the image and the position information is ignored. \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	401 __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	402 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	403
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	404 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	405 s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	406 @code{paperposition} property is automatically computed: the printed \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	407 figure will have the same size as the on-screen figure and will be centered \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	408 on the output page. Setting the __prop__ to @code{\"auto\"} does not modify \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	409 the value of the @code{paperposition} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	410
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	411 case "papersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	412 s.doc = "Vector @code{[width height]} defining the size of the \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	413 paper for printing. Setting the __prop__ property to a value, not associated \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	414 with one of the defined @code{papertypes} and consistent with the setting for \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	415 @code{paperorientation}, forces the @code{papertype} property to the value \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	416 @qcode{\"<custom>\"}. If __prop__ is set to a value associated with a \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	417 supported @code{papertype} and consistent with the @code{paperorientation}, \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	418 the @code{papertype} value is modified to the associated value.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	419 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	420
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	421 case "papertype"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	422 s.doc = "Name of the paper used for printed output. \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	423 Setting __prop__ also changes @code{papersize}, while maintaining consistency \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	424 with the @code{paperorientation} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	425
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	426 case "paperunits"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	427 s.doc = "The unit used to compute the @code{paperposition} property. \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	428 For __prop__ set to @code{\"pixels\"}, the conversion between physical \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	429 units (ex: @code{\"inches\"}) and @code{\"pixels\"} is dependent on the \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	430 @code{screenpixelsperinch} property of the root object.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	431
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	432 case "pointer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	433 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	434 case "pointershapecdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	435 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	436 case "pointershapehotspot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	437 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	438
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	439 case "position"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	440 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	441
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	442 case "renderer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	443 case "renderermode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	444
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	445 case "resize"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	446 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	447
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	448 case "resizefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	449 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	450
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	451 case "selectiontype"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	452 ## FIXME: docstring explaining what "{normal}\|open\|alt\|extend" mean.
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	453
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	454 case "sizechangedfcn"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	455 s.valid = valid_fcn;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	456
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	457 case "toolbar"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	458 s.doc = "Control the display of the toolbar along the bottom of the \
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	459 figure window. When set to @qcode{\"auto\"}, the display is based on the \
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	460 value of the @code{menubar} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	461
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	462 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	463 s.doc = "The unit used to compute the @code{position} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	464 @code{outerposition} properties.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	465
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	466 case "windowbuttondownfcn"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	467 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	468 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	469 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	470
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	471 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	472 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	473 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	474 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	475
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	476 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	477 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	478 @code{windowbuttonmotionfcn}, the mouse callback functions. These \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	479 callback functions are called when a mouse button is pressed, dragged, or \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	480 released respectively. When these callback functions are executed, the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	481 @code{currentpoint} property holds the current coordinates of the cursor.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	482 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	483
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	484 case "windowkeypressfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	485 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	486
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	487 case "windowkeyreleasefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	488 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	489
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	490 case "windowscrollwheelfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	491 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	492
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	493 case "windowstyle"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	494 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	495
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	496 ## FIXME: Need to deprecate these for 4.2
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	497 case "wvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	498 case "wvisualmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	499 case "xdisplay"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	500 case "xvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	501 case "xvisualmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	502
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	503 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	504
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	505 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	506 elseif (strcmp (objname, "axes"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	507 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	508 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	509 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	510 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	511
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	512 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	513 case "activepositionproperty"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	514 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	515 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	516
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	517 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	518 case "ambientlightcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	519 s.doc = sprintf (doc_notimpl, "Light");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	520
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	521 case "box"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	522 s.doc = "Control whether the axes has a surrounding box.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	523
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	524 case "boxstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	525 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	526
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	527 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	528 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	529
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	530 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	531 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	532 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	533
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	534 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	535 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	536 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	537
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	538 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	539 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	540 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	541
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	542 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	543 case "clim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	544 s.doc = "Define the limits for the color axis of image children. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	545 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	546 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	547
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	548 case "climmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	549
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	550 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	551 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	552
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	553 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	554 s.doc = "Color of the axes background. @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	555 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	556
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	557 case "colororder"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	558 s.doc = "RGB values used by plot function for automatic line \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	559 coloring.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	560 s.valid = "N-by-3 RGB matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	561
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	562 case "colororderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	563 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	564
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	565 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	566 s.doc = "Matrix @code{[xf, yf, zf; xb, yb, zb]} which holds the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	567 coordinates (in axes data units) of the point over which the mouse pointer \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	568 was when the mouse button was pressed. If a mouse callback function is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	569 defined, @code{currentpoint} holds the pointer coordinates at the time \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	570 the mouse button was pressed. For 3-D plots, the first row of the returned \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	571 matrix specifies the point nearest to the current camera position and the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	572 second row the furthest point. The two points forms a line which is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	573 perpendicular to the screen.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	574 s.valid = "2-by-3 matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	575
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	576 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	577 s.doc = "Specify the relative height and width of the data \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	578 displayed in the axes. Setting @code{dataaspectratio} to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	579 @w{@code{[1, 2]}} causes the length of one unit as displayed on the x-axis \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	580 to be the same as the length of 2 units on the y-axis. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	581 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	582
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	583 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	584 case "fontangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	585 case "fontname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	586 s.doc = "Name of the font used for axes annotations.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	587 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	588
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	589 case "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	590 s.doc = "Size of the font used for axes annotations. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	591 @xref{XREFaxesfontunits, , @w{fontunits property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	592 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	593
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	594 case "fontunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	595 s.doc = "Unit used to interpret @code{fontsize} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	596
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	597 case "fontsmoothing"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	598 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	599
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	600 case "fontweight"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	601
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	602 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	603 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	604
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	605 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	606 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	607
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	608 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	609 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	610
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	611 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	612 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	613
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	614 case "gridlinestyle"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	615
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	616 case "labelfontsizemultiplier"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	617 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	618
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	619 case "layer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	620 s.doc = "Control whether the axes is drawn below child graphics \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	621 objects (ticks, labels, etc. covered by plotted objects) or above.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	622
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	623 case "linestyleorder"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	624 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	625
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	626 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	627 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	628
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	629 case "linewidth"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	630
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	631 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	632 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	633
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	634 case "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	635 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	636
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	637 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	638 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	639
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	640 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	641 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	642
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	643 case "minorgridlinestyle"
19776 4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom". Rik <rik@octave.org> parents: 19746 diff changeset	644 case "mousewheelzoom"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	645 s.doc = "Fraction of axes limits to zoom for each wheel movement.";
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	646 s.valid = "scalar in the range (0, 1)";
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	647
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	648 case "nextplot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	649 case "outerposition"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	650 s.doc = "Specify the position of the plot including titles, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	651 axes, and legend. The four elements of the vector are the \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	652 coordinates of the lower left corner and width and height of the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	653 plot, in units normalized to the width and height of the plot \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	654 window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	655 left corner of the axes at @math{(0.2, 0.3)} and the width and \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	656 height to be 0.4 and 0.5 respectively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	657 @xref{XREFaxesposition, , @w{position property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	658 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	659
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	660 case "pickableparts"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	661 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	662
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	663 case "plotboxaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	664 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	665 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	666 s.doc = "Specify the position of the plot excluding titles, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	667 axes, and legend. The four elements of the vector are the \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	668 coordinates of the lower left corner and width and height of the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	669 plot, in units normalized to the width and height of the plot \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	670 window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	671 left corner of the axes at @math{(0.2, 0.3)} and the width and \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	672 height to be 0.4 and 0.5 respectively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	673 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	674 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	675
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	676 case "projection"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	677 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	678
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	679 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	680 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	681
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	682 case "tickdir"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	683 s.doc = "Control whether axes tick marks project \"in\" to the plot \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	684 box or \"out\".";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	685
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	686 case "tickdirmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	687
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	688 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	689 s.doc = "Control the way x/y/zticklabel properties are interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	690 @xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	691
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	692 case "ticklength"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	693 s.doc = "Two-element vector @code{[2Dlen 3Dlen]} specifying the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	694 length of the tickmarks relative to the longest visible axis.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	695 s.valid = valid_2elvec;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	696
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	697 case "tightinset"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	698 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	699 s.doc = "Graphics handle of the title text object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	700 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	701
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	702 case "titlefontsizemultiplier"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	703 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	704
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	705 case "titlefontweight"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	706 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	707
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	708 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	709 case "view"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	710 s.doc = "Two-element vector @code{[azimuth elevation]} specifying \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	711 the viewpoint for three-dimensional plots";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	712 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	713
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	714 case "xaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	715 case "xcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	716 s.doc = "Color of the x-axis. @xref{Colors, , colorspec}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	717 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	718
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	719 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	720 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	721
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	722 case "xdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	723 case "xgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	724 s.doc = "Control whether major x grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	725
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	726 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	727 s.doc = "Graphics handle of the x label text object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	728 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	729
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	730 case "xlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	731 s.doc = "Two-element vector @code{[xmin xmax]} specifying the limits \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	732 for the x-axis. __modemsg__. @xref{XREFxlim, , @w{xlim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	733 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	734
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	735 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	736 case "xminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	737 s.doc = "Control whether minor x grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	738
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	739 case "xminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	740 case "xscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	741 case "xtick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	742 s.doc = "Position of x tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	743 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	744 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	745
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	746 case "xticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	747 s.doc = "Labels of x tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	748 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	749
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	750 case "xticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	751 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	752 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	753
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	754 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	755 case "yaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	756 case "ycolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	757 s.doc = "Color of the y-axis. @xref{Colors, , colorspec}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	758 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	759
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	760 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	761 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	762
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	763 case "ydir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	764 case "ygrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	765 s.doc = "Control whether major y grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	766
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	767 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	768 s.doc = "Graphics handle of the y label text object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	769 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	770
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	771 case "ylim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	772 s.doc = "Two-element vector @code{[ymin ymax]} specifying the limits \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	773 for the y-axis. __modemsg__. @xref{XREFylim, , @w{ylim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	774 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	775
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	776 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	777 case "yminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	778 s.doc = "Control whether minor y grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	779
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	780 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	781 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	782 case "ytick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	783 s.doc = "Position of y tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	784 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	785 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	786
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	787 case "yticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	788 s.doc = "Labels of y tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	789 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	790
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	791 case "yticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	792 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	793 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	794
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	795 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	796 case "zcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	797 s.doc = "Color of the z-axis. @xref{Colors, , colorspec}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	798 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	799
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	800 case "zcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	801 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	802
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	803 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	804 case "zgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	805 s.doc = "Control whether major z grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	806
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	807 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	808 s.doc = "Graphics handle of the z label text object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	809 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	810
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	811 case "zlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	812 s.doc = "Two-element vector @code{[zmin zmaz]} specifying the limits \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	813 for the z-axis. __modemsg__. @xref{XREFzlim, , @w{zlim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	814 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	815
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	816 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	817 case "zminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	818 s.doc = "Control whether minor z grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	819
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	820 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	821 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	822 case "ztick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	823 s.doc = "Position of z tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	824 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	825 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	826
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	827 case "zticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	828 s.doc = "Labels of z tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	829 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	830
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	831 case "zticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	832 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	833 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	834
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	835 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	836 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	837
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	838 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	839 elseif (strcmp (objname, "line"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	840 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	841 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	842 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	843 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	844
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	845 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	846 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	847 s.doc = "Color of the line object. @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	848 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	849
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	850 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	851 s.doc = "Text for the legend entry corresponding to this line.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	852 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	853
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	854 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	855 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	856
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	857 case "interpreter"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	858
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	859 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	860 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	861
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	862 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	863 s.doc = "Width of the line object measured in points.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	864
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	865 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	866 s.doc = "Shape of the marker for each data point. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	867 @xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	868
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	869 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	870 s.doc = "Color of the edge of the markers. When set to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	871 @qcode{\"auto\"}, the marker edges have the same color as the line. If set \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	872 to @qcode{\"none\"}, no marker edges are displayed. This property can also \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	873 be set to any color. @xref{Colors, , colorspec}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	874
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	875 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	876 s.doc = "Color of the face of the markers. When set to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	877 @qcode{\"auto\"}, the marker faces have the same color as the line. If set \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	878 to @qcode{\"none\"}, the marker faces are not displayed. This property \
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	879 can also be set to any color. @xref{Colors, , colorspec}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	880
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	881 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	882 s.doc = "Size of the markers measured in points.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	883 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	884
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	885 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	886 s.doc = "Vector of x data to be plotted.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	887 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	888
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	889 case "xdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	890 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	891 x data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	892 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	893
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	894 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	895 s.doc = "Vector of y data to be plotted.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	896 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	897
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	898 case "ydatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	899 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	900 y data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	901 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	902
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	903 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	904 s.doc = "Vector of z data to be plotted.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	905 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	906
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	907 case "zdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	908 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	909 z data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	910 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	911
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	912 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	913
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	914 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	915 elseif (strcmp (objname, "text"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	916 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	917 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	918 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	919 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	920
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	921 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	922 case "backgroundcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	923 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	924 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	925
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	926 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	927 s.doc = "Color of the text. @xref{Colors, ,colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	928 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	929
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	930 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	931 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	932 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	933 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	934
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	935 case "editing"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	936 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	937 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	938
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	939 case "extent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	940 case "fontangle"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	941 s.doc = "Flag whether the font is italic or normal. \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	942 @code{fontangle} is currently unused.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	943
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	944 case "fontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	945 s.doc = "The font used for the text.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	946 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	947
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	948 case "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	949 s.doc = "The font size of the text as measured in \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	950 @code{fontunits}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	951 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	952
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	953 case "fontunits"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	954 s.doc = "The units used to interpret @code{fontsize} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	955
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	956 case "fontweight"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	957 s.doc = "Control variant of base font used: bold, light, normal, etc.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	958
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	959 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	960 case "interpreter"
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	961 s.doc = "Control the way the @qcode{\"string\"} property is \
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	962 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	963 @xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	964
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	965 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	966 s.doc = sprintf (doc_notimpl, "Background area");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	967
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	968 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	970 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	971
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	972 case "margin"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	973 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	974 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	975
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	976 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	977 s.doc = "Vector @code{[X0 Y0 Z0]} where X0, Y0 and Z0 indicate the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	978 position of the text anchor as defined by @code{verticalalignment} and \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	979 @code{horizontalalignment}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	980 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	981
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	982 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	983 s.doc = "The angle of rotation for the displayed text, \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	984 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	985 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	986
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	987 case "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	988 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	989 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	990
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	991 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	992 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	993 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	994
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	995 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	996 elseif (strcmp (objname, "image"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	997 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	998 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	999 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1000 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1001
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1002 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1003 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1004 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1005 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1006
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1007 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1008 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1009
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1010 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1011 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1012
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1013 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1014 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1015 s.doc = "Text for the legend entry corresponding to this image.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1016 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1017
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1018 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1019 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1020
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1021 case "xdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1022 s.doc = "Two-element vector @code{[xmin xmax]} specifying the x \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1023 coordinates of the first and last columns of the image.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1024 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1025 Setting @code{xdata} to the empty matrix ([]) will restore the default value \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1026 of @code{[1 columns(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1027 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1028
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1029 case "ydata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1030 s.doc = "Two-element vector @code{[ymin ymax]} specifying the y \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1031 coordinates of the first and last rows of the image.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1032 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1033 Setting @code{ydata} to the empty matrix ([]) will restore the default value \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1034 of @code{[1 rows(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1035 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1036
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1037 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1038
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1039 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1040 elseif (strcmp (objname, "surface"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1041 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1042 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1043 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1044 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1045
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1046 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1047 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1048 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1049 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1050
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1051 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1052 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1053
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1054 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1055 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1056
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1057 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1058 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1059
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1060 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1061 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1062
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1063 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1064 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1065 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1066 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1067
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1068 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1069 s.doc = "Text for the legend entry corresponding to this surface.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1070
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1071 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1072 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1073 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1074
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1075 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1076 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1077 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1078
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1079 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1080 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1081 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1082 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1083 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1084
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1085 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1086 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1087 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1088
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1089 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1090 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1091 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1092
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1093 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1094 s.doc = "@xref{XREFlinelinewidth, , @w{line linewidth property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1095
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1096 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1097 s.doc = "@xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1098
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1099 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1100 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1101 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1102
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1103 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1104 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1105 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1106
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1107 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1108 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1109 @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1110 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1111
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1112 case "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1113 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1114 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1115 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1116
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1117 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1118 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1119
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1120 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1121 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1122
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1123 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1124 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1125 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1126
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1127 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1128 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1129 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1130
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1131 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1132 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1133 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1134
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1135 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1136 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1137
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1138 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1139 elseif (strcmp (objname, "patch"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1140 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1141 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1143 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1144
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1145 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1146 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1147 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1148
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1149 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1150 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1151 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1152
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1153 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1154 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1155
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1156 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1157 s.doc = "Data defining the patch object color.\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1158 Patch color can be defined for faces or for vertices.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1159 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1160 If @code{cdata} is a scalar index into the current colormap or a RGB triplet, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1161 it defines the color of all faces.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1162 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1163 If @code{cdata} is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1164 it defines the color of each one of the N faces.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1165 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1166 If @code{cdata} is an N-by-M or an N-by-M-by-3 (RGB) matrix, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1167 it defines the color at each vertex.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1168 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1169
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1170 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1171 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1172 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1173
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1174 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1175 s.doc = "Text of the legend entry corresponding to this patch.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1176
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1177 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1178 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1179 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1180
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1181 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1182 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1183 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1184
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1185 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1186 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1187
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1188 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1189 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1190 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1191
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1193 ## Don't provide a default value, and mark colorspec with
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1194 ## braces, this forces the default rgb triplet to be displayed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1195 s.valid = packopt ({markdef(valid_color), ...
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1196 "@qcode{\"none\"}", ...
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1197 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1198 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1199
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1200 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1201 s.doc = sprintf (doc_notimpl, "Light");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1202
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1203 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1204 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1205 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1206
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1207 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1208 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1209 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1210
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1211 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1212 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1213 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1214
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1215 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1216 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1217 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1218 s.doc = "@xref{XREFlinemarker, , @w{line marker property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1219
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1220 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1221 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1222 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1223
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1224 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1225 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1226 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1227
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1228 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1229 s.doc = "@xref{XREFlinemarkersize, , @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1230 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1231
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1232 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1233 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1234 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1235 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1236
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1237 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1238 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1239 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1240
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1241 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1242 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1243 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1244
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1245 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1246 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1247 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1248
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1249 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1250 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1251
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1252 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1253 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1254
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1255 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1256 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1257
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1258 endswitch
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1259
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1260 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1261 elseif (strcmp (objname, "uimenu"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1262 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1263 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1264 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1265 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1266
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1267 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1268 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1269 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1270 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1271 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1272 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1273 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1274 case "position"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1275 case "separator"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1276
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1277 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1278
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1279 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1280 elseif (strcmp (objname, "uicontextmenu"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1281 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1282 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1283 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1284 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1285
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1286 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1287 case "callback"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1288 case "position"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1289
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1290 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1291
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1292 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1293 elseif (strcmp (objname, "uipanel"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1294 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1295 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1296
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1297 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1298 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1299 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1300 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1301 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1302 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1303 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1304 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1305 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1306 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1307 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1308 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1309 case "resizefcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1310 case "shadowcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1311 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1312 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1313 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1314
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1315 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1316
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1317 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1318 elseif (strcmp (objname, "uicontrol"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1319 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1320 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1321
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1322 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1323 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1324 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1325 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1326 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1327 case "extent"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1328 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1329 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1330 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1331 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1332 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1333 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1334 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1335 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1336 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1337 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1338 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1339 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1340 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1341 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1342 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1343 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1344 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1345 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1346 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1347
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1348 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1349
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1350 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1351 elseif (strcmp (objname, "uitoolbar"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1352 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1353 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1354 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1355 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1356
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1357 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1358
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1359 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1360 elseif (strcmp (objname, "uipushtool"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1361 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1362 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1363 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1364 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1365
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1366 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1367 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1368 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1369 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1370 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1371 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1372
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1373 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1374
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1375 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1376 elseif (strcmp (objname, "uitoggletool"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1377 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1378 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1379 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1380 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1381
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1382 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1383 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1384 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1385 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1386 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1387 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1388 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1389 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1390 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1391
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1392 endswitch
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1393 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1394
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1395 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1396 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1397 s.doc = expand_doc (s.doc, field, objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1398 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1399
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1400 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1401
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1402 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1403 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1404 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1405
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1406 modemsg = "Setting @code{%s} also forces the @code{%smode} \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1407 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1408 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1409 strout = strrep (strout, "__modemsg__", modemsg);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1410 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1411
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1412 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1413 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1414 if (! strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1415 ## Use an improbable number to avoid ishandle to return true for 1
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1416 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1417 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1418
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1419 ## Build a default object to extract its properties list and default values.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1420 if (strcmp (objname, "base"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1421 ## Base properties are extracted from hggroup that only have 2 additional
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1422 ## regular (non-hidden) properties, "displayname" and "erasemode".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1423 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1424 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1425 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1426 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1427 h = hf;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1428 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1429 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1430 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1431
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1432 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1433 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1434
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1435 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1436 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1437 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1438 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1439 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1440
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1441 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1442 val = getdoc (objname, field, base);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1443
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1444 ## Extract the default values that are not hard coded in getdoc
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1445 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1446 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1447 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1448
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1449 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1450
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1451 ## Extract the valid values that are not hard coded in getdoc
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1452 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1453 val.valid = sprop.(field);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1454 if (! isempty (val.valid) && iscellstr (val.valid))
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1455 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1456 val.valid = cellfun (@(s) ["@qcode{\"" s "\"}"], val.valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1457 "uniformoutput", false);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1458 val.valid = strjoin (val.valid, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1459 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1460 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1461
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1462 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1463 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1464 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1465
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1466 ## Build struct and remove unused fields in base properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1467 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1468
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1469 if (strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1470 s = rmfield (s, {"displayname", "erasemode"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1471 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1472
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1473 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1474 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1475 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1476
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1477 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1478
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1479 function def = getdefault (h, objname, field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1480 ## This function is meant to be run without initialization file so
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1481 ## that the properties we get are the default.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1482 def = get (h, field);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1483
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1484 ## Don't print default values for graphics handles
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1485 if (isscalar (def) && def != 0 && ishandle (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1486 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1487 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1488 if (ischar (def))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1489 def = ['@qcode{"' def '"}'];
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1490 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1491 if ((isvector (def) && numel (def) < 5) \|\| isempty (def))
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1492 ## Use disp to print the default value for short vectors and
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1493 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1494 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1495 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1496 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1497
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1498 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1499 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1500 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1501 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1502 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1503 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1504 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1505 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1506
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1507 ## Replace texinfo reserved characters
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1508 def = strrep (str, "{", "@{");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1509 def = strrep (def, "}", "@}");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1510 def = strrep (def, "@", "@@");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1511
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1512 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1513 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1514 args = arrayfun (@(x) num2str (x), size (def), "uniformoutput", false);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1515 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1516 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1517 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1518 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1519
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1520 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1521
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1522 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1523 ## Sort fields so that they appear in alphabetic order in the manual
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1524 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1525 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1526
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1527 ## File header and begining of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1528 str = [warn_autogen() "\n\n@table @asis"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1529
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1530 for ii = 1:nf
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1531 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1532 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1533
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1534 ## @anchor: cross reference using XREFobjnamefield label
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1535 ## Concept index: call info from octave with 'doc ("objname field")'
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1536 str = sprintf ("%s@anchor{XREF%s%s}\n@cindex %s %s\n",
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1537 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1538
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1539 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1540 str = sprintf ("%s@item @code{%s}", str, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1541
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1542 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1543 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1544 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1545 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1546 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1547 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1548
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1549 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1550 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1551 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1552 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1553 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1554 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1555 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1556 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1557
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1558 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1559 str = sprintf ("%s%s\n", str, obj.(field).doc);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1560 endfor
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1561
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1562 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1563 str = sprintf ("%s\n@end table", str);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1564
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1565 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1566
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1567 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1568 str = "@c DO NOT EDIT! Generated automatically by genpropdoc.m.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1569 \n\
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19597 diff changeset	1570 @c Copyright (C) 2014-2015 Pantxo Diribarne\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1571 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1572 @c This file is part of Octave.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1573 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1574 @c Octave is free software; you can redistribute it and/or modify it\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1575 @c under the terms of the GNU General Public License as published by the\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1576 @c Free Software Foundation; either version 3 of the License, or (at\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1577 @c your option) any later version.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1578 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1579 @c Octave is distributed in the hope that it will be useful, but WITHOUT\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1580 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n\
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1581 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1582 @c for more details.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1583 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1584 @c You should have received a copy of the GNU General Public License\n\
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1585 @c along with Octave; see the file COPYING. If not, see\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1586 @c <http://www.gnu.org/licenses/>.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1587 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1588
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1589 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1590 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1591 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1592 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1593 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1594 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1595 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1596 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1597 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1598 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1599 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1600 endif
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1601
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1602 endfunction

Mercurial > octave

annotate doc/interpreter/genpropdoc.m @ 21319:8880d93010d8