octave: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 23205:1468c2234478 stable

Better documentation of *fcn properties * genpropdoc.m: new place holder __fcnmsg__ to add a generic message to *fcn properties * plot.txi (Callbacks section): change variable names for clarity. Add a note (and a link) onb how a function handles can be provided. Add a caution about the "event" argument not being fully/concistently implemented.

author	Pantxo Diribarne <pantxo.diribarne@gmail.com>
date	Sun, 19 Feb 2017 14:59:58 +0100
parents	c16e46aa3553
children	8fd8ed1e3aa2 3ac9f9ecfae5

rev	line source
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 22192 diff changeset	1 ## Copyright (C) 2014-2016 Pantxo Diribarne
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	3 ## This program is free software; you can redistribute it and/or modify it
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	4 ## under the terms of the GNU General Public License as published by
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	5 ## the Free Software Foundation; either version 3 of the License, or
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	6 ## (at your option) any later version.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	7 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	8 ## This program is distributed in the hope that it will be useful,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	11 ## GNU General Public License for more details.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	12 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	13 ## You should have received a copy of the GNU General Public License
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	14 ## along with this program. If not, see
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	15 ## <http://www.gnu.org/licenses/>.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	16
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	17 ## -- texinfo --
21319 8880d93010d8 Remove further uses of CLASS field in @deftypefn macro. Rik <rik@octave.org> parents: 20930 diff changeset	18 ## @deftypefn {} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	19 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	20 ## Print FILENAME texinfo source file associated to OBJNAME objects. This
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	21 ## function is meant to be run for generating octave documentation
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	22 ## (see doc/interpreter/graphics_properties.mk).
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	23 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	24 ## All the hard coded documentation is written in getdoc function. See the
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	25 ## comments in getdoc bellow for instruction on how to document a graphics
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	26 ## property.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	27 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	28 ## @seealso{}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	29 ## @end deftypefn
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	30
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	31 function genpropdoc (objname, fname)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	32 objnames = {"root", "figure", "axes", "line", ...
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	33 "text", "image", "patch", "surface", "light", ...
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	34 "uimenu", "uibuttongroup", "uicontextmenu", "uipanel", ...
20593 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"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	127 s.doc = "__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	128 s.valid = valid_fcn;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	129
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	130 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	131 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	132 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	133
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	134 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	135 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	136 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	137
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	138 case "createfcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	139 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	140 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	141 e.g., @code{set (0, \"default__objname__createfcn\", \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	142 'disp (\"__objname__ created!\")')}.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	143 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	144
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	145 case "deletefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	146 s.doc = "Callback function executed immediately before __objname__ \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	147 is deleted.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	148 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	149
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	150 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	151 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	152 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	153
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	154 case "hittest"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	155 case "interruptible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	156 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	157 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	158 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	159
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	160 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	161 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	162 case "tag"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	163 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	164 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	165
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	166 case "type"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	167 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	168 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	169 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	170 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	171
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	172 case "uicontextmenu"
20077 69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	173 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	174 currently associated to this __objname__ object.";
69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	175 s.valid = valid_handle;
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	176
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	177 case "userdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	178 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	179 s.valid = "Any Octave data";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	180
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	181 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	182 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	183 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	184 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	185
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	186 ## Root properties:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	187 elseif (strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	188 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	189 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	190 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	191 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	192 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	193 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	194 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	195
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	196 case "parent"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	197 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	198 is always empty.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	199
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	200 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	201 case "callbackobject"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	202 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	203 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	204
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	205 case "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	206 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	207 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	208
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	209 case "diary"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	210 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	211 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	212
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	213 case "diaryfile"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	214 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	215 @xref{XREFdiary, , @w{diary function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	216 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	217
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	218 case "echo"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	219 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	220 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	221
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	222 case "errormessage"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	223 s.doc = "The last error message raised. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	224 @xref{XREFlasterr, , @w{lasterr function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	225 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	226
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	227 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	228 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	229
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	230 case "format"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	231 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	232 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	233
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	234 case "formatspacing"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	235 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	236 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	237
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	238 case "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	239 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	240
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	241 case "monitorpositions"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	242 s.doc = doc_unused;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	243 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	244
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	245 case "pointerlocation"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	246 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	247 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	248
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	249 case "pointerwindow"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	250 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	251 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	252
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	253 case "recursionlimit"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	254 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	255 recursively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	256 @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	257 s.valid = "double";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	258
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	259 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	260 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	261 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	262
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	263 case "screenpixelsperinch"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	264 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	265 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	266
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	267 case "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	268 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	269 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	270
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	271 case "showhiddenhandles"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	272 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	273 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	274 @code{handlevisibility} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	275
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	276 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	277 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	278
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	279 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	280 elseif (strcmp (objname, "figure"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	281 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	282 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	283 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	284 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	285
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	286 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	287 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	288 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	289
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	290 case "closerequestfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	291 s.doc = "Function that is executed when a figure is deleted. \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	292 @xref{XREFclosereq, , closereq function}.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	293 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	294
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	295 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	296 s.doc = "Color of the figure background. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	297 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	298 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	299
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	300 case "colormap"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	301 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	302 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	303
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	304 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	305 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	306 s.valid = valid_handle;
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 "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	309 s.doc = doc_unused;
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 "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	312 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	313
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	314 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	315 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	316 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	317 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	318 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	319 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	320 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	321 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	322 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	323 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	324 @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	325 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	326 @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	327 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	328 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	329 s.valid = valid_2elvec;
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 "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	332 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	333
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	334 case "filename"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	335 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	336 s.valid = valid_string;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	337
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	338 case "graphicssmoothing"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	339 s.doc = "Use smoothing techniques to reduce the appearance of jagged lines.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	340
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	341 case "integerhandle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	342 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	343
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	344 case "inverthardcopy"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	345 s.doc = "Replace the figure and axes background color with white when printing.";
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	346
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	347 case "keypressfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	348 s.doc = "Callback function executed when a keystroke event \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	349 happens while the figure has focus. The actual key that was pressed \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	350 can be retrieved using the second argument 'evt' of the function. __fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	351 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	352
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	353 case "keyreleasefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	354 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	355 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	356 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	357 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	358 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	359 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	360 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	361 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	362 @item Key:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	363 Lowercase value of the key\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	364 @item Modifier:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	365 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	366 key.\n\
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	367 @end table\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	368 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	369 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	370
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	371 case "menubar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	372 s.doc = "Control the display of the figure menu bar at the top \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	373 of the figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	374
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	375 case "name"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	376 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	377 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	378 property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	379 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	380
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	381 ## 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	382 #case "number"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	383 # s.doc = "Number of current figure (RO).";
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	384
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	385 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	386 s.doc = "__prop__ is used by high level plotting functions to \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	387 decide what to do with axes already present in the figure. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	388 @xref{XREFnewplot, , @w{newplot function}}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	389
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	390 case "numbertitle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	391 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	392 value in the figure title bar.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	393
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	394 case "outerposition"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	395 s.doc = "Specify the position and size of the figure including \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	396 the top menubar and the bottom status bar. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	397 The four elements of the vector are the coordinates of the lower left corner \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	398 and width and height of the figure. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	399 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	400 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	401
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	402 case "paperorientation"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	403 s.doc = "The value for the @code{papersize}, and @code{paperposition} \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	404 properties depends upon __prop__. The horizontal and vertical values for \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	405 @code{papersize} and @code{paperposition} reverse order \
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	406 when __prop__ is switched between @code{\"portrait\"} and \
22506 84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation Rik <rik@octave.org> parents: 22323 diff changeset	407 @code{\"landscape\"}.";
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	408
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	409 case "paperposition"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	410 s.doc = "Vector @code{[left bottom width height]} defining the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	411 position and size of the figure (in @code{paperunits} units) on the printed \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	412 page. The position @code{[left bottom]} defines the lower left corner of the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	413 figure on the page, and the size is defined by @code{[width height]}. For \
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	414 output formats not implicitly rendered on paper, @code{width} and \
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	415 @code{height} define the size of the image and the position information is \
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	416 ignored. \
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	417 __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	418 s.valid = valid_4elvec;
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 "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	421 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	422 @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	423 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	424 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	425 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	426
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	427 case "papersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	428 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	429 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	430 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	431 @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	432 @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	433 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	434 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	435 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	436
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	437 case "papertype"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	438 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	439 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	440 with the @code{paperorientation} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	441
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	442 case "paperunits"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	443 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	444 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	445 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	446 @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	447
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	448 case "pointer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	449 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	450 case "pointershapecdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	451 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	452 case "pointershapehotspot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	453 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	454
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	455 case "position"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	456 s.doc = "Specify the position and size of the figure canvas. \
22507 5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	457 The four elements of the vector are the coordinates of the lower left corner \
5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	458 and width and height of the figure. \
5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	459 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	460 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	461
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	462 case "renderer"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	463 s.doc = doc_unused;
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	464
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	465 case "renderermode"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	466 s.doc = doc_unused;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	467
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	468 case "resize"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	469 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	470
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	471 case "resizefcn"
22506 84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation Rik <rik@octave.org> parents: 22323 diff changeset	472 s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
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 "selectiontype"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	476 ## 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	477
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	478 case "sizechangedfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	479 s.doc = "Callback triggered when the figure window size is changed.\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	480 \n\n__fcnmsg__";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	481 s.valid = valid_fcn;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	482
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	483 case "toolbar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	484 s.doc = "Control the display of the toolbar (along the bottom of the \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	485 menubar) and the status bar. When set to @qcode{\"auto\"}, the display is based on the value of the @code{menubar} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	486
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	487 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	488 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	489 @code{outerposition} properties.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	490
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	491 case "windowbuttondownfcn"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	492 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	493 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	494 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	495
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	496 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	497 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	498 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	499 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	500
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	501 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	502 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	503 @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	504 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	505 released respectively. When these callback functions are executed, the \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	506 @code{currentpoint} property holds the current coordinates of the cursor.\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	507 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	508 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	509
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	510 case "windowkeypressfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	511 s.doc = "Function that is executed when a key is pressed and \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	512 the figure has focus.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	513 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	514
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	515 case "windowkeyreleasefcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	516 s.doc = "Function that is executed when a key is released and \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	517 the figure has focus.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	518 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	519
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	520 case "windowscrollwheelfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	521 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	522 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	523
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	524 case "windowstyle"
21996 d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	525 s.doc = "The window style of a figure. One of the following values:\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	526 @table @code\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	527 @item normal\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	528 Set the window style as non modal.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	529 @item modal\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	530 Set the window as modal so that it will stay on top of all normal figures.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	531 @item docked\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	532 Setting the window style as docked currently does not dock the window.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	533 @end table\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	534 \n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	535 Changing modes of a visible figure may cause the figure to close and reopen.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	536
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	537 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	538
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	539 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	540 elseif (strcmp (objname, "axes"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	541 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	542 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	543 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	544 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	545
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	546 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	547 case "activepositionproperty"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	548 s.doc = "Specify which of @qcode{\"position\"} or \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	549 @qcode{\"outerposition\"} properties takes precedence when axes \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	550 annotations extent changes. @xref{XREFaxesposition, , @w{position property}}, \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	551 and @ref{XREFaxesposition, , @w{outerposition property}}.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	552
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	553 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	554 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	555
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	556 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	557 case "ambientlightcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	558 s.doc = doc_unused;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	559
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	560 case "box"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	561 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	562
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	563 case "boxstyle"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	564 s.doc = "For 3-D axes, control whether the @qcode{\"full\"} \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	565 box is drawn or only the 3 @qcode{\"back\"} axes";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	566
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	567 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	568 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	569
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	570 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	571 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	572 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	573
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	574 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	575 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	576 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	577
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	578 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	579 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	580 s.valid = "scalar";
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 "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	583 case "clim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	584 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	585 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	586 s.valid = valid_2elvec;
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 "climmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	589
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	590 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	591 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	592
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	593 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	594 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	595 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	596
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	597 case "colororder"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	598 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	599 coloring.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	600 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	601
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	602 case "colororderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	603 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	604
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	605 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	606 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	607 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	608 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	609 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	610 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	611 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	612 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	613 perpendicular to the screen.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	614 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	615
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	616 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	617 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	618 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	619 @w{@code{[1, 2]}} causes the length of one unit as displayed on the x-axis \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	620 to be the same as the length of 2 units on the y-axis. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	621 @xref{XREFdaspect, , daspect function}. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	622 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	623
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	624 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	625 case "fontangle"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	626 s.doc = "Control 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	627 case "fontname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	628 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	629 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	630
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	631 case "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	632 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	633 @xref{XREFaxesfontunits, , @w{fontunits property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	634 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	635
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	636 case "fontunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	637 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	638
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	639 case "fontsmoothing"
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 "fontweight"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	643 s.doc = "Control variant of base font used: bold, demi, light, normal.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	644 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	645 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	646
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	647 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	648 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	649
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	650 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	651 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	652
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	653 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	654 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	655
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	656 case "gridlinestyle"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	657
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	658 case "labelfontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	659 s.doc = "Ratio between the x/y/zlabel fontsize and the tick \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	660 label fontsize";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	661
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	662 case "layer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	663 s.doc = "Control whether the axes is drawn below child graphics \
21530 7c143e73e921 doc: Don't create end-of-sentence period with "etc." in Texinfo. Rik <rik@octave.org> parents: 21319 diff changeset	664 objects (ticks, labels, etc.@: covered by plotted objects) or above.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	665
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	666 case "linestyleorder"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	667 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	668
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	669 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	670 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	671
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	672 case "linewidth"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	673 s.doc = "Width of the main axes lines";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	674
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	675 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	676 s.doc = sprintf (doc_notimpl, "Transparency");
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 "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	679 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	680
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	681 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	682 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	683
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	684 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	685 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	686
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	687 case "minorgridlinestyle"
19776 4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom". Rik <rik@octave.org> parents: 19746 diff changeset	688 case "mousewheelzoom"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	689 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	690 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	691
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	692 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	693 s.doc = "__prop__ is used by high level plotting functions to \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	694 decide what to do with graphics objects already present in the axes. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	695 @xref{XREFnewplot, , @w{newplot function}}. The state of __prop__ \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	696 is typically controlled using the @code{hold} function. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	697 @xref{XREFhold, , @w{hold function}}.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	698
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	699 case "outerposition"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	700 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	701 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	702 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	703 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	704 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	705 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	706 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	707 @xref{XREFaxesposition, , @w{position property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	708 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	709
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	710 case "pickableparts"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	711 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	712
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	713 case "plotboxaspectratio"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	714 s.doc = "@xref{XREFpbaspect, , pbaspect function}. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	715 __modemsg__.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	716
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	717 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	718 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	719 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	720 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	721 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	722 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	723 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	724 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	725 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	726 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	727 s.valid = valid_4elvec;
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 "projection"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	730 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	731
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	732 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	733 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	734
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	735 case "tickdir"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	736 s.doc = "Control whether axes tick marks project \"in\" to the plot \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	737 box or \"out\". __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	738
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	739 case "tickdirmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	740
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	741 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	742 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	743 @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	744
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	745 case "ticklength"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	746 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	747 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	748 s.valid = valid_2elvec;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	749
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	750 case "tightinset"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	751 s.doc = "Size of the @code{[left bottom right top]} margins \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	752 around the axes that enclose labels and title annotations.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	753 s.valid = valid_4elvec;
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	754
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	755 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	756 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	757 s.valid = valid_handle;
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 "titlefontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	760 s.doc = "Ratio between the title fontsize and the tick \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	761 label fontsize";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	762 s.valid = "positive scalar";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	763
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	764 case "titlefontweight"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	765 s.doc = "Control variant of base font used for the axes title.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	766
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	767 case "units"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	768 s.doc = "Units used to interpret the @qcode{\"position\"}, \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	769 @qcode{\"outerposition\"}, and @qcode{\"tightinset\"} properties.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	770
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	771 case "view"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	772 s.doc = "Two-element vector @code{[azimuth elevation]} specifying \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	773 the viewpoint for three-dimensional plots";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	774 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	775
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	776 case "xaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	777 s.doc = "Control the x axis location.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	778
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	779 case "xcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	780 s.doc = "Color of the x-axis. @xref{Colors, , colorspec}. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	781 __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	782 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	783
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	784 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	785
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	786 case "xdir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	787 s.doc = "Direction of the x axis: @qcode{\"normal\"} is left \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	788 to right.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	789
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	790 case "xgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	791 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	792
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	793 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	794 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	795 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	796
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	797 case "xlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	798 s.doc = "Two-element vector @code{[xmin xmax]} specifying the limits \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	799 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	800 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	801
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	802 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	803 case "xminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	804 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	805
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	806 case "xminortick"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	807 case "xscale"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	808 case "xtick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	809 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	810 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	811 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	812
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	813 case "xticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	814 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	815 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	816
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	817 case "xticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	818 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	819 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	820
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	821 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	822 case "yaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	823 s.doc = "Control the y-axis location.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	824
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	825 case "ycolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	826 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	827 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	828
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	829 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	830
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	831 case "ydir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	832 s.doc = "Direction of the y-axis: @qcode{\"normal\"} is bottom \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	833 to top.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	834
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	835 case "ygrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	836 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	837
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	838 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	839 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	840 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	841
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	842 case "ylim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	843 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	844 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	845 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	846
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	847 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	848 case "yminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	849 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	850
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	851 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	852 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	853 case "ytick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	854 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	855 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	856 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	857
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	858 case "yticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	859 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	860 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	861
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	862 case "yticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	863 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	864 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	865
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	866 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	867 case "zcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	868 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	869 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	870
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	871 case "zcolormode"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	872 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	873 case "zgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	874 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	875
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	876 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	877 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	878 s.valid = valid_handle;
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 "zlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	881 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	882 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	883 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	884
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	885 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	886 case "zminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	887 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	888
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	889 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	890 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	891 case "ztick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	892 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	893 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	894 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	895
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	896 case "zticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	897 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	898 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	899
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	900 case "zticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	901 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	902 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	903
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	904 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	905 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	906
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	907 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	908 elseif (strcmp (objname, "line"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	909 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	910 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	911 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	912 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	913
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	914 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	915 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	916 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	917 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	918
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	919 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	920 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	921 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	922
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	923 case "interpreter"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	924
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	925 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	926 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	927
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	928 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	929 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	930
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	931 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	932 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	933 @xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	934
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	935 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	936 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	937 @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	938 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	939 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	940
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	941 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	942 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	943 @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	944 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	945 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	946
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	947 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	948 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	949 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	950
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	951 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	952 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	953 s.valid = "vector";
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 "xdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	956 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	957 x data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	958 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	959
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	960 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	961 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	962 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	963
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	964 case "ydatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	965 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	966 y data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	967 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	968
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	970 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	971 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	972
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	973 case "zdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	974 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	975 z data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	976 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	977
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	978 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	979
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	980 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	981 elseif (strcmp (objname, "text"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	982 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	983 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	984 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	985 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	986
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	987 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	988 case "backgroundcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	989 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	990 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	991
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	992 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	993 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	994 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	995
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	996 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	997 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	998 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	999 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1000
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1001 case "editing"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1002 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1003
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1004 case "extent"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1005 s.doc = "Vector @code{[x0 y0 width height]} indicating the size \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1006 and location of the text string.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1007 s.valid = valid_4elvec;
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1008
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1009 case "fontangle"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1010 s.doc = "Control 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	1011 @code{fontangle} is currently unused.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1012
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1013 case "fontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1014 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	1015 s.valid = valid_string;
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 "fontsize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1018 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	1019 @code{fontunits}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1020 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1021
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1022 case "fontunits"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1023 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	1024
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1025 case "fontweight"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1026 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	1027
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1028 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1029 case "interpreter"
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1030 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	1031 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1032 @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	1033
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1034 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1035 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	1036
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1037 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1038 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1039 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1040
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1041 case "margin"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1042 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1043 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1044
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1045 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1046 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	1047 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	1048 @code{horizontalalignment}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1049 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1050
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1051 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1052 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	1053 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1054 s.valid = "scalar";
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 "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1057 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1058 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1059
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1060 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1061 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1062 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1063
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1064 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1065 elseif (strcmp (objname, "image"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1066 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1067 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1068 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1069 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1070
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1071 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1072 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1073 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1074 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1075
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1076 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1077 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	1078
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1079 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1080 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1081
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1082 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1083 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1084 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	1085 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1086
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1087 case "xdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1088 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	1089 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	1090 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1091 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	1092 of @code{[1 columns(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1093 s.valid = valid_2elvec;
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 "ydata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1096 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	1097 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	1098 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1099 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	1100 of @code{[1 rows(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1101 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1102
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1103 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1104
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1105 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1106 elseif (strcmp (objname, "surface"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1107 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1108 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1109 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1110 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1111
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1112 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1113 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1114 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1115 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1116
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1117 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1118 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	1119
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1120 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1121 s.doc = "Strength of the ambient light. Value between 0.0 and 1.0";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1122 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1123
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1124 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1125 s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1126 @qcode{\"reverselit\"}: The normals are always oriented towards the point of view. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1127 @qcode{\"unlit\"}: Faces with normals pointing away from the point of view are unlit.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1128
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1129 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1130 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1131
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1132 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1133 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1134 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1135 s.doc = "Strength of the diffuse reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1136 diffuse reflex) and 1.0 (full diffuse reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1137 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1138
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1139 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1140 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	1141
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1143 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1144 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1145
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1146 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1147 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1148 s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1149 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1150 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1151 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1152 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1153 @qcode{\"gouraud\"}.";
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 "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1156 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1157 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1158
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1159 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1160 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1161 s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1162 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1163 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1164 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1165 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1166 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1167
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1168 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1169 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1170 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1171
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1172 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1173 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	1174
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1175 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1176 s.doc = "@xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1177
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1178 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1179 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1180 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1181
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1182 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1183 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1184 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1185
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1186 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1187 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1188 @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1189 s.valid = "scalar";
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 "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1193 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1194 s.doc = "Reflectance for specular color. Value between 0.0 (color \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1195 of underlying face) and 1.0 (color of light source).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1196 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1197
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1198 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1199 s.doc = "Exponent for the specular reflex. The lower the value, \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1200 the more the reflex is spread out.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1201 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1202
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1203 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1204 s.doc = "Strength of the specular reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1205 specular reflex) and 1.0 (full specular reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1206 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1207
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1208 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1209 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1210 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1211
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1212 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1213 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1214 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1215
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1216 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1217 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1218 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1219
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1220 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1221 endswitch
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 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1224 elseif (strcmp (objname, "patch"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1225 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1226 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1227 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1228 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1229
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1230 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1231 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1232 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	1233
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1234 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1235 s.doc = "Strength of the ambient light. Value between 0.0 and 1.0";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1236 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1237
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1238 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1239 s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1240 @qcode{\"reverselit\"}: The normals are always oriented towards the point of view. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1241 @qcode{\"unlit\"}: Faces with normals pointing away from the point of view are unlit.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1242
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1243 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1244 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	1245 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	1246 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1247 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	1248 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	1249 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1250 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	1251 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	1252 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1253 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	1254 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	1255 s.valid = valid_scalmat;
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 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1258 s.doc = "Strength of the diffuse reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1259 diffuse reflex) and 1.0 (full diffuse reflex).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1260 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1261
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1262 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1263 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	1264
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1265 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1266 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1267 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1268
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1269 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1270 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1271 s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1272 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1273 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1274 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1275 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1276 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1277
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1278 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1279 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1280 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1281
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1282 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1283 ## 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	1284 ## 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	1285 s.valid = packopt ({markdef(valid_color), ...
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1286 "@qcode{\"none\"}", ...
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1287 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1288 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1289
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1290 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1291 s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1292 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1293 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1294 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1295 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1296 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1297
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1298 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1299 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1300 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1301
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1302 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1303 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1304 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1305
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1306 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1307 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1308 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1309
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1310 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1311 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1312 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1313 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	1314
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1315 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1316 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1317 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1318
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1319 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1320 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1321 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1322
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1323 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1324 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	1325 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1326
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1327 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1328 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1329 s.doc = "Reflectance for specular color. Value between 0.0 (color \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1330 of underlying face) and 1.0 (color of light source).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1331 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1332
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1333 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1334 s.doc = "Exponent for the specular reflex. The lower the value, \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1335 the more the reflex is spread out.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1336 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1337
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1338 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1339 s.doc = "Strength of the specular reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1340 specular reflex) and 1.0 (full specular reflex).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1341 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1342
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1343 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1344 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1345 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1346
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1347 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1348 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1349
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1350 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1351 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1352
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1353 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1354 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1355
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1356 endswitch
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1357
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1358 ## Light properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1359 elseif (strcmp (objname, "light"))
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1360 switch (field)
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1361 ## Overridden shared properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1362 case "children"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1363 s.doc = doc_unused;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1364
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1365 ## Specific properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1366 case "color"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1367 s.doc = "Color of the light source. @xref{Colors, ,colorspec}.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1368 s.valid = valid_color;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1369
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1370 case "position"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1371 s.doc = "Position of the light source.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1372
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1373 case "style"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1374 s.doc = "This string defines whether the light emanates from a \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1375 light source at infinite distance (@qcode{\"infinite\"}) or from a local \
22192 20b225a3ebf8 Update to light (patch #8943) Markus Mützel <markus.muetzel@gmx.de> parents: 21996 diff changeset	1376 point source (@qcode{\"local\"}).";
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1377
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1378 endswitch
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1379
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1380 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1381 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	1382 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1383 ## 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	1384 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1385 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	1386
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1387 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1388 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1389 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1390 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1391 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1392 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1393 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1394 case "position"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1395 case "separator"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1396
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1397 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1398
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1399 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1400 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	1401 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1402 ## 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	1403 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1404 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	1405
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1406 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1407 case "callback"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1408 case "position"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1409
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1410 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1411
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1412 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1413 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	1414 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1415 ## 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	1416
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1417 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1418 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1419 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1420 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1421 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1422 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1423 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1424 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1425 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1426 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1427 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1428 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1429 case "resizefcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1430 case "shadowcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1431 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1432 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1433 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1434
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1435 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1436
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1437 ## uibuttongroup properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1438 elseif (strcmp (objname, "uibuttongroup"))
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1439 switch (field)
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1440 ## Overridden shared properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1441
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1442 ## Specific properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1443 case "backgroundcolor"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1444 case "bordertype"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1445 case "borderwidth"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1446 case "fontangle"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1447 case "fontname"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1448 case "fontsize"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1449 case "fontunits"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1450 case "fontweight"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1451 case "foregroundcolor"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1452 case "highlightcolor"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1453 case "position"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1454 case "resizefcn"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1455 case "selectedobject"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1456 case "selectionchangedfcn"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1457 case "shadowcolor"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1458 case "title"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1459 case "titleposition"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1460 case "units"
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1461
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1462 endswitch
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1463
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1464 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1465 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	1466 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1467 ## 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	1468
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1469 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1470 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1471 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1472 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1473 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1474 case "extent"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1475 case "fontangle"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1476 case "fontname"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1477 case "fontsize"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1478 case "fontunits"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1479 case "fontweight"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1480 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1481 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1482 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1483 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1484 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1485 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1486 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1487 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1488 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1489 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1490 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1491 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1492 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1493 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1494
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1495 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1496
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1497 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1498 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	1499 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1500 ## 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	1501 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1502 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	1503
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1504 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1505
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1506 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1507 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	1508 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1509 ## 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	1510 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1511 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	1512
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1513 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1514 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1515 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1516 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1517 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1518 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1519
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1520 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1521
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1522 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1523 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	1524 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1525 ## 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	1526 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1527 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	1528
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1529 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1530 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1531 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1532 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1533 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1534 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1535 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1536 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1537 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1538
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1539 endswitch
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1540 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1541
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1542 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1543 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1544 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	1545 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1546
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1547 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1548
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1549 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1550 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1551 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1552
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1553 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	1554 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1555 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1556 strout = strrep (strout, "__modemsg__", modemsg);
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1557 fcnmsg = "For information on how to write graphics listener \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1558 functions see @ref{Callbacks, , @w{Callbacks section}}.";
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1559 strout = strrep (strout, "__fcnmsg__", fcnmsg);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1560 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1561
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1562 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1563 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1564 if (! strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1565 ## 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	1566 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1567 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1568
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1569 ## 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	1570 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1571 ## Base properties are extracted from hggroup that only have 1 additional
ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1572 ## regular (non-hidden) property, "displayname".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1573 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1574 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1575 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1576 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1577 h = hf;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1578 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1579 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1580 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1581
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1582 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1583 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1584
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1585 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1586 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1587 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1588 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1589 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1590
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1591 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1592 val = getdoc (objname, field, base);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1593
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1594 ## 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	1595 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1596 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1597 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1598
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1599 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1600
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1601 ## 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	1602 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1603 val.valid = sprop.(field);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1604 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	1605 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1606 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	1607 "uniformoutput", false);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1608 val.valid = strjoin (val.valid, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1609 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1610 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1611
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1612 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1613 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1614 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1615
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1616 ## 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	1617 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1618
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1619 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1620 s = rmfield (s, "displayname");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1621 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1622
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1623 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1624 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1625 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1626
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1627 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1628
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1629 function def = getdefault (h, objname, field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1630 ## 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	1631 ## 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	1632 def = get (h, field);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1633
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1634 ## 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	1635 if (isscalar (def) && def != 0 && ishandle (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1636 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1637 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1638 if (ischar (def))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1639 def = ['@qcode{"' def '"}'];
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1640 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1641 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	1642 ## 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	1643 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1644 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1645 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1646 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1647
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1648 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1649 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1650 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1651 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1652 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1653 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1654 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1655 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1656
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1657 ## Replace texinfo reserved characters
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1658 def = strrep (str, "{", "@{");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1659 def = strrep (def, "}", "@}");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1660 def = strrep (def, "@", "@@");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1661
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1662 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1663 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1664 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	1665 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1666 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1667 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1668 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1669
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1670 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1671
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1672 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1673 ## 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	1674 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1675 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1676
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1677 ## File header and begining of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1678 str = [warn_autogen() "\n\n@table @asis"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1679
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1680 for ii = 1:nf
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1681 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1682 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1683
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1684 ## @anchor: cross reference using XREFobjnamefield label
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1685 ## 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	1686 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	1687 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1688
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1689 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1690 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	1691
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1692 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1693 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1694 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1695 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1696 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1697 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1698
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1699 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1700 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1701 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1702 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1703 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1704 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1705 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1706 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1707
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1708 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1709 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	1710 endfor
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1711
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1712 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1713 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	1714
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1715 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1716
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1717 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1718 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	1719 \n\
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 22192 diff changeset	1720 @c Copyright (C) 2014-2016 Pantxo Diribarne\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1721 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1722 @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	1723 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1724 @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	1725 @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	1726 @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	1727 @c your option) any later version.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1728 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1729 @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	1730 @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	1731 @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	1732 @c for more details.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1733 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1734 @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	1735 @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	1736 @c <http://www.gnu.org/licenses/>.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1737 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1738
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1739 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1740 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1741 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1742 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1743 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1744 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1745 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1746 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1747 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1748 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1749 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1750 endif
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1751
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1752 endfunction

Mercurial > octave

annotate doc/interpreter/genpropdoc.m @ 23205:1468c2234478 stable