octave: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 20905:c640ea6a1612

genpropdoc.m: Improve wording for some of the paper* properties. * genpropdoc.m: Improve wording for some of the paper* properties.

author	Rik <rik@octave.org>
date	Tue, 15 Dec 2015 13:35:31 -0800
parents	3c986b688596
children	b6ea72a439f8

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 --
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	18 ## @deftypefn {Function File} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
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"
20905 c640ea6a1612 genpropdoc.m: Improve wording for some of the paper* properties. Rik <rik@octave.org> parents: 20886 diff changeset	388 s.doc = "The value for the @code{papersize} property depends upon \
c640ea6a1612 genpropdoc.m: Improve wording for some of the paper* properties. Rik <rik@octave.org> parents: 20886 diff changeset	389 __prop__. The @code{papersize} values reverse order when __prop__ is switched \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	390 between @code{\"portrait\"} and either @code{\"landscape\"} or \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	391 @code{\"rotated\"}. The value of @code{paperposition} is not dependent upon \
20905 c640ea6a1612 genpropdoc.m: Improve wording for some of the paper* properties. Rik <rik@octave.org> parents: 20886 diff changeset	392 the value of __prop__."
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"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	395 s.doc = "Vector @code{[x0 y0 width height]} defining the position and \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	396 size of the figure (in @code{paperunits} units) on the printed page. The \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	397 position @code{[x0 y0]} defines the lower left corner of the figure on the \
20905 c640ea6a1612 genpropdoc.m: Improve wording for some of the paper* properties. Rik <rik@octave.org> parents: 20886 diff changeset	398 page, and the size is defined by @code{[width height]}. For output formats \
c640ea6a1612 genpropdoc.m: Improve wording for some of the paper* properties. Rik <rik@octave.org> parents: 20886 diff changeset	399 not implicity rendered on paper, @code{width} and @code{height} define the \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	400 size of the image and the position information is ignored. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	401 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	402
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	403 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	404 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	405 @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	406 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	407 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	408 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	409
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	410 case "papersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	411 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	412 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	413 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	414 @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	415 @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	416 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	417 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	418 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	419
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	420 case "papertype"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	421 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	422 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	423 with the @code{paperorientation} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	424
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	425 case "paperunits"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	426 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	427 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	428 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	429 @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	430
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	431 case "pointer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	432 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	433 case "pointershapecdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	434 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	435 case "pointershapehotspot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	436 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	437
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	438 case "position"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	439 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	440
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	441 case "renderer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	442 case "renderermode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	443
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	444 case "resize"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	445 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	446
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	447 case "resizefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	448 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	449
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	450 case "selectiontype"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	451 ## 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	452
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	453 case "sizechangedfcn"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	454 s.valid = valid_fcn;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	455
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	456 case "toolbar"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	457 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	458 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	459 value of the @code{menubar} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	460
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	461 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	462 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	463 @code{outerposition} properties.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	464
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	465 case "windowbuttondownfcn"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	466 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	467 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	468 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	469
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	470 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	471 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	472 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	473 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	474
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	475 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	476 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	477 @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	478 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	479 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	480 @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	481 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	482
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	483 case "windowkeypressfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	484 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	485
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	486 case "windowkeyreleasefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	487 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	488
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	489 case "windowscrollwheelfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	490 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	491
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	492 case "windowstyle"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	493 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	494
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	495 ## 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	496 case "wvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	497 case "wvisualmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	498 case "xdisplay"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	499 case "xvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	500 case "xvisualmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	501
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	502 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	503
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	504 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	505 elseif (strcmp (objname, "axes"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	506 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	507 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	508 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	509 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	510
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	511 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	512 case "activepositionproperty"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	513 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	514 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	515
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	516 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	517 case "ambientlightcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	518 s.doc = sprintf (doc_notimpl, "Light");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	519
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	520 case "box"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	521 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	522
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	523 case "boxstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	524 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	525
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	526 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	527 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	528
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	529 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	530 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	531 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	532
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	533 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	534 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	535 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	536
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	537 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	538 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	539 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	540
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	541 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	542 case "clim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	543 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	544 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	545 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	546
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	547 case "climmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	548
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	549 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	550 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	551
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	552 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	553 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	554 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	555
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	556 case "colororder"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	557 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	558 coloring.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	559 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	560
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	561 case "colororderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	562 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	563
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	564 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	565 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	566 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	567 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	568 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	569 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	570 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	571 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	572 perpendicular to the screen.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	573 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	574
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	575 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	576 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	577 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	578 @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	579 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	580 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	581
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	582 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	583 case "fontangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	584 case "fontname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	585 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	586 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	587
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	588 case "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	589 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	590 @xref{XREFaxesfontunits, , @w{fontunits property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	591 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	592
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	593 case "fontunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	594 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	595
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	596 case "fontsmoothing"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	597 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	598
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	599 case "fontweight"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	600
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	601 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	602 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	603
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	604 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	605 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	606
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	607 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	608 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	609
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	610 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	611 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	612
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	613 case "gridlinestyle"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	614
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	615 case "labelfontsizemultiplier"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	616 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	617
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	618 case "layer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	619 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	620 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	621
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	622 case "linestyleorder"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	623 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	624
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	625 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	626 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	627
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	628 case "linewidth"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	629
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	630 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	631 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	632
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	633 case "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	634 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	635
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	636 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	637 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	638
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	639 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	640 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	641
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	642 case "minorgridlinestyle"
19776 4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom". Rik <rik@octave.org> parents: 19746 diff changeset	643 case "mousewheelzoom"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	644 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	645 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	646
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	647 case "nextplot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	648 case "outerposition"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	649 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	650 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	651 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	652 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	653 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	654 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	655 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	656 @xref{XREFaxesposition, , @w{position property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	657 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	658
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	659 case "pickableparts"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	660 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	661
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	662 case "plotboxaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	663 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	664 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	665 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	666 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	667 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	668 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	669 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	670 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	671 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	672 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	673 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	674
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	675 case "projection"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	676 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	677
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	678 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	679 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	680
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	681 case "tickdir"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	682 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	683 box or \"out\".";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	684
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	685 case "tickdirmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	686
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	687 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	688 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	689 @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	690
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	691 case "ticklength"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	692 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	693 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	694 s.valid = valid_2elvec;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	695
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	696 case "tightinset"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	697 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	698 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	699 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	700
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	701 case "titlefontsizemultiplier"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	702 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	703
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	704 case "titlefontweight"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	705 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	706
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	707 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	708 case "view"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	709 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	710 the viewpoint for three-dimensional plots";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	711 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	712
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	713 case "xaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	714 case "xcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	715 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	716 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	717
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	718 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	719 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	720
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	721 case "xdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	722 case "xgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	723 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	724
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	725 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	726 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	727 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	728
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	729 case "xlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	730 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	731 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	732 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	733
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	734 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	735 case "xminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	736 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	737
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	738 case "xminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	739 case "xscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	740 case "xtick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	741 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	742 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	743 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	744
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	745 case "xticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	746 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	747 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	748
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	749 case "xticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	750 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	751 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	752
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	753 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	754 case "yaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	755 case "ycolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	756 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	757 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	758
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	759 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	760 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	761
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	762 case "ydir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	763 case "ygrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	764 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	765
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	766 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	767 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	768 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	769
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	770 case "ylim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	771 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	772 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	773 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	774
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	775 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	776 case "yminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	777 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	778
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	779 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	780 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	781 case "ytick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	782 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	783 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	784 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	785
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	786 case "yticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	787 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	788 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	789
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	790 case "yticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	791 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	792 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	793
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	794 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	795 case "zcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	796 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	797 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	798
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	799 case "zcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	800 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	801
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	802 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	803 case "zgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	804 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	805
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	806 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	807 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	808 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	809
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	810 case "zlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	811 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	812 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	813 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	814
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	815 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	816 case "zminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	817 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	818
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	819 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	820 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	821 case "ztick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	822 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	823 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	824 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	825
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	826 case "zticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	827 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	828 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	829
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	830 case "zticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	831 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	832 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	833
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	834 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	835 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	836
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	837 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	838 elseif (strcmp (objname, "line"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	839 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	840 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	841 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	842 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	843
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	844 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	845 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	846 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	847 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	848
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	849 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	850 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	851 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	852
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	853 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	854 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	855
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	856 case "interpreter"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	857
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	858 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	859 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	860
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	861 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	862 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	863
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	864 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	865 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	866 @xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	867
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	868 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	869 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	870 @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	871 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	872 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	873
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	874 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	875 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	876 @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	877 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	878 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	879
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	880 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	881 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	882 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	883
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	884 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	885 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	886 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	887
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	888 case "xdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	889 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	890 x data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	891 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	892
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	893 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	894 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	895 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	896
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	897 case "ydatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	898 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	899 y data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	900 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	901
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	902 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	903 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	904 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	905
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	906 case "zdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	907 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	908 z data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	909 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	910
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	911 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	912
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	913 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	914 elseif (strcmp (objname, "text"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	915 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	916 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	917 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	918 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	919
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	920 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	921 case "backgroundcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	922 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	923 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	924
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	925 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	926 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	927 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	928
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	929 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	930 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	931 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	932 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	933
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	934 case "editing"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	935 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	936 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	937
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	938 case "extent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	939 case "fontangle"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	940 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	941 @code{fontangle} is currently unused.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	942
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	943 case "fontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	944 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	945 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	946
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	947 case "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	948 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	949 @code{fontunits}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	950 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	951
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	952 case "fontunits"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	953 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	954
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	955 case "fontweight"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	956 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	957
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	958 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	959 case "interpreter"
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	960 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	961 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	962 @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	963
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	964 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	965 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	966
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	967 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	968 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	970
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	971 case "margin"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	972 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	973 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	974
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	975 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	976 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	977 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	978 @code{horizontalalignment}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	979 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	980
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	981 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	982 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	983 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	984 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	985
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	986 case "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	987 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	988 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	989
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	990 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	991 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	992 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	993
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	994 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	995 elseif (strcmp (objname, "image"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	996 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	997 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	998 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	999 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1000
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1001 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1002 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1003 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1004 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1005
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1006 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1007 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	1008
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1009 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1010 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1011
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1012 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1013 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1014 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	1015 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1016
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1017 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1018 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1019
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1020 case "xdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1021 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	1022 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	1023 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1024 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	1025 of @code{[1 columns(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1026 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1027
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1028 case "ydata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1029 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	1030 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	1031 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1032 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	1033 of @code{[1 rows(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1034 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1035
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1036 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1037
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1038 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1039 elseif (strcmp (objname, "surface"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1040 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1041 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1042 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1043 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1044
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1045 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1046 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1047 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1048 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1049
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1050 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1051 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	1052
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1053 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1054 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	1055
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1056 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1057 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	1058
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1059 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1060 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1061
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1062 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1063 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1064 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1065 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	1066
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1067 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1068 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	1069
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1070 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1071 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1072 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1073
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1074 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1075 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1076 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	1077
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1078 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1079 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1080 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1081 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1082 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1083
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1084 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1085 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1086 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	1087
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1088 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1089 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1090 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1091
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1092 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1093 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	1094
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1095 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1096 s.doc = "@xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1097
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1098 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1099 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1100 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1101
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1102 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1103 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1104 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1105
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1106 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1107 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1108 @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1109 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1110
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1111 case "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1112 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1113 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1114 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	1115
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1116 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1117 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	1118
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1119 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1120 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	1121
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1122 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1123 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1124 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1125
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1126 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1127 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1128 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1129
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1130 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1131 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1132 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1133
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1134 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1135 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1136
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1137 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1138 elseif (strcmp (objname, "patch"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1139 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1140 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1141 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1143
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1144 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1145 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1146 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	1147
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1148 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1149 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1150 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1151
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1152 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1153 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	1154
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1155 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1156 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	1157 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	1158 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1159 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	1160 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	1161 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1162 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	1163 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	1164 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1165 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	1166 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	1167 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1168
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1169 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1170 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1171 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1172
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1173 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1174 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	1175
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1176 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1177 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1178 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1179
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1180 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1181 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1182 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	1183
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1184 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1185 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1186
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1187 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1188 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1189 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1190
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1191 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 ## 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	1193 ## 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	1194 s.valid = packopt ({markdef(valid_color), ...
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1195 "@qcode{\"none\"}", ...
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1196 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1197 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1198
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1199 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1200 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	1201
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1202 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1203 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1204 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1205
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1206 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1207 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1208 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1209
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1210 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1211 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1212 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1213
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1214 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1215 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1216 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1217 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	1218
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1219 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1220 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1221 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1222
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1223 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1224 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1225 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1226
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1227 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1228 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	1229 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1230
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1231 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1232 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1233 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1234 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1235
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1236 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1237 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1238 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1239
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1240 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1241 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1242 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1243
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1244 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1245 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1246 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1247
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1248 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1249 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1250
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1251 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1252 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1253
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1254 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1255 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1256
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1257 endswitch
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1258
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1259 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1260 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	1261 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1262 ## 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	1263 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1264 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	1265
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1266 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1267 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1268 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1269 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1270 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1271 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1272 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1273 case "position"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1274 case "separator"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1275
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1276 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1277
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1278 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1279 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	1280 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1281 ## 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	1282 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1283 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	1284
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1285 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1286 case "callback"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1287 case "position"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1288
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1289 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1290
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1291 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1292 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	1293 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1294 ## 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	1295
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1296 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1297 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1298 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1299 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1300 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1301 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1302 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1303 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1304 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1305 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1306 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1307 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1308 case "resizefcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1309 case "shadowcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1310 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1311 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1312 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1313
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1314 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1315
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1316 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1317 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	1318 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1319 ## 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	1320
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1321 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1322 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1323 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1324 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1325 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1326 case "extent"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1327 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1328 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1329 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1330 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1331 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1332 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1333 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1334 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1335 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1336 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1337 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1338 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1339 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1340 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1341 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1342 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1343 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1344 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1345 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1346
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1347 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1348
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1349 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1350 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	1351 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1352 ## 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	1353 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1354 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	1355
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1356 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1357
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1358 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1359 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	1360 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1361 ## 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	1362 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1363 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	1364
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1365 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1366 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1367 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1368 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1369 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1370 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1371
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1372 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1373
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1374 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1375 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	1376 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1377 ## 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	1378 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1379 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	1380
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1381 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1382 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1383 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1384 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1385 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1386 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1387 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1388 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1389 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1390
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1391 endswitch
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1392 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1393
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1394 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1395 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1396 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	1397 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1398
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1399 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1400
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1401 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1402 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1403 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1404
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1405 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	1406 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1407 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1408 strout = strrep (strout, "__modemsg__", modemsg);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1409 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1410
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1411 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1412 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1413 if (! strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1414 ## 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	1415 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1416 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1417
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1418 ## 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	1419 if (strcmp (objname, "base"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1420 ## 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	1421 ## 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	1422 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1423 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1424 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1425 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1426 h = hf;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1427 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1428 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1429 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1430
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1431 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1432 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1433
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1434 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1435 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1436 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1437 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1438 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1439
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1440 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1441 val = getdoc (objname, field, base);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1442
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1443 ## 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	1444 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1445 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1446 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1447
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1448 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1449
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1450 ## 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	1451 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1452 val.valid = sprop.(field);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1453 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	1454 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1455 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	1456 "uniformoutput", false);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1457 val.valid = strjoin (val.valid, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1458 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1459 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1460
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1461 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1462 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1463 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1464
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1465 ## 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	1466 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1467
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1468 if (strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1469 s = rmfield (s, {"displayname", "erasemode"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1470 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1471
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1472 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1473 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1474 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1475
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1476 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1477
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1478 function def = getdefault (h, objname, field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1479 ## 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	1480 ## 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	1481 def = get (h, field);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1482
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1483 ## 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	1484 if (isscalar (def) && def != 0 && ishandle (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1485 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1486 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1487 if (ischar (def))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1488 def = ['@qcode{"' def '"}'];
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1489 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1490 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	1491 ## 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	1492 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1493 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1494 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1495 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1496
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1497 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1498 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1499 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1500 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1501 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1502 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1503 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1504 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1505
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1506 ## Replace texinfo reserved characters
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1507 def = strrep (str, "{", "@{");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1508 def = strrep (def, "}", "@}");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1509 def = strrep (def, "@", "@@");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1510
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1511 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1512 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1513 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	1514 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1515 endif
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
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1518
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1519 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1520
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1521 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1522 ## 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	1523 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1524 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1525
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1526 ## File header and begining of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1527 str = [warn_autogen() "\n\n@table @asis"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1528
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1529 for ii = 1:nf
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1530 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1531 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1532
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1533 ## @anchor: cross reference using XREFobjnamefield label
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1534 ## 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	1535 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	1536 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1537
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1538 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1539 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	1540
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1541 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1542 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1543 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1544 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1545 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1546 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1547
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1548 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1549 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1550 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1551 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1552 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1553 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1554 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1555 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1556
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1557 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1558 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	1559 endfor
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1560
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1561 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1562 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	1563
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1564 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1565
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1566 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1567 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	1568 \n\
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19597 diff changeset	1569 @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	1570 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1571 @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	1572 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1573 @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	1574 @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	1575 @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	1576 @c your option) any later version.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1577 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1578 @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	1579 @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	1580 @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	1581 @c for more details.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1582 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1583 @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	1584 @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	1585 @c <http://www.gnu.org/licenses/>.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1586 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1587
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1588 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1589 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1590 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1591 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1592 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1593 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1594 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1595 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1596 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1597 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1598 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1599 endif
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1600
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1601 endfunction

Mercurial > octave

annotate doc/interpreter/genpropdoc.m @ 20905:c640ea6a1612